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/AtCmdFrame.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 0:fcaad0dfa051 12
spastor 0:fcaad0dfa051 13 #include "mbed.h"
spastor 0:fcaad0dfa051 14 #include "Utils/Debug.h"
spastor 0:fcaad0dfa051 15 #include "AtCmdFrame.h"
spastor 0:fcaad0dfa051 16
spastor 0:fcaad0dfa051 17 #define AT_CMD_LEN 2
spastor 0:fcaad0dfa051 18 #define AT_CMD_ID_LEN 1
spastor 0:fcaad0dfa051 19
spastor 0:fcaad0dfa051 20 void AtCmdFrame::build_at_cmd_frame(const char *cmd, const uint8_t *cmd_params, uint8_t payload_len, bool reverse)
spastor 0:fcaad0dfa051 21 {
spastor 0:fcaad0dfa051 22 uint8_t frame_data[AT_CMD_LEN + AT_CMD_ID_LEN + payload_len];
spastor 4:629712865107 23
spastor 0:fcaad0dfa051 24 frame_data[0] = _frame_id;
spastor 0:fcaad0dfa051 25 frame_data[1] = cmd[0];
spastor 0:fcaad0dfa051 26 frame_data[2] = cmd[1];
spastor 0:fcaad0dfa051 27 if (payload_len) {
spastor 0:fcaad0dfa051 28 if (reverse) {
spastor 0:fcaad0dfa051 29 rmemcpy(&frame_data[3], cmd_params, payload_len);
spastor 0:fcaad0dfa051 30 } else {
spastor 0:fcaad0dfa051 31 memcpy(&frame_data[3], cmd_params, payload_len);
spastor 0:fcaad0dfa051 32 }
spastor 0:fcaad0dfa051 33 }
spastor 0:fcaad0dfa051 34
spastor 0:fcaad0dfa051 35 set_api_frame(AtCmd, frame_data, AT_CMD_LEN + AT_CMD_ID_LEN + payload_len);
spastor 0:fcaad0dfa051 36 }
spastor 0:fcaad0dfa051 37
spastor 0:fcaad0dfa051 38 AtCmdFrame::AtCmdFrame(const char * const cmd, uint32_t cmd_param)
spastor 0:fcaad0dfa051 39 {
spastor 0:fcaad0dfa051 40 assert(cmd != NULL);
spastor 0:fcaad0dfa051 41 assert(strlen(cmd) == AT_CMD_LEN);
spastor 0:fcaad0dfa051 42
spastor 0:fcaad0dfa051 43 uint8_t len;
spastor 0:fcaad0dfa051 44 if (cmd_param <= 0xFF) {
spastor 0:fcaad0dfa051 45 len = 1;
spastor 0:fcaad0dfa051 46 } else if (cmd_param <= 0xFFFF) {
spastor 0:fcaad0dfa051 47 len = 2;
spastor 0:fcaad0dfa051 48 } else if (cmd_param <= 0xFFFFFF) {
spastor 0:fcaad0dfa051 49 len = 3;
spastor 0:fcaad0dfa051 50 } else {
spastor 0:fcaad0dfa051 51 len = 4;
spastor 0:fcaad0dfa051 52 }
spastor 0:fcaad0dfa051 53 build_at_cmd_frame(cmd, (uint8_t *)&cmd_param, len);
spastor 0:fcaad0dfa051 54 }
spastor 0:fcaad0dfa051 55
spastor 0:fcaad0dfa051 56 AtCmdFrame::AtCmdFrame(const char * const cmd, const uint8_t * cmd_param, uint16_t param_len)
spastor 0:fcaad0dfa051 57 {
spastor 0:fcaad0dfa051 58 assert(cmd != NULL);
spastor 0:fcaad0dfa051 59 assert(strlen(cmd) == AT_CMD_LEN);
spastor 0:fcaad0dfa051 60
spastor 0:fcaad0dfa051 61 build_at_cmd_frame(cmd, cmd_param, param_len, false);
spastor 0:fcaad0dfa051 62 }
spastor 0:fcaad0dfa051 63
spastor 0:fcaad0dfa051 64 AtCmdFrame::AtCmdFrame(uint64_t remote, const char * const cmd, uint32_t cmd_param)
spastor 0:fcaad0dfa051 65 {
spastor 0:fcaad0dfa051 66 assert(cmd != NULL);
spastor 0:fcaad0dfa051 67 assert(strlen(cmd) == AT_CMD_LEN);
spastor 4:629712865107 68
spastor 0:fcaad0dfa051 69 build_at_cmd_remote_frame(remote, ADDR16_UNKNOWN, cmd, (uint8_t *)&cmd_param, 4);
spastor 0:fcaad0dfa051 70 }
spastor 0:fcaad0dfa051 71
spastor 0:fcaad0dfa051 72 AtCmdFrame::AtCmdFrame(uint64_t remote, const char * const cmd, const uint8_t * cmd_param, uint16_t param_len)
spastor 0:fcaad0dfa051 73 {
spastor 0:fcaad0dfa051 74 assert(cmd != NULL);
spastor 0:fcaad0dfa051 75 assert(strlen(cmd) == AT_CMD_LEN);
spastor 0:fcaad0dfa051 76
spastor 0:fcaad0dfa051 77 build_at_cmd_remote_frame(remote, ADDR16_UNKNOWN, cmd, cmd_param, param_len, false);
spastor 0:fcaad0dfa051 78 }
spastor 0:fcaad0dfa051 79
spastor 0:fcaad0dfa051 80 AtCmdFrame::AtCmdFrame(uint16_t remote, const char * const cmd, uint32_t cmd_param)
spastor 0:fcaad0dfa051 81 {
spastor 0:fcaad0dfa051 82 assert(cmd != NULL);
spastor 0:fcaad0dfa051 83 assert(strlen(cmd) == AT_CMD_LEN);
spastor 4:629712865107 84
spastor 0:fcaad0dfa051 85 build_at_cmd_remote_frame(ADDR64_UNASSIGNED, remote, cmd, (uint8_t *)&cmd_param, 4);
spastor 0:fcaad0dfa051 86 }
spastor 0:fcaad0dfa051 87
spastor 0:fcaad0dfa051 88 AtCmdFrame::AtCmdFrame(uint16_t remote, const char * const cmd, const uint8_t * cmd_param, uint16_t param_len)
spastor 0:fcaad0dfa051 89 {
spastor 0:fcaad0dfa051 90 assert(cmd != NULL);
spastor 0:fcaad0dfa051 91 assert(strlen(cmd) == AT_CMD_LEN);
spastor 0:fcaad0dfa051 92
spastor 0:fcaad0dfa051 93 build_at_cmd_remote_frame(ADDR64_UNASSIGNED, remote, cmd, cmd_param, param_len, false);
spastor 0:fcaad0dfa051 94 }
spastor 0:fcaad0dfa051 95
spastor 0:fcaad0dfa051 96 AtCmdFrame::AtCmdFrame(uint64_t remote64, uint16_t remote16, const char * const cmd, uint32_t cmd_param)
spastor 0:fcaad0dfa051 97 {
spastor 0:fcaad0dfa051 98 assert(cmd != NULL);
spastor 0:fcaad0dfa051 99 assert(strlen(cmd) == AT_CMD_LEN);
spastor 4:629712865107 100
spastor 0:fcaad0dfa051 101 build_at_cmd_remote_frame(remote64, remote16, cmd, (uint8_t *)&cmd_param, 4);
spastor 0:fcaad0dfa051 102 }
spastor 0:fcaad0dfa051 103
spastor 0:fcaad0dfa051 104 AtCmdFrame::AtCmdFrame(uint64_t remote64, uint16_t remote16, const char * const cmd,
spastor 0:fcaad0dfa051 105 const uint8_t * cmd_param, uint16_t param_len)
spastor 0:fcaad0dfa051 106 {
spastor 0:fcaad0dfa051 107 assert(cmd != NULL);
spastor 0:fcaad0dfa051 108 assert(strlen(cmd) == AT_CMD_LEN);
spastor 0:fcaad0dfa051 109
spastor 0:fcaad0dfa051 110 build_at_cmd_remote_frame(remote64, remote16, cmd, cmd_param, param_len, false);
spastor 0:fcaad0dfa051 111 }
spastor 0:fcaad0dfa051 112
spastor 0:fcaad0dfa051 113 #define FRAME_ID_LEN 1
spastor 0:fcaad0dfa051 114 #define ADDR64_LEN 8
spastor 0:fcaad0dfa051 115 #define ADDR16_LEN 2
spastor 0:fcaad0dfa051 116 #define OPTIONS_LEN 1
spastor 0:fcaad0dfa051 117 #define AT_CMD_LEN 2
spastor 0:fcaad0dfa051 118 #define REM_AT_CMD_OVERHEAD (FRAME_ID_LEN + ADDR64_LEN + \
spastor 0:fcaad0dfa051 119 ADDR16_LEN + OPTIONS_LEN + \
spastor 0:fcaad0dfa051 120 AT_CMD_LEN)
spastor 0:fcaad0dfa051 121
spastor 0:fcaad0dfa051 122 void AtCmdFrame::build_at_cmd_remote_frame(uint64_t remote64, uint16_t remote16,
spastor 0:fcaad0dfa051 123 const char *const cmd, const uint8_t *const cmd_params, uint8_t params_len, bool reverse)
spastor 0:fcaad0dfa051 124 {
spastor 0:fcaad0dfa051 125 uint8_t frame_data[REM_AT_CMD_OVERHEAD + params_len];
spastor 4:629712865107 126
spastor 0:fcaad0dfa051 127 /* copy the frame id, the 64bit remote address, the 16bit network address,
spastor 0:fcaad0dfa051 128 * the options byte, the command and the command params */
spastor 0:fcaad0dfa051 129
spastor 0:fcaad0dfa051 130 frame_data[0] = _frame_id;
spastor 0:fcaad0dfa051 131 rmemcpy(&frame_data[1], (const uint8_t *)&remote64, sizeof remote64);
spastor 0:fcaad0dfa051 132 frame_data[9] = (uint8_t)(remote16 >> 8);
spastor 0:fcaad0dfa051 133 frame_data[10] = (uint8_t)remote16;
spastor 0:fcaad0dfa051 134 frame_data[11] = 0x02; /* TODO Options */
spastor 0:fcaad0dfa051 135 frame_data[12] = cmd[0];
spastor 0:fcaad0dfa051 136 frame_data[13] = cmd[1];
spastor 4:629712865107 137
spastor 0:fcaad0dfa051 138 if (params_len) {
spastor 0:fcaad0dfa051 139 if (reverse) {
spastor 0:fcaad0dfa051 140 rmemcpy(&frame_data[14], cmd_params, params_len);
spastor 0:fcaad0dfa051 141 } else {
spastor 0:fcaad0dfa051 142 memcpy(&frame_data[14], cmd_params, params_len);
spastor 0:fcaad0dfa051 143 }
spastor 0:fcaad0dfa051 144 }
spastor 0:fcaad0dfa051 145
spastor 0:fcaad0dfa051 146 set_api_frame(RemoteCmdReq, frame_data, REM_AT_CMD_OVERHEAD + params_len);
spastor 0:fcaad0dfa051 147 }