Digi International Inc.
Library to easily communicate with XBee modules.
Dependencies: DigiLogger
Dependents: WaterLogger XbeeGateway XBee_Cooker ProjetReceiver ... more
Use XBee radio modules to easily improve your project with wireless connectivity. You can enable entire networks of connected devices. XBees can exchange data with other modules in the network and configure remote modules as well as trigger actions or collect sensor data on XBee nodes without needing additional external microcontrollers. Using this documentation and configuration tools with XBee modules, it is easy to develop these types of applications and more.
The XBee mbed Library is a ready-to-import mbed extension that dramatically reduces development time for XBee projects on the mbed platforms. There are many modular examples, making it an easy and smooth process to add wireless networking to a whole range of useful applications.
Info
Currently 802.15.4 (Series 1 and 2), ZigBee (Series 2) and DigiMesh (Series 1 and 2) modules are supported. The libraries can be extended to support other protocols like DigiMesh point-to-point, WiFi, etc.
User manual
The user manual can be found at this project's Wiki pages:
- Configuring the library
- Debugging the library
- Initializing modules
- Resetting the local module
- Receiving Data from other module
- Sending data to another module
- Discovering nodes in the network
- Configuring local and remote modules
- Handling modem status changes
- Handling remote modules DIOs, ADCs and PWMs
- Handling IO Data Samples from other module
- Radio Power Management
Ready to use examples
There are a lot of ready to use examples to get started quickly.
Make sure you have a valid example setup before running the examples:
Examples for ZigBee modules
Import programXBeeZB_Receive_Data
ZigBee Receive Data example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by 
Digi International Inc.
Import programXBeeZB_Send_Data
ZigBee Send Data example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_module_config
ZigBee network configuration example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_AT_Commands
ZigBee AT Commands example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_dio_adc
ZigBee DIOs and ADCs example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_IO_Sample_Callback
ZigBee IO Sampling Callback example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_modem_status
ZigBee Modem Status example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_node_discovery
ZigBee Node Discovery example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_power_mngmnt_cyclic_sleep
ZigBee Power Management using Cyclic Sleep example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeZB_power_mngmnt_pin_sleep
ZigBee Power Management using Pin Sleep example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Examples for 802.15.4 modules
Import programXBee802_Receive_Data
802.15.4 Receive Data example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_Send_Data
802.15.4 Send Data example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_module_config
802.15.4 network configuration example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_AT_Commands
802.15.4 AT Commands example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_dio_adc_pwm
802.15.4 DIOs, ADCs and PWM example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_IO_Sample_Callback
802.15.4 IO Sampling Callback example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_node_discovery
802.15.4 Node Discovery example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_power_mngmnt_cyclic_sleep
802.15.4 Power Management using Cyclic Sleep example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBee802_power_mngmnt_pin_sleep
802.15.4 Power Management using Pin Sleep example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Examples for DigiMesh modules
Import programXBeeDM_Receive_Data
DigiMesh Receive Data example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_Send_Data
DigiMesh Send Data example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_module_config
DigiMesh network configuration example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_AT_Commands
DigiMesh AT Commands example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_dio_adc_pwm
DigiMEsh DIOs, ADCs and PWMs example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_IO_Sample_Callback
DigiMesh IO Sampling Callback example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_modem_status
DigiMesh Modem Status example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_node_discovery
DigiMesh Node Discovery example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_power_mngmnt_asyncr_cyclic_sleep
DigiMesh Power Management using Asynchronous Cyclic Sleep example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Import programXBeeDM_power_mngmnt_pin_sleep
DigiMesh Power Management using Pin Sleep example for mbed XBeeLib By Digi
Last commit 29 Jul 2016 by Digi International Inc.
Revision 9:780db84ce891, committed 2016-07-29
- Comitter:
- hbujanda
- Date:
- Fri Jul 29 13:10:07 2016 +0200
- Parent:
- 8:b5f4a0e92249
- Commit message:
- Automatic upload
Changed in this revision
--- a/DigiLogger.lib Fri Jul 29 12:10:38 2016 +0200 +++ b/DigiLogger.lib Fri Jul 29 13:10:07 2016 +0200 @@ -1,1 +1,1 @@ -http://developer.mbed.org/teams/Digi-International-Inc/code/DigiLogger/#58c5158b5120 +http://developer.mbed.org/teams/Digi-International-Inc/code/DigiLogger/#
--- a/XBee802/XBee802.cpp Fri Jul 29 12:10:38 2016 +0200
+++ b/XBee802/XBee802.cpp Fri Jul 29 13:10:07 2016 +0200
@@ -137,17 +137,6 @@
return Success;
}
-RadioStatus XBee802::set_tc_link_key(const uint8_t * const key, const uint16_t length)
-{
- if (key == NULL || length == 0 || length > 16) {
- return Failure;
- }
- AtCmdFrame::AtCmdResp cmdresp;
-
- cmdresp = set_param("KY", key, length);
- return cmdresp == AtCmdFrame::AtCmdRespOk ? Success : Failure;
-}
-
RadioStatus XBee802::get_node_discovery_timeout(uint16_t * const timeout_ms)
{
AtCmdFrame::AtCmdResp cmdresp;
--- a/XBee802/XBee802.h Fri Jul 29 12:10:38 2016 +0200
+++ b/XBee802/XBee802.h Fri Jul 29 13:10:07 2016 +0200
@@ -141,16 +141,6 @@
*/
RadioStatus set_network_address(uint16_t addr);
- /** set_tc_link_key - Sets key used for encryption and decryption (ZigBee trust center link key).
- * It is not recommended to set the key programmatically, because it could be read through the raw serial port bits.
- * @param key pointer to the 128-bit AES key
- * @param length size of the buffer pointed by 'key'
- * @returns
- * Success if the operation was successful,
- * Failure otherwise
- */
- RadioStatus set_tc_link_key(const uint8_t * const key, const uint16_t length);
-
/** register_node_discovery_cb - registers the callback function that will be called
* when the responses to the node discovery command arrive
*
--- a/XBeeDM/XBeeDM.cpp Fri Jul 29 12:10:38 2016 +0200
+++ b/XBeeDM/XBeeDM.cpp Fri Jul 29 13:10:07 2016 +0200
@@ -102,17 +102,6 @@
return Success;
}
-RadioStatus XBeeDM::set_tc_link_key(const uint8_t * const key, const uint16_t length)
-{
- if (key == NULL || length == 0 || length > 16) {
- return Failure;
- }
- AtCmdFrame::AtCmdResp cmdresp;
-
- cmdresp = set_param("KY", key, length);
- return cmdresp == AtCmdFrame::AtCmdRespOk ? Success : Failure;
-}
-
RadioStatus XBeeDM::get_node_discovery_timeout(uint16_t * const timeout_ms)
{
AtCmdFrame::AtCmdResp cmdresp;
--- a/XBeeDM/XBeeDM.h Fri Jul 29 12:10:38 2016 +0200
+++ b/XBeeDM/XBeeDM.h Fri Jul 29 13:10:07 2016 +0200
@@ -104,16 +104,6 @@
*/
RadioStatus get_network_id(uint16_t * const network_id);
- /** set_tc_link_key - Sets key used for encryption and decryption (ZigBee trust center link key).
- * It is not recommended to set the key programmatically, because it could be read through the raw serial port bits.
- * @param key pointer to the 128-bit AES key
- * @param length size of the buffer pointed by 'key'
- * @returns
- * Success if the operation was successful,
- * Failure otherwise
- */
- RadioStatus set_tc_link_key(const uint8_t * const key, const uint16_t length);
-
/** register_node_discovery_cb - registers the callback function that will be called
* when the responses to the node discovery command arrive
*
--- a/XBeeLib.h Fri Jul 29 12:10:38 2016 +0200 +++ b/XBeeLib.h Fri Jul 29 13:10:07 2016 +0200 @@ -16,7 +16,7 @@ #ifndef __XBEE_H_ #define __XBEE_H_ -#define XB_LIBRARY_VERSION 0x01010100U +#define XB_LIBRARY_VERSION 0x01010200U #define XB_MAJOR_VERSION ((XB_LIBRARY_VERSION >> 24) & 0xFFU) #define XB_MINOR_VERSION ((XB_LIBRARY_VERSION >> 16) & 0xFFU) #define XB_PATCH_LEVEL ((XB_LIBRARY_VERSION >> 8) & 0xFFU)
--- a/XBeeZB/XBeeZB.cpp Fri Jul 29 12:10:38 2016 +0200
+++ b/XBeeZB/XBeeZB.cpp Fri Jul 29 13:10:07 2016 +0200
@@ -261,17 +261,6 @@
return cmdresp == AtCmdFrame::AtCmdRespOk ? Success : Failure;
}
-RadioStatus XBeeZB::set_tc_link_key(const uint8_t * const key, const uint16_t length)
-{
- if (key == NULL || length == 0 || length > 16) {
- return Failure;
- }
- AtCmdFrame::AtCmdResp cmdresp;
-
- cmdresp = set_param("KY", key, length);
- return cmdresp == AtCmdFrame::AtCmdRespOk ? Success : Failure;
-}
-
void XBeeZB::radio_status_update(AtCmdFrame::ModemStatus modem_status)
{
/* Update the radio status variables */
--- a/XBeeZB/XBeeZB.h Fri Jul 29 12:10:38 2016 +0200
+++ b/XBeeZB/XBeeZB.h Fri Jul 29 13:10:07 2016 +0200
@@ -211,16 +211,6 @@
*/
RadioStatus set_encryption_options(const uint8_t options);
- /** set_tc_link_key - Sets key used for encryption and decryption (ZigBee trust center link key).
- * It is not recommended to set the key programmatically, because it could be read through the raw serial port bits.
- * @param key pointer to the 128-bit AES key
- * @param length size of the buffer pointed by 'key'
- * @returns
- * Success if the operation was successful,
- * Failure otherwise
- */
- RadioStatus set_tc_link_key(const uint8_t * const key, const uint16_t length);
-
/** register_node_discovery_cb - registers the callback function that will be called
* when the responses to the node discovery command arrive
*