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

Import programXBeeZB_Send_Data

ZigBee Send Data example for mbed XBeeLib By Digi

Import programXBeeZB_module_config

ZigBee network configuration example for mbed XBeeLib By Digi

Import programXBeeZB_AT_Commands

ZigBee AT Commands example for mbed XBeeLib By Digi

Import programXBeeZB_dio_adc

ZigBee DIOs and ADCs example for mbed XBeeLib By Digi

Import programXBeeZB_IO_Sample_Callback

ZigBee IO Sampling Callback example for mbed XBeeLib By Digi

Import programXBeeZB_modem_status

ZigBee Modem Status example for mbed XBeeLib By Digi

Import programXBeeZB_node_discovery

ZigBee Node Discovery example for mbed XBeeLib By Digi

Import programXBeeZB_power_mngmnt_cyclic_sleep

ZigBee Power Management using Cyclic Sleep example for mbed XBeeLib By Digi

Import programXBeeZB_power_mngmnt_pin_sleep

ZigBee Power Management using Pin Sleep example for mbed XBeeLib By Digi

Examples for 802.15.4 modules

Import programXBee802_Receive_Data

802.15.4 Receive Data example for mbed XBeeLib By Digi

Import programXBee802_Send_Data

802.15.4 Send Data example for mbed XBeeLib By Digi

Import programXBee802_module_config

802.15.4 network configuration example for mbed XBeeLib By Digi

Import programXBee802_AT_Commands

802.15.4 AT Commands example for mbed XBeeLib By Digi

Import programXBee802_dio_adc_pwm

802.15.4 DIOs, ADCs and PWM example for mbed XBeeLib By Digi

Import programXBee802_IO_Sample_Callback

802.15.4 IO Sampling Callback example for mbed XBeeLib By Digi

Import programXBee802_node_discovery

802.15.4 Node Discovery example for mbed XBeeLib By Digi

Import programXBee802_power_mngmnt_cyclic_sleep

802.15.4 Power Management using Cyclic Sleep example for mbed XBeeLib By Digi

Import programXBee802_power_mngmnt_pin_sleep

802.15.4 Power Management using Pin Sleep example for mbed XBeeLib By Digi

Examples for DigiMesh modules

Import programXBeeDM_Receive_Data

DigiMesh Receive Data example for mbed XBeeLib By Digi

Import programXBeeDM_Send_Data

DigiMesh Send Data example for mbed XBeeLib By Digi

Import programXBeeDM_module_config

DigiMesh network configuration example for mbed XBeeLib By Digi

Import programXBeeDM_AT_Commands

DigiMesh AT Commands example for mbed XBeeLib By Digi

Import programXBeeDM_dio_adc_pwm

DigiMEsh DIOs, ADCs and PWMs example for mbed XBeeLib By Digi

Import programXBeeDM_IO_Sample_Callback

DigiMesh IO Sampling Callback example for mbed XBeeLib By Digi

Import programXBeeDM_modem_status

DigiMesh Modem Status example for mbed XBeeLib By Digi

Import programXBeeDM_node_discovery

DigiMesh Node Discovery example for mbed XBeeLib By Digi

Import programXBeeDM_power_mngmnt_asyncr_cyclic_sleep

DigiMesh Power Management using Asynchronous Cyclic Sleep example for mbed XBeeLib By Digi

Import programXBeeDM_power_mngmnt_pin_sleep

DigiMesh Power Management using Pin Sleep example for mbed XBeeLib By Digi

