Distance Measurement

Description

Module: geocompy.geo.edm

Definitions for the GeoCOM EDM subsystem.

Types

  • GeoComEDM

Definitions

class GeoComEDM(parent: GeoComType)[source]

Electronic distance measurement subsystem of the GeoCOM protocol.

This subsystem provides access to control some of the EDM module functions.

Parameters:
parent: GeoComType

The parent protocol instance of this subsystem.

get_boomerang_filter_status() → GeoComResponse[bool][source]

RPC 1044, EDM_GetBumerang

Removed in version GeoCOM-TPS1100.

Gets the current status of the boomerang filter.

Returns:

Params:

  • bool: Boomerang filtering is enabled.

Error codes:

  • IVRESULT: Wrong result due to error.

  • SYSBUSY: EDM is already busy.

  • NOT_IMPL: Boomerang filter is not available.

  • EDM_COMERR: Error communicating with EDM.

  • EDM_HWFAILURE: Hardware error.

  • TIMEDOUT: Process timed out.

  • ABORT: Function was interrupted.

  • UNDEFINED: Instrument name could not be read.

  • EDM_ERR12: Supply voltage below minimum.

Return type:

GeoComResponse

get_guidelight_intensity() → GeoComResponse[Guidelight][source]

RPC 1058, EDM_GetEglIntensity

Added in version GeoCOM-TPS1100.

Gets the current intensity setting of the electronic guide light.

Returns:

Params:

  • Guidelight: Current intensity mode.

Error codes:

  • EDM_DEV_NOT_INSTALLED: Instrument has no EGL.

Return type:

GeoComResponse

get_tracklight_brightness() → GeoComResponse[Tracklight][source]

RPC 1041, EDM_GetTrkLightBrightness

Removed in version GeoCOM-TPS1100.

Gets the brightness of the tracklight.

Returns:

Params:

  • Tracklight: Tracklight brightness.

Error codes:

  • NOT_IMPL: Tracklight is not available.

Return type:

GeoComResponse

get_tracklight_status() → GeoComResponse[bool][source]

RPC 1040, EDM_GetTrkLightSwitch

Removed in version GeoCOM-TPS1100.

Gets if the track light is currently active.

Returns:

Params:

  • bool: Tracklight is on.

Error codes:

  • NOT_IMPL: Tracklight is not available.

Return type:

GeoComResponse

is_continuous_measurement(mode: MeasurementType | str) → GeoComResponse[bool][source]

RPC 1070, EDM_IsContMeasActive

Added in version GeoCOM-VivaTPS.

Checks if the continuous measurement is active in the specified mode.

Parameters:
mode: MeasurementType | str

Measurement mode.

Returns:

Params:

  • bool: Continuous measurement is active.

Return type:

GeoComResponse

set_guidelight_intensity(intensity: Guidelight | str) → GeoComResponse[None][source]

RPC 1059, EDM_SetEglIntensity

Added in version GeoCOM-TPS1100.

Sets the intensity setting of the electronic guide light.

Parameters:
intensity: Guidelight | str

Intensity setting to switch_edm.

Returns:

Error codes:

  • EDM_DEV_NOT_INSTALLED: Instrument has no EGL.

Return type:

GeoComResponse

set_tracklight_brightness(intensity: Tracklight | str) → GeoComResponse[None][source]

RPC 1032, EDM_SetTrkLightBrightness

Removed in version GeoCOM-TPS1100.

Sets the brightness of the tracklight.

Parameters:
intensity: Tracklight | str

Tracklight intensity to set.

Returns:

Error codes:

  • NOT_IMPL: Tracklight is not available.

Return type:

GeoComResponse

switch_boomerang_filter(enabled: bool) → GeoComResponse[None][source]

RPC 1007, EDM_SetBumerang

Removed in version GeoCOM-TPS1100.

Sets the status of the boomerang filter.

Parameters:
enabled: bool

Boomerant filter status to set.

Returns:

Error codes:

  • IVRESULT: Wrong result due to error.

  • SYSBUSY: EDM is already busy.

  • NOT_IMPL: Boomerang filter is not available.

  • EDM_COMERR: Error communicating with EDM.

  • EDM_HWFAILURE: Hardware error.

  • TIMEDOUT: Process timed out.

  • ABORT: Function was interrupted.

  • UNDEFINED: Instrument name could not be read.

  • EDM_ERR12: Supply voltage below minimum.

Return type:

GeoComResponse

switch_boomerang_filter_new(enable: bool) → GeoComResponse[None][source]

RPC 1061, EDM_SetBoomerangFilter

Added in version GeoCOM-VivaTPS.

Enables or disables the boomerang filter.

Parameters:
enable: bool

Enable boomerang filter.

Return type:

GeoComResponse

switch_edm(activate: bool) → GeoComResponse[None][source]

RPC 1010, EDM_On

Removed in version GeoCOM-TPS1100.

Activates or deactivates the EDM module.

Parameters:
activate: bool

Activate EDM module.

Returns:

Error codes:

  • SYSBUSY: EDM is already busy.

  • EDM_COMERR: Error communicating with EDM.

  • EDM_ERR12: Supply voltage below minimum.

  • EDM_HWFAILURE: Hardware error.

  • TIMEDOUT: Process timed out.

  • ABORT: Function was interrupted.

  • UNDEFINED: Instrument name could not be read.

Return type:

GeoComResponse

switch_laserpointer(activate: bool) → GeoComResponse[None][source]

RPC 1004, EDM_Laserpointer

Enables or disables the laser pointer.

Parameters:
activate: bool

Activate laser pointer

Returns:

Error codes:

  • NOT_IMPL: Instrument has no switch_laserpointer.

  • EDM_HWFAILURE: Hardware error.

  • EDM_COMERR: Error communicating with EDM.

  • TIMEDOUT: Process timed out.

  • ABORT: Function was interrupted.

  • SYSBUSY: EDM is already busy.

  • IVPARAM: Invalid parameter.

  • UNDEFINED: Instrument name could not be read.

Return type:

GeoComResponse

switch_tracklight(activate: bool) → GeoComResponse[None][source]

RPC 1031, EDM_SetTrkLightSwitch

Removed in version GeoCOM-TPS1100.

Sets the status of the tracklight.

Parameters:
activate: bool

Activate track light.

Returns:

Error codes:

  • IVRESULT: Wrong result due to error.

  • SYSBUSY: EDM is already busy.

  • NOT_IMPL: Tracklight is not available.

Return type:

GeoComResponse