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/ZigbeeFrames.cpp@9:780db84ce891, 2016-07-29 (annotated)

Committer:
hbujanda
Date:
Fri Jul 29 13:10:07 2016 +0200
Revision:
9:780db84ce891
Parent:
6:06522f3a6642 
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 "ZigbeeFrames.h"
spastor 0:fcaad0dfa051 14
spastor 0:fcaad0dfa051 15 #define FRAME_ID_LEN 1
spastor 0:fcaad0dfa051 16 #define ADDR64_LEN 8
spastor 0:fcaad0dfa051 17 #define ADDR16_LEN 2
spastor 0:fcaad0dfa051 18 #define BROADCAST_RADIOUS_LEN 1
spastor 0:fcaad0dfa051 19 #define OPTIONS_LEN 1
spastor 0:fcaad0dfa051 20 #define TX_REQUEST_OVERHEAD (FRAME_ID_LEN + ADDR64_LEN + \
spastor 0:fcaad0dfa051 21 ADDR16_LEN + BROADCAST_RADIOUS_LEN + \
spastor 0:fcaad0dfa051 22 OPTIONS_LEN)
spastor 0:fcaad0dfa051 23 #define SOURCE_EP_LEN 1
spastor 0:fcaad0dfa051 24 #define DEST_EP_LEN 1
spastor 0:fcaad0dfa051 25 #define CLUSTER_ID_LEN 2
spastor 0:fcaad0dfa051 26 #define PROFILE_ID_LEN 2
spastor 0:fcaad0dfa051 27
spastor 0:fcaad0dfa051 28 #define EXP_ADDR_OVERHEAD (TX_REQUEST_OVERHEAD + SOURCE_EP_LEN + \
spastor 0:fcaad0dfa051 29 DEST_EP_LEN + CLUSTER_ID_LEN + \
spastor 0:fcaad0dfa051 30 PROFILE_ID_LEN)
spastor 0:fcaad0dfa051 31
spastor 0:fcaad0dfa051 32 /** Class constructor */
spastor 0:fcaad0dfa051 33 TxFrameZB::TxFrameZB(uint64_t addr, uint16_t addr16, uint8_t broadcast_rad, uint8_t tx_opt,
spastor 0:fcaad0dfa051 34 const uint8_t *const data, uint16_t len)
spastor 0:fcaad0dfa051 35 {
spastor 0:fcaad0dfa051 36 uint8_t frame_data[TX_REQUEST_OVERHEAD + len];
spastor 4:629712865107 37
spastor 0:fcaad0dfa051 38 _frame_id = get_next_frame_id();
spastor 0:fcaad0dfa051 39
spastor 0:fcaad0dfa051 40 /* copy the frame id, the 64bit remote address, the 16bit network address,
spastor 0:fcaad0dfa051 41 * the broad cast radious, the options byte and the frame data */
spastor 0:fcaad0dfa051 42
spastor 0:fcaad0dfa051 43 frame_data[0] = _frame_id;
spastor 0:fcaad0dfa051 44 rmemcpy(&frame_data[1], (const uint8_t *)&addr, sizeof addr);
spastor 0:fcaad0dfa051 45 frame_data[9] = (uint8_t)(addr16 >> 8);
spastor 0:fcaad0dfa051 46 frame_data[10] = (uint8_t)addr16;
spastor 0:fcaad0dfa051 47 frame_data[11] = broadcast_rad;
spastor 0:fcaad0dfa051 48 frame_data[12] = tx_opt;
spastor 4:629712865107 49
spastor 4:629712865107 50 if (len) {
spastor 0:fcaad0dfa051 51 memcpy(&frame_data[13], data, len);
spastor 4:629712865107 52 }
spastor 0:fcaad0dfa051 53
hbujanda 6:06522f3a6642 54 set_api_frame(TxReqZBDM, frame_data, TX_REQUEST_OVERHEAD + len);
spastor 0:fcaad0dfa051 55 }
spastor 0:fcaad0dfa051 56
spastor 0:fcaad0dfa051 57 /** Class constructor */
spastor 0:fcaad0dfa051 58 TxFrameZB::TxFrameZB(uint64_t addr, uint16_t addr16, uint8_t source_ep, uint8_t dest_ep,
spastor 4:629712865107 59 uint16_t cluster_id, uint16_t profile_id, uint8_t broadcast_rad,
spastor 0:fcaad0dfa051 60 uint8_t tx_opt, const uint8_t *const data, uint16_t len)
spastor 0:fcaad0dfa051 61 {
spastor 0:fcaad0dfa051 62 uint8_t frame_data[EXP_ADDR_OVERHEAD + len];
spastor 4:629712865107 63
spastor 0:fcaad0dfa051 64 _frame_id = get_next_frame_id();
spastor 0:fcaad0dfa051 65
spastor 0:fcaad0dfa051 66 /* copy the frame id, the 64bit remote address, the 16bit network address,
spastor 0:fcaad0dfa051 67 * the end point source and destination addresses, the cluster and profile IDs,
spastor 0:fcaad0dfa051 68 * the broad cast radious, the options byte and the frame data */
spastor 0:fcaad0dfa051 69
spastor 0:fcaad0dfa051 70 frame_data[0] = _frame_id;
spastor 0:fcaad0dfa051 71 rmemcpy(&frame_data[1], (const uint8_t *)&addr, sizeof addr);
spastor 0:fcaad0dfa051 72 frame_data[9] = (uint8_t)(addr16 >> 8);
spastor 0:fcaad0dfa051 73 frame_data[10] = (uint8_t)addr16;
spastor 0:fcaad0dfa051 74 frame_data[11] = source_ep;
spastor 0:fcaad0dfa051 75 frame_data[12] = dest_ep;
spastor 0:fcaad0dfa051 76 frame_data[13] = (uint8_t)(cluster_id >> 8);
spastor 0:fcaad0dfa051 77 frame_data[14] = (uint8_t)cluster_id;
spastor 0:fcaad0dfa051 78 frame_data[15] = (uint8_t)(profile_id >> 8);
spastor 0:fcaad0dfa051 79 frame_data[16] = (uint8_t)profile_id;
spastor 0:fcaad0dfa051 80 frame_data[17] = broadcast_rad;
spastor 0:fcaad0dfa051 81 frame_data[18] = tx_opt;
spastor 4:629712865107 82
spastor 4:629712865107 83 if (len) {
spastor 0:fcaad0dfa051 84 memcpy(&frame_data[19], data, len);
spastor 4:629712865107 85 }
spastor 0:fcaad0dfa051 86
spastor 0:fcaad0dfa051 87 set_api_frame(ExpAddrCmd, frame_data, EXP_ADDR_OVERHEAD + len);
spastor 0:fcaad0dfa051 88 }