diff options
| author | Albin Suresh <albin.suresh@softwareag.com> | 2022-08-18 16:49:16 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-18 16:49:16 +0530 |
| commit | ad2349b43cf01ccfae3652805c20fdc4e8dc907a (patch) | |
| tree | f586fccefe79224151a8759e5f12f74079c36c08 | |
| parent | 93b9bd24fe2b8b52f98ed3391dc4ec7e9aeb61fa (diff) | |
| parent | 5052fc4cd2ea41c13144d2223cad6bbdc4d06ae8 (diff) | |
Merge pull request #1205 from albinsuresh/feature/1204/alarm-support-child-device
Issue #1204 Document alarms API for child devices
| -rw-r--r-- | docs/src/tutorials/raise-alarm.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/src/tutorials/raise-alarm.md b/docs/src/tutorials/raise-alarm.md index 026edb33..742397aa 100644 --- a/docs/src/tutorials/raise-alarm.md +++ b/docs/src/tutorials/raise-alarm.md @@ -72,6 +72,12 @@ An already raised alarm can be cleared by sending an empty message with retained If alarms of different severities exist for a given alarm type, they must all be cleared separately as they're all treated as independent alarms. +### Raising alarms from child devices + +Alarms for child devices can be raised by publishing the alarm payload to `tedge/alarms/<severity>/<alarm-type>/<child-device-id>` topic, +where the `child-device-id` is the unique device id of the child device. +The alarm payload structure is the same, as described in the previous section. + ## Cloud data mapping If the device is connected to some supported IoT cloud platform, any alarms raised locally on thin-edge.io will be forwarded to the connected cloud platform as well. @@ -92,6 +98,8 @@ For example the `temperature_high` alarm with `critical` severity described in t ... and is published to `c8y/s/us` topic which will get forwarded to the connected Cumulocity cloud instance. +If the alarm is raised from a child device, the payload is published to `c8y/s/us/<child-device-id>` topic instead. + Find more information about SmartREST representations for alarms in Cumulocity [here](https://cumulocity.com/guides/10.11.0/reference/smartrest-two/#alarm-templates) Find more information about alarms data model in Cumulocity [here](https://cumulocity.com/guides/concepts/domain-model/#events) |