Central Services¶

Description¶

Module: geocompy.geo.csv

Definitions for the GeoCOM Central services subsystem.

Types¶

GeoComCSV

Definitions¶

class GeoComCSV(parent: GeoComType)[source]¶

Central services subsystem of the GeoCOM protocol.

This subsystem contains functions to maintain centralised data and configuration of the instruments.

Parameters:

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

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

RPC 5074, (unknown, most likely CSV_AbortList)

Aborts current job listing setup.

Return type:: GeoComResponse

See also

setup_listing, list

Note

This command was not found in the reference manuals, but discovered by accident while testing. Version or the corresponding GeoCOM function name is not known. Use with caution!

check_power() → GeoComResponse[tuple[int, PowerSource, PowerSource]][source]¶

RPC 5039, CSV_CheckPower

Added in version GeoCOM-TPS1100.

Gets the remaining capacity of the active power source.

Returns:

Params:

int: Remaining capacity [%].
PowerSource: Active power source.
PowerSource: Suggested power source.

Return type:

GeoComResponse

check_property(property: Property | str) → GeoComResponse[bool][source]¶

RPC 5039, CSV_CheckProperty

Added in version GeoCOM-VivaTPS.

Checks if a specific license is available on the instrument.

Parameters:

property: Property | str¶: License to check.

Returns:

Params:

bool: License is available.

Return type:

GeoComResponse

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

RPC 5162, CSV_GetCharging

Added in version GeoCOM-VivaTPS.

Gets the current state of the charger.

Returns:

Params:

bool: Charger is active.

Return type:

GeoComResponse

get_datetime() → GeoComResponse[datetime][source]¶

RPC 5008, CSV_GetDateTime

Gets the current date and time set on the instrument.

Returns:

Params:

datetime: Current date and time.

Return type:

GeoComResponse

See also

set_datetime

get_datetime_new() → GeoComResponse[datetime][source]¶

RPC 5051, CSV_GetDateTime2

Added in version GeoComp-TPS1200.

Gets the current date and time set on the instrument.

Returns:

Params:

datetime: Current date and time.

Return type:

GeoComResponse

See also

set_datetime_new

get_datetime_precise() → GeoComResponse[datetime][source]¶

RPC 5117, CSV_GetDateTimeCentiSec

Added in version GeoCOM-TPS1200.

Gets the current date and time set on the instrument in centiseconds resolution.

Returns:

Params:

datetime: Current date and time.

Return type:

GeoComResponse

See also

get_datetime, set_datetime

get_firmware_creation_date() → GeoComResponse[str][source]¶

RPC 5038, CSV_GetSWCreationDate

Added in version GeoComp-TPS1200.

Gets the creation date of the system software version running on the instrument.

Returns:

Params:

str: Creation date.

Return type:

GeoComResponse

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

RPC 5034, CSV_GetSWVersion

Gets the system software version running on the instrument.

Returns:

Params:

int: Release number.
int: Version number.
int: Subversion number.

Return type:

GeoComResponse

get_instrument_configuration() → GeoComResponse[tuple[DeviceClass, Capabilities]][source]¶

RPC 5035, CSV_GetDeviceConfig

Gets class of the instrument, as well as information about the capatilities of the configuration.

Returns:

Params:

DeviceClass: Class of the instrument.
Capabilities: Configuration of the components.

Error codes:

UNDEFINED: Precision class is undefined.

Return type:

GeoComResponse

get_instrument_name() → GeoComResponse[str][source]¶

RPC 5004, CSV_GetInstrumentName

Gets the name of the instrument.

Returns:

Params:

str: Instrument name.

Return type:

GeoComResponse

get_internal_temperature() → GeoComResponse[float][source]¶

RPC 5011, CSV_GetIntTemp

Gets internal temperature of the instrument, measured on the main board.

Returns:

Params:

float: Internal temperature [°C].

Return type:

GeoComResponse

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

RPC 5041, CSV_GetLaserlotIntens

Added in version GeoCOM-VivaTPS.

Gets the current intensity of the laser plummet.

Returns:

Params:

int: Current laser plummet intensity.

Return type:

GeoComResponse

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

RPC 5042, CSV_GetLaserlotStatus

Added in version GeoCOM-VivaTPS.

Gets the current state of the laser plummet.

Returns:

Params:

bool: Laser plummet is active.

Return type:

GeoComResponse

get_maintenance_end() → GeoComResponse[datetime][source]¶

RPC 5114, CSV_GetMaintenanceEnd

Gets the date when the software maintenance service ends.

Returns:

Params:

datetime: Software maintenance end date.

Return type:

GeoComResponse

get_preferred_powersource() → GeoComResponse[PowerSource][source]¶

RPC 5164, CSV_GetPreferredPowersource

Added in version GeoCOM-VivaTPS.

Gets the current preferred power source.

Returns:

Params:

PowerSource: Preferred power source.

Return type:

GeoComResponse

get_reflectorless_class() → GeoComResponse[Reflectorless][source]¶

RPC 5100, CSV_GetReflectorlessClass

Added in version GeoCOM-TPS1200.

