GeoComPy

https://geocompy.readthedocs.io/stable/
Admin
GeoComPy is a Python package providing wrapper functions for controlling and automating various...
Tokens:68,042
Snippets:392
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Build and Install from Source

Source: https://geocompy.readthedocs.io/stable/overview

Build and install the package locally from the source directory.

```bash
python -m pip install .
```

--------------------------------

### Install via PyPI

Source: https://geocompy.readthedocs.io/stable/overview

Install the package and its dependencies using pip.

```bash
pip install geocompy
```

--------------------------------

### start_controller()

Source: https://geocompy.readthedocs.io/stable/api/geo/mot

Starts the motor controller in the specified mode.

```APIDOC
## POST /api/mot/start_controller

### Description
Starts the motor controller in the specified mode.

### Method
POST

### Endpoint
/api/mot/start_controller

### Parameters
#### Request Body
* **mode** (Controller | str) - Optional - Controller mode, by default Controller.MANUAL

### Request Example
```json
{
  "mode": "AUTO"
}
```

### Response
#### Success Response (200)
* **None** (null) - Indicates successful execution.

### Error Codes
* **IVPARAM**: Control mode is not appropriate for velocity control.
* **NOT_IMPL**: Motorization not available.
* **MOT_BUSY**: Subsystem is busy, controller already started.
* **MOT_UNREADY**: Subsystem is not initialized.
```

--------------------------------

### Guide Light Intensity

Source: https://geocompy.readthedocs.io/stable/api/geo/gcdata

Constants for guide light intensity settings.

```APIDOC
## Guide Light Intensity

### Description
Constants for guide light intensity settings.
- Added in version: GeoCOM-TPS1100.

### HIGH
- Value: `3`

### LOW
- Value: `1`

### MID
- Value: `2`

### OFF
- Value: `0`
```

--------------------------------

### Setup a basic serial connection

Source: https://geocompy.readthedocs.io/stable/api/communication

Initializes a serial port and wraps it in a SerialConnection instance for message exchange.

```python
>>> from serial import Serial
>>> port = Serial("COM4", timeout=15)
>>> conn = gc.communication.SerialConnection(port)
>>> # message exchanges
>>> conn.close()
```

--------------------------------

### Setup Basic TCP Socket Connection

Source: https://geocompy.readthedocs.io/stable/api/communication

Initialize a SocketConnection using a standard Python socket object.

```python
>>> import socket
>>> soc = socket.socket(
>>>     socket.AF_INET,
>>>     socket.SOCK_STREAM,
>>>     socket.IPPROTO_TCP
>>> )
>>> soc.connect(("192.168.0.1", 1212))
>>> conn = SocketConnection(soc)
>>> # message exchanges
>>> conn.close()
```

--------------------------------

### Start Remote Video Stream

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Starts a remote video stream from a specified camera.

```APIDOC
## POST /api/camera/start_remote_video

### Description
Starts a remote video stream that can be watched when connected wirelessly to the instrument. Network stream: `rtsp://192.168.254.3/TSCame`.

### Method
POST

### Endpoint
/api/camera/start_remote_video

### Parameters
#### Request Body
- **fps** (int) - Required - Frame rate 3/5/10 [Hz].
- **bitrate** (int) - Required - Video bit rate in [100; 6144] range [kbps].
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW

### Response
#### Success Response (200)
- **result** (None) - Indicates success.

#### Error Codes
- `NA`: Imaging license not found.
```

--------------------------------

### GET /is_camera_ready

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Checks if the specified camera is ready for operation.

```APIDOC
## GET /is_camera_ready

### Description
Checks if a camera is ready for use (RPC 23627, CAM_IsCameraReady).

### Method
GET

### Parameters
#### Query Parameters
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW

### Response
#### Error Codes
- **NA**: Imaging license not found.
- **CAM_NOT_READY**: Camera is turned off, or currently starting up.
```

--------------------------------

### GET /FTR_List

Source: https://geocompy.readthedocs.io/stable/api/geo/ftr

Gets a single file entry according to the predefined listing setup.

```APIDOC
## GET /FTR_List

### Description
Gets a single file entry according to the predefined listing setup.

### Method
GET

### Endpoint
/FTR_List

### Parameters
#### Query Parameters
- **next** (bool) - Optional - Get the next item, after a previous call (get first item otherwise), default False.

### Response
#### Success Response (200)
- **is_last** (bool) - If file is last in listing.
- **filename** (str) - Name of the file.
- **size** (int) - File size [byte].
- **modification_date** (datetime) - Date and time of last modification.
```

--------------------------------

### Get Dummy Logger

Source: https://geocompy.readthedocs.io/stable/api/communication

Sets up and returns a dummy logger instance. This logger does not propagate records and logs to a null device, making it suitable for situations where logging is not desired but a logger object is required.

```python
from geocompy.logging import get_dummy_logger

logger = get_dummy_logger()

```

--------------------------------

### Exchange GSI Online settings

Source: https://geocompy.readthedocs.io/stable/introduction

Example of querying and setting instrument configurations using CONF and SET commands.

```text
CONF/30   # Query command
0030/0001 # Response

