Downloading¶
The settings are saved by iterating over a set collection of parameter names. Any particular instrument might not respond to the query of any of the parameters (e.g. a total station will not respond to queries regarding the digital level settings). These settings are marked empty, and later cleaned up before the config file is saved to disk.
It is possible to save the default values for the parameters, that the instrument did not respond to. In this case, the config file might need to be manually cleaned of the irrelevant or unwanted settings.
Requirements¶
GeoCOM capable instrument
or
GSI Online DNA capable instrument
Examples¶
iman download settings COM1 geocom tps_settings.json
iman download settings -f yaml COM1 geocom tps_settings
iman download settings --defaults COM1 geocom tps_settings.json
Usage¶
iman download settings¶
Save instrument settings to file.
Runs a set of predefined settings query commands of the given protocol. Settings that cannot be queried (i.e. not applicable to the specific instrument, or cannot be queried only set) are not saved, unless defaults are enabled. If defaults are enabled, the default values are saved for missing commands.
This command requires a GeoCOM capable instrument.
iman download settings [OPTIONS] PORT {geocom|gsidna} FILE
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
- --defaults¶
Add defaults for settings that could not be saved (e.g. not applicable to the current instrument)
Arguments
- PORT¶
Required argument
Serial port that the instrument is connected to (must be a valid identifier like COM1 or /dev/usbtty0)
- PROTOCOL¶
Required argument
Communication protocol
- FILE¶
Required argument
File to save settings to