Description: XBee-mbed library http://mbed.org/users/okini3939/notebook/xbee-mbed/
XBee Class Reference
Inherited by XBeeWiFi.
|Reads all available serial bytes until a packet is parsed, an error occurs, or the buffer is empty. |
|bool||readPacket (int timeout)|
|Waits a maximum of timeout milliseconds for a response packet before timing out; returns true if packet is read. |
|Reads until a packet is received or an error occurs. |
|void||begin (long baud)|
|Starts the serial connection at the supplied baud rate. |
|XBeeResponse &||getResponse ()|
|Returns a reference to the current response Note: once readPacket is called again this response will be overwritten! |
|void||send (XBeeRequest &request)|
|Sends a XBeeRequest (TX packet) out the serial port. |
|Returns a sequential frame id between 1 and 255. |
Primary interface for communicating with an XBee Radio.
Since this code is designed to run on a microcontroller, with only one thread, you are responsible for reading the data off the serial buffer in a timely manner. This involves a call to a variant of readPacket(...). If your serial port is receiving data faster than you are reading, you can expect to lose packets. Arduino only has a 128 byte serial buffer so it can easily overflow if two or more packets arrive without a call to readPacket(...)
In order to conserve resources, this class only supports storing one response packet in memory at a time. This means that you must fully consume the packet prior to calling readPacket(...), because calling readPacket(...) overwrites the previous response.
This class creates an array of size MAX_FRAME_DATA_SIZE for storing the response packet. You may want to adjust this value to conserve memory.
Member Function Documentation
|void begin||(||long||baud )|
|XBeeResponse & getResponse||(||)|
Reads all available serial bytes until a packet is parsed, an error occurs, or the buffer is empty.
This method should always return quickly since it does not wait for serial data to arrive. You will want to use this method if you are doing other timely stuff in your loop, where a delay would cause problems. NOTE: calling this method resets the current response, so make sure you first consume the current response
|bool readPacket||(||int||timeout )|