Using the XBee mbed library you will be able to configure the parameters of local and remote devices as well as execute some other commands, for example, writing your configuration changes.

This types of operations are blocking. This means the methods will wait until the transmit status response is received or the default timeout is reached. See Synchronous Operations Timeout

Networking parameters¶

The following methods allow an easier configuration of network parameters in XBee modules.

Common¶

ZigBee¶

Optionally, ZigBee networks can be configured to use 128-bit encryption AES for security reasons. The following methods allow this:

In routers, during development it might be useful to force a check that the network coordinator is present.

802.15.4¶

DigiMesh¶

Get and set arbitrary parameters¶

If you want to get or set a parameter for which there is no custom method already in the library, you can use either of these two methods for getting and setting any AT parameter.

Getting a parameter from the local device¶

You can get the value of any parameter of an XBee device using the get_param() methods provided by every XBee object. There are two methods, one for generic parameters that uses a uint32_t variable to read 1, 2 and 4 bytes length parameters, and a method that takes a pointer to a uint8_t buffer of arbitrary length to get longer parameters. This later method should be used very rarely, as all the variable length parameters are get through a proper wrapper (i.e.: get_node_identifier() and get_operating_panid() methods).

Example: Getting a parameter from the local XBee Device

#include "XBeeLib.h"
  
using namespace XBeeLib;
 
void main()
{
    [...]  
     
    XBeeZB xbee = XBeeZB(RADIO_TX, RADIO_RX, RADIO_RESET, NC, NC, 9600);
    xbee.init();
    
    [...]
     
    AtCmdFrame::AtCmdResp cmdresp;
    uint32_t val;
     
    // Read parameter BD (Baud Rate: 9600 bps [3])
    cmdresp = xbee.get_param("BD", &val);
 
    // Print the value of the parameter if it was correctly read
    if (cmdresp == AtCmdFrame::AT_CMD_RESP_OK)
        printf("OK. Local BD=%d\r\n", val);
    else
        printf("FAILED with %d\r\n", (int) cmdresp);
}

Setting a parameter in the local device¶

To set a parameter that does not have its own setter method, you can use the set_param() methods provided by all the XBee device classes. There are two methods, one for generic parameters that uses a uint32_t variable to write 1, 2 and 4 bytes length parameters, and a method that takes a pointer to a uint8_t buffer of arbitrary length (including 0) to set longer parameters. This later method should be used very rarely, as all the variable length parameters are get through a proper wrapper (i.e.: set_node_identifier() and set_operating_panid() methods).

Example: Setting a parameter in the local XBee Device

#include "XBeeLib.h"
  
using namespace XBeeLib;
 
void main()
{
    [...]  
     
    XBeeZB xbee = XBeeZB(RADIO_TX, RADIO_RX, RADIO_RESET, NC, NC, 9600);
    xbee.init();
    
    [...]
     
    AtCmdFrame::AtCmdResp cmdresp;
    uint32_t val = 4; // Option 4 stands for 19200 bps
     
    // Set parameter BD (Baud Rate: 19200 bps [4])
    cmdresp = xbee.set_param("BD", val);
 
    // Print the value of the parameter if it was correctly read
    if (cmdresp == AtCmdFrame::AT_CMD_RESP_OK)
        printf("OK. Local BD=%d\r\n", val);
    else
        printf("FAILED with %d\r\n", (int) cmdresp);
}

Getting a parameter from the remote device¶

You can get a parameter from a remote device the same way you can do it with a local one. You just need to use the get_param() methods using the remote device object as an extra parameter (either RemoteXBeeZB or RemoteXBee802). There are two methods, one for generic parameters that uses a uint32_t variable to read 1, 2 and 4 bytes length parameters, and a method that takes a pointer to a uint8_t buffer of arbitrary length to get longer parameters. This later method should be used very rarely, as all the variable length parameters are get through a proper wrapper (i.e.: get_node_identifier() and get_operating_panid() methods).

Example: Getting a parameter from the remote XBee Device

#include "XBeeLib.h"
  
using namespace XBeeLib;
 
#define REMOTE_NODE_ADDR64_MSB      ((uint32_t)0x0013A200)
#define REMOTE_NODE_ADDR64_LSB      ((uint32_t)0xABCDEF00)
 
void main()
{
    [...]  
     
    XBeeZB xbee = XBeeZB(RADIO_TX, RADIO_RX, RADIO_RESET, NC, NC, 9600);
    xbee.init();   
    
    [...]
     
    const RemoteXBeeZB remote_xbee = RemoteXBeeZB(UINT64(REMOTE_NODE_ADDR64_MSB, REMOTE_NODE_ADDR64_LSB));
     
    AtCmdFrame::AtCmdResp cmdresp;
    uint32_t val;
     
    // Read parameter BD (Baud Rate: 9600 bps [3])
    cmdresp = xbee.get_param(remote_xbee, "BD", &val);
 
    // Print the value of the parameter if it was correctly read
    if (cmdresp == AtCmdFrame::AT_CMD_RESP_OK)
        printf("OK. Remote BD=%d\r\n", val);
    else
        printf("FAILED with %d\r\n", (int) cmdresp);
}

Setting a parameter in the remote device¶

To set a parameter in the remote device that does not have its own setter method, you can use the set_param() methods passing the remote device object as an extra parameter as shown in the following table (either RemoteXBeeZB or RemoteXBee802). There are two methods, one for generic parameters that uses a uint32_t variable to write 1, 2 and 4 bytes length parameters, and a method that takes a pointer to a uint8_t buffer of arbitrary length (including 0) to set longer parameters. This later method should be used very rarely, as all the variable length parameters are get through a proper wrapper (i.e.: set_node_identifier() and set_operating_panid() methods).

Example: Setting a parameter in the remote XBee Device

#include "XBeeLib.h"
  
using namespace XBeeLib;
 
#define REMOTE_NODE_ADDR64_MSB      ((uint32_t)0x0013A200)
#define REMOTE_NODE_ADDR64_LSB      ((uint32_t)0xABCDEF00)
 
void main()
{
    [...]  
     
    XBeeZB xbee = XBeeZB(RADIO_TX, RADIO_RX, RADIO_RESET, NC, NC, 9600);
    xbee.init();
    
    [...]
     
    const RemoteXBeeZB remote_xbee = RemoteXBeeZB(UINT64(REMOTE_NODE_ADDR64_MSB, REMOTE_NODE_ADDR64_LSB));
     
    AtCmdFrame::AtCmdResp cmdresp;
    uint32_t val = 4; // Option 4 stands for 19200 bps
     
    // Set parameter BD (Baud Rate: 19200 bps [4])
    cmdresp = xbee.set_param(remote_xbee, "BD", val);
 
    // Print the value of the parameter if it was correctly set
    if (cmdresp == AtCmdFrame::AT_CMD_RESP_OK)
        printf("OK. Remote BD=%d\r\n", val);
    else
        printf("FAILED with %d\r\n", (int) cmdresp);
}

Write configuration changes¶

To preserve node configuration between power cycles and resets they can be saved into non-volatile memory. However, this operation should not be done too often as the modules only support a limited number of write cycles.

Return values¶

Al the configuration methods return a AtCmdResp with the following meaning:

Examples¶

Here is a ready to use example:

For ZigBee modules:¶

For 802.15.4 modules:¶

For DigiMesh modules:¶