The Commissioning Pushbutton
The XBee/XBee-PRO DigiMesh 2.4 supports a set of commissioning and LED functions to help you deploy and commission devices. These functions include the Commissioning Pushbutton definitions and the associated LED functions. The following diagram shows how the hardware can support these features.
To support the Commissioning Pushbutton and its associated LED functions, connect a pushbutton and an LED to device pins 20 and 15 respectively.
Definitions
To enable the Commissioning Pushbutton functionality on pin 20, set the D0 command to 1. The functionality is enabled by default.
You must perform multiple button presses within two seconds.
The following table provides the pushbutton definitions.
Button presses |
Sleep configuration and sync status |
Action |
1 |
Not configured for sleep |
Immediately sends a Node Identification broadcast transmission. All devices that receive this transmission blink their Associate LED rapidly for one second. All devices in API operating mode that receive this transmission send a Node Identification Indicator frame (0x95) out their UART. |
1 |
Configured for asynchronous sleep |
Wakes the device for 30 seconds. Immediately sends a Node Identification broadcast transmission. All devices that receive this transmission blink their Associate LED rapidly for one second. All devices in API operating mode that receive this transmission send a Node Identification Indicator frame (0x95) out their UART. |
1 |
Configured for synchronous sleep |
Wakes the module for 30 seconds or until the synchronized network goes to sleep. Queues a Node Identification broadcast transmission that it sends at the beginning of the next network wake cycle. All devices that receive this transmission blink their Associate LED rapidly for one second. All devices in API operating mode that receive this transmission send a Node Identification Indicator frame (0x95) out their UART. |
2 |
Not configured for synchronous sleep |
No effect. |
2 |
Configured for synchronous sleep |
Causes a node configured with sleeping router nomination enabled to immediately nominate itself as the network sleep coordinator. For more information, see SO (Sleep Options). |
4 |
Any |
Sends an RE command to restore device parameters to default values. |
Use the Commissioning Pushbutton
Use the CB command to simulate button presses in software. Send CB with a parameter set to the number of button presses to perform. For example, if you send ATCB1, the device performs the action(s) associated with a single button press.
Node Identification Indicator - 0x95 is similar to Remote AT Command Response- 0x97 – it contains the device’s address, node identifier string (NI command), and other relevant data. All devices in API operating mode that receive the Node Identification Indicator frame send it out their UART as a Node Identification Indicator frame.
If you enable the Commissioning Pushbutton during sleep, it increases the sleeping current draw, especially in Asynchronous pin sleep (SM = 1) mode. When asleep, hold down the Commissioning Pushbutton for up to two seconds to wake the device from sleep, then issue the two or four button presses.