Merge ea78cbb into 613ccb9

Author: OleksandrChaika

Diff for: README.md

@@ -67,12 +67,17 @@ MQTT communication is done via 3 MQTT topics:
 ## selfupdate/currentstate
 | Topic| Direction | Description |
 |------|  -------- | ----------- |
-| selfupdate/currentstate | OUT | This message is being sent once, on SUA start. It contains information about currently installed OS version.
+| selfupdate/currentstate | OUT | This message is being sent either once on SUA start or as an answer to response received by selfupdate/currentstate/get. It contains information about currently installed OS version. |
+
+## selfupdate/currentstate/get
+| Topic| Direction | Description |
+|------|  -------- | ----------- |
+| selfupdate/currentstate/get | IN | This message can be received at any point of time. Indicates that SUA should send back version of installed OS as current state. |
 
 ## selfupdate/desiredstatefeedback
 | Topic| Direction | Description |
 |------|  -------- | ----------- |
-| selfupdate/desiredstatefeedback | OUT | This message is being sent by SUA to share current progress of triggered update process. This is the *OUT* counterpart of *selfupdate/desiredstate* input message. 
+| selfupdate/desiredstatefeedback | OUT | This message is being sent by SUA to share current progress of triggered update process. This is the *OUT* counterpart of *selfupdate/desiredstate* input message. |
 
 SUA supports 2 protocols depending on configuration: [link](docs/k8s.md) for Kubernetes-based Custom Objects or [link](docs/bfb.md) for Update Agent API.Default protocol is bfb.
 

Diff for: docs/bfb.md

@@ -1,34 +1,41 @@
 # Detailed description of bfb (binding-for-backend) communication protocol
 
 ## Current state message
-
-This is retained message sent by SUA on start-up.
-MQTT Topic: selfupdate/desiredstate
+This is retained message sent by SUA on start-up or as an answer to response for current state (then it is supplied with activityId field).
+MQTT Topic: selfupdate/currentstate
 ```
 {
-    "activityId": "",
+    "activityId": "random-uuid",
     "timestamp": 123456789,
     "payload": {
-        "domains": [
+        "softwareNodes": [
             {
-                "id": "self-update",
-                "components": [
-                    {
-                        "id": "os-image",
-                        "version": "1.0"
-                    }
-                ]
+                "id": "os-image",
+                "version": "1.0",
+                "name": "System Image",
+                "type": "IMAGE",
+                "parameters": []
             }
-        ]
+        ],
+        "hardwareNodes": [],
+        "associations": []
     }
 }
 ```
 
-## Desired state
+## Current state request
+This message is a trigger to send back version of installed OS. Can be received at any point of time.
+MQTT Topic: selfupdate/currentstate/get
+```
+{
+    "activityId": "random-uuid",
+    "timestamp": 123456789
+}
+```
 
+## Desired state
 This message indicates that SUA needs to perform an update operation.
 MQTT Topic: selfupdate/desiredstate
-
 ```
 {
     "activityId": "random-uuid",
@@ -56,10 +63,8 @@ MQTT Topic: selfupdate/desiredstate
 ```
 
 ## Desired state feedback
-
 This message contains information about SUA state - what agent is doing - installing, downloading or idle.
 MQTT Topic: selfupdate/desiredstatefeedback
-
 ```
 {
     "activityId": "random-uuid",
@@ -83,7 +88,6 @@ MQTT Topic: selfupdate/desiredstatefeedback
 ```
 
 ## Description of statuses
-
 Following combination of payload_status and action_status are possible:
 | payload_status | action_status | Description |
 |----------------|---------------|-------------|
@@ -96,7 +100,6 @@ Following combination of payload_status and action_status are possible:
 | COMPLETED | UPDATE_SUCCESS | Self-update succeeded |
 
 ## Description of other fields
-
 | name | description |
 |------|-------------|
 | activityId | Random UUID as string (needs to be taken from desiredstate message and passed back in all feedback messages) |

Diff for: docs/testing/README.md

@@ -67,6 +67,11 @@ mosquitto_sub -t "selfupdate/currentstate"
 mosquitto_sub -t "selfupdate/desiredstatefeedback"
 ```
 
+## Trigger current state request
+```
+mosquitto_pub -t "selfupdate/currentstate/get" -f docs/testing/mqtt/current-state-get.json
+```
+
 # Container
 
 For testing the container variant, it shall be ensured that all the components are connected to the same network and using proper ports mapping, so that they would be able to communicate with each other.