SET/30/2  # Setting beeping to loud
?         # Success confirmation
```

--------------------------------

### Initialize GeoCOM Instrument Connection

Source: https://geocompy.readthedocs.io/stable/introduction

Initializes an instrument object using an established serial connection, verifying the link during setup.

```python
from geocompy import GeoCom, open_serial


with open_serial("COM1", timeout=10) as com:
    tps = GeoCom(com)
```

--------------------------------

### set_velocity()

Source: https://geocompy.readthedocs.io/stable/api/geo/mot

Starts the motors at a constant speed. The motor controller must be set accordingly in advance.

```APIDOC
## POST /api/mot/velocity

### Description
Starts the motors at a constant speed. The motor controller must be set accordingly in advance.

### Method
POST

### Endpoint
/api/mot/velocity

### Parameters
#### Request Body
* **hz** (SupportsFloat) - Required - Horizontal angle to turn in a second [-pi; +pi]rad.
* **v** (SupportsFloat) - Required - Vertical angle to turn in a second [-pi; +pi]rad.

### Request Example
```json
{
  "hz": 0.5,
  "v": -0.2
}
```

### Response
#### Success Response (200)
* **None** (null) - Indicates successful execution.

### Error Codes
* **IVPARAM**: Velocities not within acceptable range.
* **MOT_NOT_CONFIG**: Motor controller was not started, or is already busy with continuous task.
* **MOT_NOT_OCOST**: Controller is not set to constant speed.
* **NOT_IMPL**: Motorization is not available.

### Notes
Instruments with piezo motors support velocities up to 180 deg/sec. Stations with traditional motor drives support velocities up to 45 deg/sec.
```

--------------------------------

### POST /setup_listing

Source: https://geocompy.readthedocs.io/stable/api/geo/csv

Prepares the instrument to list jobs stored in memory.

```APIDOC
## POST /setup_listing

### Description
Prepares listing of the jobs in memory (RPC 5072).

### Method
POST

### Endpoint
/setup_listing

### Parameters
#### Request Body
- **device** (Device | str) - Optional - Memory device, by default INTERNAL.

### Response
#### Success Response (200)
- **None** (None) - Operation successful.

#### Error Handling
- **NOTOK**: Setup already exists, previous setup was not aborted.
```

--------------------------------

### setup_listing

Source: https://geocompy.readthedocs.io/stable/api/geo/ftr

Prepares a file listing of a specified file type on a selected memory device.

```APIDOC
## RPC 23306: setup_listing

### Description
Prepares file listing of the specified file type, on the selected memory device.

### Parameters
#### Path Parameters
- **device** (Device | str) - Optional - Memory device, by default Device.CFCARD.
- **filetype** (File | str) - Optional - File type, by default File.UNKNOWN.
- **path** (str) - Optional - Search path, by default empty string.

### Error Codes
- **IVPARAM**: Memory device unavailable, or cannot find search path.
- **NOTOK**: Setup already exists, previous setup was not aborted.
- **FTR_FILEACCESS**: File access error.
```

--------------------------------

### Exchange GSI Online measurements

Source: https://geocompy.readthedocs.io/stable/introduction

Example of retrieving and setting point IDs using GET and PUT commands with GSI data words.

```text
GET/M/WI11                # Query current point ID
11....+000000A1           # Response if format is GSI8
*11....+00000000000000A1  # Response if format is GSI16

PUT/11....+000000A2       # Setting new point ID
?                         # Success confirmation
```

--------------------------------

### GET /get_fine_adjust_mode

Source: https://geocompy.readthedocs.io/stable/api/geo/aut

Gets the current fine adjustment mode.

```APIDOC
## GET /get_fine_adjust_mode

### Description
Gets the fine adjustment mode (RPC 9030, AUT_GetFineAdjustMode).

### Method
GET

### Endpoint
/get_fine_adjust_mode

### Response
#### Success Response (200)
- **mode** (Adjust) - Current fine adjustment mode.
```

--------------------------------

### GET /get_atr_status

Source: https://geocompy.readthedocs.io/stable/api/geo/aut

Gets whether or not the ATR mode is active.

```APIDOC
## GET /get_atr_status

### Description
Gets whether or not the ATR mode is active (RPC 9019, AUT_GetATRStatus).

### Method
GET

### Endpoint
/get_atr_status

### Response
#### Success Response (200)
- **status** (bool) - ATR mode is active.
```

--------------------------------

### GET /get_lock_onthefly_status

Source: https://geocompy.readthedocs.io/stable/api/geo/aut

Gets the current state of the on-the-fly lock mode.

```APIDOC
## GET /get_lock_onthefly_status

### Description
Gets the current state of the on-the-fly lock mode (RPC 9102, AUT_GetLockFlyMode).

### Method
GET

### Endpoint
/get_lock_onthefly_status

