sense¶
List of supported commands:
-
class
nardascripting.base.scpi.sense.
ScpiSense
(com: nardascripting.base.comm.CommBase)¶ SignalShark SENSe SCPI subsystem class.
-
get_adc_oor
()¶ Queries ADC out of range state for the active measurement task
- Returns
ADC out of range state
- Return type
bool
-
get_antenna_auto_all
() → Optional[nardascripting.base.scpi.data.ant_data.Narda_3300_Antenna]¶ Queries the info and data of an connected auto antenna
- Returns
ant_data.Narda_3300_Antenna
-
get_antenna_auto_data
() → Optional[nardascripting.base.scpi.data.ant_data.Data]¶ Queries the data of an connected auto antenna
- Returns
ant_data.Data
-
get_antenna_auto_info
() → Optional[nardascripting.base.scpi.data.ant_data.Info]¶ Queries the info data of an connected auto antenna
- Returns
ant_data.Info
-
get_antenna_checksum
()¶ Queries the checksum of the antenna connected to the SignalShark
- Returns
Checksum of the connected antenna. In case of error the function returns -1.
- Return type
int
-
get_antenna_handle
()¶ Queries the type of antenna handle connected to the SignalShark
- Returns
NONE, HANDLE
- Return type
-
get_antenna_isotropic_manual
()¶ Gets a flag, indicating whether manual switching of the antenna axis is enabled.
- Returns
ON, OFF
- Return type
bool
-
get_antenna_isotropic_manual_axis
()¶ Gets the current axis state of a connected antenna.
- Returns
X_AXIS, Y_AXIS, Z_AXIS, SINGLE, RSS
- Return type
-
get_antenna_manual
(rf_input: int) → str¶ Gets the manual antenna for the specified
- Parameters
rf_input (int) – RF Input i.e. 1,2,3,4
- Returns
Currently selected manual antenna
- Return type
str
-
get_antenna_manual_list
() → List[str]¶ Queries the list of available manual antennas
- Returns
Returns a list of available manual antennas
-
get_antenna_polarization
()¶ Queries the polarization of the antenna connected to the antenna handle
- Returns
NONE, HORIZONTAL, VERTICAL
- Return type
-
get_antenna_type
()¶ Queries the type of antenna connected to the SignalShark
- Returns
NONE, ADFA, DFA, ANTENNA
- Return type
-
get_attenuator
()¶ Queries the current attenuation
- Returns
Attenuation in dB
- Return type
float
-
get_attenuator_list
()¶ Queries a list of possible attenuator settings
- Returns
List of attenuator settings
- Return type
list o f float
-
get_cable_auto_all
() → Optional[nardascripting.base.scpi.data.cbl_data.Narda_3300_Cable]¶ Queries the info and data of an connected auto cable
- Returns
cbl_data.Narda_3300_Cable
-
get_cable_auto_data
() → Optional[nardascripting.base.scpi.data.cbl_data.Data]¶ Queries the data of an connected auto cable
- Returns
ant_data.Data
-
get_cable_auto_info
() → Optional[nardascripting.base.scpi.data.cbl_data.Info]¶ Queries the info data of an connected auto cable
- Returns
ant_data.Info
-
get_cable_checksum
()¶ Queries the checksum of the cable connected to the Signal Shark
- Returns
Checksum of the connected cable. In case of error the function returns -1.
- Return type
int
-
get_cable_manual
(rf_input: int) → str¶ Gets the manual cable for the specified RF Input
- Parameters
rf_input (int) – RF Input i.e. 1,2,3,4
- Returns
Currently selected manual cable
- Return type
str
-
get_cable_manual_list
() → List[str]¶ Queries the list of available manual cables
- Returns
Returns a list of available manual cables
-
get_compass_data
()¶ Compass values of the active compass
- Returns
Azimuth in degree; Elevation in degree; Roll in degree
- Return type
-
get_external_device
()¶ Queries the external device state
- Returns
External device state
- Return type
bool
-
get_external_device_switchable
()¶ Queries if the external device is switchable
- Returns
External device switchable
- Return type
bool
-
get_frequency_range
()¶ Queries the frequency range for active measurement task. The frequency range depends on the connected equipment.
- Returns
Minimum frequency in Hz; Maximum frequency in Hz
- Return type
float, float
-
get_gnss_data
()¶ GNSS values of the active GNSS
- Returns
GNSS data.
- Return type
-
get_input
()¶ Queries the RF input number
- Returns
RF input (1,2,3,4)
- Return type
int
-
get_preamp
()¶ Queries the state of the preamplifier of the antenna handle
- Returns
Preamplifier state
- Return type
bool
-
get_reference_level
()¶ Queries the reference level for the RF input
- Returns
Reference Level
- Return type
float
-
get_reference_level_list
()¶ Queries a list of possible attenuator settings
- Returns
- Return type
-
get_reference_level_offset
()¶ Queries the current reference level offset. The flag [SENSe:]REFerence:LEVel:OFFSet:ENABle must be enabled for the setting of [SENSe:]REFerence:LEVel:OFFSet to take effect!
- Returns
ReferenceLevelOffset in dB
- Return type
float
-
get_reference_level_offset_enable
()¶ Queries the corresponding reference level offset state
- Returns
Reference level offset state
- Return type
bool
-
get_reference_level_offset_list
()¶ Queries a list of possible reference level offset settings
- Returns
- Return type
-
get_tstamp_sync_deviation
()¶ Timestamp synchronization deviation
- Returns
Timestamp synchronisation deviation
- Return type
float
-
get_tstamp_sync_fine
()¶ Timestamp fine synchronization state
- Returns
True if we have fine synchronisation
- Return type
bool
-
get_tstamp_sync_state
()¶ Timestamp synchronization state
- Returns
SYNCHRONIZED, UNSYNCHRONIZED, FREERUN
- Return type
-
hold
(timeout=-1.0)¶ Holds the measurement and initializes if measurement is stopped
- Parameters
timeout (float Optional[Timespan]) – Timeout value for initializing (s)
-
hold_with_feedback
(timeout=-1.0)¶ Holds the measurement and initializes if measurement is stopped
- Parameters
timeout (float Optional[Timespan]) – Timeout value for initializing (s)
- Returns
Returns 0 if continuous run has started successfully ; Returns ‘No error’ if successful
- Return type
int, str
-
run_continuous
(timeout=-1.0)¶ Starts a new continuous measurement
- Parameters
timeout (float) – Timeout value for initializing (s)
-
run_continuous_reset
(timeout=-1.0)¶ Starts a new continuous measurement with reset
- Parameters
timeout (float Optional[Timespan]) – Timeout value for initializing (s)
-
run_continuous_reset_with_feedback
(timeout=-1.0)¶ Starts a new continuous measurement with reset
- Parameters
timeout (float Optional[Timespan]) – Timeout value for initializing (s)
- Returns
Returns 0 if continuous run has started successfully; Returns ‘No error’ if successful
- Return type
int, str
-
run_continuous_with_feedback
(timeout=-1.0)¶ Starts a new continuous measurement
- Parameters
timeout (float Optional[Timespan]) – Timeout value for initializing (s)
- Returns
Returns 0 if continuous run has started successfully; Returns ‘No error’ if successful
- Return type
int, str
-
run_single
(timeout=-1.0)¶ Starts a new single measurement with reset
- Parameters
timeout (float Optional[Timespan]) – Timeout value for initializing (s)
-
run_single_with_feedback
(timeout=-1.0)¶ Starts a new single measurement with reset. The command processing ends when scan count equals scan number or the timeout value is reached.
- Parameters
timeout (float Optional[Timespan]) – Timeout value for initializing (s)
- Returns
Returns 0 if single run has finished successfully; Returns ‘No error’ if successful
- Return type
int, str
-
set_antenna_isotropic_manual
(enable: bool)¶ Enables/Disables the manual switching of the antenna axis of isotropic antennas
- Parameters
enable (bool) – ON, OFF
-
set_antenna_isotropic_manual_axis
(axis: nardascripting.base.scpi.enums.AntAxisSelections)¶ Sets the axis which is used for measurement in case that an isotropic antenna is used
- Parameters
axis (AntAxisSelections) – X_AXIS, Y_AXIS, Z_AXIS
-
set_antenna_manual
(rf_input: int, ant_file: str)¶ Sets the manual antenna for the specified RF Input
- Parameters
rf_input (int) – RF Input i.e. 1,2,3,4
ant_file (str) – Name of the manual antenna to be loaded
-
set_attenuator
(value: float)¶ Attenuation for the RF input
- Parameters
value (float) – Attenuation (dB)
-
set_cable_manual
(rf_input: int, cbl_file: str)¶ Sets the manual cable for the specified RF Input
- Parameters
rf_input (int) – RF Input i.e. 1,2,3,4
cbl_file (str) – Name of the manual cable to be loaded
-
set_external_device
(value: bool)¶ External device
- Parameters
value (bool) – External device state
-
set_input
(value: int)¶ Selects the RF input
- Parameters
value (int) – RF input (1,2,3,4)
-
set_preamp
(value: bool)¶ Preamplifier state of the antenna handle
- Parameters
value (bool) – Preamplifier state
-
set_reference_level
(value: float)¶ Reference level for the RF input
- Parameters
value (float) – Reference Level (dBm,…)
-
set_reference_level_offset
(value: float)¶ Sets the reference level offset. The flag [SENSe:]REFerence:LEVel:OFFSet:ENABle must be enabled for the setting of [SENSe:]REFerence:LEVel:OFFSet to take effect!
- Parameters
value (float) – ReferenceLevelOffset (dB)
-
set_reference_level_offset_enable
(value: bool)¶ Enables/disables the reference level offset
- Parameters
value (bool) – Reference level offset state
-
stop
()¶ Stops the measurement
-