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.

Frames/ApiFrame.cpp@9:780db84ce891, 2016-07-29 (annotated)

Committer:
hbujanda
Date:
Fri Jul 29 13:10:07 2016 +0200
Revision:
9:780db84ce891
Parent:
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 "mbed.h"
spastor 0:fcaad0dfa051 14 #include "XBee/XBee.h"
spastor 0:fcaad0dfa051 15 #include "ApiFrame.h"
spastor 0:fcaad0dfa051 16
spastor 0:fcaad0dfa051 17 using namespace XBeeLib;
spastor 0:fcaad0dfa051 18
spastor 0:fcaad0dfa051 19 uint8_t ApiFrame::last_frame_id = 0;
spastor 0:fcaad0dfa051 20
spastor 0:fcaad0dfa051 21 ApiFrame::ApiFrame(void)
spastor 0:fcaad0dfa051 22 {
spastor 0:fcaad0dfa051 23 this->_type = Invalid;
spastor 0:fcaad0dfa051 24 this->_data = NULL;
spastor 0:fcaad0dfa051 25 this->_data_frame_len = 0;
spastor 0:fcaad0dfa051 26 this->_alloc_data = false;
spastor 0:fcaad0dfa051 27 _frame_id = get_next_frame_id();
spastor 0:fcaad0dfa051 28 }
spastor 0:fcaad0dfa051 29
spastor 0:fcaad0dfa051 30 ApiFrame::ApiFrame(uint16_t len)
spastor 0:fcaad0dfa051 31 {
spastor 0:fcaad0dfa051 32 this->_type = Invalid;
spastor 0:fcaad0dfa051 33 this->_data = new uint8_t[len];
spastor 0:fcaad0dfa051 34 this->_alloc_data = true;
spastor 0:fcaad0dfa051 35 this->_data_frame_len = len;
spastor 0:fcaad0dfa051 36 this->_frame_id = get_next_frame_id();
spastor 0:fcaad0dfa051 37 }
spastor 0:fcaad0dfa051 38
spastor 0:fcaad0dfa051 39 uint8_t ApiFrame::get_next_frame_id(void)
spastor 0:fcaad0dfa051 40 {
spastor 0:fcaad0dfa051 41 last_frame_id++;
spastor 4:629712865107 42 if (last_frame_id == 0) {
spastor 0:fcaad0dfa051 43 last_frame_id++;
spastor 4:629712865107 44 }
spastor 4:629712865107 45
spastor 0:fcaad0dfa051 46 return last_frame_id;
spastor 0:fcaad0dfa051 47 }
spastor 0:fcaad0dfa051 48
spastor 0:fcaad0dfa051 49 ApiFrame::ApiFrame(ApiFrameType type, const uint8_t *data, uint16_t len)
spastor 0:fcaad0dfa051 50 {
spastor 0:fcaad0dfa051 51 this->_data = NULL;
spastor 0:fcaad0dfa051 52 set_api_frame(type, data, len);
spastor 0:fcaad0dfa051 53 }
spastor 0:fcaad0dfa051 54
spastor 0:fcaad0dfa051 55 void ApiFrame::set_api_frame(ApiFrameType type, const uint8_t *data, uint16_t len)
spastor 0:fcaad0dfa051 56 {
spastor 0:fcaad0dfa051 57 this->_type = type;
spastor 0:fcaad0dfa051 58 this->_data_frame_len = len;
spastor 4:629712865107 59 if (this->_data) {
spastor 0:fcaad0dfa051 60 delete _data;
spastor 4:629712865107 61 }
spastor 0:fcaad0dfa051 62 this->_data = new uint8_t[len];
spastor 0:fcaad0dfa051 63 this->_alloc_data = true;
spastor 0:fcaad0dfa051 64 assert(this->_data != NULL);
spastor 0:fcaad0dfa051 65 memcpy((void *)this->_data, data, len);
spastor 0:fcaad0dfa051 66 }
spastor 0:fcaad0dfa051 67
spastor 0:fcaad0dfa051 68 ApiFrame::~ApiFrame()
spastor 0:fcaad0dfa051 69 {
spastor 0:fcaad0dfa051 70 if (this->_data != NULL && this->_alloc_data) {
spastor 0:fcaad0dfa051 71 delete[] this->_data;
spastor 0:fcaad0dfa051 72 }
spastor 0:fcaad0dfa051 73 }
spastor 0:fcaad0dfa051 74
spastor 0:fcaad0dfa051 75 void ApiFrame::dump(void) const
spastor 0:fcaad0dfa051 76 {
spastor 0:fcaad0dfa051 77 #if defined(ENABLE_LOGGING)
spastor 0:fcaad0dfa051 78 digi_log(LogLevelFrameData, "API frame: type %02x, len %d\r\n", this->_type, this->_data_frame_len);
spastor 4:629712865107 79 for (int i = 0; i < this->_data_frame_len; i++)
spastor 0:fcaad0dfa051 80 digi_log(LogLevelFrameData, "%02x ", this->_data[i]);
spastor 0:fcaad0dfa051 81 digi_log(LogLevelFrameData, "\r\n");
spastor 0:fcaad0dfa051 82 #endif
spastor 0:fcaad0dfa051 83 }
spastor 0:fcaad0dfa051 84
spastor 0:fcaad0dfa051 85 void ApiFrame::dump_if(ApiFrameType type)
spastor 0:fcaad0dfa051 86 {
spastor 4:629712865107 87 if (_type != type) {
spastor 0:fcaad0dfa051 88 return;
spastor 4:629712865107 89 }
spastor 4:629712865107 90 dump();
spastor 0:fcaad0dfa051 91 }
spastor 4:629712865107 92
spastor 0:fcaad0dfa051 93 ApiFrame::ApiFrameType ApiFrame::get_frame_type() const
spastor 0:fcaad0dfa051 94 {
spastor 0:fcaad0dfa051 95 return _type;
spastor 0:fcaad0dfa051 96 }
spastor 0:fcaad0dfa051 97
spastor 0:fcaad0dfa051 98 void ApiFrame::set_frame_type(ApiFrameType type)
spastor 0:fcaad0dfa051 99 {
spastor 0:fcaad0dfa051 100 _type = type;
spastor 0:fcaad0dfa051 101 }
spastor 0:fcaad0dfa051 102
spastor 0:fcaad0dfa051 103 uint16_t ApiFrame::get_data_len() const
spastor 0:fcaad0dfa051 104 {
spastor 0:fcaad0dfa051 105 return _data_frame_len;
spastor 4:629712865107 106 }
spastor 0:fcaad0dfa051 107
spastor 4:629712865107 108 void ApiFrame::set_data_len(uint16_t len)
spastor 0:fcaad0dfa051 109 {
spastor 0:fcaad0dfa051 110 _data_frame_len = len;
spastor 4:629712865107 111 }
spastor 0:fcaad0dfa051 112
spastor 0:fcaad0dfa051 113 const uint8_t *ApiFrame::get_data() const
spastor 0:fcaad0dfa051 114 {
spastor 0:fcaad0dfa051 115 return _data;
spastor 4:629712865107 116 }
spastor 0:fcaad0dfa051 117
spastor 0:fcaad0dfa051 118 uint8_t ApiFrame::get_data_at(uint16_t index) const
spastor 0:fcaad0dfa051 119 {
spastor 0:fcaad0dfa051 120 return *(_data + index);
spastor 4:629712865107 121 }
spastor 0:fcaad0dfa051 122
spastor 4:629712865107 123 void ApiFrame::set_data(uint8_t d, uint16_t index)
spastor 0:fcaad0dfa051 124 {
spastor 0:fcaad0dfa051 125 *(_data + index) = d;
spastor 4:629712865107 126 }
spastor 0:fcaad0dfa051 127
spastor 0:fcaad0dfa051 128 /* Returns the frame_id of this frame */
spastor 0:fcaad0dfa051 129 uint8_t ApiFrame::get_frame_id() const
spastor 0:fcaad0dfa051 130 {
spastor 0:fcaad0dfa051 131 return _frame_id;
spastor 0:fcaad0dfa051 132 }