### Response
#### Success Response (200)
- **status** (bool) - On-the-fly lock mode is enabled.
```

--------------------------------

### Initialize GeoCom with Serial Connection

Source: https://geocompy.readthedocs.io/stable/api/geo

Demonstrates opening a serial connection and initializing the GeoCom handler.

```python
>>> from geocompy.communication import open_serial
>>> from geocompy.geo import GeoCom
>>>
>>> with open_serial("COM1") as line:
...     tps = GeoCom(line)
...     tps.com.nullprocess()
...
>>>
```

--------------------------------

### Startup Modes

Source: https://geocompy.readthedocs.io/stable/api/geo/gcdata

Enumeration for instrument startup modes.

```APIDOC
## Startup Modes

### Description
Specifies the instrument startup mode.

### Enum Values
- **GUI** (2) - Start onboard software. Added in version GeoCOM-VivaTPS.
- **LOCAL** (0) - Manual mode. Deprecated since version GeoCOM-VivaTPS.
- **REMOTE** (1) - GeoCOM mode.
```

--------------------------------

### setup_large_download

Source: https://geocompy.readthedocs.io/stable/api/geo/ftr

Prepares the download of a large file of a specified type on a selected memory device.

```APIDOC
## RPC 23313: setup_large_download

### Description
Prepares download of the specified large file of the specified type, on the selected memory device.

### Parameters
#### Path Parameters
- **filename** (str) - Required - File name (or full path if type is unknown).
- **blocksize** (int) - Required - Download data block size.
- **device** (Device | str) - Optional - Memory device, by default Device.INTERNAL.
- **filetype** (File | str) - Optional - File type, by default File.UNKNOWN.

### Response
#### Success Response (200)
- **int** - Number of download blocks needed.

### Error Codes
- **IVPARAM**: Memory device unavailable, or cannot find file path.
- **NOTOK**: Setup already exists, previous setup was not aborted.
- **FTR_INVALIDINPUT**: Block size too big.
- **FTR_FILEACCESS**: File access error.
```

--------------------------------

### EDM - Guide Light

Source: https://geocompy.readthedocs.io/stable/api/geo/edm

Control and query the intensity of the electronic guide light.

```APIDOC
## GET /api/edm/guidelight/intensity

### Description
Gets the current intensity setting of the electronic guide light.

### Method
GET

### Endpoint
/api/edm/guidelight/intensity

### Response
#### Success Response (200)
- **Guidelight** (Guidelight) - Current intensity mode.

#### Response Example
```json
{
  "intensity": "medium"
}
```

## POST /api/edm/guidelight/intensity

### Description
Sets the intensity setting of the electronic guide light.

### Method
POST

### Endpoint
/api/edm/guidelight/intensity

### Parameters
#### Request Body
- **intensity** (Guidelight | str) - Required - Intensity setting to switch_edm.

### Request Example
```json
{
  "intensity": "high"
}
```

### Response
#### Success Response (200)
- **None**

#### Response Example
```json
{
  "message": "Guidelight intensity set successfully."
}
```
```

--------------------------------

### Initialize and Access Coordinate Components

Source: https://geocompy.readthedocs.io/stable/api/data

Shows how to instantiate a 3D Coordinate and access its components via attributes, indexing, or unpacking.

```python
>>> c = gc.data.Coordinate(1, 2, 3)
>>> print(c)
Coordinate(1.0, 2.0, 3.0)
>>> c.x
1.0
>>> c[1]
2.0
>>> x, y, z = c
>>> z
3.0
```

--------------------------------

### GeoCOM Transaction ID Examples

Source: https://geocompy.readthedocs.io/stable/connections

Examples of request-response message formats using transaction IDs to track communication state.

```text
%R1Q,0:
%R1P,0,0:0
```

```text
%R1Q,0,1:
%R1P,0,1:0
```

```text
%R1Q,0,3:
%R1P,0,2:0
```

--------------------------------

### Initialize GeoCom with Logging

Source: https://geocompy.readthedocs.io/stable/api/geo

Shows how to pass a logger instance to the GeoCom constructor to monitor communication traffic.

```python
>>> from sys import stdout
>>> from logging import getLogger, DEBUG, StreamHandler
>>>
>>> from geocompy.communication import open_serial
>>> from geocompy.geo import GeoCom
>>>
>>> logger = getLogger("TPS")
>>> logger.addHandler(StreamHandler(stdout))
>>> logger.setLevel(DEBUG)
>>> with open_serial("COM1") as com:
...     tps = GeoCom(com, logger=logger)
...     tps.com.nullprocess()
...
>>>
GeoComResponse(COM_NullProc) ... # Startup connection test
GeoComResponse(COM_GetDoublePrecision) ... # Precision sync
GeoComResponse(COM_NullProc) ... # First executed command
```

--------------------------------

### GSIOnlineDNA: Get Request

Source: https://geocompy.readthedocs.io/stable/api/gsi/dna

Executes a GSI Online GET command to retrieve and parse a GSI word. Specify the request mode and the GsiWord type.

```python
dna.getrequest(mode, wordtype)
```

--------------------------------

### Initialize GSI Online DNA with Logger

Source: https://geocompy.readthedocs.io/stable/api/gsi/dna

Initializes the GSIOnlineDNA handler with a custom logger for detailed output. Requires setting up the logger and handler beforehand.

```python
from sys import stdout
from logging import getLogger, DEBUG, StreamHandler

