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/DigiMeshFrames.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
hbujanda 6:06522f3a6642 1 /**
hbujanda 6:06522f3a6642 2 * Copyright (c) 2015 Digi International Inc.,
hbujanda 6:06522f3a6642 3 * All rights not expressly granted are reserved.
hbujanda 6:06522f3a6642 4 *
hbujanda 6:06522f3a6642 5 * This Source Code Form is subject to the terms of the Mozilla Public
hbujanda 6:06522f3a6642 6 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
hbujanda 6:06522f3a6642 7 * You can obtain one at http://mozilla.org/MPL/2.0/.
hbujanda 6:06522f3a6642 8 *
hbujanda 6:06522f3a6642 9 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
hbujanda 6:06522f3a6642 10 * =======================================================================
hbujanda 6:06522f3a6642 11 */
hbujanda 6:06522f3a6642 12
hbujanda 6:06522f3a6642 13 #include "DigiMeshFrames.h"
hbujanda 6:06522f3a6642 14
hbujanda 6:06522f3a6642 15 #define FRAME_ID_LEN 1
hbujanda 6:06522f3a6642 16 #define ADDR64_LEN 8
hbujanda 6:06522f3a6642 17 #define ADDR16_LEN 2
hbujanda 6:06522f3a6642 18 #define BROADCAST_RADIOUS_LEN 1
hbujanda 6:06522f3a6642 19 #define OPTIONS_LEN 1
hbujanda 6:06522f3a6642 20 #define TX_REQUEST_OVERHEAD (FRAME_ID_LEN + ADDR64_LEN + \
hbujanda 6:06522f3a6642 21 ADDR16_LEN + BROADCAST_RADIOUS_LEN + \
hbujanda 6:06522f3a6642 22 OPTIONS_LEN)
hbujanda 6:06522f3a6642 23 #define SOURCE_EP_LEN 1
hbujanda 6:06522f3a6642 24 #define DEST_EP_LEN 1
hbujanda 6:06522f3a6642 25 #define CLUSTER_ID_LEN 2
hbujanda 6:06522f3a6642 26 #define PROFILE_ID_LEN 2
hbujanda 6:06522f3a6642 27
hbujanda 6:06522f3a6642 28 #define EXP_ADDR_OVERHEAD (TX_REQUEST_OVERHEAD + SOURCE_EP_LEN + \
hbujanda 6:06522f3a6642 29 DEST_EP_LEN + CLUSTER_ID_LEN + \
hbujanda 6:06522f3a6642 30 PROFILE_ID_LEN)
hbujanda 6:06522f3a6642 31
hbujanda 6:06522f3a6642 32 /** Class constructor */
hbujanda 6:06522f3a6642 33 TxFrameDM::TxFrameDM(uint64_t addr, uint16_t addr16, uint8_t broadcast_rad, uint8_t tx_opt,
hbujanda 6:06522f3a6642 34 const uint8_t *const data, uint16_t len)
hbujanda 6:06522f3a6642 35 {
hbujanda 6:06522f3a6642 36 uint8_t frame_data[TX_REQUEST_OVERHEAD + len];
hbujanda 6:06522f3a6642 37
hbujanda 6:06522f3a6642 38 _frame_id = get_next_frame_id();
hbujanda 6:06522f3a6642 39
hbujanda 6:06522f3a6642 40 /* copy the frame id, the 64bit remote address, the 16bit network address,
hbujanda 6:06522f3a6642 41 * the broad cast radious, the options byte and the frame data */
hbujanda 6:06522f3a6642 42
hbujanda 6:06522f3a6642 43 frame_data[0] = _frame_id;
hbujanda 6:06522f3a6642 44 rmemcpy(&frame_data[1], (const uint8_t *)&addr, sizeof addr);
hbujanda 6:06522f3a6642 45 frame_data[9] = (uint8_t)(addr16 >> 8);
hbujanda 6:06522f3a6642 46 frame_data[10] = (uint8_t)addr16;
hbujanda 6:06522f3a6642 47 frame_data[11] = broadcast_rad;
hbujanda 6:06522f3a6642 48 frame_data[12] = tx_opt;
hbujanda 6:06522f3a6642 49
hbujanda 6:06522f3a6642 50 if (len) {
hbujanda 6:06522f3a6642 51 memcpy(&frame_data[13], data, len);
hbujanda 6:06522f3a6642 52 }
hbujanda 6:06522f3a6642 53
hbujanda 6:06522f3a6642 54 set_api_frame(TxReqZBDM, frame_data, TX_REQUEST_OVERHEAD + len);
hbujanda 6:06522f3a6642 55 }
hbujanda 6:06522f3a6642 56
hbujanda 6:06522f3a6642 57 /** Class constructor */
hbujanda 6:06522f3a6642 58 TxFrameDM::TxFrameDM(uint64_t addr, uint16_t addr16, uint8_t source_ep, uint8_t dest_ep,
hbujanda 6:06522f3a6642 59 uint16_t cluster_id, uint16_t profile_id, uint8_t broadcast_rad,
hbujanda 6:06522f3a6642 60 uint8_t tx_opt, const uint8_t *const data, uint16_t len)
hbujanda 6:06522f3a6642 61 {
hbujanda 6:06522f3a6642 62 uint8_t frame_data[EXP_ADDR_OVERHEAD + len];
hbujanda 6:06522f3a6642 63
hbujanda 6:06522f3a6642 64 _frame_id = get_next_frame_id();
hbujanda 6:06522f3a6642 65
hbujanda 6:06522f3a6642 66 /* copy the frame id, the 64bit remote address, the 16bit network address,
hbujanda 6:06522f3a6642 67 * the end point source and destination addresses, the cluster and profile IDs,
hbujanda 6:06522f3a6642 68 * the broad cast radious, the options byte and the frame data */
hbujanda 6:06522f3a6642 69
hbujanda 6:06522f3a6642 70 frame_data[0] = _frame_id;
hbujanda 6:06522f3a6642 71 rmemcpy(&frame_data[1], (const uint8_t *)&addr, sizeof addr);
hbujanda 6:06522f3a6642 72 frame_data[9] = (uint8_t)(addr16 >> 8);
hbujanda 6:06522f3a6642 73 frame_data[10] = (uint8_t)addr16;
hbujanda 6:06522f3a6642 74 frame_data[11] = source_ep;
hbujanda 6:06522f3a6642 75 frame_data[12] = dest_ep;
hbujanda 6:06522f3a6642 76 frame_data[13] = (uint8_t)(cluster_id >> 8);
hbujanda 6:06522f3a6642 77 frame_data[14] = (uint8_t)cluster_id;
hbujanda 6:06522f3a6642 78 frame_data[15] = (uint8_t)(profile_id >> 8);
hbujanda 6:06522f3a6642 79 frame_data[16] = (uint8_t)profile_id;
hbujanda 6:06522f3a6642 80 frame_data[17] = broadcast_rad;
hbujanda 6:06522f3a6642 81 frame_data[18] = tx_opt;
hbujanda 6:06522f3a6642 82
hbujanda 6:06522f3a6642 83 if (len) {
hbujanda 6:06522f3a6642 84 memcpy(&frame_data[19], data, len);
hbujanda 6:06522f3a6642 85 }
hbujanda 6:06522f3a6642 86
hbujanda 6:06522f3a6642 87 set_api_frame(ExpAddrCmd, frame_data, EXP_ADDR_OVERHEAD + len);
hbujanda 6:06522f3a6642 88 }