diff options
| author | Martin Braun <martin.braun@ettus.com> | 2021-12-01 10:15:14 +0100 |
|---|---|---|
| committer | Aaron Rossetto <aaron.rossetto@ni.com> | 2022-01-10 08:02:41 -0600 |
| commit | edf16b3a85507064d42da2021d5eaea4002f7912 (patch) | |
| tree | 7bd37e229da275602f0d0e72a4670ad13a9366c8 /host | |
| parent | 716ed77f7f65d83635a95815c8508ac49f013ad6 (diff) | |
| download | uhd-edf16b3a85507064d42da2021d5eaea4002f7912.tar.gz uhd-edf16b3a85507064d42da2021d5eaea4002f7912.tar.bz2 uhd-edf16b3a85507064d42da2021d5eaea4002f7912.zip | |
e31x/e320: Amend LO-locked sensor names
In UHD 3, we had two sensors names for LO lock on these devices:
lo_lock, and lo_locked. The latter is the more standard, and is checked
in examples like rx_samples_to_file.
In UHD 4, the latter was removed without comment. This adds the sensor
back again and also updates the documentation accordingly.
Diffstat (limited to 'host')
| -rw-r--r-- | host/docs/usrp_e3xx.dox | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/host/docs/usrp_e3xx.dox b/host/docs/usrp_e3xx.dox index b51a31ab6..f13708925 100644 --- a/host/docs/usrp_e3xx.dox +++ b/host/docs/usrp_e3xx.dox @@ -549,9 +549,7 @@ For a list of which arguments can be passed into make(), see Section \subsection e3xx_usage_sensors The sensor API -\subsubsection e310_sensors E31X Sensors - -Like other USRPs, the E310 series has RF and motherboard sensors. +Like other USRPs, the E3x0 series has RF and motherboard sensors. When using uhd::usrp::multi_usrp, the following API calls are relevant to interact with the sensor API: @@ -562,24 +560,22 @@ interact with the sensor API: - uhd::usrp::multi_usrp::get_tx_sensor() - uhd::usrp::multi_usrp::get_rx_sensor() +\subsubsection e310_sensors E31X Sensors + The following motherboard sensors are always available: - `temp_fpga`: temperature (in Celsius) of the FPGA die - `temp_mb`: temperature (in Celsius) of the motherboard - `ref_locked`: This will check that all the daughter boards have locked to the reference clock. -\subsubsection e320_sensors E320 Sensors - -Like other USRPs, the E320 series has RF and motherboard sensors. -When using uhd::usrp::multi_usrp, the following API calls are relevant to -interact with the sensor API: +The following daughterboard sensors are always available: +- `lo_locked`: Boolean sensor value to check if the AD9361 LO has locked to its + reference +- `lo_lock`: Alias to `lo_locked` (for backward compatibility reasons) +- `ad9361_temperature`: Temperature sensor of the RFIC die +- `rssi`: RSSI value as returned from the AD9361 (RX only) -- uhd::usrp::multi_usrp::get_mboard_sensor_names() -- uhd::usrp::multi_usrp::get_mboard_sensor() -- uhd::usrp::multi_usrp::get_tx_sensor_names() -- uhd::usrp::multi_usrp::get_rx_sensor_names() -- uhd::usrp::multi_usrp::get_tx_sensor() -- uhd::usrp::multi_usrp::get_rx_sensor() +\subsubsection e320_sensors E320 Sensors The following motherboard sensors are always available: - `temp_internal`: temperature (in Celsius) of Temperature Sensor on board @@ -595,6 +591,13 @@ The following motherboard sensors are always available: external/internal reference clock. - `fan`: get fan speed (in rpm) +The following daughterboard sensors are always available: +- `lo_locked`: Boolean sensor value to check if the AD9361 LO has locked to its + reference +- `lo_lock`: Alias to `lo_locked` (for backward compatibility reasons) +- `ad9361_temperature`: Temperature sensor of the RFIC die +- `rssi`: RSSI value as returned from the AD9361 (RX only) + \section e3xx_rasm Remote Management \subsection e3xx_rasm_mender Mender: Remote update capability |