Bearing¶
List of supported commands:
-
class
nardascripting.base.scpi.bearing.
ScpiBearing
(com: nardascripting.base.comm.CommBase)¶ SignalShark BEARing SCPI subsystem class.
-
get_azimuth_correction
()¶ Queries the azimuth correction for bearing
- Returns
Azimuth correction in degree
- Return type
float
-
get_cbw
()¶ Queries the channel bandwidth for bearing
- Returns
Channel Bandwidth in Hz
- Return type
float
-
get_cbw_list
()¶ Queries a list of possible CBW settings
- Returns
- Return type
-
get_current_tstamp
()¶ Queries current BEARing timestamp
- Returns
TimeStamp object
- Return type
-
get_cycle_time
()¶ Queries the cycle time for bearing
- Returns
Cycle time in s
- Return type
float
-
get_data_all
()¶ Queries all available bearing data.
- Returns
Bearing data as BearingData.
- Return type
BearingData
-
get_data_azimuth
()¶ Queries the azimuth of the bearing result.
- Returns
Azimuth of bearing in degree
- Return type
float
-
get_data_detector
()¶ Queries the bearing detector value
- Returns
Omnidirectional Detector value
- Return type
float
-
get_data_dfquality
()¶ Queries the DF quality of the current bearing in percent
- Returns
Quality of the bearing
- Return type
float
-
get_data_elevation
()¶ Queries the elevation of the bearing result.
- Returns
Elevation of bearing in degree.
- Return type
float
-
get_data_scan_number
()¶ Queries the bearing data scan number
- Returns
Scan number
- Return type
int
-
get_data_tstamp_raw
()¶ Queries the bearing data timestamp
- Returns
Timestamp Sync Flag; Seconds since 1.1.1970 0:00 Greenwich Mean Time; Nanoseconds fractional part
- Return type
bool, int, int
-
get_data_update
(scan_number=-1, timeout=3.0)¶ Synchronization command, that waits for new bearing results.
- Parameters
scan_number (Integer number) – ScanNumber of last queried measurement data. The command forces an update, if not set.
timeout (Float number) – Timeout value for update data in seconds
- Returns
ScanNumber of current measurement data or -1 if error.
- Return type
Integer number
note:: Update is only available in RUN and HOLD state!
-
get_data_update_stop
(scan_number=-1, timeout=3.0)¶ Synchronization command, that waits for new bearing results and stops measurement if new bearing results are available.
- Parameters
scan_number (Integer number) – ScanNumber of last queried measurement data. The command forces an update, if not set.
timeout (Float number) – Timeout value for update data in seconds
- Returns
ScanNumber of current measurement data or -1 if error.
- Return type
Integer number
note:: Update is only available in RUN and HOLD state!
-
get_data_valid
()¶ Queries the valid flag of the last bearing result
- Returns
Valid flag of bearing data.
- Return type
bool
-
get_data_valid_enable
()¶ Queries last valid bearing data state. When enabled, last valid bearing is returned and not the last measurement run data. Filter settings like ‘BEARing:DFSQuelch’, ‘BEARing:MIN:DFQuality’ or ‘BEARing:MIN:STABility’ will only take effect, if this parameter is enabled!
- Returns
Last valid bearing data
- Return type
bool
-
get_dfsquelch
()¶ Queries the DF squelch level for bearing. The flags BEARing:DFSQuelch:ENABle and BEARing:DATA:VALid:ENABle must be enabled for the settings of BEARing:DFSQuelch to take effect!
- Returns
DF Squelch level in actual unit
- Return type
float
-
get_dfsquelch_enable
()¶ Queries the DF squelch state. The flag BEARing:DATA:VALid:ENABle must also be enabled for the settings of BEARing:DFSQuelch:ENABle to take effect.
- Returns
DF Squelch state
- Return type
bool
-
get_frequency_tune
()¶ Queries the bearing tune frequency
- Returns
Tune frequency in Hz
- Return type
float
-
get_frequency_tune_step
()¶ Queries the tune frequency step for bearing
- Returns
Tune frequency step in Hz
- Return type
float
-
get_measurement_time
()¶ Queries the measurement time for bearing
- Returns
Measurement time in s
- Return type
float
-
get_min_dfquality
()¶ Queries the minimum DF quality for a bearing. Sets the minimum DF quality for a bearing. The flags BEARing:MIN:DFQuality:ENABle and BEARing:DATA:VALid:ENABle must be enabled for the settings of BEARing:MIN:DFQuality to take effect!
- Returns
minimum DF quality
- Return type
float
-
get_min_dfquality_enable
()¶ Queries the minimum DF quality criteria state. The flag BEARing:DATA:VALid:ENABle must also be enabled for the settings of BEARing:MIN:DFQuality:ENABle to take effect.
- Returns
min DF quality state
- Return type
bool
-
get_min_stability
()¶ Queries the minimum level stability for bearings. The flags BEARing:DATA:VALid:ENABle and BEARing:MIN:STABility:ENABle must be enabled for the settings of BEARing:MIN:STABility to take effect!
- Returns
Min Stability in (dB)
- Return type
float
-
get_min_stability_enable
()¶ Queries the minimum stability criteria state. The flag BEARing:DATA:VALid:ENABle must also be enabled for the settings of BEARing:MIN:STABility:ENABle to take effect.
- Returns
min stability state
- Return type
bool
-
get_north_reference
()¶ Queries the north reference for bearing
- Returns
Bearing north reference as BearingNorthRefs (ExtEnum)
- Return type
-
get_post_avg
()¶ Queries the post averaging time for bearing
- Returns
Post averaging time in s
- Return type
float
-
get_reference_mark_direction
()¶ Queries the reference mark direction for bearing
- Returns
Reference mark direction in degrees
- Return type
float
-
get_scan_count
()¶ Queries the bearing scan count
- Returns
Scan count
- Return type
int
-
get_scan_number
()¶ Queries the bearing scan number
- Returns
Scan number
- Return type
int
-
get_scan_time
()¶ Queries the scan time for bearing
- Returns
Scan time in s
- Return type
float
-
set_azimuth_correction
(value: float)¶ Sets the azimuth correction for bearing
- Parameters
value (float) – Azimuth correction in degree
-
set_cbw
(value: float)¶ Sets the channel bandwidth for bearing
- Parameters
value (float) – Channel Bandwidth (Hz)
-
set_data_valid_enable
(value: bool)¶ Switches ‚Last valid bearing data‘ flag on/off. When enabled, last valid bearing is returned and not the last measurement run data. Filter settings like ‘BEARing:DFSQuelch’, ‘BEARing:MIN:DFQuality’ or ‘BEARing:MIN:STABility’ will only take effect, if this parameter is enabled!
- Parameters
value (bool) – Last valid bearing data
-
set_dfsquelch
(value: float)¶ Sets the DF squelch for bearing. The flags BEARing:DFSQuelch:ENABle and BEARing:DATA:VALid:ENABle must be enabled for the settings of BEARing:DFSQuelch to take effect!
- Parameters
value (float) – DF Squelch level in actual unit
-
set_dfsquelch_enable
(value: bool)¶ Enables/Disables DF squelch criteria for bearings. The flag BEARing:DATA:VALid:ENABle must also be enabled for the settings of BEARing:DFSQuelch:ENABle to take effect.
- Parameters
value (bool) – DF Squelch state
-
set_frequency_tune
(value: float)¶ Sets the bearing tune frequency
- Parameters
value (float) – Tune frequency (Hz)
-
set_frequency_tune_step
(value: float)¶ Sets the tune frequency step for bearing
- Parameters
value (float) – Tune frequency step (Hz)
-
set_measurement_time
(value: float)¶ Sets the measurement time for bearing
- Parameters
value (float) – Measurement time (s)
-
set_min_dfquality
(df_min: float)¶ Sets the minimum DF quality for a bearing. The flags BEARing:MIN:DFQuality:ENABle and BEARing:DATA:VALid:ENABle must be enabled for the settings of BEARing:MIN:DFQuality to take effect!
- Parameters
df_min (float) – minimum DF quality
-
set_min_dfquality_enable
(value: bool)¶ Enables/Disables minimum DF quality criteria for bearings. The flag BEARing:DATA:VALid:ENABle must also be enabled for the settings of BEARing:MIN:DFQuality:ENABle to take effect
- Parameters
value (bool) – min DF quality state
-
set_min_stability
(value: float)¶ Sets the minimum stability for bearings. The flags BEARing:DATA:VALid:ENABle and BEARing:MIN:STABility:ENABle must be enabled for the settings of BEARing:MIN:STABility to take effect!
- Parameters
value (float) – Min Stability in (dB)
-
set_min_stability_enable
(value: bool)¶ Enables/Disables minimum stability criteria for bearings. The flag BEARing:DATA:VALid:ENABle must also be enabled for the settings of BEARing:MIN:STABility:ENABle to take effect.
- Parameters
value (bool) – min stability state
-
set_north_reference
(value=REFERENCE_MARK_DIRECTION)¶ Sets the north reference for bearing
- Parameters
value (Enum) – Type (COMPASS, GNSS_VELOCITY, REFERENCE_MARK_DIRECTION)
-
set_post_avg
(value: float)¶ Sets the post averaging time for bearing
- Parameters
value (float) – Post averaging time (s)
-
set_reference_mark_direction
(value: float)¶ Sets the reference mark direction for bearing
- Parameters
value (float) – Reference mark direction in degrees
-
set_scan_count
(value: int)¶ Sets the bearing scan count
- Parameters
value (int) – Scan count
-