[settings] added docs

Author: MrClock8163

docs/commands/settings/download.rst

@@ -0,0 +1,36 @@
+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.
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Saving only applicable GeoCom settings
+
+    iman download settings COM1 geocom tps_settings.json
+
+.. code-block:: shell
+    :caption: Saving to YAML format in a file without extension
+
+    iman download settings -f yaml COM1 geocom tps_settings
+
+.. code-block:: shell
+    :caption: Saving all settings including defaults of not applicable ones
+
+    iman download settings --defaults COM1 geocom tps_settings.json
+
+Usage
+-----
+
+.. click:: instrumentman.settings:cli_download
+    :prog: iman download settings

docs/commands/settings/index.rst

@@ -0,0 +1,15 @@
+:icon: material/cog
+
+Settings
+========
+
+For different measurements, different instrument settings might be required.
+The settings commands can be used to save the settings to the config file,
+and later load them back as necessary.
+
+.. toctree::
+    :maxdepth: 1
+
+    download
+    validate
+    upload

docs/commands/settings/upload.rst

@@ -0,0 +1,61 @@
+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.
+
+.. note::
+ 
+    Configs can be validated before upload with the validation command.
+
+Examples
+--------
+
+.. code-block:: json
+    :caption: Total station ATR and target setting
+
+    {
+        "protocol": "geocom",
+        "settings": [
+            {
+                "subsystem": "aut",
+                "options": {
+                    "atr": true
+                }
+            },
+            {
+                "subsystem": "bap",
+                "options": {
+                    "target_type": "REFLECTOR",
+                    "prizm_type": "MINI"
+                }
+            }
+        ]
+    }
+
+
+.. code-block:: json
+    :caption: DNA normal staff direction with meter units
+
+    {
+        "protocol": "gsidna",
+        "settings": [
+            {
+                "subsystem": "settings",
+                "options": {
+                    "distance_unit": "METER",
+                    "staff_mode": false
+                }
+            }
+        ]
+    }
+
+Usage
+-----
+
+.. click:: instrumentman.settings:cli_upload
+    :prog: iman upload settings

docs/commands/settings/validate.rst

@@ -0,0 +1,13 @@
+Validation
+==========
+
+An instrument settings file must have a valid structure, or the upload will be
+refused. The schema file is available in the
+`GitHub repository <https://github.com/MrClock8163/Instrumentman/blob/main/src/instrumentman/settings/schema_settings.json>`_.
+
+Usage
+-----
+
+.. click:: instrumentman.settings:cli_validate
+    :prog: iman validate settings
+

docs/index.rst

@@ -44,6 +44,7 @@ Content
     commands/protocoltest/index
     commands/files/index
     commands/jobs/index
+    commands/settings/index
 
 Indices
 

docs/latexindex.rst

@@ -29,3 +29,4 @@ Applications
     commands/protocoltest/index
     commands/files/index
     commands/jobs/index
+    commands/settings/index

src/instrumentman/settings/save.py

@@ -183,7 +183,7 @@ def download_settings_gsidna(
         "delay": 0,
         "autooff": "SLEEP",
         "display_heater": False,
-        "curvature_correction": True,
+        "curvature_correction": False,
         "staff_mode": False,
         "format": "GSI8",
         "code_recording": "BEFORE"