from geocompy.communication import open_serial
from geocompy.gsi.dna import GsiOnlineDNA

logger = getLogger("TPS")
logger.addHandler(StreamHandler(stdout))
logger.setLevel(DEBUG)
with open_serial("COM1") as com:
    dna = GsiOnlineDNA(com, logger=logger)
    dna.beep('SHORT')

```

--------------------------------

### POST /search

Source: https://geocompy.readthedocs.io/stable/api/geo/aut

Initiates a target search within a specified window size.

```APIDOC
## POST /search

### Description
Search for target in the specified search window. The search is terminated once a prism appears in the view of the ATR.

### Method
POST

### Endpoint
/search

### Parameters
#### Request Body
- **width** (SupportsFloat) - Required - Width of target search window.
- **height** (SupportsFloat) - Required - Heigth of target search window.
```

--------------------------------

### GET /get_serial_number

Source: https://geocompy.readthedocs.io/stable/api/geo/csv

Retrieves the unique serial number of the instrument.

```APIDOC
## GET /get_serial_number

### Description
Gets the serial number of the instrument (RPC 5003).

### Method
GET

### Endpoint
/get_serial_number

### Response
#### Success Response (200)
- **int** (int) - Serial number.

#### Response Example
{
  "int": 123456
}
```

--------------------------------

### Manage Serial Connections

Source: https://geocompy.readthedocs.io/stable/api/communication

Demonstrates opening and closing a serial connection manually.

```python
>>> conn = open_serial("COM1", speed=19200, timeout=5)
>>> # do operations
>>> conn.close()
```

--------------------------------

### POST /FTR_AbortDownload

Source: https://geocompy.readthedocs.io/stable/api/geo/ftr

Aborts the current file download setup.

```APIDOC
## POST /FTR_AbortDownload

### Description
Aborts current file download setup.

### Method
POST

### Endpoint
/FTR_AbortDownload

### Response
#### Success Response (200)
- **response** (GeoComResponse) - Empty response indicating success.
```

--------------------------------

### GSIOnlineDNA: Wake Up

Source: https://geocompy.readthedocs.io/stable/api/gsi/dna

Wakes up the instrument, initiating or testing the connection. This command is automatically sent on initialization if the instrument is not already active.

```python
dna.wakeup()
```

--------------------------------

### GET /get_telescopic_crosshair

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Retrieves the current position of the crosshair in the camera resolution.

```APIDOC
## GET /get_telescopic_crosshair

### Description
Gets the position of the crosshair in the actual camera resolution (RPC 23671, CAM_OAC_GetCrossHairPos).

### Method
GET

### Response
#### Success Response (200)
- **int**: Horizontal position
- **int**: Vertical position

#### Error Codes
- **NA**: Imaging license not found.
```

--------------------------------

### Manage Socket Connections

Source: https://geocompy.readthedocs.io/stable/api/communication

Demonstrates opening and closing a TCP socket connection manually.

```python
>>> conn = open_socket("192.168.0.1", 1212, "tcp", timeout=5)
>>> # do operations
>>> conn.close()
```

--------------------------------

### RPC 23602 CAM_OVC_ReadInterOrient

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Gets the interior orientation parameters of the camera.

```APIDOC
## GET /CAM_OVC_ReadInterOrient

### Description
Gets the interior orientation parameters of the camera.

### Method
GET

### Parameters
#### Query Parameters
- **calibrated** (bool) - Optional - Use calibrated data, default True.

### Response
#### Success Response (200)
- **float** - Horizontal position of principal point [px].
- **float** - Vertical position of principal point [px].
- **float** - Focus length [m].
- **float** - Pixel size [m/px].

#### Error Handling
- **NA** - Imaging license not found.
```

--------------------------------

### Create and Parse Byte Objects

Source: https://geocompy.readthedocs.io/stable/api/data

Demonstrates initializing a Byte object and parsing it from a serialized hexadecimal string representation.

```python
>>> b = gc.data.Byte(17)
>>> print(b)
'11'
```

```python
>>> value = "'11'"
>>> b = gc.data.Byte.parse(value)
```

```python
>>> value = "'1A'" # value read from serial line
>>> b = gc.data.Byte.parse(value)
```

--------------------------------

### RPC 23603 CAM_OVC_ReadExterOrient

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Gets the exterior orientation parameters of the camera.

```APIDOC
## GET /CAM_OVC_ReadExterOrient

### Description
Gets the exterior orientation parameters of the camera.

### Method
GET

### Parameters
#### Query Parameters
- **calibrated** (bool) - Optional - Use calibrated data, default True.

### Response
#### Success Response (200)
- **Coordinate** - Camera offset coordinates.
- **Angle** - Yaw deviation.
- **Angle** - Pitch deviation.
- **Angle** - Roll deviation.

#### Error Handling
- **NA** - Imaging license not found.
```

--------------------------------

### RPC 23636 CAM_GetCameraPowerSwitch

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Gets the current power state of the camera.

```APIDOC
## GET /CAM_GetCameraPowerSwitch

### Description
Gets the current state of the camera.

### Method
GET

### Parameters
#### Query Parameters
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW.

