Communication¶

Description¶

Module: geocompy.geo.com

Definitions for the GeoCOM Communication subsystem.

Types¶

• GeoComCOM

Definitions¶

class GeoComCOM(parent: GeoComType)[source]¶

Communication subsystem of the GeoCOM protocol.

This subsystem contains functions relevant to the communication with the instrument.

Parameters:

parent: GeoComType¶

The parent protocol instance of this subsystem.

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

RPC 113, COM_GetBinaryAvailable

Checks if the instrument supports binary communication.

Returns:

Params:

• bool: Availability of binary mode.

Return type:

GeoComResponse

See also

set_binary_available

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

RPC 108, COM_GetDoublePrecision

Gets the current ASCII communication floating point precision of the instrument.

Returns:

Params:

• int: Floating point decimal places.

Return type:

GeoComResponse

See also

set_double_precision

get_geocom_version() → GeoComResponse[tuple[int, int, int]][source]¶

RPC 110, COM_GetSWVersion

Gets the version of the installed GeoCOM release.

Returns:

Params:

• int: Release number.

• int: Version number.

• int: Subversion number.

Return type:

GeoComResponse

See also

csv.get_firmware_version

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

RPC 0, COM_NullProc

Tests connection by executing the null process.

set_binary_available(enable: bool) → GeoComResponse[None][source]¶

RPC 114, COM_SetBinaryAvailable

Enables or disables binary communication with the instrument.

Parameters:

enable: bool¶

Enable or disable binary communication.

See also

get_binary_available

set_double_precision(digits: int) → GeoComResponse[None][source]¶

RPC 107, COM_SetDoublePrecision

Sets the ASCII communication floating point precision of the instrument.

Parameters:

digits: int¶

Floating points decimal places.

Return type:

GeoComResponse

See also

get_double_precision

set_send_delay(delay: float) → GeoComResponse[None][source]¶

RPC 109, COM_SetSendDelay

Removed in version GeoCOM-TPS1200.

Sets response delay on the instrument.

Parameters:

delay: float¶

Response delay [s].

Return type:

GeoComResponse

switch_off(mode: Shutdown | str = Shutdown.SHUTDOWN) → GeoComResponse[None][source]¶

RPC 112, COM_SwitchOffTPS

Switches off the instrument.

Parameters:

mode: Shutdown | str = Shutdown.SHUTDOWN¶

Desired stop mode, by default Shutdown.SHUTDOWN

Return type:

GeoComResponse

See also

switch_on

switch_on(mode: Startup | str = Startup.REMOTE) → GeoComResponse[None][source]¶

RPC 111, COM_SwitchOnTPS

Switches on the instrument.

Parameters:

mode: Startup | str = Startup.REMOTE¶

Desired startup mode, by default Startup.REMOTE

Returns:

Error codes:

• NOT_IMPL: Instrument is already on.

Return type:

GeoComResponse

Notes

The instrument can be switched on with any command, or even just a single character.

See also

switch_off

switch_signoff(enable: bool) → GeoComResponse[None][source]¶

RPC 115, COM_EnableSignOff

Removed in version GeoCOM-TPS1200.

Enables or disables the signoff message upon operation mode changes.

Parameters:

enable: bool¶

Return type:

GeoComResponse

Note

This setting is not persistent between sessions.

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

RPC 1, COM_Local

Switches instrument to local mode, exiting the online mode.

Return type:

GeoComResponse

Warning

Once the instrument is switched to local mode, all further RPCs will be ignored, until the online mode is manually activated again.