[datatransfer] added docs

Author: MrClock8163

docs/commands/data/download.rst

@@ -0,0 +1,39 @@
+Downloading
+===========
+
+Data downloading works by simply listening on the serial line, and saving
+whatever the instrument sends. Some instruments have their own data formats
+(maybe even a complete ASCII representation of their internal database), others
+might use more common interchange formats.
+
+Some formats have an end-of-file (EOF) marker (e.g. the last line of the
+Trimble M5 format is simply ``END``), this can be specified as an option, to
+automatically finish the transfer, when this marker sequence is received.
+Other formats (like the Leica GSI) do not have such a marker. In these cases
+the transfer has to be manually closed (with keyboard interrupt), once all
+data was received.
+
+To help detecting when the transfer finished, the output is always printed
+to the standard output, even if an output file is specified.
+
+.. caution::
+    :class: warning
+
+    The output in the terminal might not be a 100% accurate representation of
+    the received data. The data might by partially or completely binary, which
+    cannot be accurately represented with ASCII characters in the terminal
+    (non-ASCII bytes are replaced with ``?`` symbols in the terminal output).
+
+Examples
+--------
+
+.. code-block:: shell
+    :caption: Downloading Trimble M5 format
+
+    iman download data --eof END -b 38400 COM4 data.m5
+
+Usage
+-----
+
+.. click:: instrumentman.datatransfer:cli_download
+    :prog: iman download data

docs/commands/data/index.rst

@@ -0,0 +1,18 @@
+:icon: material/database-outline
+
+Data
+====
+
+Older instruments might not have a USB or even CF or SD card slot. In these
+cases, data can only be transferred through a serial connection. The data
+transfer commands can be used for simple download and upload operations.
+
+.. tip::
+
+    Serial data transfer does not require any command protocol, only that the
+    instrument is capable of sending date through a serial line.
+
+.. toctree::
+    :maxdepth: 1
+
+    download

docs/index.rst

@@ -43,6 +43,7 @@ Content
     commands/inclination/index
     commands/protocoltest/index
     commands/files/index
+    commands/data/index
     commands/jobs/index
 
 Indices

docs/latexindex.rst

@@ -28,4 +28,5 @@ Applications
     commands/inclination/index
     commands/protocoltest/index
     commands/files/index
+    commands/data/index
     commands/jobs/index