### Response
#### Success Response (200)
- **bool** - Camera is powered and active.

#### Error Handling
- **NA** - Imaging license not found.
```

--------------------------------

### Initialize instrument connection with GSI Online

Source: https://geocompy.readthedocs.io/stable/introduction

Establishes a serial connection and initializes the GsiOnlineDNA instrument object.

```python
from geocompy import GsiOnlineDNA, open_serial


with open_serial("COM1", timeout=10) as com:
    level = GsiOnlineDNA(com)
```

--------------------------------

### GET /get_search_area

Source: https://geocompy.readthedocs.io/stable/api/geo/aut

Retrieves the current position and size of the PowerSearch window.

```APIDOC
## GET /get_search_area

### Description
Gets current position and size of the PowerSearch window.

### Method
GET

### Endpoint
/get_search_area

### Response
#### Success Response (200)
- **Horizontal center** (Angle) - Horizontal center of window.
- **Vertical center** (Angle) - Vertical center of window.
- **Width** (Angle) - Width of window.
- **Height** (Angle) - Height of window.
- **Enabled** (bool) - If window is enabled.
```

--------------------------------

### GET /get_preferred_powersource

Source: https://geocompy.readthedocs.io/stable/api/geo/csv

Retrieves the current preferred power source of the instrument.

```APIDOC
## GET /get_preferred_powersource

### Description
Gets the current preferred power source.

### Method
GET

### Endpoint
/get_preferred_powersource

### Response
#### Success Response (200)
- **PowerSource** (PowerSource) - Preferred power source.

#### Response Example
{
  "PowerSource": "INTERNAL"
}
```

--------------------------------

### switch_startup_message

Source: https://geocompy.readthedocs.io/stable/api/geo/csv

Enables or disables the startup message mode on the instrument.

```APIDOC
## POST /instruments/startup-message

### Description
Enables or disables the startup message mode on the instrument.

### Method
POST

### Endpoint
/instruments/startup-message

### Parameters
#### Request Body
- **enabled** (bool) - Required - Startup message mode is enabled.

### Request Example
{
  "enabled": true
}

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **message** (string) - A message describing the result of the operation.

#### Response Example
{
  "status": "success",
  "message": "Startup message mode enabled."
}
```

--------------------------------

### Continuous Autofocus Control

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Starts or stops the continuous autofocus feature.

```APIDOC
## POST /api/camera/switch_continuous_autofocus

### Description
Starts or stops the continuous autofocus.

### Method
POST

### Endpoint
/api/camera/switch_continuous_autofocus

### Parameters
#### Request Body
- **start** (bool) - Required - Start the continuous autofocus.

### Response
#### Success Response (200)
- **result** (None) - Indicates success.

#### Error Codes
- `NA`: Imaging license not found.
```

--------------------------------

### GET /get_zoom

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Retrieves the current zoom factor for a specified camera device.

```APIDOC
## GET /get_zoom

### Description
Sets the current zoom factor on a camera device (RPC 23609, CAM_GetZoomFactor).

### Method
GET

### Parameters
#### Query Parameters
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW

### Response
#### Success Response (200)
- **Zoom**: Current zoom level

#### Error Codes
- **NA**: Imaging license not found.
```

--------------------------------

### POST /fine_adjust

Source: https://geocompy.readthedocs.io/stable/api/geo/aut

Precisely targets a prism using a search window.

```APIDOC
## POST /fine_adjust

### Description
Precisely targets a prism. If the prism is not within the view of the ATR, a target search is executed in the specified window (RPC 9037, AUT_FineAdjust).

### Method
POST

### Endpoint
/fine_adjust

### Parameters
#### Query Parameters
- **width** (SupportsFloat) - Required - Width of target search window.
- **height** (SupportsFloat) - Required - Height of target search window.

### Response
#### Success Response (200)
- **result** (None) - Returns GeoComResponse.
```

--------------------------------

### Get User Lock State

Source: https://geocompy.readthedocs.io/stable/api/geo/aus

Retrieves the current state of the LOCK mode.

```APIDOC
## GET /aus/user/lock/state

### Description
Gets the current state of the LOCK mode.

### Method
GET

### Endpoint
`/aus/user/lock/state`

### Returns
#### Success Response (200)
* **bool** - True if ATR lock is enabled, False otherwise.

#### Response Example
```json
{
  "status": "success",
  "data": true
}
```

### Error Codes
* `NOT_IMPL`: ATR is not available.
```

--------------------------------

### RPC 23611 CAM_GetCamPos

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Gets the position of the overview camera relative to the station coordinates.

```APIDOC
## GET /CAM_GetCamPos

### Description
Gets the position of the overview camera, relative to the station coordinates.

### Method
GET

### Parameters
#### Query Parameters
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW.

### Response
#### Success Response (200)
- **Coordinate** - Relative coordinates of the camera.

#### Error Handling
- **NA** - Imaging license not found.
```

--------------------------------

### Create Serial Connection with Utility Function

Source: https://geocompy.readthedocs.io/stable/connections

Utilize the `open_serial` function for a more concise way to create and manage serial connections, similar to Python's built-in `open()` function. It supports context management.

```python
from geocompy.communication import open_serial


