doc update (commands and datatypes)

Change-Id: Ia89a179043491be71d0b2d1fac7a6e41b596c91d
This commit is contained in:
zolliker 2017-09-13 14:43:37 +02:00 committed by Alexander Lenz
parent e6fd421ec7
commit 6c0f54d988
3 changed files with 26 additions and 0 deletions

3
.gitignore vendored
View File

@ -11,3 +11,6 @@ build
# Sphinx
doc/_build
# Mac
.DS_Store

View 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)

View File

@ -13,6 +13,7 @@ Protocol documentation
heartbeat
jsonstruct
datatypes
commands
todo
notes
history