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.
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.
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"
Settings/Status
Import programXBeeApiSimpleATCmdsExample
Simple example of using XBeeApi to send AT-style commands to the XBee
Import programXBeeApiRemoteATCmdsExample
Example of using the XBeeApi library to send AT commands to remote XBee devices in order to read/write settings
Receive
Import programXBeeApiSimpleReceiveExample
Simple example of using XBeeApi to receive data packets via wireless
Import programXBeeApiReceiveCallbackExample
Example of using the XBeeApi library to receive a message via a callback method
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
Remote I/O
Import programXBeeApiRemoteIOExample
Example of using the XBeeApi library to read inputs on a remote XBee
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.
Utility/XBeeApiCmdAtBlocking.hpp
- Committer:
- johnb
- Date:
- 2014-07-28
- Revision:
- 51:a7d0d2ef9261
- Child:
- 56:7fe74b03e6b1
File content as of revision 51:a7d0d2ef9261:
/** @file @brief Class to abstract AT commands send to the XBee API using a blocking API. @author John Bailey @copyright Copyright 2014 John Bailey @section LICENSE Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ #if !defined XBEEAPICMDATBLOCKING_HPP #define XBEEAPICMDATBLOCKING_HPP #include "XBeeApiCmdAt.hpp" #include <stdint.h> /** Class to access the configuration interface of the XBee. In contrast to XBeeApiCmdAt, the getXXX methods block until the data is received (or a timeout has occurred) which means that the caller doesn't have to deal with the asynchronous nature of the API provided by XBeeApiCmdAt. It's not necessary to use any of the requestXXX methods (as the getXXX methods will take care of this, however calling a requestXXX method will effectively pre-fetch the data meaning that getXXX will not have to block */ class XBeeApiCmdAtBlocking : public XBeeApiCmdAt { protected: /** Timeout used for blocking methods in milliseconds */ uint16_t m_timeout; /** Wait slice time while blocking. The function will wait_ms(m_slice) until the XBee responds with the data or m_timeout elapses */ uint16_t m_slice; public: /** Constructor \param p_device XBee device with which this object should be associated \param p_timeout Timeout to be used when waiting for data from the XBee, specified in milliseconds \param p_slice While waiting for data, blocking methods will call the OS wait_ms() function, using the value specified by p_slice */ XBeeApiCmdAtBlocking( XBeeDevice* const p_device = NULL, const uint16_t p_timeout = 1000, const uint16_t p_slice = 100); /** Destructor */ virtual ~XBeeApiCmdAtBlocking( void ) {}; /* Implement XBeeApiCmdAt's virtual methods */ virtual bool getHardwareVersion( uint16_t* const p_ver ); virtual bool getFirmwareVersion( uint16_t* const p_ver ); virtual bool getSerialNumber( uint64_t* const p_sn ); virtual bool getChannel( uint8_t* const p_chan ); virtual bool setChannel( uint8_t const p_chan ); virtual bool getCoordinatorEnabled( bool* constp_en ); virtual bool setCoordinatorEnabled( const bool p_en ); virtual bool getEndDeviceAssociationEnabled( bool* const p_en ); virtual bool setEndDeviceAssociationEnabled( const bool p_en ); virtual bool getPanId( panId_t* const p_id ); virtual bool setPanId( const panId_t p_id ); virtual bool getSourceAddress( uint16_t* const p_addr ); virtual bool setSourceAddress( const uint16_t p_addr ); virtual bool getRetries( uint8_t* const p_addr ); virtual bool setRetries( const uint8_t p_addr ); virtual bool getRandomDelaySlots( uint8_t* const p_addr ); virtual bool setRandomDelaySlots( const uint8_t p_addr ); virtual bool getMacMode( XBeeApiMACMode_e* const p_mode ); virtual bool setMacMode( const XBeeApiMACMode_e p_mode ); virtual bool getDioConfig( const uint8_t p_chanNo, XBeeApiDioConfig_e* const p_conf ); virtual bool setDioConfig( const uint8_t p_chanNo, const XBeeApiDioConfig_e p_conf ); virtual bool getDioChangeDetectMask( uint8_t* const p_mask ); virtual bool setDioChangeDetectMask( const uint8_t p_mask ); virtual bool getDioLevels( uint8_t* const p_mask ); virtual bool setDioLevels( const uint8_t p_mask ); virtual bool getSampleRate( uint16_t* const p_interval ); virtual bool setSampleRate( const uint16_t p_interval ); virtual bool getDestinationAddress( uint64_t* const p_address ); virtual bool setDestinationAddress( const uint64_t p_address ); virtual bool getDestinationAddressHigh( uint32_t* const p_address ); virtual bool setDestinationAddressHigh( const uint32_t p_address ); virtual bool getDestinationAddressLow( uint32_t* const p_address ); virtual bool setDestinationAddressLow( const uint32_t p_address ); }; #endif