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@0:fcaad0dfa051, 2015-05-08 (annotated)

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