Go to the source code of this file.
Data Structures | |
| struct | XBee_ATCommand |
| The structure used for a standard AT Command packet. More... | |
| struct | XBee_ATCommandResponse |
| The structure used for a response to a standard AT Command packet. More... | |
| struct | XBee_TX64 |
| The structure used to transmit a data packet with a 64-bit destination address. More... | |
| struct | XBee_TX16 |
| The structure used to transmit a data packet with a 16-bit destination address. More... | |
| struct | XBee_TXStatus |
| When a transmit request is completed, the module sends a transmit status message. More... | |
| struct | XBee_RX64 |
| An incoming data packet with a 64-bit address. More... | |
| struct | XBee_RX16 |
| An incoming data packet with a 16-bit address. More... | |
| struct | XBee_IO64 |
| An incoming packet with IO data from a 64-bit address. More... | |
| struct | XBee_IO16 |
| An incoming packet with IO data from a 16-bit address. More... | |
| struct | XBeePacket |
| Representation of an XBee packet. More... | |
Enumerations | |
| enum | XBeeApiId { XBEE_TX64 = 0x00, XBEE_TX16 = 0x01, XBEE_TXSTATUS = 0x89, XBEE_RX64 = 0x80, XBEE_RX16 = 0x81, XBEE_ATCOMMAND = 0x08, XBEE_ATCOMMANDQ = 0x09, XBEE_ATCOMMANDRESPONSE = 0x88, XBEE_IO64 = 0x82, XBEE_IO16 = 0x83 } |
| Possible API IDs for different kinds of packets. More... | |
Functions | |
| int | XBee_SetActive (int state) |
| Controls the active state of the XBee subsystem. | |
| int | XBee_GetActive (void) |
| Read the active state of the XBee subsystem. | |
| int | XBee_GetPacket (XBeePacket *packet, int timeout) |
| Receive an incoming XBee packet. | |
| int | XBee_SendPacket (XBeePacket *packet, int datalength) |
| Send an XBee packet. | |
| void | XBee_ResetPacket (XBeePacket *packet) |
| Initialize a packet before reading into it. | |
| int | XBee_Write (uchar *buffer, int count, int timeout) |
| Write the specified number of bytes into the XBee unit. | |
| int | XBee_Read (uchar *buffer, int count, int timeout) |
| Read data from the Xbee unit waiting for the specified time. | |
| int | XBee_IsBusyPacket (XBeePacket *packet) |
| Checks to see if a packet is receiving a message. | |
| bool | XBee_CreateTX16Packet (XBeePacket *xbp, uint8 frameID, uint16 destination, uint8 options, uint8 *data, uint8 datalength) |
| Create a packet to be transmitted with a 16-bit address. | |
| bool | XBee_CreateTX64Packet (XBeePacket *xbp, uint8 frameID, uint64 destination, uint8 options, uint8 *data, uint8 datalength) |
| Create a packet to be transmitted with a 64-bit address. | |
| bool | XBee_ReadRX16Packet (XBeePacket *xbp, uint16 *srcAddress, uint8 *sigstrength, uint8 *options, uint8 **data, uint8 *datalength) |
| Unpack the info from an incoming packet with a 16-bit address. | |
| bool | XBee_ReadRX64Packet (XBeePacket *xbp, uint64 *srcAddress, uint8 *sigstrength, uint8 *options, uint8 **data, uint8 *datalength) |
| Unpack the info from an incoming packet with a 64-bit address. | |
| bool | XBee_ReadIO16Packet (XBeePacket *xbp, uint16 *srcAddress, uint8 *sigstrength, uint8 *options, int *samples) |
| Unpack the info from an incoming IO packet with a 16-bit address. | |
| bool | XBee_ReadIO64Packet (XBeePacket *xbp, uint64 *srcAddress, uint8 *sigstrength, uint8 *options, int *samples) |
| Unpack the info from an incoming IO packet with a 64-bit address. | |
| void | XBee_CreateATCommandPacket (XBeePacket *packet, uint8 frameID, char *cmd, uint8 *params, uint8 datalength) |
| A convenience function for creating an AT command packet. | |
| bool | XBee_ReadAtResponsePacket (XBeePacket *xbp, uint8 *frameID, char **command, uint8 *status, int *datavalue) |
| Unpack the info from an incoming AT Command Response packet. | |
| bool | XBee_ReadTXStatusPacket (XBeePacket *xbp, uint8 *frameID, uint8 *status) |
| Unpack the info from TX Status packet. | |
| void | XBeeConfig_SetPacketApiMode (int value) |
| Set a module into packet API mode. | |
| int | XBeeConfig_RequestPacketApiMode (void) |
| Query whether the module is in API mode. | |
| void | XBeeConfig_WriteStateToMemory (void) |
| Save the configuration changes you've made on the module to memory. | |
| void | XBeeConfig_SetAddress (uint16 address) |
| Set this module's address. | |
| int | XBeeConfig_RequestAddress (void) |
| Query the address of the module. | |
| void | XBeeConfig_SetPanID (uint16 id) |
| Set this PAN (Personal Area Network) ID. | |
| int | XBeeConfig_RequestPanID (void) |
| Query the PAN ID of the module. | |
| void | XBeeConfig_SetChannel (uint8 channel) |
| Set the module's channel. | |
| int | XBeeConfig_RequestChannel (void) |
| Query the channel of the module. | |
| void | XBeeConfig_SetSampleRate (uint16 rate) |
| Set the rate at which the module will sample its IO pins. | |
| int | XBeeConfig_RequestSampleRate (void) |
| Query the sample rate of the module. | |
| void | XBeeConfig_SetIO (int index, int value) |
| Configure the IO settings on an XBee module. | |
| int | XBeeConfig_RequestIO (int pin) |
| Query the configuration of an IO pin. | |
| int | XBeeConfig_RequestATResponse (char *cmd) |
| Query the address of the module. | |
| void | XBee_IntToBigEndianArray (int value, uint8 *array) |
| Convert a 32-bit integer into a big endian array of 4 unsigned 8-bit integers. | |
Definition in file xbee.h.