John Bailey / XBeeApi

API for communicating with XBee devices.

Dependencies:   CircularBuffer FixedLengthList

Dependents:   XBeeApiTest XBeeApiSimpleATCmdsExample XBeeApiBroadcastExample XBeeApiBroadcastExampleRTOS ... more

Overview

XBeeApi is intended to be a library for providing a high-level API interface to the XBee - for example getChannel() and setChannel(2) methods rather than needing to send( "ATCH" ) and send( "ATCH 2" ) - and then de-code the responses.

See the notebook page here for a description of how the API works & some details on the various classes.

Features:

  • Support for transmission & reception of data packets
  • Support for reading & changing settings
  • Support for "Remote AT" interface to access settings & I/O channels on remote XBees
  • XBeeApi should work if you're using mbed-rtos, though it is not currently threadsafe. Take a look at the XBeeApiBroadcastExampleRTOS example if you're including mbed-rtos.

Example Programs

There are also example programs available:

Transmit

Import programXBeeApiSimpleBroadcastExample

Simple example of how to use XBeeApi - set up the XBee, configure P2P networking then transmit a frame.

Last commit 06 Jul 2014 by John Bailey

Import programXBeeApiBroadcastExample

Example for XBeeAPI; a little more involved than XBeeApiSimpleBroadcastExample with report on failure to set up the XBee and on the transmit status of the message.

Last commit 05 Jul 2014 by John Bailey

Import programXBeeApiBroadcastExampleRTOS

Example of using the XBeeApi library to broadcast a message, based on XBeeApiBroadcastExample. This example shows how to use the library when using mbed-rtos. Before compiling you must open "XbeeApi\Config\XBeeApiCfg.hpp" and change the '#if 0' to '#if 1' on the line above the comment reading "Use RTOS features to make XBeeApi threadsafe"

Last commit 06 Jul 2014 by John Bailey

Settings/Status

Import programXBeeApiSimpleATCmdsExample

Simple example of using XBeeApi to send AT-style commands to the XBee

Last commit 31 Mar 2014 by John Bailey

Import programXBeeApiRemoteATCmdsExample

Example of using the XBeeApi library to send AT commands to remote XBee devices in order to read/write settings

Last commit 13 Jul 2014 by John Bailey

Receive

Import programXBeeApiSimpleReceiveExample

Simple example of using XBeeApi to receive data packets via wireless

Last commit 08 Jul 2014 by John Bailey

Import programXBeeApiReceiveCallbackExample

Example of using the XBeeApi library to receive a message via a callback method

Last commit 08 Jul 2014 by John Bailey

Import programXBeeApiReceiveCallbackExampleRTOS

Example of using the XBeeApi library to receive a message via a callback method. This example shows how to use the library when using mbed-rtos. See the comment at the top of main.cpp

Last commit 08 Jul 2014 by John Bailey

Remote I/O

Import programXBeeApiRemoteIOExample

Example of using the XBeeApi library to read inputs on a remote XBee

Last commit 28 Jul 2014 by John Bailey

If you have 2 mbed connected XBees available then you can use XBeeApiSimpleReceiveExample and XBeeApiSimpleBroadcastExample as a pair.

Note that this is still a work in progress! XBeeApiTodoList tracks some of the functionality still to be added.

RXTX/XBeeApiRxFrameDecoder.cpp@56:7fe74b03e6b1, 2014-08-08 (annotated)

