Changes between Version 1 and Version 2 of Tutorials/Wireless/Measurement Tool


Ignore:
Timestamp:
May 21, 2019, 3:48:05 AM (6 years ago)
Author:
nilanjan
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • Tutorials/Wireless/Measurement Tool

    v1 v2  
    22This tutorial will demonstrate data collection method using the OML interface.
    33
    4 == Prerequisites ==
    5  1. Accounts, ssh keys
    6  2. Reservation
    7  3. Familiarity with USRPs.
    8 
    94=== Description ===
    105This tutorial utilizes an existing application provided by the UHD driver. The application used is ''rx_multi_sample'' which is a c++ application that configures and reads samples from multiple the USRPs. A c++ based OML-wrapper has been added to this application to store FFTed blocks of samples to an OML database server.
    116
    127=== Set up ===
    13  1. First ssh into the console that you made a reservation.
    14  2. Use the ''omf stat'' to find all the experiment servers and SDRs that are seen by OMF.
    15 {{{
    16 console> omf stat -t all
    17  INFO NodeHandler: OMF Experiment Controller 5.4 (git 861d645)
    18  INFO NodeHandler: Slice ID: default_slice (default)
    19  INFO NodeHandler: Experiment ID: default_slice-2019-05-14t10.58.59.167-04.00
    20  INFO NodeHandler: Message authentication is disabled
    21  INFO property.resetDelay: resetDelay = 200 (Fixnum)
    22  INFO property.resetTries: resetTries = 1 (Fixnum)
    23  INFO property.nodes: nodes = "system:topo:all" (String)
    24  INFO property.summary: summary = false (FalseClass)
    25  INFO Topology: Loaded topology 'system:topo:all'.
    26 
    27 Talking to the CMC service, please wait
    28 -----------------------------------------------
    29  Node: mob1.sb1.cosmos-lab.org           State: POWERON
    30  Node: mob2.sb1.cosmos-lab.org           State: POWERON
    31  Node: mob3.sb1.cosmos-lab.org           State: POWERON
    32  Node: sdr1-lg1.sb1.cosmos-lab.org       State: POWERON
    33  Node: sdr1-md1.sb1.cosmos-lab.org       State: POWERON
    34  Node: sdr2-lg1.sb1.cosmos-lab.org       State: POWERON
    35  Node: sdr2-md1.sb1.cosmos-lab.org       State: POWERON
    36  Node: srv1-lg1.sb1.cosmos-lab.org       State: POWERON
    37  Node: srv2-lg1.sb1.cosmos-lab.org       State: POWERON
    38 -----------------------------------------------
    39 
    40  INFO EXPERIMENT_DONE: Event triggered. Starting the associated tasks.
    41  INFO NodeHandler:
    42  INFO NodeHandler: Shutting down experiment, please wait...
    43  INFO NodeHandler:
    44  INFO run: Experiment default_slice-2019-05-14t10.58.59.167-04.00 finished after 0:5
    45 }}}
    46 
    47  3. Load the ''baseline-sdr.ndz'' image onto the experiment server. This image has the UHD driver and other pertinent libraries  pre-installed. For this tutoral we'll use ''srv1-lg1.sb1.cosmos-lab.org'' as the experiment server.
    48 {{{
    49 console> omf load -i baseline-sdr.ndz -t srv1-lg1.sb1.cosmos-lab.org
    50 }}}
    51 
    52  4. After loading is complete turn on the experiment server. We'll also use the ''sdr1-lg1.sb1.cosmos-lab.org'' which is an N310 USRP. So turn this on as well.
    53 {{{
    54 console> omf tell -a on -t srv1-lg1.sb1.cosmos-lab.org,sdr1-lg1.sb1.cosmos-lab.org
    55 }}}
    56 
    57  5. Use the ''omf stat'' command again to verify ON/OFF status of the devices.
    58 {{{
    59 console> omf stat -t srv1-lg1.sb1.cosmos-lab.org,sdr1-lg1.sb1.cosmos-lab.org
    60 }}}
    61 
    62 
    63  7. Configure interface
    64 {{{
    65 ifconfig enp1s0 10.115.1.1 netmask 255.255.0.0 mtu 8000
    66 }}}
    67 
    68  6. Next ssh into the experiment server and discover the USRP that we turned on. We'll need the ip address for this USRP; At the command line do a 'host sdr1-lg1.sb1.cosmos-lab.org' to find its ip address. Then run ''uhd_find_devices'' with the --args option to discovery the USRP.
    69 {{{
    70 native@localhost:~$ host sdr1-lg1.sb1.cosmos-lab.org
    71 sdr1-lg1.sb1.cosmos-lab.org has address 10.113.2.1
    72 
    73 native@localhost:~$ uhd_find_devices --args="addr=10.113.2.1"
    74 
    75 <<some output here>>>
    76 }}}
     8 1. Sign up for a [https://cosmos-lab.org/portal-2/ COSMOS account]
     9 2. [Documentation/Short/CreateRes Create a resource reservation on sandbox 1]
     10 3. [Documentation/Short/Login Login into your reserved domain.]
     11 4. Load baseline-uhd1.ndz on your resource. [Documentation/Short/LoadImage  - this is done via OMF commands.] After loading the mage onto a Krypton node and start the PCIe driver from the Krypton's host and verify the radio is detected. [https://wiki.cosmos-lab.org/wiki/tutorials/krypton_usage Details on Krypton set up is here.]
     12
     13
    7714
    7815=== Explain ''rx_multi_receive'' application and how to use ===
    … …  
    8219Use the --help option to display all the variables ''rx_multi_receive'' accepts.
    8320{{{
    84 root@node20-1:~/RX_MULTI_RECEIVE# ./rx_multi_receive --help
    85 linux; GNU C++ version 4.8.4; Boost_105400; UHD_003.010.001.001-0-unknown
    86 
     21root@sdr2-md1:~/RX_MULTI_RECEIVE# ./rx_multi_receive --help
    8722UHD RX Multi Receive Allowed options:
    8823  --help                        help message
    … …  
    11247To use ''rx_multi_receive'' standalone on an experiment server we can using the following options
    11348{{{
    114 root@node20-1:~/RX_MULTI_RECEIVE# ~/RX_MULTI_RECEIVE/rx_multi_receive --args="addr0=10.10.23.5" --freq 2440e6 --rate 20e6 --gain 3
    115  --nsamps 1024000 --channels "0" --dilv
    116 }}}
    117 
    118  --args="addr0=10.10.23.5" specifies the SDR's IP address.
    119  --freq 2440e6             sets the center freq
    120  --rate 20e6               sets sampling rate
    121  --gain 3                  sets receive path gain
    122  --nsamps 1024000          number of samples to collect
    123 
    124 Executing the application with only the above options will only configure the USRP's radio parameters and read in the specified nu
    125 mber of samples. However the samples will be lost once the application exits. You should see output similar to the following.
    126 {{{
    127 
    128 linux; GNU C++ version 4.8.4; Boost_105400; UHD_003.010.001.001-0-unknown
    129 
    130 
    131 Creating the usrp device with: addr0=10.10.23.5...
    132 -- X300 initialization sequence...
    133 -- Determining maximum frame size... 7972 bytes.
    134 -- Setup basic communication...
    135 -- Loading values from EEPROM...
    136 -- Setup RF frontend clocking...
    137 -- Radio 1x clock:200
    138 
    139 :
    140 :
    141 :
    142 
     49root@sdr2-md1:~/RX_MULTI_RECEIVE# ./rx_multi_receive --args="type=x300" --nsamps 1024000 --freq 2440e6 --rate 100e6 --gain 15 --dilv
     50}}}
     51
     52 || --args="addr0=10.10.23.5" || specifies the SDR's IP address. ||
     53 || --freq 2440e6             || sets the center freq ||
     54 || --rate 20e6               || sets sampling rate ||
     55 || --gain 3                  || sets receive path gain ||
     56 || --nsamps 1024000          || number of samples to collect ||
     57
     58Executing the application with only the above options will only configure the USRP's radio parameters and read in the specified number of samples. However the samples will be lost once the application exits. You should see output similar to the following.
     59{{{
     60Creating the usrp device with: type=x300...
     61[INFO] [UHD] linux; GNU C++ version 7.4.0; Boost_106501; UHD_3.14.0.HEAD-0-g6875d061
     62[INFO] [X300] X300 initialization sequence...
     63[INFO] [X300] Connecting to niusrpriorpc at localhost:5444...
     64[INFO] [X300] Using LVBITX bitfile /usr/local/share/uhd/images/usrp_x310_fpga_HG.lvbitx...
     65[INFO] [X300] Radio 1x clock: 200 MHz
     66[INFO] [GPS] Found an internal GPSDO: LC_XO, Firmware Rev 0.929a
     67[INFO] [0/DmaFIFO_0] Initializing block control (NOC ID: 0xF1F0D00000000000)
     68[INFO] [0/DmaFIFO_0] BIST passed (Throughput: 1296 MB/s)
     69[INFO] [0/DmaFIFO_0] BIST passed (Throughput: 1302 MB/s)
     70[INFO] [0/Radio_0] Initializing block control (NOC ID: 0x12AD100000000001)
     71[INFO] [0/Radio_1] Initializing block control (NOC ID: 0x12AD100000000001)
     72[INFO] [0/DDC_0] Initializing block control (NOC ID: 0xDDC0000000000000)
     73[INFO] [0/DDC_1] Initializing block control (NOC ID: 0xDDC0000000000000)
     74[INFO] [0/DUC_0] Initializing block control (NOC ID: 0xD0C0000000000000)
     75[INFO] [0/DUC_1] Initializing block control (NOC ID: 0xD0C0000000000000)
    14376Using Device: Single USRP:
    14477  Device: X-Series Device
    … …  
    14780    RX DSP: 0
    14881    RX Dboard: A
     82    RX Subdev: UBX RX
     83  RX Channel: 1
     84    RX DSP: 0
     85    RX Dboard: B
    14986    RX Subdev: UBX RX
    15087  TX Channel: 0
    … …  
    15895
    15996Number mboards        = 1
    160 Number of rx channels = 1
    161 Setting RX Rate: 20.000000 Msps...
    162 Actual RX Rate: 20.000000 Msps...
     97Number of rx channels = 2
     98Setting RX Rate: 100.000000 Msps...
     99Actual RX Rate: 100.000000 Msps...
    163100
    164101Setting RX Freq: 2440.000000 MHz...
    165102Actual RX Freq: 2440.000000 MHz...
    166103
    167 Setting RX Gain: 3.000000 dB...
    168 Actual RX Gain: 3.000000 dB...
     104Setting RX Gain: 15.000000 dB...
     105Actual RX Gain: 15.000000 dB...
    169106
    170107Setting device timestamp to 0...
    171108channel_nums.size() = 1
    172 
    173 UHD Warning:
    174     For this connection, UHD recommends a send frame size of at least 8000 for best
    175     performance, but your system's MTU will only allow 7972.
    176     This will negatively impact your maximum achievable sample rate.
    177 
    178 UHD Warning:
    179     For this connection, UHD recommends a receive frame size of at least 8000 for best
    180     performance, but your system's MTU will only allow 7972.
    181     This will negatively impact your maximum achievable sample rate.
    182109
    183110Begin streaming 1024000 samples, 1.500000 seconds in the future...
    … …  
    185112num_buff_ptrs = 1000
    186113mdbp_idx = 1000
    187 
     114Writing FFT blocks into rx_multi_samples.sq3 @ 10.113.0.10:3003
    188115Done!
    189116
    … …  
    191118
    192119To save the samples for post processing, specify the following OML arguments
    193  --oml-id `hostname`          this identifies the source of the data being store.
    194  --oml-domain rx_samples     file name for the OML database
    195  --oml-collect oml:3003       network storage located on oml:3003
    196 
     120 || --oml-id `hostname`     || this identifies the source of the data being store ||
     121 || --oml-domain rx_samples || file name for the OML database ||
     122 || --oml-collect 10.113.0.10:3003  || network storage located on the console ||
    197123
    198124Rerun the application with these and we'll see a few additional lines of output at the end indicating a connection to the OML database server.
    … …  
    200126{{{
    201127
    202 Writing FFT blocks into rx_samples.sq3 @ oml:3003
    203 May 13 21:36:18 INFO    OML Client V2.10.1rc [Protocol V4] Copyright 2007-2013, NICTA
    204 INFO    OmlNetOutStream: attempting to connect to server at tcp://oml:3003
    205 INFO    tcp:oml:3003: Waiting for buffered queue thread to drain...
    206 
    207 }}}
    208 
     128Writing FFT blocks into rx_multi_samples.sq3 @ 10.113.0.10:3003
     129May 20 23:12:24 INFO    OML Client 2.11.1rc-dirty [OMSPv5] Copyright 2007-2014, NICTA
     130INFO    tcp:10.113.0.10:3003: Connected
     131INFO    tcp:10.113.0.10:3003: Waiting for buffered queue thread to drain...
     132}}}
     133
     134
     135=== ''rx_multi_receive'' break down ===
     136The source file for this application is in ~/RX_MULTI_RECEIVE/main.cpp. Without going into the details off c++ and the enitire contents of the source file, we'll make note of the following blocks of code:
     137
     138 1. A handle to the radio is constructed and is used thoughout the source to make reference to the radio.
     139{{{
     140    std::cout << std::endl;
     141    std::cout << boost::format("Creating the usrp device with: %s...") % args << std::endl;
     142    uhd::usrp::multi_usrp::sptr usrp = uhd::usrp::multi_usrp::make(args);
     143}}}
     144
     145 2. Use the handle to configure the radio paramters passed in from the command line.
     146{{{
     147
     148    //set the rx sample rate (sets across all channels)
     149    std::cout << boost::format("Setting RX Rate: %f Msps...") % (rate/1e6) << std::endl;
     150    usrp->set_rx_rate(rate);
     151    std::cout << boost::format("Actual RX Rate: %f Msps...") % (usrp->get_rx_rate()/1e6) << std::endl << std::endl;
     152
     153    //set the rx center frequency
     154    std::cout << boost::format("Setting RX Freq: %f MHz...") % (freq/1e6) << std::endl;
     155    uhd::tune_request_t tune_request(freq);
     156    if(vm.count("int-n")) tune_request.args = uhd::device_addr_t("mode_n=integer");
     157    for (unsigned int ch = 0; ch < num_rx_channels; ++ch)
     158      usrp->set_rx_freq(tune_request, ch);
     159    std::cout << boost::format("Actual RX Freq: %f MHz...") % (usrp->get_rx_freq()/1e6) << std::endl << std::endl;
     160
     161    //set the rx rf gain
     162    std::cout << boost::format("Setting RX Gain: %f dB...") % gain << std::endl;
     163    for (unsigned int ch = 0; ch < num_rx_channels; ++ch)
     164      usrp->set_rx_gain(gain,ch);
     165    std::cout << boost::format("Actual RX Gain: %f dB...") % usrp->get_rx_gain() << std::endl << std::endl;
     166
     167
     168
     169}}}
     170
     171
     172 3. A receive streamer is created and a loop is used to read out complex samples into a large buffer that is used during post processing samples.
     173{{{
     174
     175    //setup streaming
     176    std::cout << std::endl;
     177    std::cout << boost::format(
     178        "Begin streaming %u samples, %f seconds in the future..."
     179    ) % total_num_samps % seconds_in_future << std::endl;
     180    uhd::stream_cmd_t stream_cmd(uhd::stream_cmd_t::STREAM_MODE_NUM_SAMPS_AND_DONE);
     181    stream_cmd.num_samps = total_num_samps;
     182    stream_cmd.stream_now = false;
     183    stream_cmd.time_spec = uhd::time_spec_t(seconds_in_future);
     184    rx_stream->issue_stream_cmd(stream_cmd); //tells all channels to stream
     185
     186
     187    while(num_acc_samps < total_num_samps)
     188    {
     189      //receive multi channel buffers
     190      size_t num_rx_samps = rx_stream->recv( MultiDeviceBufferPtrs.at(mdbp_idx++), samps_per_buff, md, timeout);
     191
     192      //use a small timeout for subsequent packets
     193      timeout = 0.1;
     194
     195      //handle the error code
     196      if (md.error_code == uhd::rx_metadata_t::ERROR_CODE_TIMEOUT) break;
     197      else if (md.error_code == uhd::rx_metadata_t::ERROR_CODE_OVERFLOW) continue;
     198      else if (md.error_code != uhd::rx_metadata_t::ERROR_CODE_NONE){
     199        throw std::runtime_error(str(boost::format("Recv'd samples %i\nReceiver error %s") % num_acc_samps % md.strerror()));
     200      }
     201
     202      if(verbose) std::cout << boost::format(
     203                                             "Received packet: %u samples, %u full secs, %f frac secs"
     204                                             ) % num_rx_samps % md.time_spec.get_full_secs() % md.time_spec.get_frac_secs() << std::endl;
     205
     206      num_acc_samps += num_rx_samps;
     207    } // while()
     208
     209
     210}}}
    209211
    210212=== Instrumenting ''rx_multi_receive'' application with OML ===
    211 The source file for this application is in ~/RX_MULTI_RECEIVE/main.cpp. Without going into the details off c++ and the enitire contents of the source file, we'll make note of the following blocks of code:
    212 
    213  1. Lines xxx creates a handle to the USRP at the specified IP address. This handle is used thoughout the source to make reference to the radio.
    214  2. Lines xxx uses the handle to configure the radio paramters passed in from the command line.
    215  3. The read loop on lines xxx to xxx. This block reads out the complex floating samples into a buffer that is used for post processi
    216 ng samples.
    217  4. Lines xxx to xxx are OML additions made to send the FFTed sample data to the OML server for storage.
     213 4. Once the read buffer is completely populated, create and fft object to convert the time samples into frequency bins. FFT is take for every 1024 time samples and saved into another buffer.
    218214
    219215 In side this block, we create an object that performs 1024pt FFTs.
    … …  
    230226}}}
    231227
    232  We also contruct an object for writing data to an OML server. Initialized the OML object with the OML options described above.
     228 We also construct an object for writing data to an OML server. Initialize the OML object with the OML options described above.
    233229{{{
    234230      // OML object for sending data
    … …  
    263259
    264260 After the OML start has been issued we can set the keyed-value pairs with updated values from sensors. In this section the FFT is
    265  performed on chunk of 1024 comoplex samples and the magnitude is computed. These get stored in the OML as binary data (oml_blob).
     261 performed on chunks of 1024 complex samples and the magnitude is computed. These get stored in the OML as binary data (oml_blob).
    266262 Once all the keyed-valued pairs are updated with set_key(), they are sented over to the OML server by issuing the insert command.
    267263 This is done repeatedly until the entire buffer has been processed.