Library to easily communicate with XBee modules.
Dependencies: DigiLogger
Dependents: WaterLogger XbeeGateway XBee_Cooker ProjetReceiver ... more
Use XBee radio modules to easily improve your project with wireless connectivity. You can enable entire networks of connected devices. XBees can exchange data with other modules in the network and configure remote modules as well as trigger actions or collect sensor data on XBee nodes without needing additional external microcontrollers. Using this documentation and configuration tools with XBee modules, it is easy to develop these types of applications and more.
The XBee mbed Library is a ready-to-import mbed extension that dramatically reduces development time for XBee projects on the mbed platforms. There are many modular examples, making it an easy and smooth process to add wireless networking to a whole range of useful applications.
Info
Currently 802.15.4 (Series 1 and 2), ZigBee (Series 2) and DigiMesh (Series 1 and 2) modules are supported. The libraries can be extended to support other protocols like DigiMesh point-to-point, WiFi, etc.
User manual
The user manual can be found at this project's Wiki pages:
- Configuring the library
- Debugging the library
- Initializing modules
- Resetting the local module
- Receiving Data from other module
- Sending data to another module
- Discovering nodes in the network
- Configuring local and remote modules
- Handling modem status changes
- Handling remote modules DIOs, ADCs and PWMs
- Handling IO Data Samples from other module
- Radio Power Management
Ready to use examples
There are a lot of ready to use examples to get started quickly.
Make sure you have a valid example setup before running the examples:
Examples for ZigBee modules
Import programXBeeZB_Receive_Data
ZigBee Receive Data example for mbed XBeeLib By Digi
Import programXBeeZB_Send_Data
ZigBee Send Data example for mbed XBeeLib By Digi
Import programXBeeZB_module_config
ZigBee network configuration example for mbed XBeeLib By Digi
Import programXBeeZB_AT_Commands
ZigBee AT Commands example for mbed XBeeLib By Digi
Import programXBeeZB_dio_adc
ZigBee DIOs and ADCs example for mbed XBeeLib By Digi
Import programXBeeZB_IO_Sample_Callback
ZigBee IO Sampling Callback example for mbed XBeeLib By Digi
Import programXBeeZB_modem_status
ZigBee Modem Status example for mbed XBeeLib By Digi
Import programXBeeZB_node_discovery
ZigBee Node Discovery example for mbed XBeeLib By Digi
Import programXBeeZB_power_mngmnt_cyclic_sleep
ZigBee Power Management using Cyclic Sleep example for mbed XBeeLib By Digi
Import programXBeeZB_power_mngmnt_pin_sleep
ZigBee Power Management using Pin Sleep example for mbed XBeeLib By Digi
Examples for 802.15.4 modules
Import programXBee802_Receive_Data
802.15.4 Receive Data example for mbed XBeeLib By Digi
Import programXBee802_Send_Data
802.15.4 Send Data example for mbed XBeeLib By Digi
Import programXBee802_module_config
802.15.4 network configuration example for mbed XBeeLib By Digi
Import programXBee802_AT_Commands
802.15.4 AT Commands example for mbed XBeeLib By Digi
Import programXBee802_dio_adc_pwm
802.15.4 DIOs, ADCs and PWM example for mbed XBeeLib By Digi
Import programXBee802_IO_Sample_Callback
802.15.4 IO Sampling Callback example for mbed XBeeLib By Digi
Import programXBee802_node_discovery
802.15.4 Node Discovery example for mbed XBeeLib By Digi
Import programXBee802_power_mngmnt_cyclic_sleep
802.15.4 Power Management using Cyclic Sleep example for mbed XBeeLib By Digi
Import programXBee802_power_mngmnt_pin_sleep
802.15.4 Power Management using Pin Sleep example for mbed XBeeLib By Digi
Examples for DigiMesh modules
Import programXBeeDM_Receive_Data
DigiMesh Receive Data example for mbed XBeeLib By Digi
Import programXBeeDM_Send_Data
DigiMesh Send Data example for mbed XBeeLib By Digi
Import programXBeeDM_module_config
DigiMesh network configuration example for mbed XBeeLib By Digi
Import programXBeeDM_AT_Commands
DigiMesh AT Commands example for mbed XBeeLib By Digi
Import programXBeeDM_dio_adc_pwm
DigiMEsh DIOs, ADCs and PWMs example for mbed XBeeLib By Digi
Import programXBeeDM_IO_Sample_Callback
DigiMesh IO Sampling Callback example for mbed XBeeLib By Digi
Import programXBeeDM_modem_status
DigiMesh Modem Status example for mbed XBeeLib By Digi
Import programXBeeDM_node_discovery
DigiMesh Node Discovery example for mbed XBeeLib By Digi
Import programXBeeDM_power_mngmnt_asyncr_cyclic_sleep
DigiMesh Power Management using Asynchronous Cyclic Sleep example for mbed XBeeLib By Digi
Import programXBeeDM_power_mngmnt_pin_sleep
DigiMesh Power Management using Pin Sleep example for mbed XBeeLib By Digi
Frames/ApiFrame.h@4:629712865107, 2015-06-01 (annotated)
- Committer:
- spastor
- Date:
- Mon Jun 01 18:59:43 2015 +0200
- Revision:
- 4:629712865107
- Parent:
- 3:8662ebe83570
- Child:
- 6:06522f3a6642
Automatic upload
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
spastor | 0:fcaad0dfa051 | 1 | /** |
spastor | 0:fcaad0dfa051 | 2 | * Copyright (c) 2015 Digi International Inc., |
spastor | 0:fcaad0dfa051 | 3 | * All rights not expressly granted are reserved. |
spastor | 0:fcaad0dfa051 | 4 | * |
spastor | 0:fcaad0dfa051 | 5 | * This Source Code Form is subject to the terms of the Mozilla Public |
spastor | 0:fcaad0dfa051 | 6 | * License, v. 2.0. If a copy of the MPL was not distributed with this file, |
spastor | 0:fcaad0dfa051 | 7 | * You can obtain one at http://mozilla.org/MPL/2.0/. |
spastor | 0:fcaad0dfa051 | 8 | * |
spastor | 0:fcaad0dfa051 | 9 | * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343 |
spastor | 0:fcaad0dfa051 | 10 | * ======================================================================= |
spastor | 0:fcaad0dfa051 | 11 | */ |
spastor | 0:fcaad0dfa051 | 12 | |
spastor | 0:fcaad0dfa051 | 13 | #if !defined(__API_FRAME_H_) |
spastor | 0:fcaad0dfa051 | 14 | #define __API_FRAME_H_ |
spastor | 0:fcaad0dfa051 | 15 | |
spastor | 0:fcaad0dfa051 | 16 | #include "XBee/Addresses.h" |
spastor | 0:fcaad0dfa051 | 17 | |
spastor | 0:fcaad0dfa051 | 18 | /** Class for XBee API frames */ |
spastor | 4:629712865107 | 19 | class ApiFrame |
spastor | 0:fcaad0dfa051 | 20 | { |
spastor | 0:fcaad0dfa051 | 21 | /** Static variable that contains the last frame ID value assigned */ |
spastor | 0:fcaad0dfa051 | 22 | static uint8_t last_frame_id; |
spastor | 4:629712865107 | 23 | |
spastor | 0:fcaad0dfa051 | 24 | public: |
spastor | 0:fcaad0dfa051 | 25 | /** List of API frames. Note that not all frames are supported by all radios */ |
spastor | 0:fcaad0dfa051 | 26 | enum ApiFrameType { |
spastor | 4:629712865107 | 27 | |
spastor | 0:fcaad0dfa051 | 28 | TxReq64Bit = 0x00, /**< TxReq64Bit: Only for 802.15.4 modules */ |
spastor | 0:fcaad0dfa051 | 29 | TxReq16Bit = 0x01, /**< TxReq16Bit: Only for 802.15.4 modules */ |
spastor | 0:fcaad0dfa051 | 30 | AtCmd = 0x08, /**< AtCmd */ |
spastor | 0:fcaad0dfa051 | 31 | AtCmdQueuePV = 0x09, /**< AtCmdQueuePV */ |
spastor | 0:fcaad0dfa051 | 32 | TxReqZB = 0x10, /**< TxReqZB: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 33 | ExpAddrCmd = 0x11, /**< ExpAddrCmd: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 34 | RemoteCmdReq = 0x17, /**< RemoteCmdReq */ |
spastor | 0:fcaad0dfa051 | 35 | CreateSrcRoute = 0x21, /**< CreateSrcRoute */ |
spastor | 0:fcaad0dfa051 | 36 | RxPacket64Bit = 0x80, /**< RxPacket64Bit: Only for 802.15.4 modules */ |
spastor | 0:fcaad0dfa051 | 37 | RxPacket16Bit = 0x81, /**< RxPacket16Bit: Only for 802.15.4 modules */ |
spastor | 0:fcaad0dfa051 | 38 | Io64Bit = 0x82, /**< Io64Bit: Only for 802.15.4 modules */ |
spastor | 0:fcaad0dfa051 | 39 | Io16Bit = 0x83, /**< Io16Bit */ |
spastor | 0:fcaad0dfa051 | 40 | AtCmdResp = 0x88, /**< AtCmdResp */ |
spastor | 0:fcaad0dfa051 | 41 | TxStatus = 0x89, /**< TxStatus */ |
spastor | 0:fcaad0dfa051 | 42 | AtModemStatus = 0x8A, /**< AtModemStatus */ |
spastor | 0:fcaad0dfa051 | 43 | TxStatusZB = 0x8B, /**< TxStatusZB: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 44 | RxPacketAO0 = 0x90, /**< RxPacketAO0: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 45 | RxPacketAO1 = 0x91, /**< RxPacketAO1: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 46 | IoSampleRxZB = 0x92, /**< IoSampleRxZB: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 47 | SensorRxIndAO0 = 0x94, /**< SensorRxIndAO0: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 48 | NodeIdentIndAO0 = 0x95, /**< NodeIdentIndAO0: Only for ZigBee modules */ |
spastor | 0:fcaad0dfa051 | 49 | RemoteCmdResp = 0x97, /**< RemoteCmdResp */ |
spastor | 0:fcaad0dfa051 | 50 | OtaFwUpStatus = 0xA0, /**< OtaFwUpStatus */ |
spastor | 0:fcaad0dfa051 | 51 | RouteRecInd = 0xA1, /**< RouteRecInd */ |
spastor | 0:fcaad0dfa051 | 52 | Many2OneRRInd = 0xA3, /**< Many2OneRRInd */ |
spastor | 0:fcaad0dfa051 | 53 | Invalid = ~0, /**< Invalid */ |
spastor | 0:fcaad0dfa051 | 54 | }; |
spastor | 4:629712865107 | 55 | |
spastor | 0:fcaad0dfa051 | 56 | /** Default constructor */ |
spastor | 0:fcaad0dfa051 | 57 | ApiFrame(); |
spastor | 0:fcaad0dfa051 | 58 | |
spastor | 4:629712865107 | 59 | /** Constructor |
spastor | 0:fcaad0dfa051 | 60 | * |
spastor | 0:fcaad0dfa051 | 61 | * @param len length of the API frame (will allocate len bytes). |
spastor | 0:fcaad0dfa051 | 62 | */ |
spastor | 0:fcaad0dfa051 | 63 | ApiFrame(uint16_t len); |
spastor | 4:629712865107 | 64 | |
spastor | 4:629712865107 | 65 | /** Constructor |
spastor | 0:fcaad0dfa051 | 66 | * |
spastor | 0:fcaad0dfa051 | 67 | * @param type frame type of this api frame. |
spastor | 0:fcaad0dfa051 | 68 | * @param data pointer to frame data payload. |
spastor | 0:fcaad0dfa051 | 69 | * @param len length of the payload. |
spastor | 0:fcaad0dfa051 | 70 | */ |
spastor | 0:fcaad0dfa051 | 71 | ApiFrame(ApiFrameType type, const uint8_t *data, uint16_t len); |
spastor | 4:629712865107 | 72 | |
spastor | 0:fcaad0dfa051 | 73 | /** Destructor */ |
spastor | 0:fcaad0dfa051 | 74 | ~ApiFrame(); |
spastor | 0:fcaad0dfa051 | 75 | |
spastor | 0:fcaad0dfa051 | 76 | ApiFrame(const ApiFrame& other); /* Intentionally not implemented */ |
spastor | 0:fcaad0dfa051 | 77 | |
spastor | 4:629712865107 | 78 | /** get_frame_type gets the type of the frame |
spastor | 0:fcaad0dfa051 | 79 | * |
spastor | 0:fcaad0dfa051 | 80 | * @returns the type of this frame. |
spastor | 0:fcaad0dfa051 | 81 | */ |
spastor | 0:fcaad0dfa051 | 82 | ApiFrameType get_frame_type() const; |
spastor | 4:629712865107 | 83 | |
spastor | 0:fcaad0dfa051 | 84 | /** dump dumps the information of this frame */ |
spastor | 0:fcaad0dfa051 | 85 | void dump() const; |
spastor | 4:629712865107 | 86 | |
spastor | 0:fcaad0dfa051 | 87 | /** dump_if dumps the information of the frame if the frame type matches |
spastor | 0:fcaad0dfa051 | 88 | * with the parameter. |
spastor | 0:fcaad0dfa051 | 89 | * |
spastor | 0:fcaad0dfa051 | 90 | * @param type dump the frame info/data if the frame type matches with type. |
spastor | 0:fcaad0dfa051 | 91 | */ |
spastor | 0:fcaad0dfa051 | 92 | void dump_if(ApiFrameType type); |
spastor | 0:fcaad0dfa051 | 93 | |
spastor | 0:fcaad0dfa051 | 94 | |
spastor | 0:fcaad0dfa051 | 95 | /** set_frame_type sets the type of the frame to type. |
spastor | 0:fcaad0dfa051 | 96 | * |
spastor | 0:fcaad0dfa051 | 97 | * @param type the type we want to set on the frame. |
spastor | 0:fcaad0dfa051 | 98 | */ |
spastor | 0:fcaad0dfa051 | 99 | void set_frame_type(ApiFrameType type); |
spastor | 4:629712865107 | 100 | |
spastor | 0:fcaad0dfa051 | 101 | /** get_data_len gets the length of the frame data payload. |
spastor | 0:fcaad0dfa051 | 102 | * |
spastor | 0:fcaad0dfa051 | 103 | * @returns the length of the data payload. |
spastor | 0:fcaad0dfa051 | 104 | */ |
spastor | 0:fcaad0dfa051 | 105 | uint16_t get_data_len() const; |
spastor | 0:fcaad0dfa051 | 106 | |
spastor | 0:fcaad0dfa051 | 107 | /** set_data_len sets the length of the frame data payload. |
spastor | 0:fcaad0dfa051 | 108 | * |
spastor | 0:fcaad0dfa051 | 109 | * @param len the length of the data payload will be set on this frame. |
spastor | 0:fcaad0dfa051 | 110 | */ |
spastor | 0:fcaad0dfa051 | 111 | void set_data_len(uint16_t len); |
spastor | 4:629712865107 | 112 | |
spastor | 0:fcaad0dfa051 | 113 | /** get_data returns a pointer to the frame data payload. |
spastor | 0:fcaad0dfa051 | 114 | * |
spastor | 0:fcaad0dfa051 | 115 | * @returns a pointer to the frame data payload. |
spastor | 0:fcaad0dfa051 | 116 | */ |
spastor | 0:fcaad0dfa051 | 117 | const uint8_t *get_data() const; |
spastor | 4:629712865107 | 118 | |
spastor | 0:fcaad0dfa051 | 119 | /** get_data_at returns the byte at index offset. |
spastor | 0:fcaad0dfa051 | 120 | * |
spastor | 0:fcaad0dfa051 | 121 | * @param index offset of the byte we want to get. |
spastor | 0:fcaad0dfa051 | 122 | * @returns the byte at index offset. |
spastor | 0:fcaad0dfa051 | 123 | */ |
spastor | 4:629712865107 | 124 | uint8_t get_data_at(uint16_t index) const; |
spastor | 0:fcaad0dfa051 | 125 | |
spastor | 0:fcaad0dfa051 | 126 | /** set_data sets data byte at the specified index or offset. |
spastor | 0:fcaad0dfa051 | 127 | * |
spastor | 0:fcaad0dfa051 | 128 | * @param data byte that will be set at index position. |
spastor | 0:fcaad0dfa051 | 129 | * @param index offset of the byte we want to set. |
spastor | 0:fcaad0dfa051 | 130 | */ |
spastor | 0:fcaad0dfa051 | 131 | void set_data(uint8_t data, uint16_t index); |
spastor | 0:fcaad0dfa051 | 132 | |
spastor | 0:fcaad0dfa051 | 133 | /** get_frame_id returns the frame id of this frame. |
spastor | 0:fcaad0dfa051 | 134 | * |
spastor | 0:fcaad0dfa051 | 135 | * @returns the frame id of this frame. |
spastor | 0:fcaad0dfa051 | 136 | */ |
spastor | 0:fcaad0dfa051 | 137 | uint8_t get_frame_id() const; |
spastor | 0:fcaad0dfa051 | 138 | |
spastor | 0:fcaad0dfa051 | 139 | static uint8_t get_current_frame_id() |
spastor | 0:fcaad0dfa051 | 140 | { |
spastor | 0:fcaad0dfa051 | 141 | return last_frame_id; |
spastor | 0:fcaad0dfa051 | 142 | } |
spastor | 4:629712865107 | 143 | |
spastor | 0:fcaad0dfa051 | 144 | protected: |
spastor | 0:fcaad0dfa051 | 145 | /** Type of this frame */ |
spastor | 0:fcaad0dfa051 | 146 | ApiFrameType _type; |
spastor | 0:fcaad0dfa051 | 147 | |
spastor | 4:629712865107 | 148 | /** length of the payload, excluding the frame type */ |
spastor | 0:fcaad0dfa051 | 149 | uint16_t _data_frame_len; |
spastor | 0:fcaad0dfa051 | 150 | |
spastor | 4:629712865107 | 151 | /** pointer to the frame data */ |
spastor | 0:fcaad0dfa051 | 152 | uint8_t *_data; |
spastor | 0:fcaad0dfa051 | 153 | |
spastor | 4:629712865107 | 154 | /** True if the constructor allocates the data. Needed to delete it on the destructor */ |
spastor | 0:fcaad0dfa051 | 155 | bool _alloc_data; |
spastor | 4:629712865107 | 156 | |
spastor | 0:fcaad0dfa051 | 157 | /** Frame ID of this frame */ |
spastor | 0:fcaad0dfa051 | 158 | uint8_t _frame_id; |
spastor | 4:629712865107 | 159 | |
spastor | 0:fcaad0dfa051 | 160 | /** get_next_frame_id - returns the next frame ID secuentially, skipping the value 0 |
spastor | 0:fcaad0dfa051 | 161 | * |
spastor | 0:fcaad0dfa051 | 162 | * @returns the next frame ID that should be assigned to a frame |
spastor | 0:fcaad0dfa051 | 163 | */ |
spastor | 0:fcaad0dfa051 | 164 | uint8_t get_next_frame_id(); |
spastor | 0:fcaad0dfa051 | 165 | |
spastor | 4:629712865107 | 166 | /** set_api_frame sets several members |
spastor | 0:fcaad0dfa051 | 167 | * |
spastor | 0:fcaad0dfa051 | 168 | * @param type frame type of this api frame. |
spastor | 0:fcaad0dfa051 | 169 | * @param data pointer to frame data payload. |
spastor | 0:fcaad0dfa051 | 170 | * @param len length of the payload. |
spastor | 0:fcaad0dfa051 | 171 | */ |
spastor | 0:fcaad0dfa051 | 172 | void set_api_frame(ApiFrameType type, const uint8_t *data, uint16_t len); |
spastor | 0:fcaad0dfa051 | 173 | }; |
spastor | 0:fcaad0dfa051 | 174 | |
spastor | 0:fcaad0dfa051 | 175 | #endif /* __API_FRAME_H_ */ |