Skip to content

Commit

Permalink
Update alarm.md
Browse files Browse the repository at this point in the history
  • Loading branch information
emiltin authored Oct 23, 2024
1 parent dadc737 commit 2b24c6f
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions docs/pages/alarm.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,14 @@ alarm/tlc/1/45fe # A0001 serious hardware error (for main component) on node 4
alarm/tlc/301/45fe/dl.7 # A0301 serious deteector error for component dl.7 on node 45fe
```
## Publishing
Devices publish to:
`alarm/<id>/<component>/<module>/<alarm>`
id: unique id of the device
component: component delivering the data
module: the module containing the alarm type
alarm: the type of alarm
For example, a traffic light `bb35` that has a hardware error might publish to:
`alarm/bb35/tlc/hardware`
For example, a traffic light `bb35` that has a hardware error in detector logic 4 might publish to:
`alarm/tlc/1/bb35/dl/4`
## Subscribing
Supervisors can subscribe to all alarm from all devices using:
`alarm/#`
Or if you only want alarms from a certain module:
`alarm/+/sensor/#`
`alarm/sensor/#`

0 comments on commit 2b24c6f

Please sign in to comment.