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.

/media/uploads/spastor/xbee-xbeepro-series1.jpg

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:

  1. Configuring the library
  2. Debugging the library
  3. Initializing modules
  4. Resetting the local module
  5. Receiving Data from other module
  6. Sending data to another module
  7. Discovering nodes in the network
  8. Configuring local and remote modules
  9. Handling modem status changes
  10. Handling remote modules DIOs, ADCs and PWMs
  11. Handling IO Data Samples from other module
  12. 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

Committer:
hbujanda
Date:
Fri Jul 29 13:10:07 2016 +0200
Revision:
9:780db84ce891
Parent:
4:629712865107
Automatic upload

Who changed what in which revision?

UserRevisionLine numberNew 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(__FH_IO_DATA_SAMPLE_ZB_H_)
spastor 0:fcaad0dfa051 14 #define __FH_IO_DATA_SAMPLE_ZB_H_
spastor 0:fcaad0dfa051 15
spastor 0:fcaad0dfa051 16 #include "FrameHandler.h"
spastor 0:fcaad0dfa051 17 #include "RemoteXBee/RemoteXBee.h"
spastor 0:fcaad0dfa051 18
spastor 0:fcaad0dfa051 19 namespace XBeeLib {
spastor 0:fcaad0dfa051 20
spastor 0:fcaad0dfa051 21 class IOSampleZB;
spastor 0:fcaad0dfa051 22
spastor 0:fcaad0dfa051 23 /**
spastor 0:fcaad0dfa051 24 * @defgroup callback_types "Callback types declaration"
spastor 0:fcaad0dfa051 25 * @{
spastor 0:fcaad0dfa051 26 */
spastor 0:fcaad0dfa051 27 /** IO Data Sample reception (ZigBee modules) callback type declaration
spastor 0:fcaad0dfa051 28 * @param remote the remote module that sent the data
spastor 0:fcaad0dfa051 29 * @param sample_data a referece to an @ref IOSampleZB that can be queried for the IoLines' values
spastor 0:fcaad0dfa051 30 */
spastor 0:fcaad0dfa051 31 typedef void (*io_data_cb_zb_t)(const RemoteXBeeZB& remote, const IOSampleZB& sample_data);
spastor 0:fcaad0dfa051 32 /**
spastor 0:fcaad0dfa051 33 * @}
spastor 0:fcaad0dfa051 34 */
spastor 0:fcaad0dfa051 35
spastor 0:fcaad0dfa051 36 class FH_IoDataSampeZB : public FrameHandler
spastor 0:fcaad0dfa051 37 {
spastor 0:fcaad0dfa051 38 public:
spastor 0:fcaad0dfa051 39 /** Class constructor */
spastor 0:fcaad0dfa051 40 FH_IoDataSampeZB();
spastor 0:fcaad0dfa051 41
spastor 0:fcaad0dfa051 42 /** Class destructor */
spastor 0:fcaad0dfa051 43 virtual ~FH_IoDataSampeZB();
spastor 4:629712865107 44
spastor 0:fcaad0dfa051 45 virtual void process_frame_data(const ApiFrame *const frame);
spastor 0:fcaad0dfa051 46
spastor 0:fcaad0dfa051 47 void register_io_data_cb(io_data_cb_zb_t function);
spastor 4:629712865107 48
spastor 0:fcaad0dfa051 49 void unregister_io_data_cb();
spastor 0:fcaad0dfa051 50
spastor 0:fcaad0dfa051 51 private:
spastor 0:fcaad0dfa051 52 /** Callback function, invoked if registered */
spastor 0:fcaad0dfa051 53 io_data_cb_zb_t io_data_cb;
spastor 0:fcaad0dfa051 54 };
spastor 0:fcaad0dfa051 55
spastor 0:fcaad0dfa051 56 } /* namespace XBeeLib */
spastor 0:fcaad0dfa051 57
spastor 0:fcaad0dfa051 58 #endif /* __FH_IO_DATA_SAMPLE_ZB_H_ */