Uploading¶

Once a config file is created (either manually, or saved from the instrument), the parameters can be uploaded back to the instrument. The config file must have a valid structure, or the upload will be refused.

The config file can either be in JSON, YAML or TOML format, but regardless, the structure must follow the required schema.

Requirements¶

• GeoCOM capable instrument

or

• GSI Online DNA capable instrument

Examples¶

{
    "protocol": "geocom",
    "settings": [
        {
            "subsystem": "aut",
            "options": {
                "atr": true
            }
        },
        {
            "subsystem": "bap",
            "options": {
                "target_type": "REFLECTOR",
                "prizm_type": "MINI"
            }
        }
    ]
}

{
    "protocol": "gsidna",
    "settings": [
        {
            "subsystem": "settings",
            "options": {
                "distance_unit": "METER",
                "staff_mode": false
            }
        }
    ]
}

Usage¶

iman upload settings¶

Load instrument settings from file.

The options are read from the settings config file, and the corresponding instrument commands are executed with the supplied values.

This command requires a GeoCOM capable instrument.

iman upload settings [OPTIONS] PORT SETTINGS

Options

-b, --baud <baud>¶

Serial speed

Options:¶

1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 56000 | 57600 | 115200 | 230400 | 921600

-t, --timeout <timeout>¶

Serial timeout

-a, --attempts <attempts>¶

Number of connection attempts

--sync-after-timeout¶

Attempt to synchronize message que after a timeout

-f, --format <format>¶

Settings file format

Options:¶

auto | json | yaml | toml

Arguments

PORT¶

Required argument

Serial port that the instrument is connected to (must be a valid identifier like COM1 or /dev/usbtty0)

SETTINGS¶

Required argument

File containing instrument settings