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.h@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 #if !defined(__FRAME_BUFFER_H_)
spastor 0:fcaad0dfa051 14 #define __FRAME_BUFFER_H_
spastor 0:fcaad0dfa051 15
spastor 0:fcaad0dfa051 16 #include "config.h"
spastor 0:fcaad0dfa051 17 #include "mbed.h"
spastor 0:fcaad0dfa051 18 #include "Frames/ApiFrame.h"
spastor 0:fcaad0dfa051 19
spastor 0:fcaad0dfa051 20 #if FRAME_BUFFER_SIZE > 255
spastor 0:fcaad0dfa051 21 # error "FRAME_BUFFER_SIZE must be lower than 256"
spastor 0:fcaad0dfa051 22 #endif
spastor 0:fcaad0dfa051 23
spastor 0:fcaad0dfa051 24 typedef struct element {
spastor 0:fcaad0dfa051 25 ApiFrame *frame;
spastor 0:fcaad0dfa051 26 uint8_t status;
spastor 0:fcaad0dfa051 27 } buf_element_t;
spastor 0:fcaad0dfa051 28
spastor 0:fcaad0dfa051 29 /**
spastor 0:fcaad0dfa051 30 * @class FrameBuffer
spastor 0:fcaad0dfa051 31 * @brief storage class for incoming frames
spastor 0:fcaad0dfa051 32 */
spastor 0:fcaad0dfa051 33 class FrameBuffer
spastor 0:fcaad0dfa051 34 {
spastor 0:fcaad0dfa051 35 public:
spastor 0:fcaad0dfa051 36 /** Constructor */
spastor 0:fcaad0dfa051 37 FrameBuffer();
spastor 0:fcaad0dfa051 38
spastor 0:fcaad0dfa051 39 FrameBuffer(const FrameBuffer& other); /* Intentionally not implemented */
spastor 0:fcaad0dfa051 40 /** Destructor */
spastor 0:fcaad0dfa051 41 ~FrameBuffer();
spastor 0:fcaad0dfa051 42
spastor 0:fcaad0dfa051 43 /** get_next_free_frame returns the next free frame
spastor 0:fcaad0dfa051 44 *
spastor 0:fcaad0dfa051 45 * @returns a pointer to the next free frame */
spastor 0:fcaad0dfa051 46 ApiFrame *get_next_free_frame();
spastor 0:fcaad0dfa051 47
spastor 0:fcaad0dfa051 48 /** complete_frame sets the status of the frame to complete once the
spastor 0:fcaad0dfa051 49 * data has been set in the buffer.
spastor 0:fcaad0dfa051 50 *
spastor 0:fcaad0dfa051 51 * @param pointer to the buffer we want to set as complete
spastor 0:fcaad0dfa051 52 * @returns true on success, false otherwise
spastor 0:fcaad0dfa051 53 */
spastor 0:fcaad0dfa051 54 bool complete_frame(ApiFrame *frame);
spastor 0:fcaad0dfa051 55
spastor 0:fcaad0dfa051 56 /** free_frame makes the frame available to be reused in future
spastor 0:fcaad0dfa051 57 *
spastor 0:fcaad0dfa051 58 * @param frame to release */
spastor 0:fcaad0dfa051 59 bool free_frame(ApiFrame *frame);
spastor 0:fcaad0dfa051 60
spastor 0:fcaad0dfa051 61 /** get_next_complete_frame_app returns the pointer to the next complete frame using _tail_app
spastor 0:fcaad0dfa051 62 *
spastor 0:fcaad0dfa051 63 * @returns the pointer to the selected buffer
spastor 0:fcaad0dfa051 64 */
spastor 0:fcaad0dfa051 65 ApiFrame *get_next_complete_frame_app();
spastor 0:fcaad0dfa051 66
spastor 0:fcaad0dfa051 67 /** get_next_complete_frame_syncr returns the pointer to the next complete frame using _tail_syncr
spastor 0:fcaad0dfa051 68 *
spastor 0:fcaad0dfa051 69 * @returns the pointer to the selected buffer
spastor 0:fcaad0dfa051 70 */
spastor 0:fcaad0dfa051 71 ApiFrame *get_next_complete_frame_syncr();
spastor 0:fcaad0dfa051 72
spastor 0:fcaad0dfa051 73 /** get_dropped_frames_count returns the number of dropped frames since latest call to this method
spastor 0:fcaad0dfa051 74 *
spastor 0:fcaad0dfa051 75 * @returns the number of dropped frames since latest call to this method
spastor 0:fcaad0dfa051 76 */
spastor 0:fcaad0dfa051 77 uint32_t get_dropped_frames_count();
spastor 0:fcaad0dfa051 78
spastor 0:fcaad0dfa051 79
spastor 0:fcaad0dfa051 80 protected:
spastor 0:fcaad0dfa051 81
spastor 0:fcaad0dfa051 82 /** frame status */
spastor 0:fcaad0dfa051 83 enum FrameStatus {
spastor 0:fcaad0dfa051 84 FrameStatusFree = 0, /**< Free */
spastor 0:fcaad0dfa051 85 FrameStatusAssigned, /**< Assigned */
spastor 0:fcaad0dfa051 86 FrameStatusComplete /**< Complete */
spastor 0:fcaad0dfa051 87 };
spastor 0:fcaad0dfa051 88
spastor 0:fcaad0dfa051 89 /** buffer array */
spastor 0:fcaad0dfa051 90 buf_element_t _frm_buf[FRAME_BUFFER_SIZE];
spastor 0:fcaad0dfa051 91
spastor 0:fcaad0dfa051 92 /** head frame index */
spastor 0:fcaad0dfa051 93 uint8_t _head;
spastor 0:fcaad0dfa051 94
spastor 0:fcaad0dfa051 95 /** tail frame index for application */
spastor 0:fcaad0dfa051 96 uint8_t _tail_app;
spastor 0:fcaad0dfa051 97
spastor 0:fcaad0dfa051 98 /** tail frame index for syncronous operations */
spastor 0:fcaad0dfa051 99 uint8_t _tail_syncr;
spastor 0:fcaad0dfa051 100
spastor 0:fcaad0dfa051 101 /** dropped frames */
spastor 0:fcaad0dfa051 102 uint32_t _dropped_frames;
spastor 0:fcaad0dfa051 103
spastor 0:fcaad0dfa051 104 /** get_next_complete_frame returns the pointer to the next complete frame
spastor 0:fcaad0dfa051 105 *
spastor 0:fcaad0dfa051 106 * @param tail tail index to use (either _tail_app or _tail_syncr)
spastor 0:fcaad0dfa051 107 * @returns the pointer to the selected buffer
spastor 0:fcaad0dfa051 108 */
spastor 0:fcaad0dfa051 109 ApiFrame *get_next_complete_frame(uint8_t* tail);
spastor 0:fcaad0dfa051 110 };
spastor 0:fcaad0dfa051 111
spastor 0:fcaad0dfa051 112 #endif /* __FRAME_BUFFER_H_ */
spastor 0:fcaad0dfa051 113
spastor 0:fcaad0dfa051 114