Skip to content

Commit a3f1434

Browse files
Added documentation for current state request
1 parent 613ccb9 commit a3f1434

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,11 @@ MQTT communication is done via 3 MQTT topics:
6969
|------| -------- | ----------- |
7070
| selfupdate/currentstate | OUT | This message is being sent once, on SUA start. It contains information about currently installed OS version.
7171

72+
## selfupdate/currentstate/get
73+
| Topic| Direction | Description |
74+
|------| -------- | ----------- |
75+
| 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.
76+
7277
## selfupdate/desiredstatefeedback
7378
| Topic| Direction | Description |
7479
|------| -------- | ----------- |

docs/bfb.md

+9
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ MQTT Topic: selfupdate/desiredstate
2424
}
2525
```
2626

27+
## Current state request
28+
This message is a trigger to send back version of installed OS. Can be received at any point of time.
29+
```
30+
{
31+
"activityId": "",
32+
"timestamp": 123456789
33+
}
34+
```
35+
2736
## Desired state
2837

2938
This message indicates that SUA needs to perform an update operation.

docs/testing/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,11 @@ mosquitto_sub -t "selfupdate/currentstate"
6767
mosquitto_sub -t "selfupdate/desiredstatefeedback"
6868
```
6969

70+
## Trigger current state request
71+
```
72+
mosquitto_pub -t "selfupdate/currentstate/get" -f docs/testing/mqtt/current-state-get.json
73+
```
74+
7075
# Container
7176

7277
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.

0 commit comments

Comments
 (0)