Skip to content

Commit 421c1e0

Browse files
committed
[docs] added missing requirement notes
1 parent 19a222c commit 421c1e0

File tree

17 files changed

+81
-19
lines changed

17 files changed

+81
-19
lines changed

docs/commands/data/download.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ to the standard output, even if an output file is specified.
2727
cannot be accurately represented with ASCII characters in the terminal
2828
(non-ASCII bytes are replaced with ``?`` symbols in the terminal output).
2929

30+
Requirements
31+
------------
32+
33+
- Instrument capable of serial ASCII data transfer
34+
3035
Examples
3136
--------
3237

docs/commands/data/upload.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ sending the file data line by line. Most instruments, that support data
66
uploads through serial, accept coordinate data in CSV format. Some instruments
77
also support their own specialized database record formats.
88

9+
Requirements
10+
------------
11+
12+
- Instrument capable of serial ASCII data transfer
13+
914
.. caution::
1015
:class: warning
1116

docs/commands/files/download.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ by either a file name and type, or a full file path.
1111
File downloads over serial (especially Bluetooth) are rather slow, and
1212
greatly affected by the communication speed settings.
1313

14+
Requirements
15+
------------
16+
17+
- GeoCom capable instrument
18+
1419
Process
1520
-------
1621

@@ -25,11 +30,6 @@ as this results in the fastest transfer. If the connection is not completely
2530
reliable, decreasing the chunk size might reduce the size of data, that needs
2631
to be resent due to timed out exchanges.
2732

28-
Requirements
29-
------------
30-
31-
- GeoCom capable instrument
32-
3333
Examples
3434
--------
3535

docs/commands/inclination/calc.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ can be calculated from the results. The results give the coordinate system
66
axis-aligned inclination components and standard deviations, as well as the
77
resulting inclination and its direction.
88

9+
Requirements
10+
------------
11+
12+
- Inclination measurement files from previous measurements
13+
914
Methodology
1015
-----------
1116

docs/commands/inclination/measure.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ these measurements is usually in the domain of arcseconds. If the inclination
77
has to be known with better reliability, multiple measurements have to be
88
taken, preferably in different horizontal positions of the instrument.
99

10+
Requirements
11+
------------
12+
13+
- GeoCom capable robotic total station
14+
1015
Results
1116
-------
1217

@@ -17,11 +22,6 @@ instrument was oriented to an existing coordinate system at the time, then the
1722
horizontal angles are whole circle bearings in that system, otherwise they
1823
are relative to the arbitrary orientation.
1924

20-
Requirements
21-
------------
22-
23-
- GeoCom capable robotic total station
24-
2525
Examples
2626
--------
2727

docs/commands/inclination/merge.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@ files. If multiple measurements are from the same setup and need to be
66
processed together, the files need to be merged. The merging command provides
77
a convenience tool for this purpose.
88

9+
Requirements
10+
------------
11+
12+
- Inclination measurement files from previous measurements
13+
914
.. note::
1015

1116
The command does not do any semantic validation of the data in the
1217
specified files. It simply concatenates those rows from all files, that
1318
follow the required format.
1419

15-
Requirements
16-
------------
17-
18-
- inclination measurement files from previous measurements
19-
2020
Usage
2121
-----
2222

docs/commands/morse.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ relays a Morse encoded ASCII message through the speakers of a total station.
88
The signals are played with the man-machine interface beep signals of the
99
instrument.
1010

11+
Requirements
12+
------------
13+
14+
- GeoCom capable instrument
15+
1116
Examples
1217
--------
1318

docs/commands/protocoltest/geocom.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ see what part of the protocol might be usable on the instrument.
1212
command used for testing, but does not actually respond to the other
1313
commands of the subsystem with valid data.
1414

15+
Requirements
16+
------------
17+
18+
- GeoCom capable instrument
19+
1520
Usage
1621
-----
1722

docs/commands/protocoltest/gsidna.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ and a ``SET`` command are executed first to check if read-writes to the
77
instrument settings are available. Then a ``GET`` and a ``PUT`` command is
88
run to test if the GSI based measurement/database commands are responsive.
99

10+
Requirements
11+
------------
12+
13+
- GSI Online DNA capable instrument
14+
1015
Usage
1116
-----
1217

docs/commands/sets/calc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ to a simple CSV file.
99
Requirements
1010
------------
1111

12-
- session result file from previous set measurement
12+
- Session result file from previous set measurement
1313

1414
Examples
1515
--------

0 commit comments

Comments
 (0)