Comms Hub Function Sub GHz#

API and Callbacks for the Comms Hub Function Sub GHz Component.

The Sub-GHz extension of the Comms Hub Function (CHF). Implements the channel change sequence as outlined in section 10.6.2.8 of GBCS v3.0.

API#

Complete the sub-GHz channel change sequence.

API Documentation#

emberAfCommsHubFunctionSubGhzStartChannelChangeSequence#

EmberAfPluginCommsHubFunctionStatus emberAfCommsHubFunctionSubGhzStartChannelChangeSequence (void)

Trigger the sub-GHz channel change sequence.

Parameters
N/A

The sub-GHz CHF channel change comprises several steps:

  1. Set the EnergyScanPending Functional Notification flag.

  2. Wait until the GSME reads that flag or one GSME wake up period, whichever comes first.

  3. Perform an energy scan and determine the new page and channel.

  4. Set the ChannelChangePending Functional Notification flag and the ChannelChange attribute.

  5. Wait until the GSME reads that attribute or two GSME wake up periods, whichever comes first.

  6. Change the channel.

Note 1: The GSME must have completed the registration and allocated a mirror before this function is called.

Note 2: emberAfPluginCommsHubFunctionSubGhzChannelChangeCallback() is called at steps 3 and 6 in the above sequence. After step 3, the application must call emberAfCommsHubFunctionSubGhzCompleteChannelChangeSequence() to advance to steps 4 and and beyond.


Definition at line 65 of file app/framework/plugin/comms-hub-function-sub-ghz/comms-hub-function-sub-ghz.h

emberAfCommsHubFunctionSubGhzCompleteChannelChangeSequence#

EmberAfPluginCommsHubFunctionStatus emberAfCommsHubFunctionSubGhzCompleteChannelChangeSequence (uint32_t pageChannelMask)

Complete the sub-GHz channel change sequence.

Parameters
N/ApageChannelMask

Requested new page and channel as a 32-bit mask (Top 5 bits denote the page, bottom 27 bits the channel. Only one of the bottom 27 bits can be set to 1.)

The application may call this function following an energy scan (step 3 in the sequence described above).

If the mask is 0, the sequence is terminated immediately and the channel is not changed.


Definition at line 79 of file app/framework/plugin/comms-hub-function-sub-ghz/comms-hub-function-sub-ghz.h