Committer:
spastor
Date:
Mon Jun 01 18:59:43 2015 +0200
Revision:
4:629712865107
Parent:
3:8662ebe83570
Child:
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 #include "XBee802.h"
spastor 0:fcaad0dfa051 13 #include "IO/IOSample802.h"
spastor 0:fcaad0dfa051 14 #include "Frames/802_Frames.h"
spastor 0:fcaad0dfa051 15 #include "FrameHandlers/FH_ModemStatus.h"
spastor 0:fcaad0dfa051 16
spastor 0:fcaad0dfa051 17 using namespace XBeeLib;
spastor 0:fcaad0dfa051 18
spastor 0:fcaad0dfa051 19 /* Class constructor */
spastor 0:fcaad0dfa051 20 XBee802::XBee802(PinName tx, PinName rx, PinName reset, PinName rts, PinName cts, int baud) :
spastor 0:fcaad0dfa051 21 XBee(tx, rx, reset, rts, cts, baud),
spastor 4:629712865107 22 _nd_handler(NULL), _rx_64b_handler(NULL), _rx_16b_handler(NULL),
spastor 0:fcaad0dfa051 23 _io_data_64b_handler(NULL), _io_data_16b_handler(NULL)
spastor 0:fcaad0dfa051 24 {
spastor 0:fcaad0dfa051 25
spastor 0:fcaad0dfa051 26 }
spastor 0:fcaad0dfa051 27
spastor 0:fcaad0dfa051 28 /* Class destructor */
spastor 0:fcaad0dfa051 29 XBee802::~XBee802()
spastor 0:fcaad0dfa051 30 {
spastor 0:fcaad0dfa051 31 unregister_node_discovery_cb();
spastor 0:fcaad0dfa051 32 unregister_receive_cb();
spastor 0:fcaad0dfa051 33 unregister_io_sample_cb();
spastor 0:fcaad0dfa051 34 }
spastor 0:fcaad0dfa051 35
spastor 0:fcaad0dfa051 36 RadioStatus XBee802::init()
spastor 0:fcaad0dfa051 37 {
spastor 0:fcaad0dfa051 38 RadioStatus retval = XBee::init();
spastor 4:629712865107 39 uint16_t addr16;
spastor 4:629712865107 40 RadioStatus error = get_network_address(&addr16);
spastor 4:629712865107 41 if (error == Success) {
spastor 4:629712865107 42 digi_log(LogLevelInfo, "ADDR16: %04x\r\n", addr16);
spastor 4:629712865107 43 } else {
spastor 4:629712865107 44 digi_log(LogLevelInfo, "ADDR16: UNKNOWN\r\n");
spastor 4:629712865107 45 }
spastor 4:629712865107 46
spastor 0:fcaad0dfa051 47 const RadioProtocol radioProtocol = get_radio_protocol();
spastor 0:fcaad0dfa051 48 if (radioProtocol != Raw_802_15_4) {
spastor 0:fcaad0dfa051 49 digi_log(LogLevelError, "Radio protocol does not match, needed a %d got a %d\r\n", Raw_802_15_4, radioProtocol);
spastor 0:fcaad0dfa051 50 retval = Failure;
spastor 0:fcaad0dfa051 51 }
spastor 0:fcaad0dfa051 52 assert(radioProtocol == Raw_802_15_4);
spastor 0:fcaad0dfa051 53
spastor 0:fcaad0dfa051 54 return retval;
spastor 0:fcaad0dfa051 55 }
spastor 0:fcaad0dfa051 56
spastor 0:fcaad0dfa051 57 RadioStatus XBee802::set_channel(uint8_t channel)
spastor 0:fcaad0dfa051 58 {
spastor 0:fcaad0dfa051 59 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 60
spastor 0:fcaad0dfa051 61 if (is_PRO()) {
spastor 0:fcaad0dfa051 62 if (channel < 0x0C || channel > 0x17) {
spastor 0:fcaad0dfa051 63 return Failure;
spastor 0:fcaad0dfa051 64 }
spastor 0:fcaad0dfa051 65 } else {
spastor 0:fcaad0dfa051 66 if (channel < 0x0B || channel > 0x1A) {
spastor 0:fcaad0dfa051 67 return Failure;
spastor 0:fcaad0dfa051 68 }
spastor 0:fcaad0dfa051 69 }
spastor 0:fcaad0dfa051 70
spastor 0:fcaad0dfa051 71 cmdresp = set_param("CH", channel);
spastor 0:fcaad0dfa051 72 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 73 return Failure;
spastor 0:fcaad0dfa051 74 }
spastor 0:fcaad0dfa051 75 return Success;
spastor 0:fcaad0dfa051 76 }
spastor 0:fcaad0dfa051 77
spastor 0:fcaad0dfa051 78 RadioStatus XBee802::get_channel(uint8_t * const channel)
spastor 0:fcaad0dfa051 79 {
spastor 0:fcaad0dfa051 80 if (channel == NULL) {
spastor 0:fcaad0dfa051 81 return Failure;
spastor 0:fcaad0dfa051 82 }
spastor 0:fcaad0dfa051 83 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 84
spastor 0:fcaad0dfa051 85 uint32_t var32;
spastor 0:fcaad0dfa051 86 cmdresp = get_param("CH", &var32);
spastor 4:629712865107 87 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 88 return Failure;
spastor 4:629712865107 89 }
spastor 0:fcaad0dfa051 90 *channel = var32;
spastor 0:fcaad0dfa051 91 return Success;
spastor 0:fcaad0dfa051 92 }
spastor 0:fcaad0dfa051 93
spastor 0:fcaad0dfa051 94 RadioStatus XBee802::set_panid(uint16_t panid)
spastor 0:fcaad0dfa051 95 {
spastor 0:fcaad0dfa051 96 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 97
spastor 0:fcaad0dfa051 98 cmdresp = set_param("ID", panid);
spastor 0:fcaad0dfa051 99 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 100 return Failure;
spastor 0:fcaad0dfa051 101 }
spastor 0:fcaad0dfa051 102 return Success;
spastor 0:fcaad0dfa051 103 }
spastor 0:fcaad0dfa051 104
spastor 0:fcaad0dfa051 105 RadioStatus XBee802::get_panid(uint16_t * const panid)
spastor 0:fcaad0dfa051 106 {
spastor 0:fcaad0dfa051 107 if (panid == NULL) {
spastor 0:fcaad0dfa051 108 return Failure;
spastor 0:fcaad0dfa051 109 }
spastor 0:fcaad0dfa051 110 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 111
spastor 0:fcaad0dfa051 112 uint32_t var32;
spastor 0:fcaad0dfa051 113 cmdresp = get_param("ID", &var32);
spastor 4:629712865107 114 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 115 return Failure;
spastor 4:629712865107 116 }
spastor 0:fcaad0dfa051 117 *panid = var32;
spastor 0:fcaad0dfa051 118 return Success;
spastor 0:fcaad0dfa051 119 }
spastor 0:fcaad0dfa051 120
spastor 0:fcaad0dfa051 121 RadioStatus XBee802::set_network_address(uint16_t addr16)
spastor 0:fcaad0dfa051 122 {
spastor 0:fcaad0dfa051 123 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 124
spastor 0:fcaad0dfa051 125 cmdresp = set_param("MY", addr16);
spastor 0:fcaad0dfa051 126 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 127 return Failure;
spastor 0:fcaad0dfa051 128 }
spastor 0:fcaad0dfa051 129 return Success;
spastor 0:fcaad0dfa051 130 }
spastor 0:fcaad0dfa051 131
spastor 0:fcaad0dfa051 132 void XBee802::radio_status_update(AtCmdFrame::ModemStatus modem_status)
spastor 0:fcaad0dfa051 133 {
spastor 0:fcaad0dfa051 134 /* Update the radio status variables */
spastor 4:629712865107 135 if (modem_status == AtCmdFrame::HwReset) {
spastor 0:fcaad0dfa051 136 _hw_reset_cnt++;
spastor 4:629712865107 137 } else if (modem_status == AtCmdFrame::WdReset) {
spastor 0:fcaad0dfa051 138 _wd_reset_cnt++;
spastor 4:629712865107 139 }
spastor 0:fcaad0dfa051 140
spastor 0:fcaad0dfa051 141 _modem_status = modem_status;
spastor 4:629712865107 142
spastor 0:fcaad0dfa051 143 digi_log(LogLevelDebug, "\r\nUpdating radio status: %02x\r\n", modem_status);
spastor 0:fcaad0dfa051 144 }
spastor 0:fcaad0dfa051 145
spastor 3:8662ebe83570 146 TxStatus XBee802::send_data(const RemoteXBee& remote, const uint8_t *const data, uint16_t len, bool syncr)
spastor 0:fcaad0dfa051 147 {
spastor 0:fcaad0dfa051 148 if (remote.is_valid_addr64b()) {
spastor 0:fcaad0dfa051 149 const uint64_t remote64 = remote.get_addr64();
spastor 0:fcaad0dfa051 150
spastor 0:fcaad0dfa051 151 digi_log(LogLevelDebug, "send_data ADDR64: %08x:%08x\r\n", UINT64_HI32(remote64), UINT64_LO32(remote64));
spastor 0:fcaad0dfa051 152
spastor 0:fcaad0dfa051 153 TxFrame802 frame = TxFrame802(remote64, _tx_options, data, len);
spastor 0:fcaad0dfa051 154
spastor 3:8662ebe83570 155 if (syncr) {
spastor 3:8662ebe83570 156 return send_data(&frame);
spastor 3:8662ebe83570 157 } else {
spastor 3:8662ebe83570 158 frame.set_data(0, 0); /* Set frame id to 0 so there is no answer */
spastor 3:8662ebe83570 159 send_api_frame(&frame);
spastor 3:8662ebe83570 160 return TxStatusSuccess;
spastor 3:8662ebe83570 161 }
spastor 0:fcaad0dfa051 162 }
spastor 0:fcaad0dfa051 163
spastor 0:fcaad0dfa051 164 if (remote.is_valid_addr16b()) {
spastor 0:fcaad0dfa051 165 const uint16_t remote16 = remote.get_addr16();
spastor 0:fcaad0dfa051 166
spastor 0:fcaad0dfa051 167 digi_log(LogLevelDebug, "send_data ADDR16: %04x\r\n", remote16);
spastor 0:fcaad0dfa051 168
spastor 0:fcaad0dfa051 169 TxFrame802 frame = TxFrame802(remote16, _tx_options, data, len);
spastor 0:fcaad0dfa051 170
spastor 3:8662ebe83570 171 if (syncr) {
spastor 3:8662ebe83570 172 return send_data(&frame);
spastor 3:8662ebe83570 173 } else {
spastor 3:8662ebe83570 174 frame.set_data(0, 0); /* Set frame id to 0 so there is no answer */
spastor 3:8662ebe83570 175 send_api_frame(&frame);
spastor 3:8662ebe83570 176 return TxStatusSuccess;
spastor 3:8662ebe83570 177 }
hbujanda 2:2ee1b6d51df2 178 }
hbujanda 2:2ee1b6d51df2 179
hbujanda 2:2ee1b6d51df2 180 return TxStatusInvalidAddr;
hbujanda 1:794d1d3e4a08 181 }
hbujanda 1:794d1d3e4a08 182
spastor 4:629712865107 183 XBee802::AssocStatus XBee802::get_assoc_status(void)
spastor 4:629712865107 184 {
spastor 4:629712865107 185 return (AssocStatus)get_AI();
spastor 4:629712865107 186 }
spastor 4:629712865107 187
hbujanda 2:2ee1b6d51df2 188 RemoteXBee802 XBee802::get_remote_node_by_id(const char * const node_id)
hbujanda 1:794d1d3e4a08 189 {
hbujanda 2:2ee1b6d51df2 190 uint64_t addr64;
hbujanda 2:2ee1b6d51df2 191 uint16_t addr16;
spastor 4:629712865107 192
hbujanda 2:2ee1b6d51df2 193 _get_remote_node_by_id(node_id, &addr64, &addr16);
hbujanda 2:2ee1b6d51df2 194 return RemoteXBee802(addr64, addr16);
spastor 0:fcaad0dfa051 195 }
spastor 0:fcaad0dfa051 196
spastor 0:fcaad0dfa051 197 void XBee802::register_node_discovery_cb(node_discovery_802_cb_t function)
spastor 0:fcaad0dfa051 198 {
spastor 0:fcaad0dfa051 199 if (_nd_handler == NULL) {
spastor 0:fcaad0dfa051 200 _nd_handler = new FH_NodeDiscovery802();
spastor 0:fcaad0dfa051 201 register_frame_handler(_nd_handler);
spastor 0:fcaad0dfa051 202 }
spastor 0:fcaad0dfa051 203 _nd_handler->register_node_discovery_cb(function);
spastor 0:fcaad0dfa051 204 }
spastor 0:fcaad0dfa051 205
spastor 0:fcaad0dfa051 206 void XBee802::unregister_node_discovery_cb()
spastor 0:fcaad0dfa051 207 {
spastor 0:fcaad0dfa051 208 if (_nd_handler != NULL) {
spastor 0:fcaad0dfa051 209 _nd_handler->unregister_node_discovery_cb();
spastor 0:fcaad0dfa051 210 unregister_frame_handler(_nd_handler);
spastor 0:fcaad0dfa051 211 delete _nd_handler;
spastor 0:fcaad0dfa051 212 _nd_handler = NULL; /* as delete does not set to NULL */
spastor 0:fcaad0dfa051 213 }
spastor 0:fcaad0dfa051 214 }
spastor 0:fcaad0dfa051 215
spastor 0:fcaad0dfa051 216 void XBee802::register_receive_cb(receive_802_cb_t function)
spastor 0:fcaad0dfa051 217 {
spastor 0:fcaad0dfa051 218 if (_rx_64b_handler == NULL) {
spastor 0:fcaad0dfa051 219 _rx_64b_handler = new FH_RxPacket64b802();
spastor 0:fcaad0dfa051 220 register_frame_handler(_rx_64b_handler);
spastor 0:fcaad0dfa051 221 }
spastor 0:fcaad0dfa051 222 _rx_64b_handler->register_receive_cb(function);
spastor 0:fcaad0dfa051 223
spastor 0:fcaad0dfa051 224 if (_rx_16b_handler == NULL) {
spastor 0:fcaad0dfa051 225 _rx_16b_handler = new FH_RxPacket16b802();
spastor 0:fcaad0dfa051 226 register_frame_handler(_rx_16b_handler);
spastor 0:fcaad0dfa051 227 }
spastor 0:fcaad0dfa051 228 _rx_16b_handler->register_receive_cb(function);
spastor 0:fcaad0dfa051 229 }
spastor 0:fcaad0dfa051 230
spastor 0:fcaad0dfa051 231 void XBee802::unregister_receive_cb()
spastor 0:fcaad0dfa051 232 {
spastor 0:fcaad0dfa051 233 if (_rx_64b_handler != NULL) {
spastor 0:fcaad0dfa051 234 _rx_64b_handler->unregister_receive_cb();
spastor 0:fcaad0dfa051 235 unregister_frame_handler(_rx_64b_handler);
spastor 0:fcaad0dfa051 236 delete _rx_64b_handler;
spastor 0:fcaad0dfa051 237 _rx_64b_handler = NULL; /* as delete does not set to NULL */
spastor 0:fcaad0dfa051 238 }
spastor 0:fcaad0dfa051 239
spastor 0:fcaad0dfa051 240 if (_rx_16b_handler != NULL) {
spastor 0:fcaad0dfa051 241 _rx_16b_handler->unregister_receive_cb();
spastor 0:fcaad0dfa051 242 unregister_frame_handler(_rx_16b_handler);
spastor 0:fcaad0dfa051 243 delete _rx_16b_handler;
spastor 0:fcaad0dfa051 244 _rx_16b_handler = NULL; /* as delete does not set to NULL */
spastor 0:fcaad0dfa051 245 }
spastor 0:fcaad0dfa051 246 }
spastor 0:fcaad0dfa051 247
spastor 0:fcaad0dfa051 248 void XBee802::register_io_sample_cb(io_data_cb_802_t function)
spastor 0:fcaad0dfa051 249 {
spastor 0:fcaad0dfa051 250 if (_io_data_64b_handler == NULL) {
spastor 0:fcaad0dfa051 251 _io_data_64b_handler = new FH_IoDataSampe64b802();
spastor 0:fcaad0dfa051 252 register_frame_handler(_io_data_64b_handler);
spastor 0:fcaad0dfa051 253 }
spastor 0:fcaad0dfa051 254 _io_data_64b_handler->register_io_data_cb(function);
spastor 0:fcaad0dfa051 255
spastor 0:fcaad0dfa051 256 if (_io_data_16b_handler == NULL) {
spastor 0:fcaad0dfa051 257 _io_data_16b_handler = new FH_IoDataSampe16b802();
spastor 0:fcaad0dfa051 258 register_frame_handler(_io_data_16b_handler);
spastor 0:fcaad0dfa051 259 }
spastor 0:fcaad0dfa051 260 _io_data_16b_handler->register_io_data_cb(function);
spastor 0:fcaad0dfa051 261 }
spastor 0:fcaad0dfa051 262
spastor 0:fcaad0dfa051 263 void XBee802::unregister_io_sample_cb()
spastor 0:fcaad0dfa051 264 {
spastor 0:fcaad0dfa051 265 if (_io_data_64b_handler != NULL) {
spastor 0:fcaad0dfa051 266 _io_data_64b_handler->unregister_io_data_cb();
spastor 0:fcaad0dfa051 267 unregister_frame_handler(_io_data_64b_handler);
spastor 0:fcaad0dfa051 268 delete _io_data_64b_handler;
spastor 0:fcaad0dfa051 269 _io_data_64b_handler = NULL; /* as delete does not set to NULL */
spastor 0:fcaad0dfa051 270 }
spastor 0:fcaad0dfa051 271
spastor 0:fcaad0dfa051 272 if (_io_data_16b_handler != NULL) {
spastor 0:fcaad0dfa051 273 _io_data_16b_handler->unregister_io_data_cb();
spastor 0:fcaad0dfa051 274 unregister_frame_handler(_io_data_16b_handler);
spastor 0:fcaad0dfa051 275 delete _io_data_16b_handler;
spastor 0:fcaad0dfa051 276 _io_data_16b_handler = NULL; /* as delete does not set to NULL */
spastor 0:fcaad0dfa051 277 }
spastor 0:fcaad0dfa051 278 }
spastor 0:fcaad0dfa051 279
spastor 0:fcaad0dfa051 280 AtCmdFrame::AtCmdResp XBee802::get_param(const RemoteXBee& remote, const char * const param, uint32_t * const data)
spastor 0:fcaad0dfa051 281 {
spastor 0:fcaad0dfa051 282 uint16_t len = sizeof *data;
spastor 0:fcaad0dfa051 283 AtCmdFrame::AtCmdResp atCmdResponse;
spastor 0:fcaad0dfa051 284
spastor 0:fcaad0dfa051 285 if (remote.is_valid_addr64b()) {
spastor 0:fcaad0dfa051 286 const uint64_t dev_addr64 = remote.get_addr64();
spastor 0:fcaad0dfa051 287
spastor 0:fcaad0dfa051 288 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr64, param);
spastor 0:fcaad0dfa051 289 atCmdResponse = send_at_cmd(&cmd_frame, (uint8_t *)data, &len, RadioRemote);
spastor 0:fcaad0dfa051 290 } else if (remote.is_valid_addr16b()) {
spastor 0:fcaad0dfa051 291 const uint16_t dev_addr16 = remote.get_addr16();
spastor 0:fcaad0dfa051 292
spastor 0:fcaad0dfa051 293 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr16, param);
spastor 0:fcaad0dfa051 294 atCmdResponse = send_at_cmd(&cmd_frame, (uint8_t *)data, &len, RadioRemote);
spastor 0:fcaad0dfa051 295 } else {
spastor 0:fcaad0dfa051 296 return AtCmdFrame::AtCmdRespInvalidAddr;
spastor 0:fcaad0dfa051 297 }
spastor 0:fcaad0dfa051 298
spastor 0:fcaad0dfa051 299 if (atCmdResponse == AtCmdFrame::AtCmdRespOk && len > sizeof *data) {
spastor 0:fcaad0dfa051 300 atCmdResponse = AtCmdFrame::AtCmdRespLenMismatch;
spastor 0:fcaad0dfa051 301 }
spastor 0:fcaad0dfa051 302
spastor 0:fcaad0dfa051 303 return atCmdResponse;
spastor 0:fcaad0dfa051 304 }
spastor 0:fcaad0dfa051 305
spastor 0:fcaad0dfa051 306 AtCmdFrame::AtCmdResp XBee802::set_param(const RemoteXBee& remote, const char * const param, uint32_t data)
spastor 0:fcaad0dfa051 307 {
spastor 0:fcaad0dfa051 308 if (remote.is_valid_addr64b()) {
spastor 0:fcaad0dfa051 309 const uint64_t dev_addr64 = remote.get_addr64();
spastor 0:fcaad0dfa051 310
spastor 0:fcaad0dfa051 311 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr64, param, data);
spastor 0:fcaad0dfa051 312 return send_at_cmd(&cmd_frame, NULL, NULL, RadioRemote);
spastor 0:fcaad0dfa051 313 }
spastor 0:fcaad0dfa051 314
spastor 0:fcaad0dfa051 315 if (remote.is_valid_addr16b()) {
spastor 0:fcaad0dfa051 316 const uint16_t dev_addr16 = remote.get_addr16();
spastor 0:fcaad0dfa051 317
spastor 0:fcaad0dfa051 318 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr16, param, data);
spastor 0:fcaad0dfa051 319 return send_at_cmd(&cmd_frame, NULL, NULL, RadioRemote);
spastor 0:fcaad0dfa051 320 }
spastor 0:fcaad0dfa051 321
spastor 0:fcaad0dfa051 322 return AtCmdFrame::AtCmdRespInvalidAddr;
spastor 0:fcaad0dfa051 323 }
spastor 0:fcaad0dfa051 324
spastor 0:fcaad0dfa051 325 AtCmdFrame::AtCmdResp XBee802::set_param(const RemoteXBee& remote, const char * const param, const uint8_t * data, uint16_t len)
spastor 0:fcaad0dfa051 326 {
spastor 0:fcaad0dfa051 327 if (remote.is_valid_addr64b()) {
spastor 0:fcaad0dfa051 328 const uint64_t dev_addr64 = remote.get_addr64();
spastor 0:fcaad0dfa051 329
spastor 0:fcaad0dfa051 330 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr64, param, data, len);
spastor 0:fcaad0dfa051 331 return send_at_cmd(&cmd_frame, NULL, NULL, RadioRemote);
spastor 0:fcaad0dfa051 332 }
spastor 0:fcaad0dfa051 333
spastor 0:fcaad0dfa051 334 if (remote.is_valid_addr16b()) {
spastor 0:fcaad0dfa051 335 const uint16_t dev_addr16 = remote.get_addr16();
spastor 0:fcaad0dfa051 336
spastor 0:fcaad0dfa051 337 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr16, param, data, len);
spastor 0:fcaad0dfa051 338 return send_at_cmd(&cmd_frame, NULL, NULL, RadioRemote);
spastor 0:fcaad0dfa051 339 }
spastor 0:fcaad0dfa051 340
spastor 0:fcaad0dfa051 341 return AtCmdFrame::AtCmdRespInvalidAddr;
spastor 0:fcaad0dfa051 342 }
spastor 0:fcaad0dfa051 343
spastor 0:fcaad0dfa051 344 AtCmdFrame::AtCmdResp XBee802::get_param(const RemoteXBee& remote, const char * const param, uint8_t * const data, uint16_t * const len)
spastor 0:fcaad0dfa051 345 {
spastor 0:fcaad0dfa051 346 if (remote.is_valid_addr64b()) {
spastor 0:fcaad0dfa051 347 uint64_t dev_addr64 = remote.get_addr64();
spastor 0:fcaad0dfa051 348
spastor 0:fcaad0dfa051 349 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr64, param);
spastor 0:fcaad0dfa051 350 return send_at_cmd(&cmd_frame, data, len, RadioRemote, false);
spastor 0:fcaad0dfa051 351 }
spastor 0:fcaad0dfa051 352
spastor 0:fcaad0dfa051 353 if (remote.is_valid_addr16b()) {
spastor 0:fcaad0dfa051 354 uint16_t dev_addr16 = remote.get_addr16();
spastor 0:fcaad0dfa051 355
spastor 0:fcaad0dfa051 356 AtCmdFrame cmd_frame = AtCmdFrame(dev_addr16, param);
spastor 0:fcaad0dfa051 357 return send_at_cmd(&cmd_frame, data, len, RadioRemote, false);
spastor 0:fcaad0dfa051 358 }
spastor 0:fcaad0dfa051 359
spastor 0:fcaad0dfa051 360 return AtCmdFrame::AtCmdRespInvalidAddr;
spastor 0:fcaad0dfa051 361 }
spastor 0:fcaad0dfa051 362
spastor 0:fcaad0dfa051 363 static void get_dio_cmd(XBee802::IoLine line, char * const iocmd)
spastor 0:fcaad0dfa051 364 {
spastor 0:fcaad0dfa051 365 if (line >= XBee802::PWM0) {
spastor 0:fcaad0dfa051 366 iocmd[0] = 'P';
spastor 0:fcaad0dfa051 367 iocmd[1] = '0' + line - XBee802::PWM0;
spastor 0:fcaad0dfa051 368 } else {
spastor 0:fcaad0dfa051 369 iocmd[0] = 'D';
spastor 0:fcaad0dfa051 370 iocmd[1] = '0' + line;
spastor 0:fcaad0dfa051 371 }
spastor 0:fcaad0dfa051 372 iocmd[2] = '\0';
spastor 0:fcaad0dfa051 373 }
spastor 0:fcaad0dfa051 374
spastor 0:fcaad0dfa051 375 RadioStatus XBee802::set_pin_config(const RemoteXBee& remote, IoLine line, IoMode mode)
spastor 0:fcaad0dfa051 376 {
spastor 0:fcaad0dfa051 377 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 378 char iocmd[3];
spastor 0:fcaad0dfa051 379
spastor 0:fcaad0dfa051 380 get_dio_cmd(line, iocmd);
spastor 0:fcaad0dfa051 381
spastor 0:fcaad0dfa051 382 cmdresp = set_param(remote, iocmd, (uint8_t)mode);
spastor 0:fcaad0dfa051 383 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 384 digi_log(LogLevelError, "set_pin_config: set_param returned %d\r\n", cmdresp);
spastor 0:fcaad0dfa051 385 return Failure;
spastor 0:fcaad0dfa051 386 }
spastor 0:fcaad0dfa051 387
spastor 0:fcaad0dfa051 388 return Success;
spastor 0:fcaad0dfa051 389 }
spastor 0:fcaad0dfa051 390
spastor 0:fcaad0dfa051 391 RadioStatus XBee802::get_pin_config(const RemoteXBee& remote, IoLine line, IoMode * const mode)
spastor 0:fcaad0dfa051 392 {
spastor 0:fcaad0dfa051 393 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 394 char iocmd[3];
spastor 0:fcaad0dfa051 395
spastor 0:fcaad0dfa051 396 get_dio_cmd(line, iocmd);
spastor 0:fcaad0dfa051 397
spastor 0:fcaad0dfa051 398 uint32_t var32;
spastor 0:fcaad0dfa051 399 cmdresp = get_param(remote, iocmd, &var32);
spastor 0:fcaad0dfa051 400 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 401 return Failure;
spastor 0:fcaad0dfa051 402 }
spastor 0:fcaad0dfa051 403 *mode = (IoMode)var32;
spastor 0:fcaad0dfa051 404
spastor 0:fcaad0dfa051 405 return Success;
spastor 0:fcaad0dfa051 406 }
spastor 0:fcaad0dfa051 407
spastor 0:fcaad0dfa051 408 RadioStatus XBee802::set_dio(const RemoteXBee& remote, IoLine line, DioVal val)
spastor 0:fcaad0dfa051 409 {
spastor 0:fcaad0dfa051 410 if (line > DI8) {
spastor 0:fcaad0dfa051 411 digi_log(LogLevelError, "set_dio: Pin %d not supported as IO\r\n", line);
spastor 0:fcaad0dfa051 412 return Failure;
spastor 0:fcaad0dfa051 413 }
spastor 0:fcaad0dfa051 414
spastor 0:fcaad0dfa051 415 if (val == Low) {
spastor 0:fcaad0dfa051 416 return set_pin_config(remote, line, DigitalOutLow);
spastor 0:fcaad0dfa051 417 } else {
spastor 0:fcaad0dfa051 418 return set_pin_config(remote, line, DigitalOutHigh);
spastor 0:fcaad0dfa051 419 }
spastor 0:fcaad0dfa051 420 }
spastor 0:fcaad0dfa051 421
spastor 0:fcaad0dfa051 422 RadioStatus XBee802::get_dio(const RemoteXBee& remote, IoLine line, DioVal * const val)
spastor 0:fcaad0dfa051 423 {
spastor 3:8662ebe83570 424 return get_iosample(remote).get_dio(line, val);
spastor 0:fcaad0dfa051 425 }
spastor 0:fcaad0dfa051 426
spastor 0:fcaad0dfa051 427 RadioStatus XBee802::get_adc(const RemoteXBee& remote, IoLine line, uint16_t * const val)
spastor 0:fcaad0dfa051 428 {
spastor 3:8662ebe83570 429 return get_iosample(remote).get_adc(line, val);
spastor 0:fcaad0dfa051 430 }
spastor 0:fcaad0dfa051 431
spastor 0:fcaad0dfa051 432 RadioStatus XBee802::set_pwm(const RemoteXBee& remote, IoLine line, float duty_cycle)
spastor 0:fcaad0dfa051 433 {
spastor 0:fcaad0dfa051 434 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 435 char iocmd[3] = { 'M', '0', '\0' };
spastor 4:629712865107 436
spastor 0:fcaad0dfa051 437 if (line != PWM0 && line != PWM1) {
spastor 0:fcaad0dfa051 438 return Failure;
spastor 0:fcaad0dfa051 439 }
spastor 0:fcaad0dfa051 440 if (line == PWM1) {
spastor 0:fcaad0dfa051 441 iocmd[1] = '1';
spastor 0:fcaad0dfa051 442 }
spastor 4:629712865107 443
spastor 0:fcaad0dfa051 444 uint16_t pwm_val = (uint16_t)(duty_cycle * DR_PWM_MAX_VAL / 100);
spastor 0:fcaad0dfa051 445
spastor 0:fcaad0dfa051 446 cmdresp = set_param(remote, iocmd, pwm_val);
spastor 4:629712865107 447 return cmdresp == AtCmdFrame::AtCmdRespOk ? Success : Failure;
spastor 0:fcaad0dfa051 448 }
spastor 0:fcaad0dfa051 449
spastor 3:8662ebe83570 450 IOSample802 XBee802::get_iosample(const RemoteXBee& remote)
spastor 3:8662ebe83570 451 {
spastor 3:8662ebe83570 452 uint8_t io_sample[MAX_IO_SAMPLE_802_LEN];
spastor 3:8662ebe83570 453 uint16_t len = sizeof io_sample;
spastor 3:8662ebe83570 454
spastor 3:8662ebe83570 455 RadioStatus resp = _get_iosample(remote, io_sample, &len);
spastor 3:8662ebe83570 456 if (resp != Success) {
spastor 3:8662ebe83570 457 digi_log(LogLevelError, "XBee802::get_iosample failed to get an IOSample\r\n");
spastor 3:8662ebe83570 458 len = 0;
spastor 3:8662ebe83570 459 }
spastor 3:8662ebe83570 460 return IOSample802(io_sample, len);
spastor 3:8662ebe83570 461 }
spastor 3:8662ebe83570 462
spastor 0:fcaad0dfa051 463 static uint8_t get_dio_mask(XBee802::IoLine line)
spastor 0:fcaad0dfa051 464 {
spastor 0:fcaad0dfa051 465 switch (line) {
spastor 0:fcaad0dfa051 466 case XBee802::DIO4_AD4:
spastor 0:fcaad0dfa051 467 return (1 << 0);
spastor 0:fcaad0dfa051 468 case XBee802::DIO3_AD3:
spastor 0:fcaad0dfa051 469 return (1 << 1);
spastor 0:fcaad0dfa051 470 case XBee802::DIO2_AD2:
spastor 0:fcaad0dfa051 471 return (1 << 2);
spastor 0:fcaad0dfa051 472 case XBee802::DIO1_AD1:
spastor 0:fcaad0dfa051 473 return (1 << 3);
spastor 0:fcaad0dfa051 474 case XBee802::DIO0_AD0:
spastor 0:fcaad0dfa051 475 return (1 << 4);
spastor 0:fcaad0dfa051 476 case XBee802::DIO6:
spastor 0:fcaad0dfa051 477 return (1 << 5);
spastor 0:fcaad0dfa051 478 case XBee802::DI8:
spastor 0:fcaad0dfa051 479 return (1 << 6);
spastor 0:fcaad0dfa051 480 default:
spastor 0:fcaad0dfa051 481 return 0;
spastor 0:fcaad0dfa051 482 }
spastor 0:fcaad0dfa051 483 }
spastor 0:fcaad0dfa051 484
spastor 0:fcaad0dfa051 485 RadioStatus XBee802::set_pin_pull_up(const RemoteXBee& remote, IoLine line, bool enable)
spastor 0:fcaad0dfa051 486 {
spastor 0:fcaad0dfa051 487 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 488 uint32_t var32;
spastor 0:fcaad0dfa051 489 uint8_t pr;
spastor 0:fcaad0dfa051 490
spastor 0:fcaad0dfa051 491 cmdresp = get_param(remote, "PR", &var32);
spastor 4:629712865107 492 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 493 return Failure;
spastor 4:629712865107 494 }
spastor 0:fcaad0dfa051 495 pr = var32;
spastor 0:fcaad0dfa051 496
spastor 0:fcaad0dfa051 497 const uint8_t dio_mask = get_dio_mask(line);
spastor 0:fcaad0dfa051 498 if (dio_mask == 0) {
spastor 0:fcaad0dfa051 499 digi_log(LogLevelError, "XBee802::set_pin_pull_up: invalid pin %d\r\n", line);
spastor 0:fcaad0dfa051 500 return Failure;
spastor 0:fcaad0dfa051 501 }
spastor 0:fcaad0dfa051 502
spastor 0:fcaad0dfa051 503 if (enable) {
spastor 0:fcaad0dfa051 504 pr |= dio_mask;
spastor 0:fcaad0dfa051 505 } else {
spastor 0:fcaad0dfa051 506 pr &= ~dio_mask;
spastor 0:fcaad0dfa051 507 }
spastor 0:fcaad0dfa051 508
spastor 0:fcaad0dfa051 509 cmdresp = set_param(remote, "PR", pr);
spastor 4:629712865107 510 return cmdresp == AtCmdFrame::AtCmdRespOk ? Success : Failure;
spastor 0:fcaad0dfa051 511 }
spastor 0:fcaad0dfa051 512
spastor 0:fcaad0dfa051 513 static uint8_t get_dio_ic_mask(XBee802::IoLine line)
spastor 0:fcaad0dfa051 514 {
spastor 0:fcaad0dfa051 515 if (line < XBee802::DI8) {
spastor 0:fcaad0dfa051 516 return (1 << line);
spastor 0:fcaad0dfa051 517 }
spastor 0:fcaad0dfa051 518 return 0;
spastor 0:fcaad0dfa051 519 }
spastor 0:fcaad0dfa051 520
spastor 0:fcaad0dfa051 521 RadioStatus XBee802::enable_dio_change_detection(const RemoteXBee& remote, IoLine line, bool enable)
spastor 0:fcaad0dfa051 522 {
spastor 0:fcaad0dfa051 523 if (line > DIO7) {
spastor 0:fcaad0dfa051 524 digi_log(LogLevelError, "XBee802::enable_dio_change_detection: pin not supported (%d)\r\n", line);
spastor 0:fcaad0dfa051 525 return Failure;
spastor 0:fcaad0dfa051 526 }
spastor 0:fcaad0dfa051 527
spastor 0:fcaad0dfa051 528 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 529 uint32_t var32;
spastor 0:fcaad0dfa051 530 uint8_t ic;
spastor 0:fcaad0dfa051 531
spastor 0:fcaad0dfa051 532 cmdresp = get_param(remote, "IC", &var32);
spastor 0:fcaad0dfa051 533 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 534 return Failure;
spastor 0:fcaad0dfa051 535 }
spastor 0:fcaad0dfa051 536 ic = var32;
spastor 0:fcaad0dfa051 537
spastor 0:fcaad0dfa051 538 const uint8_t dio_mask = get_dio_ic_mask(line);
spastor 0:fcaad0dfa051 539 if (dio_mask == 0) {
spastor 0:fcaad0dfa051 540 digi_log(LogLevelError, "XBeeZB::enable_dio_change_detection: invalid pin %d\r\n", line);
spastor 0:fcaad0dfa051 541 return Failure;
spastor 0:fcaad0dfa051 542 }
spastor 0:fcaad0dfa051 543
spastor 0:fcaad0dfa051 544 if (enable) {
spastor 0:fcaad0dfa051 545 ic |= dio_mask;
spastor 0:fcaad0dfa051 546 } else {
spastor 0:fcaad0dfa051 547 ic &= ~dio_mask;
spastor 0:fcaad0dfa051 548 }
spastor 0:fcaad0dfa051 549
spastor 0:fcaad0dfa051 550 cmdresp = set_param(remote, "IC", ic);
spastor 4:629712865107 551 return cmdresp == AtCmdFrame::AtCmdRespOk ? Success : Failure;
spastor 4:629712865107 552 }
spastor 0:fcaad0dfa051 553
spastor 0:fcaad0dfa051 554 #ifdef GET_PWM_AVAILABLE
spastor 0:fcaad0dfa051 555 RadioStatus XBee802::get_pwm(const RemoteXBee& remote, IoLine line, float * const duty_cycle)
spastor 0:fcaad0dfa051 556 {
spastor 0:fcaad0dfa051 557 AtCmdFrame::AtCmdResp cmdresp;
spastor 0:fcaad0dfa051 558 char iocmd[3] = { 'M', '0', '\0' };
spastor 4:629712865107 559
spastor 4:629712865107 560 if (line != PWM0 && line != PWM1) {
spastor 0:fcaad0dfa051 561 return Failure;
spastor 4:629712865107 562 }
spastor 0:fcaad0dfa051 563
spastor 4:629712865107 564 if (line == PWM1) {
spastor 0:fcaad0dfa051 565 iocmd[1] = '1';
spastor 4:629712865107 566 }
spastor 4:629712865107 567
spastor 0:fcaad0dfa051 568 uint16_t pwm_val;
spastor 0:fcaad0dfa051 569
spastor 0:fcaad0dfa051 570 cmdresp = get_param(remote, iocmd, &pwm_val);
spastor 4:629712865107 571 if (cmdresp != AtCmdFrame::AtCmdRespOk) {
spastor 0:fcaad0dfa051 572 return Failure;
spastor 4:629712865107 573 }
spastor 0:fcaad0dfa051 574
spastor 0:fcaad0dfa051 575 *duty_cycle = (float)(pwm_val * 100 / DR_PWM_MAX_VAL);
spastor 0:fcaad0dfa051 576
spastor 0:fcaad0dfa051 577 return Success;
spastor 0:fcaad0dfa051 578 }
spastor 0:fcaad0dfa051 579 #endif