Alt-User

Description

Module: geocompy.geo.aus

Definitions for the GeoCOM Alt user subsystem.

Types

  • GeoComAUS

Definitions

class GeoComAUS(parent: GeoComType)[source]

Alt user subsystem of the GeoCOM protocol.

Added in version GeoCOM-TPS1100.

This subsystem can be used to set and query the ATR and LOCK automation modes.

Parameters:
parent: GeoComType

The parent protocol instance of this subsystem.

get_rcs_search_status() → GeoComResponse[bool][source]

RPC 18010, AUS_GetRcsSearchSwitch

Added in version GeoCOM-TPS1100.

Removed in version GeoCOM-TPS1200.

Gets the current state of the RCS search mode.

Returns:

Params:

  • bool: RCS-style search is enabled.

Error codes:

  • NOT_IMPL: ATR is not available.

Return type:

GeoComResponse

get_user_atr_state() → GeoComResponse[bool][source]

RPC 18006, AUS_GetUserAtrState

Gets the current state of the ATR mode.

Returns:

Params:

  • bool: ATR is enabled.

Error codes:

  • NOT_IMPL: ATR is not available.

Return type:

GeoComResponse

Notes

This command does not indicate if the ATR has acquired a prism.

See also

switch_user_atr

get_user_lock_state() → GeoComResponse[bool][source]

RPC 18005, AUS_GetUserLockState

Gets the current state of the LOCK mode.

Returns:

Params:

  • bool: ATR lock is enabled.

Error codes:

  • NOT_IMPL: ATR is not available.

Return type:

GeoComResponse

See also

switch_user_lock, mot.get_lockon_status

RPC 18009, AUS_SwitchRcsSearch

Added in version GeoCOM-TPS1100.

Removed in version GeoCOM-TPS1200.

Enables or disables the RCS searching mode.

Parameters:
enabled: bool

RCS-style search is enabled.

Returns:

Error codes:

  • NOT_IMPL: ATR is not available.

Return type:

GeoComResponse

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

RPC 18005, AUS_SetUserAtrState

Activates or deactivates the ATR mode.

Parameters:
enabled: bool

ATR is enabled.

Returns:

Error codes:

  • NOT_IMPL: ATR is not available.

Return type:

GeoComResponse

Notes

If LOCK mode is active when the ATR is activated, then LOCK mode changes to ATR mode.

If the ATR is deactivated, the LOCK mode does not change.

See also

get_user_atr_state, get_user_lock_state, switch_user_lock

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

RPC 18007, AUS_SetUserLockState

Activates or deactivates the LOCK mode.

Parameters:
enabled: bool

ATR lock is enabled.

Returns:

Error codes:

  • NOT_IMPL: ATR is not available.

Return type:

GeoComResponse

Notes

Activating the LOCK mode does not mean that the instrument is automatically locked onto a prism.

See also

get_user_lock_state, get_user_atr_state, aut.lock_in