Digital Level¶

Description¶

Module: geocompy.geo.dna

Definitions for the GeoCOM Digital level subsystem.

Types¶

GeoComDNA

Definitions¶

class GeoComDNA(parent: GeoComType)[source]¶

Digital level subsystem of the GeoCOM protocol.

Added in version GeoCOM-LS.

Parameters:

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

autofocus() → GeoComResponse[None][source]¶

RPC 29068, DNA_StartAutofocus

Executes a camera autofocus cycle.

Return type:: GeoComResponse

do_measurement() → GeoComResponse[None][source]¶

RPC 29036, DNA_StartMeasurement

Carries out a staff reading. The results are not returend, but retained in memory, and used by other commands.

Return type:: GeoComResponse

get_compass_bearing() → GeoComResponse[Angle][source]¶

RPC 29072, DNA_GetCompassData

Gets the current digital magnetic compass bearing.

Returns:

Params:

Angle: Compass bearing.

Return type:

GeoComResponse

get_curvature_correction_status() → GeoComResponse[bool][source]¶

RPC 29108, DNA_GetEarthCurvatureStatus

Gets the current status of the Earth curvature correction.

Returns:

Params:

bool: Curvature correction is enabled.

Return type:

GeoComResponse

get_inclination_cross() → GeoComResponse[Angle][source]¶

RPC 29070, DNA_GetTiltX

Gets the current cross inclination.

Returns:

Params:

Angle: Cross inclination.

Return type:

GeoComResponse

get_inclination_length() → GeoComResponse[Angle][source]¶

RPC 29104, DNA_GetTiltL

Gets the current length inclination.

Returns:

Params:

Angle: Length inclination.

Return type:

GeoComResponse

get_job_number() → GeoComResponse[int][source]¶

RPC 29109, DNA_GetJobNumber

Gets the number of stored jobs and code lists.

Returns:

Params:

int: Number of jobs and code lists.

Return type:

GeoComResponse

get_reading(wait: int = 5) → GeoComResponse[tuple[float, float]][source]¶

RPC 29005, DNA_GetMeasResult

Gets the current staff reading in memory. A measurement has to be completed in advance.

Parameters:

wait: int = 5¶: Time to wait for a measurement to complete [s], by default 5

Returns:

Params:

float: Staff reading.
float: Staff distance.

Return type:

GeoComResponse

get_staff_type() → GeoComResponse[StaffType][source]¶

RPC 29126, DNA_GetStaffLength

Gets the currently set levelling staff length.

Returns:

Params:

StaffType: Staff length type.

Return type:

GeoComResponse

get_staffmode_status() → GeoComResponse[bool][source]¶

RPC 29011, DNA_GetRodPos

Gets the current the levelling staff reading mode.

Returns:

Params:

bool: Upside down reading (inverted staff).

Return type:

GeoComResponse

set_staff_type(staff: StaffType | str) → GeoComResponse[None][source]¶

RPC 29127, DNA_SetStaffLength

Sets the levelling staff length

Parameters:

staff: StaffType | str¶: Levelling staff type.

Return type:

GeoComResponse

switch_curvature_correction(enabled: bool) → GeoComResponse[None][source]¶

RPC 29107, DNA_SwitchEarthCurvature

Enables or disables the Earth curvature correction.

Parameters:

enabled: bool¶: Enable curvature correction.

Return type:

GeoComResponse

switch_staffmode(inverted: bool) → GeoComResponse[None][source]¶

RPC 29010, DNA_SetRodPos

Sets the levelling staff reading mode.

Parameters:

inverted: bool¶: Upside down reading (inverted staff).

Return type:

GeoComResponse

wake_up() → GeoComResponse[None][source]¶

RPC 29110, DNA_WakeUpInstrument

Wake up the instrument from stadby mode.

Return type:: GeoComResponse