with open_serial("COM1", timeout=15) as com:
    com.send("some message")
```

--------------------------------

### RPC 23611 CAM_GetCamViewingDir

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Gets the view vector of the overview camera relative to its coordinates.

```APIDOC
## GET /CAM_GetCamViewingDir

### Description
Gets the view vector of the overview camera relative to its coordinates. The viewing vector is a 3D vector along the optical axis of the camera, with the given slope distance length.

### Method
GET

### Parameters
#### Query Parameters
- **dist** (float) - Required - View vector length.
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW.

### Response
#### Success Response (200)
- **Coordinate** - Viewing vector.

#### Error Handling
- **NA** - Imaging license not found.
```

--------------------------------

### POST /set_camera_properties

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Configures camera resolution, compression, and JPEG quality.

```APIDOC
## POST /set_camera_properties

### Description
Sets camera parameters (RPC 23633, CAM_SetCameraProperties).

### Method
POST

### Parameters
#### Request Body
- **resolution** (Resolution | str) - Required - Image resolution
- **compression** (Compression | str) - Required - Image compression
- **jpegquality** (JPEGQuality | str) - Required - JPEG image compression quality
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW

### Response
#### Error Codes
- **NA**: Imaging license not found.
```

--------------------------------

### GET /IMG_GetTccConfig

Source: https://geocompy.readthedocs.io/stable/api/geo/img

Retrieves the current telescopic camera configuration from the specified memory device.

```APIDOC
## GET IMG_GetTccConfig

### Description
Gets the current telescopic camera settings on the specified memory device.

### Method
GET

### Parameters
#### Query Parameters
- **at** (Device | str) - Optional - Memory device, by default CFCARD

### Response
#### Success Response (200)
- **int** - Current image number
- **int** - JPEG compression quality [0; 100]%
- **CameraFunctions** - Current camera function combination
- **str** - File name prefix
```

--------------------------------

### Create and Access Vector Components

Source: https://geocompy.readthedocs.io/stable/api/data

Demonstrates how to create a 3D Cartesian vector and access its components using attribute access or indexing. Vectors support standard arithmetic operations.

```python
>>> c = gc.data.Vector(1, 2, 3)
>>> print(c)
Vector(1.0, 2.0, 3.0)
>>> c.x
1.0
>>> c[1]
2.0
>>> x, y, z = c
>>> z
3.0
```

--------------------------------

### GET /CTL_GetUpCounter

Source: https://geocompy.readthedocs.io/stable/api/geo/ctl

Retrieves the number of times the instrument has been switched on or awakened from sleep mode.

```APIDOC
## GET CTL_GetUpCounter

### Description
Retrieves how many times the instrument has been switched on, or awakened from sleep mode. Note that the counters are reset to zero once the command is executed.

### Method
GET

### Endpoint
RPC 12003

### Response
#### Success Response (200)
- **int** (Switch on count) - The number of times the instrument has been switched on.
- **int** (Wake up count) - The number of times the instrument has been awakened from sleep mode.

#### Response Example
{
  "switch_on_count": 5,
  "wake_up_count": 2
}
```

--------------------------------

### Geocompy F Components

Source: https://geocompy.readthedocs.io/stable/genindex

Details on GeoCom attributes, classes, and methods starting with 'F'.

```APIDOC
## F

### Face Attributes
*   **F1** (Face attribute)
*   **F2** (Face attribute)

### Classes
*   **Face** (class in geocompy.geo.gcdata)
*   **File** (class in geocompy.geo.gcdata)
*   **Format** (class in geocompy.geo.gcdata)

