Modules#

Button Joining

Button Joining#

API and Callbacks for the Button Joining Component.

This component requires Network Creator Security + Network Creator or Network Steering component to function correctly in Zigbee 3.0 networks. Otherwise, the Network Find component is strongly recommended but not mandatory. This code hooks up button 0 to have specific behavior based on the current network state. The behavior is as follows: If the device is not joined to a network, it either forms a Zigbee 3.0 network (via the Network Creator component) if it is configured as a coordinator, or joins a Zigbee 3.0 or ZHA legacy network (via the Network Steering component) if it is configured as a router. If the device is joined to a network, pressing the button broadcasts a ZDO permit join to allow new devices to join. Holding the button for 5 seconds and releasing causes the device to leave the network. Button 1 is not used and a callback is provided to another module wishing to use it.

API#

void

Press a button.

API Documentation#

emberAfPluginButtonJoiningPressButton#

void emberAfPluginButtonJoiningPressButton (uint8_t button)

Press a button.

Parameters
N/Abutton

The button that was pressed.

Presses a button indicated by the button argument.


Definition at line 55 of file app/framework/plugin/button-joining/button-joining.h