Gets the class of the reflectorless EDM module, if the instrument is equipped with one.

Returns:

Params:

Reflectorless: Class of the reflectorless EDM module.

Return type:

GeoComResponse

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

RPC 5003, CSV_GetInstrumentNo

Gets the serial number of the instrument.

Returns:

Params:

int: Serial number.

Return type:

GeoComResponse

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

RPC 5156, CSV_GetStartupMessageMode

Added in version GeoCOM-VivaTPS.

Gets the current status of the startup message mode on the instrument.

Returns:

Params:

bool: Startup message is enabled.

Return type:

GeoComResponse

get_user_instrument_name() → GeoComResponse[str][source]¶

RPC 5006, CSV_GetUserInstrumentName

Removed in version GeoCOM-TPS1100.

Gets the user defined name of the instrument.

Returns:

Params:

str: Instrument name.

Return type:

GeoComResponse

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

RPC 5165, CSV_GetVoltage

Added in version GeoCOM-VivaTPS.

Gets the instrument voltage.

Returns:

Params:

int: Instrument voltage [mV].

Return type:

GeoComResponse

get_voltage_battery() → GeoComResponse[float][source]¶

RPC 5009, CSV_GetVBat

Deprecated since version GeoCOM-TPS1100: The command is still available, but should not be used with instruments that support the new check_power command.

Removed in version GeoCOM-TPS1200.

Gets the voltage of the power supply.

12,7 V < voltage full

12,4 V < voltage < 12,7 V near full

11,1 V < voltage < 12,4 V good

10,5 V < voltage < 11,1 V empty

voltage < 10,5 V powered off

Returns:

Params:

float: Power source voltage [V].

Return type:

GeoComResponse

get_voltage_memory() → GeoComResponse[float][source]¶

RPC 5010, CSV_GetVMem

Removed in version GeoCOM-TPS1200.

Gets the voltage of the memory backup power supply.

Voltage above 3.1 V is OK.

Returns:

Params:

float: Power source voltage [V].

Return type:

GeoComResponse

list() → GeoComResponse[tuple[str, str, int, int, str]][source]¶

RPC 5073, CSV_List

Added in version GeoCOM-TPS1200.

Gets the next job listing entry.

Returns:

Params:

str: Job name.
str: File name (-01: job, -02: code list).
int: Unknown.
int: Unknown.
str: Unknown.

Return type:

GeoComResponse

See also

setup_listing

set_datetime(time: datetime) → GeoComResponse[None][source]¶

RPC 5007, CSV_SetDateTime

Sets the date and time on the instrument.

Parameters:

time: datetime¶: New date and time to set.

Return type:

GeoComResponse

See also

get_datetime

set_datetime_new(time: datetime) → GeoComResponse[None][source]¶

RPC 5050, CSV_SetDateTime2

Added in version GeoComp-VivaTPS.

Sets the date and time on the instrument.

Parameters:

time: datetime¶: New date and time to set.

Return type:

GeoComResponse

See also

get_datetime_new

set_laserplummet_intensity(intensity: int) → GeoComResponse[None][source]¶

RPC 5040, CSV_SetLaserlotIntens

Added in version GeoCOM-VivaTPS.

Sets the intensity of the laser plummet.

Parameters:

intensity: int¶: New laser plummet intensity to set.

Return type:

GeoComResponse

set_preferred_powersource(source: PowerSource | str) → GeoComResponse[None][source]¶

RPC 5163, CSV_SetPreferredPowersource

Added in version GeoCOM-VivaTPS.

Sets the preferred power source.

Parameters:

source: PowerSource | str¶: New preferred power source to set.

set_user_instrument_name(name: str) → GeoComResponse[None][source]¶

RPC 5005, CSV_SetUserInstrumentName

Removed in version GeoCOM-TPS1100.

Parameters:

name: str¶: Instrument name.

Return type:

GeoComResponse

setup_listing(device: Device | str = Device.INTERNAL) → GeoComResponse[None][source]¶

RPC 5072, CSV_SetupList

Added in version GeoCOM-TPS1200.

Prepares listing of the jobs in memory.

Parameters:

device: Device | str = Device.INTERNAL¶: Memory device, by default INTERNAL

Returns:

Error codes:

NOTOK: Setup already exists, previous setup was not aborted.

Return type:

GeoComResponse

See also

list, abort_listing

switch_charging(activate: bool) → GeoComResponse[None][source]¶

RPC 5161, CSV_SetCharging

Added in version GeoCOM-VivaTPS.

Sets the state of the charger.

Parameters:

activate: bool¶: Activate charger.

Return type:

GeoComResponse

switch_laserplummet(active: bool) → GeoComResponse[None][source]¶

RPC 5043, CSV_SwitchLaserlot

Added in version GeoCOM-VivaTPS.

Sets the state of the laser plummet.

Parameters:

active: bool¶: Activate laser plummet.

Return type:

GeoComResponse

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

RPC 5155, CSV_SetStartupMessageMode

Added in version GeoCOM-VivaTPS.

Enables or disables the startup message mode on the instrument.

Parameters:

enabled: bool¶: Startup message mode is enabled.

Return type:

GeoComResponse