Committer:
johnb
Date:
Fri Aug 08 11:59:52 2014 +0000
Revision:
56:7fe74b03e6b1
Parent:
38:291aee9eb900 
Add support for setting up encrypted communications; Re-jig XBeeApiCmdAt virtual functions to make inheritance by XBeeDeviceRemoteAt cleaner.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 38:291aee9eb900 1 /**
johnb 38:291aee9eb900 2
johnb 38:291aee9eb900 3 Copyright 2014 John Bailey
johnb 38:291aee9eb900 4
johnb 38:291aee9eb900 5 Licensed under the Apache License, Version 2.0 (the "License");
johnb 38:291aee9eb900 6 you may not use this file except in compliance with the License.
johnb 38:291aee9eb900 7 You may obtain a copy of the License at
johnb 38:291aee9eb900 8
johnb 38:291aee9eb900 9 http://www.apache.org/licenses/LICENSE-2.0
johnb 38:291aee9eb900 10
johnb 38:291aee9eb900 11 Unless required by applicable law or agreed to in writing, software
johnb 38:291aee9eb900 12 distributed under the License is distributed on an "AS IS" BASIS,
johnb 38:291aee9eb900 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 38:291aee9eb900 14 See the License for the specific language governing permissions and
johnb 38:291aee9eb900 15 limitations under the License.
johnb 38:291aee9eb900 16
johnb 38:291aee9eb900 17 */
johnb 38:291aee9eb900 18
johnb 38:291aee9eb900 19 #include "XBeeApiRxFrameDecoder.hpp"
johnb 38:291aee9eb900 20
johnb 38:291aee9eb900 21 XBeeApiRxFrameDecoder::XBeeApiRxFrameDecoder( XBeeDevice* p_device ) : XBeeApiFrameDecoder( p_device )
johnb 38:291aee9eb900 22 {
johnb 38:291aee9eb900 23 }
johnb 38:291aee9eb900 24
johnb 38:291aee9eb900 25 XBeeApiRxFrameDecoder::~XBeeApiRxFrameDecoder( void )
johnb 38:291aee9eb900 26 {
johnb 38:291aee9eb900 27 }
johnb 38:291aee9eb900 28
johnb 38:291aee9eb900 29 bool XBeeApiRxFrameDecoder::decodeCallback( const uint8_t* const p_data, size_t p_len )
johnb 38:291aee9eb900 30 {
johnb 38:291aee9eb900 31 bool ret_val = false;
johnb 38:291aee9eb900 32
johnb 38:291aee9eb900 33 /* TODO: Length check */
johnb 38:291aee9eb900 34
johnb 38:291aee9eb900 35 if(( XBEE_CMD_RX_64B_ADDR == p_data[ XBEE_CMD_POSN_API_ID ] ) ||
johnb 38:291aee9eb900 36 ( XBEE_CMD_RX_16B_ADDR == p_data[ XBEE_CMD_POSN_API_ID ] ))
johnb 38:291aee9eb900 37 {
johnb 38:291aee9eb900 38 size_t pos = XBEE_CMD_POSN_ID_SPECIFIC_DATA;
johnb 38:291aee9eb900 39 uint64_t addr;
johnb 38:291aee9eb900 40 bool addrIs16bit;
johnb 38:291aee9eb900 41 uint8_t rssi;
johnb 38:291aee9eb900 42 bool addressBroadcast;
johnb 38:291aee9eb900 43 bool panBroadcast;
johnb 38:291aee9eb900 44 const uint8_t* data;
johnb 38:291aee9eb900 45 size_t dataLen;
johnb 38:291aee9eb900 46
johnb 38:291aee9eb900 47 /* Depending on the frame type, decode either a 64- or 16-bit address */
johnb 38:291aee9eb900 48 if( XBEE_CMD_RX_64B_ADDR == p_data[ XBEE_CMD_POSN_API_ID ] )
johnb 38:291aee9eb900 49 {
johnb 38:291aee9eb900 50 addr = (((uint64_t)p_data[ pos ]) << 54U ) |
johnb 38:291aee9eb900 51 (((uint64_t)p_data[ pos+1 ]) << 48U ) |
johnb 38:291aee9eb900 52 (((uint64_t)p_data[ pos+2 ]) << 40U ) |
johnb 38:291aee9eb900 53 (((uint64_t)p_data[ pos+3 ]) << 32U ) |
johnb 38:291aee9eb900 54 (((uint64_t)p_data[ pos+4 ]) << 24U ) |
johnb 38:291aee9eb900 55 (((uint64_t)p_data[ pos+5 ]) << 16U ) |
johnb 38:291aee9eb900 56 (((uint64_t)p_data[ pos+6 ]) << 8U ) |
johnb 38:291aee9eb900 57 p_data[ pos+7 ];
johnb 38:291aee9eb900 58 pos += sizeof( uint64_t );
johnb 38:291aee9eb900 59 addrIs16bit = false;
johnb 38:291aee9eb900 60 }
johnb 38:291aee9eb900 61 else
johnb 38:291aee9eb900 62 {
johnb 38:291aee9eb900 63 addr = (((uint16_t)p_data[ pos ]) << 8U ) |
johnb 38:291aee9eb900 64 p_data[ pos+1 ];
johnb 38:291aee9eb900 65 pos += sizeof( uint16_t );
johnb 38:291aee9eb900 66 addrIs16bit = true;
johnb 38:291aee9eb900 67 }
johnb 38:291aee9eb900 68
johnb 38:291aee9eb900 69 rssi += p_data[ pos++ ];
johnb 38:291aee9eb900 70
johnb 38:291aee9eb900 71 addressBroadcast = p_data[ pos ] & 2U;
johnb 38:291aee9eb900 72 panBroadcast = p_data[ pos ] & 4U;
johnb 38:291aee9eb900 73 pos++;
johnb 38:291aee9eb900 74
johnb 38:291aee9eb900 75 data = &( p_data[ pos ] );
johnb 38:291aee9eb900 76
johnb 38:291aee9eb900 77 /* -1 to account for the checksum */
johnb 38:291aee9eb900 78 dataLen = p_len - pos - 1;
johnb 38:291aee9eb900 79
johnb 38:291aee9eb900 80 XBeeApiRxFrame new_frame( (XBeeApiIdentifier_e)(p_data[ XBEE_CMD_POSN_API_ID ]),
johnb 38:291aee9eb900 81 data,
johnb 38:291aee9eb900 82 dataLen );
johnb 38:291aee9eb900 83
johnb 38:291aee9eb900 84 frameRxCallback( &new_frame );
johnb 38:291aee9eb900 85
johnb 38:291aee9eb900 86 ret_val = true;
johnb 38:291aee9eb900 87 }
johnb 38:291aee9eb900 88
johnb 38:291aee9eb900 89 return ret_val;
johnb 38:291aee9eb900 90 }