From 6c0f54d9884cf353c05ca09ff50c6a36d967667f Mon Sep 17 00:00:00 2001
From: Markus Zolliker <markus.zolliker@psi.ch>
Date: Wed, 13 Sep 2017 14:43:37 +0200
Subject: [PATCH] doc update (commands and datatypes)

Change-Id: Ia89a179043491be71d0b2d1fac7a6e41b596c91d
---
 .gitignore                       |  3 +++
 doc/source/protocol/commands.rst | 22 ++++++++++++++++++++++
 doc/source/protocol/index.rst    |  1 +
 3 files changed, 26 insertions(+)
 create mode 100644 doc/source/protocol/commands.rst

diff --git a/.gitignore b/.gitignore
index aed62ea..7394a38 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,3 +11,6 @@ build
 
 # Sphinx
 doc/_build
+
+# Mac
+.DS_Store
diff --git a/doc/source/protocol/commands.rst b/doc/source/protocol/commands.rst
new file mode 100644
index 0000000..434bf1e
--- /dev/null
+++ b/doc/source/protocol/commands.rst
@@ -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)
+  
+
+  
diff --git a/doc/source/protocol/index.rst b/doc/source/protocol/index.rst
index 00b79e2..b549281 100644
--- a/doc/source/protocol/index.rst
+++ b/doc/source/protocol/index.rst
@@ -13,6 +13,7 @@ Protocol documentation
    heartbeat
    jsonstruct
    datatypes
+   commands
    todo
    notes
    history