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.

FrameBuffer/FrameBuffer.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 4:629712865107 12
spastor 0:fcaad0dfa051 13 #include "FrameBuffer.h"
spastor 4:629712865107 14 #include "Utils/Debug.h"
spastor 0:fcaad0dfa051 15
spastor 0:fcaad0dfa051 16 #if !(defined AVOID_DISABLE_IRQS)
spastor 0:fcaad0dfa051 17 #define disable_irq() __disable_irq()
spastor 0:fcaad0dfa051 18 #define enable_irq() __enable_irq()
spastor 0:fcaad0dfa051 19 #else
spastor 0:fcaad0dfa051 20 #define disable_irq()
spastor 0:fcaad0dfa051 21 #define enable_irq()
spastor 0:fcaad0dfa051 22 #endif
spastor 0:fcaad0dfa051 23
spastor 4:629712865107 24 FrameBuffer::FrameBuffer(uint8_t size, uint16_t max_payload_len) : _size(size), _head(0), _tail(0), _dropped_frames(0)
spastor 0:fcaad0dfa051 25 {
spastor 4:629712865107 26 _frm_buf = new buf_element_t[_size];
spastor 4:629712865107 27
spastor 4:629712865107 28 assert(_frm_buf != NULL);
spastor 4:629712865107 29
spastor 4:629712865107 30 for (int i = 0; i < _size; i++) {
spastor 4:629712865107 31 _frm_buf[i].frame = new ApiFrame(max_payload_len - 1);
spastor 0:fcaad0dfa051 32 _frm_buf[i].status = FrameStatusFree;
spastor 0:fcaad0dfa051 33 }
spastor 0:fcaad0dfa051 34 }
spastor 0:fcaad0dfa051 35
spastor 0:fcaad0dfa051 36 FrameBuffer::~FrameBuffer()
spastor 0:fcaad0dfa051 37 {
spastor 4:629712865107 38 for (int i = 0; i < _size; i++) {
spastor 0:fcaad0dfa051 39 delete _frm_buf[i].frame;
spastor 0:fcaad0dfa051 40 }
spastor 4:629712865107 41
spastor 4:629712865107 42 delete _frm_buf;
spastor 0:fcaad0dfa051 43 }
spastor 4:629712865107 44
spastor 0:fcaad0dfa051 45 ApiFrame *FrameBuffer::get_next_free_frame(void)
spastor 0:fcaad0dfa051 46 {
spastor 0:fcaad0dfa051 47 uint8_t i = _head;
spastor 0:fcaad0dfa051 48 ApiFrame *ret = NULL;
spastor 4:629712865107 49
spastor 0:fcaad0dfa051 50 do {
spastor 0:fcaad0dfa051 51 if (_frm_buf[i].status == FrameStatusFree || _frm_buf[i].status == FrameStatusComplete) {
spastor 4:629712865107 52 if (_frm_buf[i].status == FrameStatusComplete) {
spastor 0:fcaad0dfa051 53 _dropped_frames++;
spastor 4:629712865107 54 }
spastor 0:fcaad0dfa051 55 _frm_buf[i].status = FrameStatusAssigned;
spastor 0:fcaad0dfa051 56 ret = _frm_buf[i].frame;
spastor 4:629712865107 57 _head = ++i % _size;
spastor 0:fcaad0dfa051 58 break;
spastor 0:fcaad0dfa051 59 }
spastor 0:fcaad0dfa051 60 i++;
spastor 4:629712865107 61 i = i % _size;
spastor 0:fcaad0dfa051 62 } while (i != _head);
spastor 0:fcaad0dfa051 63
spastor 4:629712865107 64 return ret;
spastor 0:fcaad0dfa051 65 }
spastor 0:fcaad0dfa051 66
spastor 0:fcaad0dfa051 67 bool FrameBuffer::complete_frame(ApiFrame *frame)
spastor 0:fcaad0dfa051 68 {
spastor 0:fcaad0dfa051 69 bool ret = false;
spastor 4:629712865107 70
spastor 4:629712865107 71 for (int i = 0; i < _size; i++) {
spastor 0:fcaad0dfa051 72 if (_frm_buf[i].frame == frame) {
spastor 0:fcaad0dfa051 73 _frm_buf[i].status = FrameStatusComplete;
spastor 0:fcaad0dfa051 74 ret = true;
spastor 0:fcaad0dfa051 75 break;
spastor 0:fcaad0dfa051 76 }
spastor 0:fcaad0dfa051 77 }
spastor 0:fcaad0dfa051 78
spastor 0:fcaad0dfa051 79 return ret;
spastor 0:fcaad0dfa051 80 }
spastor 0:fcaad0dfa051 81
spastor 4:629712865107 82 ApiFrame *FrameBuffer::get_next_complete_frame(void)
spastor 0:fcaad0dfa051 83 {
spastor 4:629712865107 84 uint8_t i = _tail;
spastor 0:fcaad0dfa051 85 ApiFrame *ret = NULL;
spastor 4:629712865107 86
spastor 0:fcaad0dfa051 87 do {
spastor 0:fcaad0dfa051 88 disable_irq();
spastor 0:fcaad0dfa051 89 if (_frm_buf[i].status == FrameStatusComplete) {
spastor 0:fcaad0dfa051 90 _frm_buf[i].status = FrameStatusAssigned;
spastor 0:fcaad0dfa051 91 enable_irq();
spastor 0:fcaad0dfa051 92 ret = _frm_buf[i].frame;
spastor 4:629712865107 93 _tail = ++i % _size;
spastor 0:fcaad0dfa051 94 break;
spastor 0:fcaad0dfa051 95 }
spastor 0:fcaad0dfa051 96 enable_irq();
spastor 0:fcaad0dfa051 97 i++;
spastor 4:629712865107 98 i = i % _size;
spastor 4:629712865107 99 } while (i != _tail);
spastor 0:fcaad0dfa051 100
spastor 4:629712865107 101 return ret;
spastor 0:fcaad0dfa051 102 }
spastor 0:fcaad0dfa051 103
spastor 0:fcaad0dfa051 104 bool FrameBuffer::free_frame(ApiFrame *frame)
spastor 0:fcaad0dfa051 105 {
spastor 0:fcaad0dfa051 106 bool ret = false;
spastor 4:629712865107 107
spastor 4:629712865107 108 for (int i = 0; i < _size; i++) {
spastor 0:fcaad0dfa051 109 if (_frm_buf[i].frame == frame) {
spastor 0:fcaad0dfa051 110 _frm_buf[i].status = FrameStatusFree;
spastor 0:fcaad0dfa051 111 ret = true;
spastor 0:fcaad0dfa051 112 break;
spastor 0:fcaad0dfa051 113 }
spastor 0:fcaad0dfa051 114 }
spastor 0:fcaad0dfa051 115
spastor 0:fcaad0dfa051 116 return ret;
spastor 0:fcaad0dfa051 117 }
spastor 0:fcaad0dfa051 118
spastor 0:fcaad0dfa051 119 uint32_t FrameBuffer::get_dropped_frames_count(void)
spastor 0:fcaad0dfa051 120 {
spastor 0:fcaad0dfa051 121 const uint32_t dropped_frames = _dropped_frames;
spastor 0:fcaad0dfa051 122
spastor 0:fcaad0dfa051 123 _dropped_frames = 0;
spastor 0:fcaad0dfa051 124
spastor 0:fcaad0dfa051 125 return dropped_frames;
spastor 0:fcaad0dfa051 126 }