map¶
List of supported commands:
-
class
nardascripting.base.scpi.map.
ScpiMap
(com: nardascripting.base.comm.CommBase)¶ SignalShark MAP SCPI subsystem class.
-
get_localization_area_raw
()¶ Queries the localization area.
- Returns
Top left latitude in degree (decimal); Top left longitude in degree (decimal); Bottom right latitude in degree (decimal); Bottom right longitude in degree (decimal)
- Return type
float, float, float, float
-
get_localization_bearing_error
()¶ Queries the bearing error for the localization
- Returns
Bearing error in degree 0°…20°
- Return type
float
-
get_localization_data
()¶ Queries the localization data
- Returns
Localization result.
- Return type
LocalizationData
-
get_localization_frequency_tune_list
()¶ Queries the available Ftunes for localization
- Returns
Available Ftune frequencies.
- Return type
List of float
-
get_localization_frequency_tune_select
()¶ Queries the frequency of the localization
- Returns
Frequency of the localization in Hz
- Return type
float
-
get_localization_los_probability
()¶ Queries the line of sight probability for the localization
- Returns
Line of sight probability in percent 0%,1%…100%
- Return type
float
-
get_localization_min_dfquality
()¶ Queries the minimum DF quality for a bearing to be taken into account by the localization. The flag MAP:LOCalization:MIN:DFQuality:ENABle must be enabled for the setting of MAP:LOCalization:MIN:DFQuality to take effect!
- Returns
minimum DF quality 0%, 5%, …, 100%
- Return type
float
-
get_localization_min_dfquality_enable
()¶ Queries the minimum DF quality criteria state.
- Returns
min DF quality state
- Return type
bool
-
get_localization_min_speed
()¶ Queries the min. Speed parameter for the localization. The flag MAP:LOCalization:MIN:SPEed:ENABle must be enabled for the setting of MAP:LOCalization:MIN:SPEed to take effect!
- Returns
min. Speed in m/s
- Return type
float
-
get_localization_min_speed_enable
()¶ Queries the minimum speed criteria state for bearings to be taken into account by the localization.
- Returns
min Speed state
- Return type
bool
-
get_localization_min_speed_list
()¶ Queries the list of possible values for the min. Speed parameter
- Returns
List of min. speed values in m/s
- Return type
List of float
-
get_localization_record_bearing
()¶ Queries the recording of bearings state
- Returns
Type ON,OFF
- Return type
bool
-
get_localization_record_list
()¶ Queries the available records for localization
- Returns
List of records for localization
- Return type
List of str
-
get_localization_record_select
()¶ Queries the record used for localization
- Returns
Name of the selected record
- Return type
str
-
get_localization_resolution
()¶ Queries the resolution of the localization area
- Returns
Resolution (VERY_HIGH, HIGH, NORMAL, LOW, VERY_LOW)
- Return type
-
get_localization_use_case_preset
()¶ Queries the use case preset for the localization
- Returns
Use case preset (CITY_VEHICLE_GNSS, CITY_FIXED_SITE, FREE_FIELD_VEHICLE_GNSS, FREE_FIELD_FIXED_SITE)
- Return type
-
get_mode
()¶ Queries the map mode
- Returns
Mode (NONE, DISCRETE_LOCALIZATION, CONTINUES_LOCALIZATION, MEASUREMENT_SITES, COVERAGE, LOCALIZATION_RESULTS)
- Return type
-
localization_start
()¶ Starts the localization
-
localization_start_wait
()¶ Starts the localization and wait until it is started.
-
localization_stop
()¶ Stops the localization
-
set_localization_area
(area: nardascripting.base.scpi.datatypes.GnssRect)¶ Sets the localization area.
- Parameters
area (GnssRect) – GNSS area
-
set_localization_area_raw
(top_left_lat: float, top_left_lon: float, bottom_right_lat: float, bottom_right_lon: float)¶ Sets the localization area.
- Parameters
top_left_lat (float) – Top left latitude in degree (decimal)
top_left_lon (float) – Top left longitude in degree (decimal)
bottom_right_lat (float) – Bottom right latitude in degree (decimal)
bottom_right_lon (float) – Bottom right longitude in degree (decimal)
-
set_localization_bearing_error
(value: float)¶ Sets the bearing error for the localization
- Parameters
value (float) – Bearing error in degree 0°…20°
-
set_localization_frequency_tune_select
(value: float)¶ Sets the frequency of the localization
- Parameters
value (float) – Frequency (Hz)
-
set_localization_los_probability
(value: float)¶ Sets the line of sight probability for the localization
- Parameters
value (float) – Line of sight probability in percent 0%,1%…100%
-
set_localization_min_dfquality
(df_min: float)¶ Sets the minimum DF quality for a bearing. The flag MAP:LOCalization:MIN:DFQuality:ENABle must be enabled for the setting of MAP:LOCalization:MIN:DFQuality to take effect!
- Parameters
df_min (float) – minimum DF quality 0%, 5%, …, 100%
-
set_localization_min_dfquality_enable
(value: bool)¶ Enables/Disables minimum DF quality criteria for bearings.
- Parameters
value (bool) – min DF quality state
-
set_localization_min_speed
(value: float, unit: nardascripting.base.scpi.enums.SpeedUnits = km_h)¶ Sets the min. Speed parameter for the localization. The flag MAP:LOCalization:MIN:SPEed:ENABle must be enabled for the setting of MAP:LOCalization:MIN:SPEed to take effect!
- Parameters
value (float) – min. Speed (in m_s, km_h or mi_h)
unit (SpeedUnits) – m_s, km_h or mi_h
-
set_localization_min_speed_enable
(value: bool)¶ Enables/Disables minimum speed criteria for bearings to be taken into account by the localization.
- Parameters
value (bool) – min Speed state
-
set_localization_record_bearing
(value: bool)¶ Starts/Stops recording of bearings
- Parameters
value (bool) – Type ON,OFF
-
set_localization_record_select
(record_name: str)¶ Selects the record used for localization
- Parameters
record_name (str) – Name of the record
-
set_localization_resolution
(value: nardascripting.base.scpi.enums.LocAreaResolutions)¶ Sets the resolution of the localization area
- Parameters
value (LocAreaResolutions) – Resolution (VERY_HIGH, HIGH, NORMAL, LOW, VERY_LOW)
-
set_localization_use_case_preset
(value: enum.Enum)¶ Sets the use case preset for the localization
- Parameters
value (LocUseCasePresets) – Use case preset (CITY_VEHICLE_GNSS, CITY_FIXED_SITE, FREE_FIELD_VEHICLE_GNSS, FREE_FIELD_FIXED_SITE)
-