frappy/doc/source/protocol/commands.rst
Markus Zolliker 6c0f54d988 doc update (commands and datatypes)
Change-Id: Ia89a179043491be71d0b2d1fac7a6e41b596c91d
2017-09-13 16:21:08 +02:00

23 lines
576 B
ReStructuredText

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)