This page conveys release notes for firmware and software releases.
...
This release of RapidHA Lighting will still operate independently on the network as before and will also continue to operate the PWM GPIO in response to lighting events, but will now also inform a connected Host about incoming lighting events (On/Off, Move to Level and their combinations) via the serial interface. The serial protocol adheres to the RapidHA serial protocol with the incorporation of one new frame.
New Features
This release will provide facilities for your Host processor to be notified of changes to the On/Off, Identify, and Level Control attributes/states so you can manipulate LED drivers accordingly. The serial frames issues issued by the application are described below.
Identify Start Command
| RapidHA Primary Header | 0x11 (General Cluster Frames) |
|---|---|
| RapidHA Secondary Header | 0x10 |
...
on
...
Payload for Identify Start Command
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | ID of the endpoint on which the Identify action should start. |
Expected Host Action
The Host shall initiate its Identify action (e.g., blinking LED, etc.) on the specified endpoint.
Example Payload
F1 11 10 DE 01 16 16 01 [RHAIdentifyStart]
Identify Stop Command
| RapidHA Primary Header | 0x11 (General Cluster Frames) |
|---|---|
| RapidHA Secondary Header | 0x11 |
The Identify Stop command is sent by the Module to the Host on expiration of a preceding Identify Start command (i.e., when the Identify Time duration of that command has been expended) or on reception of an explicit command from the network prompting the application to stop identifying on the given endpoint.
Payload for Identify Stop Command
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint | ID of the endpoint on which the Identify action should stop. |
Expected Host Action
The Host shall stop its Identify action on the specified endpoint.
Example Payload
F1 11 11 E3 01 16 1C 01 [RHAIdentifyStop]
On/Off Status Update
| RapidHA Primary Header | 0x12 (HA Cluster Frames) |
|---|---|
| RapidHA Secondary Header | 0x00 |
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.
This command will also be issued to Host with any Move to Level command that is combined with an On/Off action, thought the expected value of the On/Off Status attribute will be conveyed in the Move to Level command itself as well.
Finally, this command will be issued in alternating sequence (On and Off) to the Host in response to an Identify command from the network (i.e. following issuance of Identify Start to the Host), such that the Host may blink LED's for the appropriate duration (i.e. until the reception of Identify Stop). It is the Host's option to use this aspect of the feature to drive the blinking of LED's during an Identify command.
Payload for On/Off State Update Command
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 | 0x00 = Local Source |
Expected Host Action
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.
Example Payload
- (Indicating OFF) F1 12 00 DF 03 16 00 00 0A 01 [RHAOnOffStateUpdate]
Move to Level with On/Off Status
| RapidHA Primary Header | 0x12 (HA Cluster Frames) |
|---|---|
| RapidHA Secondary Header | 0x25 (note that this is different from the secondary header for the Move to Level command, which is 0x20) |
The Move to Level with On/Off status command is sent by the Module to the Host on reception of a Move to Level command from the network, targeted to an endpoint on which the application supports the Level Control server cluster.
Payload for Move to Level Command
...
Byte Index
...
Field Name
...
Notes
...
0
...
Endpoint ID
...
Endpoint ID of the application Level Control server cluster.
...
1
...
Level
...
The applied Level value, 0x00-0xFF.
...
2,3
...
Transition Time
...
Time taken to move to the new level, in tenths of a second, or as close to this as the device is able.
If the Transition Time value is 0xFFFF then the time taken to move to the new level shall instead be determined by the OnOffTransitionTime attribute. If OnOffTransitionTime, which is an optional attribute, is not present, the device shall move to its new level as fast as it is able.
If the device is not able to move at a variable rate, the Transition Time field may be disregarded.
...
4
...
On/Off Status
...
Expected Host Action
The Host shall modify its hardware output appropriately based on the new Level. For example, if the given device is a dimmer, the Host shall dim the connected light to the light level corresponding to the given Level value. In this example, if the Host controls multiple dimmers on disparate endpoints, the change in Level should only be applied to the dimmer identified by the target Endpoint ID.
The Host is otherwise required to mirror the state indicated by the On/Off Status parameter on the physical device.
Example Payload
- (Indicating Level 100, Transition Time 0, On/Off Status ON) F1 12 25 BB 05 16 64 00 00 01 72 01 [RHAMoveToLevel]
the Serial Protocol page.