### GeoCom Attributes & Properties
*   **FAHRENHEIT** (Units.Temperature attribute)
*   **FATAL** (GeoComCode attribute)
*   **FEET** (Units.Distance attribute)
*   **FIL_BAD_FORMAT** (GeoComCode attribute)
*   **FIL_BATTERY_LOW** (GeoComCode attribute)
*   **FIL_CANNOT_DELETE** (GeoComCode attribute)
*   **FIL_END_OF_FILE** (GeoComCode attribute)
*   **FIL_FAT_ERROR** (GeoComCode attribute)
*   **FIL_FATAL_ERROR** (GeoComCode attribute)
*   **FIL_FILE_ALREADY_OPEND_FOR_WR** (GeoComCode attribute)
*   **FIL_FILE_NOT_DELETED** (GeoComCode attribute)
*   **FIL_FILNAME_NOT_FOUND** (GeoComCode attribute)
*   **FIL_ILLEGAL_DRIVE** (GeoComCode attribute)
*   **FIL_ILLEGAL_FILE_OPEN_TYPE** (GeoComCode attribute)
*   **FIL_ILLEGAL_ORIGIN** (GeoComCode attribute)
*   **FIL_INVALID_FILE_DESCR** (GeoComCode attribute)
*   **FIL_INVALID_PATH** (GeoComCode attribute)
*   **FIL_MEDIUM_NEWLY_INSERTED** (GeoComCode attribute)
*   **FIL_MEDIUM_WRITE_PROTECTED** (GeoComCode attribute)
*   **FIL_MEMORY_FAILED** (GeoComCode attribute)
*   **FIL_NO_ERROR** (GeoComCode attribute)
*   **FIL_NO_MAKE_DIRECTORY** (GeoComCode attribute)
*   **FIL_NO_MORE_ROOM_ON_MEDIUM** (GeoComCode attribute)
*   **FIL_NO_STORAGE_MEDIUM_IN_DEVICE** (GeoComCode attribute)
*   **FIL_PATTERN_DOES_NOT_MATCH** (GeoComCode attribute)
*   **FIL_RENAME_DIR_FAILED** (GeoComCode attribute)
*   **FIL_RENAME_FILE_FAILED** (GeoComCode attribute)
*   **FIL_SEEK_FAILED** (GeoComCode attribute)
*   **FIL_START_SEARCH_NOT_CALLED** (GeoComCode attribute)
*   **FIL_UNSUPPORTED_MEDIUM** (GeoComCode attribute)
*   **FIL_WRITE_TO_MEDIUM_FAILED** (GeoComCode attribute)
*   **FREQ** (MeasurementType attribute)
*   **FREQUENCY** (Measurement attribute)
*   **ftr** (GeoCom attribute)
*   **FTR_FILEACCESS** (GeoComCode attribute)
*   **FTR_INVALIDINPUT** (GeoComCode attribute)
*   **FTR_MISSINGSETUP** (GeoComCode attribute)
*   **FTR_NOTENOUGHSPACE** (GeoComCode attribute)
*   **FTR_WRONGFILEBLOCKNUMBER** (GeoComCode attribute)

### Methods
*   **fine_adjust()** (GeoComAUT method)
*   **format_gsi_word()** (in module geocompy.gsi.gsiformat)

### Class Methods
*   **from_dms()** (Angle class method)
*   **from_polar()** (Coordinate class method)
```

--------------------------------

### Geocompy E Components

Source: https://geocompy.readthedocs.io/stable/genindex

Details on GeoCom attributes, classes, and methods starting with 'E'.

```APIDOC
## E

### GeoCom Attributes & Properties
*   **e** (Coordinate property)
*   **edm** (GeoCom attribute)
*   **EDM_ACTION_NO_MORE_VALID** (GeoComCode attribute)
*   **EDM_AMPL_RELATION_ERR** (GeoComCode attribute)
*   **EDM_BUSY** (GeoComCode attribute)
*   **EDM_CHKSUM_ERR** (GeoComCode attribute)
*   **EDM_COMERR** (GeoComCode attribute)
*   **EDM_DEV_NOT_INSTALLED** (GeoComCode attribute)
*   **EDM_DIL99** (GeoComCode attribute)
*   **EDM_DIST_TOO_SHORT** (GeoComCode attribute)
*   **EDM_DISTRANGE_ERR** (GeoComCode attribute)
*   **EDM_DIVISION_BY_ZERO** (GeoComCode attribute)
*   **EDM_ERR12** (GeoComCode attribute)
*   **EDM_ERROR_RECEIVED** (GeoComCode attribute)
*   **EDM_FLUKT_ERR** (GeoComCode attribute)
*   **EDM_FMOT_ERR** (GeoComCode attribute)
*   **EDM_INIT_OR_STOP_ERR** (GeoComCode attribute)
*   **EDM_INTERNAL_ERR** (GeoComCode attribute)
*   **EDM_INVALID_ANSWER** (GeoComCode attribute)
*   **EDM_MEAS_ABORTED** (GeoComCode attribute)
*   **EDM_MEAS_DIST_NOT_ALLOWED** (GeoComCode attribute)
*   **EDM_METER_FEET** (GeoComCode attribute)
*   **EDM_MISSING_EE_CONSTS** (GeoComCode attribute)
*   **EDM_MISSING_SRVPWD** (GeoComCode attribute)
*   **EDM_MULTRG_ERR** (GeoComCode attribute)
*   **EDM_NO_MEASACTIVITY** (GeoComCode attribute)
*   **EDM_NOISEHIGH_ERR** (GeoComCode attribute)
*   **EDM_NOPRECISE** (GeoComCode attribute)
*   **EDM_NOSIGNAL** (GeoComCode attribute)
*   **EDM_NOT_EXECUTED** (GeoComCode attribute)
*   **EDM_NOT_FOUND** (GeoComCode attribute)
*   **EDM_PPM_MM** (GeoComCode attribute)
*   **EDM_PWD_NOTSET** (GeoComCode attribute)
*   **EDM_RECEIVE_ERR** (GeoComCode attribute)
*   **EDM_SEND_ERR** (GeoComCode attribute)
*   **EDM_SIG_FORM_ERR** (GeoComCode attribute)
*   **EDM_SIGNTONOISE_ERR** (GeoComCode attribute)
*   **EDM_SLDR_ADDR_ERROR** (GeoComCode attribute)
*   **EDM_SLDR_CHK_SUM_ERROR** (GeoComCode attribute)
*   **EDM_SLDR_DATA_ERROR** (GeoComCode attribute)
*   **EDM_SLDR_INV_LOADFILE** (GeoComCode attribute)
*   **EDM_SLDR_TRANSFER_ILLEGAL** (GeoComCode attribute)
*   **EDM_SLDR_TRANSFER_PENDING** (GeoComCode attribute)
*   **EDM_SLDR_UNSUPPORTED** (GeoComCode attribute)
*   **EDM_SRL_NOT_AVAILABLE** (GeoComCode attribute)
*   **EDM_SYNTH_ERR** (GeoComCode attribute)
*   **EDM_TIMEOUT** (GeoComCode attribute)
*   **EDM_UNKNOW_ERR** (GeoComCode attribute)
*   **EGL** (Capabilities attribute)
*   **error** (GeoComResponse attribute)
*   **EVEN** (Communication.Parity attribute)

