Alarm Operations
This section describes the main operations that are performed using the Alarms cluster - raising an alarm and clearing/resetting an alarm.
Raising an Alarm
An alarm is raised when an alarm condition occurs on a cluster on the same endpoint as the Alarms cluster server - for example, when a cluster attribute falls below a lower threshold. The Alarms cluster server should then send an Alarm notification to any remote Alarms cluster clients that might be interested in the alarm. The server application can send this notification and add an entry to the Alarms table by calling the eCLD_AlarmsSignalAlarm() function. On arriving at a destination device, the notification causes an E_CLD_ALARMS_CMD_ALARM event to be generated to notify the client application.
Parent topic:Alarm Operations
Resetting Alarms (from Client)
A client application can remotely request one alarm or all alarms to be reset:
The function eCLD_AlarmsCommandResetAlarmCommandSend() can be used to request an individual alarm to be reset. A Reset Alarm command is sent to the cluster server. On arriving at the destination device, the command causes an E_CLD_ALARMS_CMD_RESET_ALARM event to be generated.
The function eCLD_AlarmsCommandResetAllAlarmsCommandSend() can be used to request all alarms to be reset. A Reset All Alarms command is sent to the cluster server. On arriving at the destination device, the command causes an E_CLD_ALARMS_CMD_RESET_ALL_ALARMS event to be generated.
On the generation of the above events on the cluster server, the server application can remove the relevant entry or entries from the local Alarms table as described in Section 17.4.2.
Note: The client application can also request that all the entries in an Alarms table are removed by calling eCLD_AlarmsCommandResetAlarmLogCommandSend(). In this case, the entries are automatically deleted by the ZCL on the server.
Parent topic:Alarm Operations
Parent topic:Alarms Cluster