diff mbox series

[RFC,v1,4/4] doc: add description for hawkBit server status

Message ID 20210924092411.10768-5-roland.gaudig-oss@weidmueller.com
State Changes Requested
Headers show
Series suricatta: ipc: add request to get hawkbit server status | expand

Commit Message

Roland Gaudig Sept. 24, 2021, 9:24 a.m. UTC 
From: Roland Gaudig <roland.gaudig@weidmueller.com>

Signed-off-by: Roland Gaudig <roland.gaudig@weidmueller.com>
---

 doc/source/swupdate-ipc.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
diff mbox series

Patch

diff --git a/doc/source/swupdate-ipc.rst b/doc/source/swupdate-ipc.rst
index 3c45ab3..2945b82 100644
--- a/doc/source/swupdate-ipc.rst
+++ b/doc/source/swupdate-ipc.rst
@@ -242,6 +242,29 @@  should be stored during the update process.
           "details" : [ ]
         }
 
+Get hawkBit Server Status
+.........................
+
+To provide the hawkBit server status to other processes, it can be requested by
+sending an empty message with message type CMD_GET_STATUS.
+
+The response is a JSON object containing the hawkBit server status <status>.
+<status> is a number representing the value of the channel_op_res_t enum from
+channel_op_res.h. As the hawkBit server is polled, its status can only be
+updated when it has been polled. Therefore the response also contains the
+time <time>, when the hawBit server has been polled the last time. It is
+provided in Unix style as seconds since Epoch (1970-01-01 00:00:00).
+
+::
+
+        { "server" : {
+	                "status" : <status>
+			"time" : <time>
+                     }
+        }
+
+An example applicatino can be found under tools/swupdate-gethawkbitstatus.c
+
 API to the integrated Webserver
 ===============================