### Classes
*   **EDMMode** (class in geocompy.geo.gcdata)
*   **EDMModeV1** (class in geocompy.geo.gcdata)
*   **EDMModeV2** (class in geocompy.geo.gcdata)

### Methods
*   **exchange()** (Connection method)
    *   (SerialConnection method)
    *   (SocketConnection method)
*   **exchange_binary()** (Connection method)
    *   (SerialConnection method)
    *   (SocketConnection method)

### Attributes
*   **EXTERNAL** (PowerSource attribute)
```

--------------------------------

### Swizzle Vector Components

Source: https://geocompy.readthedocs.io/stable/api/data

Shows how to create a new vector by rearranging components of an existing vector using the swizzle method. Supports component selection and optional negation.

```python
>>> v = Vector(1.0, 2.0, 3.0)
>>> v.swizzle('y', 'x', 'z')
Vector(2.0, 1.0, 3.0)
>>> v.swizzle('x', 'y', '0', flip_x=True)
Vector(-1.0, 2.0, 0.0)
```

--------------------------------

### RPC 23619 CAM_GetCameraFoV

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Gets the field of view of the overview camera for a given zoom level.

```APIDOC
## GET /CAM_GetCameraFoV

### Description
Gets field of view of the overview camera for a given zoom level.

### Method
GET

### Parameters
#### Query Parameters
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW.
- **zoom** (Zoom | str) - Optional - Zoom level, by default X1.

### Response
#### Success Response (200)
- **Angle** - Horizontal field of view.
- **Angle** - Vertical field of view.

#### Error Handling
- **IVPARAM** - Invalid parameter.
- **NA** - Imaging license not found.
```

--------------------------------

### Open TCP/IP Connection in Python

Source: https://geocompy.readthedocs.io/stable/connections

Connect to an instrument over WLAN using TCP/IP sockets.

```python
from geocompy import open_socket


with open_socket("192.168.0.1", 1212, "tcp") as soc:
    soc.send("some message")
```

--------------------------------

### Configure Bluetooth Service for SPP

Source: https://geocompy.readthedocs.io/stable/connections

Modify the bluez service configuration to enable compatibility mode and register the SPP service.

```bash
sudo nano /etc/systemd/system/dbus-org.bluez.service
```

```bash
ExecStart=/usr/lib/bluetooth/bluetoothd -C
ExecStartPost=/usr/bin/sdptool add SP
```

--------------------------------

### Turn off beeping and get a staff reading

Source: https://geocompy.readthedocs.io/stable/introduction

Executes settings and measurement commands on an initialized instrument object.

```python
level.settings.set_beep(level.settings.BEEPINTENSITY.OFF)
resp = level.measurements.get_reading()
print(resp)  # GsiOnlineResponse(Reading) success, value: ...
```

--------------------------------

### Open Serial Connection and Initialize GSI Online DNA

Source: https://geocompy.readthedocs.io/stable/api/gsi/dna

Opens a serial connection and initializes the GSIOnlineDNA handler. Ensure the correct serial port is specified.

```python
from geocompy.communication import open_serial
from geocompy.gsi.dna import GsiOnlineDNA

with open_serial("COM1") as line:
    dna = GsiOnlineDNA(line)
    dna.beep('SHORT')

```

--------------------------------

### Wait for Camera Ready

Source: https://geocompy.readthedocs.io/stable/api/geo/cam

Waits for a specified camera device to become ready for use.

```APIDOC
## POST /api/camera/wait_for_camera_ready

### Description
Waits for the camera device to become ready for use.

### Method
POST

### Endpoint
/api/camera/wait_for_camera_ready

### Parameters
#### Request Body
- **wait** (int) - Optional - Time to wait for the camera to come online [s], defaults to 30.
- **camera** (Camera | str) - Optional - Camera device, by default OVERVIEW

### Response
#### Success Response (200)
- **result** (None) - Indicates success.

#### Error Codes
- `NA`: Imaging license not found.
- `TIMEOUT`: Camera did not become usable within the specified time.
```

--------------------------------

### Import GeoComPy

Source: https://geocompy.readthedocs.io/stable/api

Standard import convention for accessing GeoComPy functionality.

```python
>>> import geocompy as gc
```

--------------------------------

### Import GeoComPy

Source: https://geocompy.readthedocs.io/stable/overview

Import the GeoCom class from the geocompy package.

```python
from geocompy import GeoCom
```
Tokens:
Raw