run.py

# (c) 2022 The Regents of the University of Colorado, a body corporate. Created by Stefan Tschimben.
# This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
# To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

import time
import argparse
import random
import sys
import libtmux
import os
import signal
from CBSD import CBSD

# This function can be used to create a random serial number
def rand_serial(length):
    serial = ''
    for _ in range(length):
        # Considering only upper and lowercase letters
        random_integer = random.randint(97, 97 + 26 - 1)
        flip_bit = random.randint(0, 1)
        random_integer = random_integer - 32 if flip_bit == 1 else random_integer
        serial += (chr(random_integer))
    
    return serial

def killProcess(name):
    try:
        # iterating through each instance of the process
        for line in os.popen("ps ax | grep " + name + " | grep -v grep"):
            fields = line.split()
            
            # extracting Process ID from the output
            pid = fields[0]
            
            # terminating process
            os.kill(int(pid), signal.SIGKILL)
        print("Process Successfully terminated")
        
    except Exception as e:
        print("Error Encountered while running script:", e)

def main():
    # This application takes one argument in the form of the number of heartbeats until the emulator should relinquish the frequency and deregister
    parser = argparse.ArgumentParser()
    required = parser.add_argument_group('required named arguments')
    required.add_argument('-hb', '--heartbeats', type=int, help='Number of Heartbeats to send', default=1)
    
    #add argument for latitute and longitude
    parser.add_argument('-lat', '--latitude', type=float, help='Latitude of CBSD', default=38.8809874594408)
    parser.add_argument('-lon', '--longitude', type=float, help='Longitude of CBSD', default=-77.11572714384802)
    parser.add_argument('-land', '--landmark', type=str, help='Landmark for the CBSD', default="VTARC")
    parser.add_argument('-low', '--lowfreq', type=str, help='Lower frequency for grant', default=3550e6)
    parser.add_argument('-high', '--highfreq', type=str, help='Higher frequency for grant', default=3560e6)
    parser.add_argument('-eirp', '--maxeirp', type=int, help='max EIRP when requesting a grant', default=30)
    parser.add_argument('-react', '--dpareact', type=int, help='reaction when it receives grant terminated', default=0)
    #generate random serial number


    #add argument for FCC ID
    parser.add_argument('-fcc', '--fcc_id', type=str, help='FCC ID of CBSD', default='CUBoulder-CBSD-' + str(rand_serial(6)))

    args = parser.parse_args()

    # Update these CBSD parameters with your information
    fcc_id = args.fcc_id
    user_id = "virginia-tech"
    serial = rand_serial(10) # or replace with your actual serial number
    callsign = "YourCallSign"
    category = "A" # your CBSD category
    interface = "E_UTRA" # change to match your interface

    #set latitude and longitude
    installation = {"latitude": args.latitude, "longitude": args.longitude, "height": 3.0,
    "heightType": "AGL", "indoorDeployment": "True", "eirpCapability": 25,
    "antennaGain": 8 }
    eirp = args.maxeirp

    new_cbsd = CBSD()

    # Send a registration request
    try:
        print('====================\n***Begin Registration Request***')
        cbsdId, responseCode, responseMessage, responseData = new_cbsd.register(fcc_id, user_id, serial, callsign, category, interface, installation)
        print("***Response from Registration:***")
        print("Serial Number: %s"%(serial))
        print("CBSD ID: %s" %(cbsdId))
        print("Response Code: %s" %(responseCode))
        print("Response Message: %s" %(responseMessage))
        print("Response Data: %s" %(responseData))
        print('***End of Registration Request***')

        if responseCode > 0:
            raise ValueError('Response Code %s. Registration denied with %s'%(responseCode, responseMessage))

    except ValueError as err:
        print(err)
        sys.exit(0)

    # sleep between requests to leave enough time for the repsonse
    time.sleep(2)

    # Send a spectrum inquiry
    try:
        print('====================\n***Begin Spectrum Inquiry***')
        low_freq, high_freq, responseCode, responseMessage, responseData = new_cbsd.inquiry(cbsdId)
        # Override frequency
        low_freq = int(float(args.lowfreq))
        high_freq = int(float(args.highfreq))
        print("***Response from Spectrum Inquiry:***")
        print("Selected Low Frequency: %s" %(low_freq))
        print("Selected High Frequency: %s" %(high_freq))
        print("Response Code: %s" %(responseCode))
        print("Response Message: %s" %(responseMessage))
        print("Response Data: %s" %(responseData))
        print('***End of Spectrum Inquiry Request***')
        
        if responseCode > 0:
            raise ValueError('Response Code %s. Spectrum Inquiry failed with %s'%(responseCode, responseMessage))

    except ValueError as err:
        print(err)
        sys.exit(0)

    time.sleep(2)
    Granted = False
    try: 
        while(True):
            eirp = args.maxeirp
            low_freq = int(float(args.lowfreq))
            high_freq = int(float(args.highfreq))
            # Send a grant request
            try:
                print('====================\n***Begin Grant Request***')
                grantId, grantExpireTime, heartbeatInterval, channelType, responseCode, responseMessage, responseData = new_cbsd.grant_request(cbsdId, eirp, low_freq, high_freq)
                print("***Response from Grant:***")
                print("Grant ID: %s" %(grantId))
                print("Grant Expire Time: %s" %(grantExpireTime))
                print("Heartbeat Max Interval: %s" %(heartbeatInterval))
                print("Channel Type: %s" %(channelType))
                print("Response Code: %s" %(responseCode))
                print("Response Message: %s" %(responseMessage))
                print("Response Data: %s" %(responseData))
                print('***End of Grant Request***')
                if(responseCode == 0):
                    Granted = True
                    server = libtmux.Server()
                    server.list_sessions()
                    session = server.get_by_id('$0')
                    window = session.attached_window
                    pane = window.split_window(vertical=False)
                    window.rename_window('srsRAN')
                    pane.send_keys('gnb -c gnb_rf_x310_tdd_n78_20mhz.yml; sleep 2; exit')
                else:
                    Granted = False
                    killProcess("gnb")
                    # check what the reaction should be
                    if(args.dpareact == 0):
                        # Do nothing
                        print("No changes made")
                    if(args.dpareact == 1):
                        # Change frequency
                        print("Changing frequency")
                        args.lowfreq = 3560e6
                        args.highfreq = 3570e6
                        # Update LEDs
                    if(args.dpareact == 2):
                        # Lower maxEIRP for the next grant
                        print("Lowering maxEIRP to 0 dBm")
                        args.maxeirp = 16
                        # Update LEDs
                if responseCode > 0:
                    raise ValueError('Response Code %s. Grant Request failed with %s'%(responseCode, responseMessage))

            except ValueError as err:
                print(err)
                #sys.exit(0)

            time.sleep(2)
            if(Granted):
                # Send the first heartbeat request
                try:
                    print('====================\n***Begin Heartbeat Request #1')
                    responseCode, transmitExpireTime, responseMessage, responseData = new_cbsd.heartbeat(cbsdId, grantId, 'GRANTED')
                    print("***Response from Heartbeat:***")
                    print("Transmit Expire Time: %s" %(transmitExpireTime))
                    print("Response Code: %s" %(responseCode))
                    print("Response Message: %s" %(responseMessage))
                    print("Response Data: %s" %(responseData))
                    print('***End of Heartbeat Request***')
                    if(responseMessage == 'SUSPENDED_GRANT' or not responseCode == 0):
                        GrantTerminated = True
                        print("Killing gnb process")
                        killProcess("gnb")
                        # check what the reaction should be
                        if(args.dpareact == 0):
                            # Do nothing
                            print("No changes made")
                        if(args.dpareact == 1):
                            # Change frequency
                            print("Changing frequency")
                            args.lowfreq = 3560e6
                            args.highfreq = 3570e6
                            # Update LEDs
                        if(args.dpareact == 2):
                            # Lower maxEIRP for the next grant
                            print("Lowering maxEIRP to 0 dBm")
                            args.maxeirp = 16
                            # Update LEDs

                        Granted = False
                    if responseCode > 0:
                        raise ValueError('Response Code %s. Spectrum Inquiry failed with %s'%(responseCode, responseMessage))

                except ValueError as err:
                    print(err)
                    #sys.exit(0)

                # Wait between each heartbeat request until heartbeat interval -1 second before sending the next heartbeat request
                time.sleep(heartbeatInterval-1)
                
                # Send N - 1 heartbeat requests before relinquishing the band
                # for beats in range(args.heartbeats-1):
                GrantTerminated = False
                while(not GrantTerminated):
                    beats = 0
                    try:
                        print('====================\n***Begin Heartbeat Request #%s***'%(beats+2))
                        responseCode, transmitExpireTime, responseMessage, responseData = new_cbsd.heartbeat(cbsdId, grantId, 'AUTHORIZED')
                        print("***Response from Heartbeat:***")
                        print("Transmit Expire Time: %s" %(transmitExpireTime))
                        print("Response Code: %s" %(responseCode))
                        print("Response Message: %s" %(responseMessage))
                        print("Response Data: %s" %(responseData))
                        print('***End of Heartbeat Request***')

                        time.sleep(heartbeatInterval-2)
                        if(responseMessage == 'SUSPENDED_GRANT' or not responseCode == 0):
                            print("Killing gnb process")
                            killProcess("gnb")
                            GrantTerminated = True
                            Granted = False
                            # check what the reaction should be
                            if(args.dpareact == 0):
                                # Do nothing
                                print("No changes made")
                            if(args.dpareact == 1):
                                # Change frequency
                                print("Changing frequency")
                                args.lowfreq = 3560e6
                                args.highfreq = 3570e6
                                # Update LEDs
                            if(args.dpareact == 2):
                                # Lower maxEIRP for the next grant
                                print("Lowering maxEIRP to 0 dBm")
                                args.maxeirp = 16
                                # Update LEDs
                            break
                        if responseCode > 0:
                            raise ValueError('Response Code %s. Spectrum Inquiry failed with %s'%(responseCode, responseMessage))
                    except ValueError as err:
                        print(err)
                        #sys.exit(0)
                    beats += 1
    except KeyboardInterrupt:
        pass
    # Send a relinquishment request
    try:
        killProcess("gnb")
        print('====================\n***Begin Relinquishment Request***')
        responseCode, responseMessage, responseData = new_cbsd.relinquish(cbsdId, grantId)
        print("***Response from Relinquishment:***")
        print("Response Code: %s" %(responseCode))
        print("Response Message: %s" %(responseMessage))
        #print("Response Data: %s" %(responseData))
        print('***End of Relinquishment Request***')

        if responseCode > 0:
            raise ValueError('Response Code %s. Spectrum Inquiry failed with %s'%(responseCode, responseMessage))

    except ValueError as err:
        print(err)
        sys.exit(0)

    time.sleep(2)

    # Send a deregistration request
    try:
        print('====================\n***Begin Deregistration Request***')
        responseCode, responseMessage, responseData = new_cbsd.deregister(cbsdId)
        print("***Response from Deregistration:***")
        print("Response Code: %s" %(responseCode))
        print("Response Message: %s" %(responseMessage))
        print("Response Data: %s" %(responseData))
        print('***End of Deregistration Request***')
        print("#####==========#####")

        if responseCode > 0:
            raise ValueError('Response Code %s. Spectrum Inquiry failed with %s'%(responseCode, responseMessage))

    except ValueError as err:
        print(err)
        sys.exit(0)

if __name__ == '__main__':
    main()