Changes between Version 6 and Version 7 of WARPLab/Reference/Interface/X245


Ignore:
Timestamp:
Sep 14, 2015, 9:26:22 AM (9 years ago)
Author:
welsh
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WARPLab/Reference/Interface/X245

    v6 v7  
    3333== Command List and Documentation ==
    3434
     35
    3536=== {{{tx_en}}} ===
    3637Enable transmit mode for selected interfaces[[BR]]
     
    6364
    6465
     66=== {{{read_tx_rx_state}}} ===
     67Read the current state of the interface[[BR]]
     68
     69
     70'''Requires BUFF_SEL:''' Yes
     71
     72'''Arguments:''' none
     73
     74'''Returns:''' Current state of the buffer:  TX, RX or STANDBY
     75
     76
     77
    6578=== {{{channel}}} ===
    6679Tune selected interfaces to the specified band and channel[[BR]]
    6780
    6881
    69 '''Arguments:''' (float BAND, int CHAN)[[BR]]
    70   BAND: Must be 2.4 or 5, to select 2.4GHz or 5GHz channels[[BR]]
    71   CHAN: Must be integer in ![1,11] for BAND=2.4; ![1,23] for BAND=5[[BR]]
    72 
    73 '''Returns:''' none
    74 
    75 BAND and CHAN must be scalars (same values for all specified interfaces) or 1-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
     82'''Arguments:''' (float BAND, int CHAN)
     83BAND: Must be 2.4 or 5, to select 2.4GHz or 5GHz channels[[BR]]
     84CHAN: Must be integer in ![1,11] for BAND=2.4, ![1,23] for BAND=5[[BR]]
     85
     86'''Returns:''' none
     87
     88BAND and CHAN must be scalars (same values for all specified interfaces) or[[BR]]
     891-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
    7690
    7791Band/Channel - Center Frequency Map:[[BR]]
     
    104118
    105119
     120
     121
    106122=== {{{tx_gains}}} ===
    107123Sets the gains for the variable gain amplifiers in the MAX2829 Tx path[[BR]]
     
    109125
    110126
    111 '''Arguments:''' (int BB_GAIN, int RF_GAIN)[[BR]]
    112   BB_GAIN: Must be integer in ![0,1,2,3] for approx ![-5, -3, -1.5, 0]dB baseband gain[[BR]]
    113   RF_GAIN: Must be integer in ![0:63] for approx ![0:31]dB RF gain[[BR]]
    114 
    115 '''Returns:''' none
    116 
    117 BB_GAIN and RF_GAIN must be scalars (same values for all specified interfaces) or 1-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
     127'''Arguments:''' (int BB_GAIN, int RF_GAIN)
     128BB_GAIN: Must be integer in ![0,1,2,3] for approx ![-5, -3, -1.5, 0]dB baseband gain[[BR]]
     129RF_GAIN: Must be integer in ![0:63] for approx ![0:31]dB RF gain[[BR]]
     130
     131'''Returns:''' none
     132
     133BB_GAIN and RF_GAIN must be scalars (same values for all specified interfaces) or[[BR]]
     1341-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
    118135
    119136NOTE:  The parameters are in the order in which they are applied to the signal (ie baseband gain, then RF gain)[[BR]]
     
    126143
    127144
    128 '''Arguments:''' (int RF_GAIN, int BB_GAIN)[[BR]]
    129   RF_GAIN: Must be integer in ![1,2,3] for approx ![0,15,30]dB RF gain[[BR]]
    130   BB_GAIN: Must be integer in ![0:31] for approx ![0:63]dB baseband gain[[BR]]
    131 
    132 '''Returns:''' none
    133 
    134 BB_GAIN and RF_GAIN must be scalars (same values for all specified interfaces) or 1-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
     145'''Arguments:''' (int RF_GAIN, int BB_GAIN)
     146RF_GAIN: Must be integer in ![1,2,3] for approx ![0,15,30]dB RF gain[[BR]]
     147BB_GAIN: Must be integer in ![0:31] for approx ![0:63]dB baseband gain[[BR]]
     148
     149'''Returns:''' none
     150
     151BB_GAIN and RF_GAIN must be scalars (same values for all specified interfaces) or[[BR]]
     1521-D vectors (one value per interface) with length equal to the length of the interface ID vector[[BR]]
    135153
    136154NOTE:  The parameters are in the order in which they are applied to the signal (ie RF gain, then baseband gain)[[BR]]
     
    143161
    144162
    145 '''Arguments:''' (int FILT)[[BR]]
    146   FILT: Must be integer in ![1,2,3] for approx ![12,18,24]MHz corner frequencies (![24,36,48]MHz bandwidths)[[BR]]
    147 
    148 '''Returns:''' none
    149 
    150 FILT must be scalar (same value for all specified interfaces) or 1-D vector (one value per interface) with length equal to the length of the interface ID vector[[BR]]
     163'''Arguments:''' (int FILT)
     164FILT: Must be integer in ![1,2,3] for approx ![12,18,24]MHz corner frequencies (![24,36,48]MHz bandwidths)[[BR]]
     165
     166'''Returns:''' none
     167
     168FILT must be scalar (same value for all specified interfaces) or 1-D vector (one value per interface) [[BR]]
     169with length equal to the length of the interface ID vector[[BR]]
    151170
    152171
     
    157176
    158177
    159 '''Arguments:''' (int FILT)[[BR]]
    160   FILT: Must be integer in ![0,1,2,3] for approx ![7.5,9.5,14,18]MHz corner [[BR]]
     178'''Arguments:''' (int FILT)
     179FILT: Must be integer in ![0,1,2,3] for approx ![7.5,9.5,14,18]MHz corner [[BR]]
    161180frequencies (![15,19,28,36]MHz bandwidths)[[BR]]
    162181
    163182'''Returns:''' none
    164183
    165 FILT must be scalar (same value for all specified interfaces) or 1-D vector (one value per interface) with length equal to the length of the interface ID vector[[BR]]
     184FILT must be scalar (same value for all specified interfaces) or 1-D vector (one value per interface) [[BR]]
     185with length equal to the length of the interface ID vector[[BR]]
     186
     187
     188
     189=== {{{rx_hpf_corn_freq}}} ===
     190Sets the corner frequency for the MAX2829 Rx path high pass filter when RXHP = 'disable' (ie 0)[[BR]]
     191
     192
     193'''Arguments:''' (int MODE)
     194MODE: Must be 0 (HPF corner of 100 Hz) or 1 (default; HPF corner of 30 kHz)[[BR]]
     195
     196'''Returns:''' none
     197
     198MODE must be scalar (same value for all specified interfaces) or 1-D vector (one value per interface) [[BR]]
     199with length equal to the length of the interface ID vector[[BR]]
     200
     201The MAX2829 default setting is 1 (30 kHz corner frequency). This is the better setting for most[[BR]]
     202applications. The lower cutoff frequency (100 Hz) should only be used when the Rx waveform  has[[BR]]
     203energy in the 60 kHz around DC.[[BR]]
     204
     205This filter setting is only used when RXHP is 'disable' (ie 0).[[BR]]
    166206
    167207
     
    171211
    172212
    173 '''Arguments:''' (string MODE)[[BR]]
    174   MODE: 'automatic' for AGC, or 'manual' for manual gain control[[BR]]
     213'''Arguments:''' (string MODE)
     214MODE: 'automatic' for AGC, or 'manual' for manual gain control[[BR]]
    175215
    176216'''Returns:''' none
     
    182222
    183223
    184 '''Arguments:''' (string MODE)[[BR]]
    185   MODE: 'enable', or 'disable' RXHP on the node when in manual gain control[[BR]]
    186 
    187 '''Returns:''' none
    188 
     224'''Arguments:''' (string MODE)
     225MODE: 'enable', or 'disable' RXHP on the node when in manual gain control[[BR]]
     226
     227'''Returns:''' none
     228