doc update (commands and datatypes)
Change-Id: Ia89a179043491be71d0b2d1fac7a6e41b596c91d
This commit is contained in:
parent
e6fd421ec7
commit
6c0f54d988
3
.gitignore
vendored
3
.gitignore
vendored
@ -11,3 +11,6 @@ build
|
|||||||
|
|
||||||
# Sphinx
|
# Sphinx
|
||||||
doc/_build
|
doc/_build
|
||||||
|
|
||||||
|
# Mac
|
||||||
|
.DS_Store
|
||||||
|
22
doc/source/protocol/commands.rst
Normal file
22
doc/source/protocol/commands.rst
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
Commands
|
||||||
|
========
|
||||||
|
|
||||||
|
The "done" message should be returned quickly, the time scale should
|
||||||
|
be in the order of the time needed for communications. Actions which have
|
||||||
|
to wait for physical changes, can be triggered with a command.
|
||||||
|
The information about the success of such an action has to be transferred
|
||||||
|
via parameters, namely the status parameter.
|
||||||
|
|
||||||
|
A command has at least the following properties:
|
||||||
|
|
||||||
|
:description:
|
||||||
|
tell what this command does
|
||||||
|
|
||||||
|
:arguments:
|
||||||
|
a list of datatypes for the command arguments (may be empty)
|
||||||
|
|
||||||
|
:resulttype:
|
||||||
|
the type of the result (may be null)
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -13,6 +13,7 @@ Protocol documentation
|
|||||||
heartbeat
|
heartbeat
|
||||||
jsonstruct
|
jsonstruct
|
||||||
datatypes
|
datatypes
|
||||||
|
commands
|
||||||
todo
|
todo
|
||||||
notes
|
notes
|
||||||
history
|
history
|
||||||
|
Loading…
x
Reference in New Issue
Block a user