Skip to content

Commit 5cafbac

Browse files
committed
[datatransfer] added data upload docs
1 parent a599642 commit 5cafbac

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

docs/commands/data/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ transfer commands can be used for simple download and upload operations.
1616
:maxdepth: 1
1717

1818
download
19+
upload

docs/commands/data/upload.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Uploading
2+
=========
3+
4+
Data can be uploaded to instruments through a serial connection, by simply
5+
sending the file data line by line. Most instruments, that support data
6+
uploads through serial, accept coordinate data in CSV format. Some instruments
7+
also support their own specialized database record formats.
8+
9+
.. caution::
10+
:class: warning
11+
12+
Currently only ASCII encodable files can be uploaded. Older instruments
13+
do not accept special code pages like windows-1252 and other extended
14+
ASCII sets (especially not modern unicode), so accented characters have
15+
to be avoided.
16+
17+
Usage
18+
-----
19+
20+
.. click:: instrumentman.datatransfer:cli_upload
21+
:prog: iman upload data

0 commit comments

Comments
 (0)