Settings¶

Description¶

Module: geocompy.gsi.dna.settings

Definitions for the DNA settings subsystem.

Types¶

GsiOnlineDNASettings

Definitions¶

class GsiOnlineDNASettings(parent: GsiOnlineType)[source]¶

Settings subsystem of the DNA GSI Online protocol.

This subsystem gives access to the internal parameters of the instrument. Most parameters (with a few exceptions) can be both queried and set/changed.

Parameters:

parent: GsiOnlineType¶: The parent protocol instance of this subsystem.

get_autooff() → GsiOnlineResponse[AutoOff][source]¶

CONF 95

Gets the current status of the automatic shutdown feature.

Returns:: Status of the automatic shutdown.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_battery() → GsiOnlineResponse[int][source]¶

CONF 90

Gets the current level of the battery.

Returns:: Remaining battery capacity in [0; 10] range.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_baud() → GsiOnlineResponse[Baud][source]¶

CONF 70

Gets the current communication speed.

Returns:: Communication speed.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_beep() → GsiOnlineResponse[BeepIntensity][source]¶

CONF 30

Gets the current set intensity of the beep signals.

Returns:: Current beep intensity.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_contrast() → GsiOnlineResponse[int][source]¶

CONF 32

Gets the current display contrast level.

Returns:: Contrast level in [0; 100] range.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_curvature_correction() → GsiOnlineResponse[bool][source]¶

CONF 125

Gets the current status of the Earth curvature correction.

Returns:: Status of the curvature correction.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_decimals() → GsiOnlineResponse[int][source]¶

CONF 51

Gets the current number of displayed decimals.

Returns:: Number of decimals.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_delay() → GsiOnlineResponse[int][source]¶

CONF 78

Gets the current message delay.

Returns:: Delay between two messages in [0; 50] range in [10ms] units.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_display_heater() → GsiOnlineResponse[bool][source]¶

CONF 106

Gets the current status of the display heater unit.

Returns:: Status of the display heater.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_distance_unit() → GsiOnlineResponse[Distance][source]¶

CONF 41

Gets the current distance measurement unit.

Returns:: Distance unit.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_format() → GsiOnlineResponse[GSIFormat][source]¶

CONF 137

Gets the current GSI communication format of the instrument.

Returns:: GSI format.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

Note

If the request is successful, the internal format variable is updated accordingly to keep the communication in sync between the computer and the instrument.

get_illumination() → GsiOnlineResponse[Illumination][source]¶

CONF 31

Gets the current status of the diplay and bubble illumination.

Returns:: Illumination status.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_parity() → GsiOnlineResponse[Parity][source]¶

CONF 71

Gets the current parity bit setting.

Returns:: Parity bit setting.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_protocol() → GsiOnlineResponse[bool][source]¶

CONF 75

Gets the current status of the communication protocol.

Returns:: Protocol status.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_recorder() → GsiOnlineResponse[Recorder][source]¶

CONF 76

Gets the current measurement recording device.

Returns:: Target recording device.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_staff_mode() → GsiOnlineResponse[bool][source]¶

CONF 127

Gets the current mode of the levelling staff.

Returns:: Is the levelling staff inverted?
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_temperature() → GsiOnlineResponse[int][source]¶

CONF 91

Gets the current internal temperature.

Returns:: Internal temperature.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_temperature_unit() → GsiOnlineResponse[Temperature][source]¶

CONF 42

Gets the current temperature measurement unit.

Returns:: Temperature unit.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

get_terminator() → GsiOnlineResponse[Terminator][source]¶

CONF 73

Gets the current message terminator.

Returns:: Message terminator.
Return type:: GsiOnlineResponse

Note

The value in the response is None if the value could not be retrieved (i.e. an error occured during the request).

set_autooff(status: AutoOff | str) → GsiOnlineResponse[bool][source]¶

SET 95

Sets the status of the automatic shutdown feature.

Parameters:

status: AutoOff | str¶: Automatic shutdown mode.

Returns:

Success of the change.

Return type: