Digi International Inc. / XBeeLib

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.

/media/uploads/spastor/xbee-xbeepro-series1.jpg

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:

  1. Configuring the library
  2. Debugging the library
  3. Initializing modules
  4. Resetting the local module
  5. Receiving Data from other module
  6. Sending data to another module
  7. Discovering nodes in the network
  8. Configuring local and remote modules
  9. Handling modem status changes
  10. Handling remote modules DIOs, ADCs and PWMs
  11. Handling IO Data Samples from other module
  12. 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.

FrameHandlers/FH_AtCmdResp.cpp@0:fcaad0dfa051, 2015-05-08 (annotated)

Committer:
spastor
Date:
Fri May 08 11:50:56 2015 +0200
Revision:
0:fcaad0dfa051
Child:
4:629712865107
Automatic upload

Who changed what in which revision?

UserRevisionLine numberNew contents of line
spastor 0:fcaad0dfa051 1 /**
spastor 0:fcaad0dfa051 2 * Copyright (c) 2015 Digi International Inc.,
spastor 0:fcaad0dfa051 3 * All rights not expressly granted are reserved.
spastor 0:fcaad0dfa051 4 *
spastor 0:fcaad0dfa051 5 * This Source Code Form is subject to the terms of the Mozilla Public
spastor 0:fcaad0dfa051 6 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
spastor 0:fcaad0dfa051 7 * You can obtain one at http://mozilla.org/MPL/2.0/.
spastor 0:fcaad0dfa051 8 *
spastor 0:fcaad0dfa051 9 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
spastor 0:fcaad0dfa051 10 * =======================================================================
spastor 0:fcaad0dfa051 11 */
spastor 0:fcaad0dfa051 12
spastor 0:fcaad0dfa051 13 #include "FrameHandlers/FH_AtCmdResp.h"
spastor 0:fcaad0dfa051 14 #include "Frames/ApiFrame.h"
spastor 0:fcaad0dfa051 15
spastor 0:fcaad0dfa051 16 using namespace XBeeLib;
spastor 0:fcaad0dfa051 17
spastor 0:fcaad0dfa051 18 /** Class constructor */
spastor 0:fcaad0dfa051 19 FH_AtCmdResp::FH_AtCmdResp() :
spastor 0:fcaad0dfa051 20 FrameHandler(ApiFrame::AtCmdResp), at_cmd_resp_cb(NULL)
spastor 0:fcaad0dfa051 21 {
spastor 0:fcaad0dfa051 22 }
spastor 0:fcaad0dfa051 23
spastor 0:fcaad0dfa051 24 FH_AtCmdResp::FH_AtCmdResp(ApiFrame::ApiFrameType type) :
spastor 0:fcaad0dfa051 25 FrameHandler(type), at_cmd_resp_cb(NULL)
spastor 0:fcaad0dfa051 26 {
spastor 0:fcaad0dfa051 27 }
spastor 0:fcaad0dfa051 28
spastor 0:fcaad0dfa051 29 /** Class destructor */
spastor 0:fcaad0dfa051 30 FH_AtCmdResp::~FH_AtCmdResp()
spastor 0:fcaad0dfa051 31 {
spastor 0:fcaad0dfa051 32 }
spastor 0:fcaad0dfa051 33
spastor 0:fcaad0dfa051 34 /** */
spastor 0:fcaad0dfa051 35 void FH_AtCmdResp::register_at_cmd_resp_cb(at_cmd_resp_cb_t function)
spastor 0:fcaad0dfa051 36 {
spastor 0:fcaad0dfa051 37 at_cmd_resp_cb = function;
spastor 0:fcaad0dfa051 38 }
spastor 0:fcaad0dfa051 39
spastor 0:fcaad0dfa051 40 /** */
spastor 0:fcaad0dfa051 41 void FH_AtCmdResp::unregister_at_cmd_resp_cb()
spastor 0:fcaad0dfa051 42 {
spastor 0:fcaad0dfa051 43 at_cmd_resp_cb = NULL;
spastor 0:fcaad0dfa051 44 }
spastor 0:fcaad0dfa051 45
spastor 0:fcaad0dfa051 46 void FH_AtCmdResp::process_frame_data(const ApiFrame * const frame)
spastor 0:fcaad0dfa051 47 {
spastor 0:fcaad0dfa051 48 /* The caller checks that the type matches, so no need to check it here again */
spastor 0:fcaad0dfa051 49
spastor 0:fcaad0dfa051 50 if (at_cmd_resp_cb == NULL)
spastor 0:fcaad0dfa051 51 return;
spastor 0:fcaad0dfa051 52
spastor 0:fcaad0dfa051 53 at_cmd_resp_cb(frame->get_data(), frame->get_data_len());
spastor 0:fcaad0dfa051 54 }
spastor 0:fcaad0dfa051 55
spastor 0:fcaad0dfa051 56
spastor 0:fcaad0dfa051 57 /** Class constructor */
spastor 0:fcaad0dfa051 58 FH_NodeDiscoveryZB::FH_NodeDiscoveryZB() :
spastor 0:fcaad0dfa051 59 FH_AtCmdResp(ApiFrame::AtCmdResp), node_discovery_cb(NULL)
spastor 0:fcaad0dfa051 60 {
spastor 0:fcaad0dfa051 61 }
spastor 0:fcaad0dfa051 62
spastor 0:fcaad0dfa051 63 /** Class destructor */
spastor 0:fcaad0dfa051 64 FH_NodeDiscoveryZB::~FH_NodeDiscoveryZB()
spastor 0:fcaad0dfa051 65 {
spastor 0:fcaad0dfa051 66 }
spastor 0:fcaad0dfa051 67
spastor 0:fcaad0dfa051 68 /** */
spastor 0:fcaad0dfa051 69 void FH_NodeDiscoveryZB::register_node_discovery_cb(node_discovery_zb_cb_t function)
spastor 0:fcaad0dfa051 70 {
spastor 0:fcaad0dfa051 71 node_discovery_cb = function;
spastor 0:fcaad0dfa051 72 }
spastor 0:fcaad0dfa051 73
spastor 0:fcaad0dfa051 74 /** */
spastor 0:fcaad0dfa051 75 void FH_NodeDiscoveryZB::unregister_node_discovery_cb()
spastor 0:fcaad0dfa051 76 {
spastor 0:fcaad0dfa051 77 node_discovery_cb = NULL;
spastor 0:fcaad0dfa051 78 }
spastor 0:fcaad0dfa051 79
spastor 0:fcaad0dfa051 80
spastor 0:fcaad0dfa051 81 void FH_NodeDiscoveryZB::process_frame_data(const ApiFrame *const frame)
spastor 0:fcaad0dfa051 82 {
spastor 0:fcaad0dfa051 83 /* The caller checks that the type matches, so no need to check it here again */
spastor 0:fcaad0dfa051 84
spastor 0:fcaad0dfa051 85 if (node_discovery_cb == NULL) {
spastor 0:fcaad0dfa051 86 return;
spastor 0:fcaad0dfa051 87 }
spastor 0:fcaad0dfa051 88
spastor 0:fcaad0dfa051 89 if (frame->get_data_at(ATCMD_RESP_CMD_LOW_OFFSET) != 'N' ||
spastor 0:fcaad0dfa051 90 frame->get_data_at(ATCMD_RESP_CMD_HIGH_OFFSET) != 'D') {
spastor 0:fcaad0dfa051 91 return;
spastor 0:fcaad0dfa051 92 }
spastor 0:fcaad0dfa051 93
spastor 0:fcaad0dfa051 94 if (frame->get_data_at(ATCMD_RESP_STATUS_OFFSET) != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 95 return;
spastor 0:fcaad0dfa051 96 }
spastor 0:fcaad0dfa051 97
spastor 0:fcaad0dfa051 98 const uint8_t * const data = frame->get_data(); /* The data payload we get here is the full AT command response payload, excluding the frameid. Keep that in mind for the offsets */
spastor 0:fcaad0dfa051 99 const uint16_t addr16 = UINT16(data[ATCMD_RESP_NW_ADDR_H_OFFSET], data[ATCMD_RESP_NW_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 100 const uint64_t addr64 = addr64_from_uint8_t(&data[ATCMD_RESP_SH_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 101 const char * const node_id = (const char *)&data[ATCMD_RESP_NI_OFFSET];
spastor 0:fcaad0dfa051 102 #if 0
spastor 0:fcaad0dfa051 103 const unsigned int node_id_len = strlen(node_id);
spastor 0:fcaad0dfa051 104 const unsigned int parent_addr16_offset = ATCMD_RESP_NI_OFFSET + node_id_len + sizeof "";
spastor 0:fcaad0dfa051 105 const uint16_t parent_addr16 = UINT16(data[parent_addr16_offset], data[parent_addr16_offset + 1]);
spastor 0:fcaad0dfa051 106 const NetworkRole network_role = (NetworkRole)(data[parent_addr16_offset + 2]);
spastor 0:fcaad0dfa051 107 const uint16_t profile_id = UINT16(data[parent_addr16_offset + 4], data[parent_addr16_offset + 5]);
spastor 0:fcaad0dfa051 108 const uint16_t manuf_id = UINT16(data[parent_addr16_offset + 6], data[parent_addr16_offset + 7]);
spastor 0:fcaad0dfa051 109 #endif
spastor 0:fcaad0dfa051 110 RemoteXBeeZB remote = RemoteXBeeZB(addr64, addr16);
spastor 0:fcaad0dfa051 111
spastor 0:fcaad0dfa051 112 node_discovery_cb(remote, node_id);
spastor 0:fcaad0dfa051 113 }
spastor 0:fcaad0dfa051 114
spastor 0:fcaad0dfa051 115
spastor 0:fcaad0dfa051 116
spastor 0:fcaad0dfa051 117 /** Class constructor */
spastor 0:fcaad0dfa051 118 FH_NodeDiscovery802::FH_NodeDiscovery802() :
spastor 0:fcaad0dfa051 119 FH_AtCmdResp(ApiFrame::AtCmdResp), node_discovery_cb(NULL)
spastor 0:fcaad0dfa051 120 {
spastor 0:fcaad0dfa051 121 }
spastor 0:fcaad0dfa051 122
spastor 0:fcaad0dfa051 123 /** Class destructor */
spastor 0:fcaad0dfa051 124 FH_NodeDiscovery802::~FH_NodeDiscovery802()
spastor 0:fcaad0dfa051 125 {
spastor 0:fcaad0dfa051 126 }
spastor 0:fcaad0dfa051 127
spastor 0:fcaad0dfa051 128 /** */
spastor 0:fcaad0dfa051 129 void FH_NodeDiscovery802::register_node_discovery_cb(node_discovery_802_cb_t function)
spastor 0:fcaad0dfa051 130 {
spastor 0:fcaad0dfa051 131 node_discovery_cb = function;
spastor 0:fcaad0dfa051 132 }
spastor 0:fcaad0dfa051 133
spastor 0:fcaad0dfa051 134 /** */
spastor 0:fcaad0dfa051 135 void FH_NodeDiscovery802::unregister_node_discovery_cb()
spastor 0:fcaad0dfa051 136 {
spastor 0:fcaad0dfa051 137 node_discovery_cb = NULL;
spastor 0:fcaad0dfa051 138 }
spastor 0:fcaad0dfa051 139
spastor 0:fcaad0dfa051 140
spastor 0:fcaad0dfa051 141 void FH_NodeDiscovery802::process_frame_data(const ApiFrame *const frame)
spastor 0:fcaad0dfa051 142 {
spastor 0:fcaad0dfa051 143 /* The caller checks that the type matches, so no need to check it here again */
spastor 0:fcaad0dfa051 144
spastor 0:fcaad0dfa051 145 if (node_discovery_cb == NULL) {
spastor 0:fcaad0dfa051 146 return;
spastor 0:fcaad0dfa051 147 }
spastor 0:fcaad0dfa051 148
spastor 0:fcaad0dfa051 149 if (frame->get_data_at(ATCMD_RESP_CMD_LOW_OFFSET) != 'N' ||
spastor 0:fcaad0dfa051 150 frame->get_data_at(ATCMD_RESP_CMD_HIGH_OFFSET) != 'D') {
spastor 0:fcaad0dfa051 151 return;
spastor 0:fcaad0dfa051 152 }
spastor 0:fcaad0dfa051 153
spastor 0:fcaad0dfa051 154 if (frame->get_data_at(ATCMD_RESP_STATUS_OFFSET) != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 155 return;
spastor 0:fcaad0dfa051 156 }
spastor 0:fcaad0dfa051 157
spastor 0:fcaad0dfa051 158 const uint16_t min_atnd_response_with_data = 2 + 8 + 1;
spastor 0:fcaad0dfa051 159 if (frame->get_data_len() < min_atnd_response_with_data) {
spastor 0:fcaad0dfa051 160 /* Do not process the ATND "OK" response */
spastor 0:fcaad0dfa051 161 return;
spastor 0:fcaad0dfa051 162 }
spastor 0:fcaad0dfa051 163
spastor 0:fcaad0dfa051 164 const uint8_t * const data = frame->get_data();
spastor 0:fcaad0dfa051 165 const uint16_t addr16 = UINT16(data[ATCMD_RESP_NW_ADDR_H_OFFSET], data[ATCMD_RESP_NW_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 166 const uint64_t addr64 = addr64_from_uint8_t(&data[ATCMD_RESP_SH_ADDR_L_OFFSET]);
spastor 0:fcaad0dfa051 167 #if 0
spastor 0:fcaad0dfa051 168 const uint8_t signal_strength = data[ATCMD_802_RESP_SIGN_STR_OFFSET];
spastor 0:fcaad0dfa051 169 #endif
spastor 0:fcaad0dfa051 170 const RemoteXBee802 remote = RemoteXBee802(addr64, addr16);
spastor 0:fcaad0dfa051 171 const char * const nodeid = (const char *)(&data[ATCMD_802_RESP_NI_OFFSET]);
spastor 0:fcaad0dfa051 172
spastor 0:fcaad0dfa051 173 node_discovery_cb(remote, nodeid);
spastor 0:fcaad0dfa051 174 }