Supervisor

Description

Module: geocompy.geo.sup

Definitions for the GeoCOM Supervisor subsystem.

Types

  • GeoComSUP

Definitions

class GeoComSUP(parent: GeoComType)[source]

Supervisor subsystem of the GeoCOM protocol.

This subsystem controls the continuous operation of the system, and it allows to automatically display status information.

Parameters:
parent: GeoComType

The parent protocol instance of this subsystem.

get_poweroff_configuration() → GeoComResponse[tuple[bool, AutoPower, int]][source]

RPC 14001, SUP_GetConfig

Gets the current poweroff and timing configuration.

Returns:

Params:

  • bool: Low temperature shutdown enabled.

  • AutoPower: Current shutdown mechanism.

  • int: Idling timeout [ms].

Return type:

GeoComResponse

See also

set_poweroff_configuration

set_poweroff_configuration(lowtemp: bool, autopower: AutoPower | str = AutoPower.SHUTDOWN, timeout: int = 600000) → GeoComResponse[None][source]

RPC 14002, SUP_SetConfig

Sets the poweroff and timing configuration.

Parameters:
lowtemp: bool

Enable low temperature shutdown.

autopower: AutoPower | str = AutoPower.SHUTDOWN

Automatic poweroff action, by default AutoPower.SHUTDOWN

timeout: int = 600000

Idling timeout [60000, 6000000] [ms], by default 600000

Returns:

Error codes:

  • IVPARAM: Invalid timeout parameter.

Return type:

GeoComResponse

See also

get_poweroff_configuration

switch_autorestart(autorestart: bool) → GeoComResponse[None][source]

RPC 14006, SUP_SetPowerFailAutoRestart

Added in version GeoCOM-VivaTPS.

Configure the instrument to automatically restard if power is restored after an irregular shutdown.

Parameters:
autorestart: bool

Enable automatic restart.

Returns:

Error codes:

  • NA: Command not available.

Return type:

GeoComResponse

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

RPC 14003, SUP_SwitchLowTempControl

Removed in version GeoCOM-TPS1200.

Enables or disables the low temperature shutdown mechanism. When active, the mechanism will shut the instrument down, if the internal temperature falls below -30 degree celsius.

Parameters:
enabled: bool

Enable low temperature shutdown.

Return type:

GeoComResponse

See also

get_poweroff_configuration, set_poweroff_configuration