(0x12) HA Clusters
The HA clusters command set encompasses the following ZCL clusters for common HA applications:
On/Off
Level Control
Power Configuration
Lock/Unlock Door (under development)
The mandatory commands associated with a given HA cluster are only made available if that cluster is first appended to the application endpoint configuration. For example, the On/Off State Update command will only become available to the Host after it configures an application endpoint with the On/Off server cluster.
( PH:0x012, SH:0x00 ) - On/Off State Update Command
Overview
The On/Off State Update command is sent by the Module to the Host on reception of a network command that modifies the On/Off attribute value on the given endpoint (i.e. that which supports the On/Off server cluster). The command contains the current On/Off state and indicates if it was updated by a local or remote source.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | Endpoint ID of the application On/Off server cluster. |
1 | New On/Off State | 0x00 = Off |
2 | Local/Remote Source | It should be noted that this byte has been retained for backwards compatibility with the RapidHA application stream. Regardless of the source of change to the On/Off State attribute (Host vs. Network), this byte will always be reported as 0x00 (Local Source). 0x00 = Local Source |
Effect On Receipt
The Host shall modify its hardware output appropriately based on the new On/Off state. For example, if the given device is a light switch and the command indicates a new state of “On” the switch should be turned on.
Allowed Context
Network Up.
Sent By Host/Module
Module.
( PH:0x012, SH:0x23 ) - Level Stop Command
Overview
The Level Stop command is sent by the Module to the Host on reception of a Stop command from the network, targeted to an endpoint on which the application supports the Level Control server cluster.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | Endpoint ID of the application Level Control server cluster. |
Effect On Receipt
The Host shall stop all Level Control movement on the specified hardware endpoint.
Allowed Context
Network Up.
Sent By Host/Module
Module.
( PH:0x012, SH:0x24 ) - Check Battery Attribute Command
Overview
The Check Battery Attribute command is sent from the Host to the Module which triggers the Module to check the battery voltage. It is recommended that this command be called after updating the battery voltage attribute.
Payload
The command has no payload.
Effect on Receipt
Module responds with a Status Response. If the battery voltage is lower than the threshold voltage, an alarm will be sent out through the OTA client.
Status Response to Check Battery Attribute Command
Error Status | Description |
|---|---|
Success | Module received the command and will start check if battery voltage is lower than threshold. |
Allowed Context
Network Up.
Sent By Host/Module
Host.