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/XBeeApiTxFrame.hpp@47:5d3608835668, 2014-07-06 (annotated)

Committer:
johnb
Date:
Sun Jul 06 22:10:28 2014 +0000
Revision:
47:5d3608835668
Parent:
44:85a66d56e176
Child:
53:7b65422d7a32
Re-jig XBeeApiTxFrame to allow getDataPtr to be a const method again.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 9:ba90e9efd68b 1 /**
johnb 9:ba90e9efd68b 2 @file
johnb 12:58319a467943 3 @brief Class to support transmission of data via the XBee's wireless
johnb 9:ba90e9efd68b 4
johnb 9:ba90e9efd68b 5 @author John Bailey
johnb 9:ba90e9efd68b 6
johnb 9:ba90e9efd68b 7 @copyright Copyright 2014 John Bailey
johnb 9:ba90e9efd68b 8
johnb 9:ba90e9efd68b 9 @section LICENSE
johnb 9:ba90e9efd68b 10
johnb 9:ba90e9efd68b 11 Licensed under the Apache License, Version 2.0 (the "License");
johnb 9:ba90e9efd68b 12 you may not use this file except in compliance with the License.
johnb 9:ba90e9efd68b 13 You may obtain a copy of the License at
johnb 9:ba90e9efd68b 14
johnb 9:ba90e9efd68b 15 http://www.apache.org/licenses/LICENSE-2.0
johnb 9:ba90e9efd68b 16
johnb 9:ba90e9efd68b 17 Unless required by applicable law or agreed to in writing, software
johnb 9:ba90e9efd68b 18 distributed under the License is distributed on an "AS IS" BASIS,
johnb 9:ba90e9efd68b 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 9:ba90e9efd68b 20 See the License for the specific language governing permissions and
johnb 9:ba90e9efd68b 21 limitations under the License.
johnb 9:ba90e9efd68b 22
johnb 9:ba90e9efd68b 23 */
johnb 9:ba90e9efd68b 24
johnb 16:8095c43a2a6e 25 #if !defined XBEEAPITXFRAME_HPP
johnb 16:8095c43a2a6e 26 #define XBEEAPITXFRAME_HPP
johnb 9:ba90e9efd68b 27
johnb 9:ba90e9efd68b 28 #include "XBeeApiFrame.hpp"
johnb 9:ba90e9efd68b 29 #include "XBeeDevice.hpp"
johnb 9:ba90e9efd68b 30
johnb 9:ba90e9efd68b 31 #include <stdint.h>
johnb 9:ba90e9efd68b 32
johnb 16:8095c43a2a6e 33 #define XBEE_API_TX_FRAME_BUFFER_SIZE 11U
johnb 16:8095c43a2a6e 34
johnb 16:8095c43a2a6e 35 #define XBEE_API_MAX_TX_PAYLOAD_LEN 100U
johnb 16:8095c43a2a6e 36
johnb 16:8095c43a2a6e 37 /** Class to represent a frame of data being transmitted by the XBee */
johnb 9:ba90e9efd68b 38 class XBeeApiTxFrame : public XBeeApiFrame, public XBeeApiFrameDecoder
johnb 9:ba90e9efd68b 39 {
johnb 9:ba90e9efd68b 40 protected:
johnb 27:6356ef5fe39b 41 /** Destination address of the frame */
johnb 27:6356ef5fe39b 42 uint64_t m_addr;
johnb 27:6356ef5fe39b 43
johnb 16:8095c43a2a6e 44 /** Whether or not an acknowledgement of the frame is requested */
johnb 12:58319a467943 45 bool m_ack;
johnb 16:8095c43a2a6e 46 /** Whether or not the frame is a PAN broadcast */
johnb 12:58319a467943 47 bool m_panBroadcast;
johnb 16:8095c43a2a6e 48 /** Buffer to house data relating to the frame header */
johnb 16:8095c43a2a6e 49 uint8_t m_buffer[XBEE_API_TX_FRAME_BUFFER_SIZE];
johnb 21:09ddf12a65ed 50
johnb 47:5d3608835668 51 uint8_t m_bufferLen;
johnb 47:5d3608835668 52
johnb 21:09ddf12a65ed 53 /** Called by XBeeDevice in order to offer frame data to the object for
johnb 21:09ddf12a65ed 54 decoding
johnb 21:09ddf12a65ed 55
johnb 21:09ddf12a65ed 56 \param p_data Pointer to the content of the received data
johnb 21:09ddf12a65ed 57 \param p_len Length of the data pointed to by p_data
johnb 21:09ddf12a65ed 58 */
johnb 21:09ddf12a65ed 59 virtual bool decodeCallback( const uint8_t* const p_data, size_t p_len );
johnb 21:09ddf12a65ed 60
johnb 47:5d3608835668 61 void updateBuffer( void );
johnb 47:5d3608835668 62
johnb 9:ba90e9efd68b 63 public:
johnb 20:3fa7a0daf1c7 64 /** Enum for capturing the possible status of an XBee message TX
johnb 20:3fa7a0daf1c7 65 attempt */
johnb 15:ff9f12e38f44 66 typedef enum
johnb 15:ff9f12e38f44 67 {
johnb 20:3fa7a0daf1c7 68 /** Frame was transmitted OK. Note that successfully transmitted
johnb 20:3fa7a0daf1c7 69 broadcast frames will have this status, even in the case
johnb 20:3fa7a0daf1c7 70 that they are not received by any other nodes */
johnb 15:ff9f12e38f44 71 XBEE_API_TX_STATUS_OK = 0,
johnb 20:3fa7a0daf1c7 72 /** No acknowledgement was received when the frame was transmitted.
johnb 20:3fa7a0daf1c7 73 See XBEE_API_TX_STATUS_OK for note regarding broadcast frames */
johnb 15:ff9f12e38f44 74 XBEE_API_TX_STATUS_NO_ACK = 1,
johnb 20:3fa7a0daf1c7 75 /** Channel is unavailable for transmission (Clear Channel
johnb 20:3fa7a0daf1c7 76 Assessment failed) */
johnb 15:ff9f12e38f44 77 XBEE_API_TX_STATUS_CCA_FAIL = 2,
johnb 20:3fa7a0daf1c7 78 /** Coordinator has timed out an indirect transmission */
johnb 16:8095c43a2a6e 79 XBEE_API_TX_STATUS_PURGED = 3,
johnb 16:8095c43a2a6e 80 /** Not an actual status, used to provide a handle on the numer of
johnb 16:8095c43a2a6e 81 enumeration items */
johnb 16:8095c43a2a6e 82 XBEE_API_TX_STATUS_LAST = 4
johnb 15:ff9f12e38f44 83 } XBeeApiTxStatus_e;
johnb 15:ff9f12e38f44 84
johnb 44:85a66d56e176 85 XBeeApiTxFrame( XBeeDevice* p_device = NULL,
johnb 44:85a66d56e176 86 const uint8_t* p_data = NULL,
johnb 44:85a66d56e176 87 const size_t p_dataLen = 0,
johnb 44:85a66d56e176 88 const uint64_t p_addr = XBEE_BROADCAST_ADDR,
johnb 44:85a66d56e176 89 const XBeeDevice::XBeeApiAddrType_t p_type = XBeeDevice::XBEE_API_ADDR_TYPE_16BIT );
johnb 12:58319a467943 90 virtual ~XBeeApiTxFrame( void );
johnb 9:ba90e9efd68b 91
johnb 12:58319a467943 92 void setDestAddrType( const XBeeDevice::XBeeApiAddrType_t p_type );
johnb 9:ba90e9efd68b 93 void setDestAddr( uint64_t p_addr );
johnb 9:ba90e9efd68b 94 void setDestAddrBroadcast( void );
johnb 9:ba90e9efd68b 95 void setPanBroadcast( const bool p_bc );
johnb 9:ba90e9efd68b 96
johnb 16:8095c43a2a6e 97 virtual uint16_t getCmdLen( void ) const;
johnb 47:5d3608835668 98 virtual void getDataPtr( const uint16_t p_start, const uint8_t** p_buff, uint16_t* const p_len ) const;
johnb 16:8095c43a2a6e 99
johnb 16:8095c43a2a6e 100 virtual uint8_t getFrameId( void ) const;
johnb 15:ff9f12e38f44 101
johnb 16:8095c43a2a6e 102 /** Callback function which is invoked when a response to the TX request is received from
johnb 35:0f8910a023a3 103 the XBee.
johnb 16:8095c43a2a6e 104
johnb 16:8095c43a2a6e 105 \param p_status Status of the TX attempt */
johnb 15:ff9f12e38f44 106 virtual void frameTxCallback( const XBeeApiTxStatus_e p_status );
johnb 16:8095c43a2a6e 107
johnb 16:8095c43a2a6e 108 /** Set the frame payload
johnb 16:8095c43a2a6e 109
johnb 16:8095c43a2a6e 110 \param p_buff Pointer to the buffer containing the data. Note that this buffer is not copied, so
johnb 16:8095c43a2a6e 111 must retain the appropriate content until transmission is complete
johnb 16:8095c43a2a6e 112 \param p_len Length of the data pointed to be p_buff. Must be 100 or less.
johnb 16:8095c43a2a6e 113 \returns true in the case that the operation was successful, false in the case that it was not
johnb 16:8095c43a2a6e 114 (content too long, etc)
johnb 16:8095c43a2a6e 115 */
johnb 16:8095c43a2a6e 116 bool setDataPtr( const uint8_t* const p_buff, const uint16_t p_len );
johnb 9:ba90e9efd68b 117 };
johnb 9:ba90e9efd68b 118
johnb 9:ba90e9efd68b 119 #endif