Digi International Inc. / XBeeLib

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

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_Send_Data

ZigBee Send Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_module_config

ZigBee network configuration example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_AT_Commands

ZigBee AT Commands example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_dio_adc

ZigBee DIOs and ADCs example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_IO_Sample_Callback

ZigBee IO Sampling Callback example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_modem_status

ZigBee Modem Status example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_node_discovery

ZigBee Node Discovery example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_power_mngmnt_cyclic_sleep

ZigBee Power Management using Cyclic Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeZB_power_mngmnt_pin_sleep

ZigBee Power Management using Pin Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Examples for 802.15.4 modules

Import programXBee802_Receive_Data

802.15.4 Receive Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_Send_Data

802.15.4 Send Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_module_config

802.15.4 network configuration example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_AT_Commands

802.15.4 AT Commands example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_dio_adc_pwm

802.15.4 DIOs, ADCs and PWM example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_IO_Sample_Callback

802.15.4 IO Sampling Callback example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_node_discovery

802.15.4 Node Discovery example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_power_mngmnt_cyclic_sleep

802.15.4 Power Management using Cyclic Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBee802_power_mngmnt_pin_sleep

802.15.4 Power Management using Pin Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Examples for DigiMesh modules

Import programXBeeDM_Receive_Data

DigiMesh Receive Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_Send_Data

DigiMesh Send Data example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_module_config

DigiMesh network configuration example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_AT_Commands

DigiMesh AT Commands example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_dio_adc_pwm

DigiMEsh DIOs, ADCs and PWMs example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_IO_Sample_Callback

DigiMesh IO Sampling Callback example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_modem_status

DigiMesh Modem Status example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_node_discovery

DigiMesh Node Discovery example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_power_mngmnt_asyncr_cyclic_sleep

DigiMesh Power Management using Asynchronous Cyclic Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

Import programXBeeDM_power_mngmnt_pin_sleep

DigiMesh Power Management using Pin Sleep example for mbed XBeeLib By Digi

Last commit 29 Jul 2016 by Digi International Inc.

IO/IOSample802.h@0:fcaad0dfa051, 2015-05-08 (annotated)

Committer:
spastor
Date:
Fri May 08 11:50:56 2015 +0200
Revision:
0:fcaad0dfa051
Child:
3:8662ebe83570
Automatic upload

Who changed what in which revision?

UserRevisionLine numberNew contents of line
spastor 0:fcaad0dfa051 1 /**
spastor 0:fcaad0dfa051 2 * Digi XBee library for mbed. This is the only header you have to include from your application to use the library.
spastor 0:fcaad0dfa051 3 *
spastor 0:fcaad0dfa051 4 * Copyright (c) 2015 Digi International Inc.,
spastor 0:fcaad0dfa051 5 * All rights not expressly granted are reserved.
spastor 0:fcaad0dfa051 6 *
spastor 0:fcaad0dfa051 7 * This Source Code Form is subject to the terms of the Mozilla Public
spastor 0:fcaad0dfa051 8 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
spastor 0:fcaad0dfa051 9 * You can obtain one at http://mozilla.org/MPL/2.0/.
spastor 0:fcaad0dfa051 10 *
spastor 0:fcaad0dfa051 11 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343.
spastor 0:fcaad0dfa051 12 */
spastor 0:fcaad0dfa051 13
spastor 0:fcaad0dfa051 14 #ifndef _IO_IOSAMPLE802_H_
spastor 0:fcaad0dfa051 15 #define _IO_IOSAMPLE802_H_
spastor 0:fcaad0dfa051 16
spastor 0:fcaad0dfa051 17 #define MAX_IO_SAMPLE_802_LEN (2 + 2 * 6)
spastor 0:fcaad0dfa051 18
spastor 0:fcaad0dfa051 19 namespace XBeeLib {
spastor 0:fcaad0dfa051 20
spastor 0:fcaad0dfa051 21 /** Class to handle the incoming IO Data Samples in 802.15.4 modules */
spastor 0:fcaad0dfa051 22 class IOSample802 {
spastor 0:fcaad0dfa051 23 public:
spastor 0:fcaad0dfa051 24 /** Class constructor
spastor 0:fcaad0dfa051 25 * @param raw_data The IO Sample data, as returned by an "IS" command response or in the Io16Bit (0x83) or Io64Bit (0x82) frames
spastor 0:fcaad0dfa051 26 * @param size size (in bytes) of raw_data
spastor 0:fcaad0dfa051 27 */
spastor 0:fcaad0dfa051 28 IOSample802(const uint8_t* const raw_data, size_t size);
spastor 0:fcaad0dfa051 29
spastor 0:fcaad0dfa051 30 /** Class destructor */
spastor 0:fcaad0dfa051 31 ~IOSample802();
spastor 0:fcaad0dfa051 32
spastor 0:fcaad0dfa051 33 /** get_dio - read the value of a DIO configured as digital input
spastor 0:fcaad0dfa051 34 *
spastor 0:fcaad0dfa051 35 * @param line DIO line being read
spastor 0:fcaad0dfa051 36 * @param val pointer where the DIO value read will be stored
spastor 0:fcaad0dfa051 37 * @returns
spastor 0:fcaad0dfa051 38 * Success if the operation was successful,
spastor 0:fcaad0dfa051 39 * Failure otherwise
spastor 0:fcaad0dfa051 40 */
spastor 0:fcaad0dfa051 41 RadioStatus get_dio(XBee802::IoLine line, DioVal* const dio_value) const;
spastor 0:fcaad0dfa051 42
spastor 0:fcaad0dfa051 43 /** get_adc - read the value of the espcified ADC line
spastor 0:fcaad0dfa051 44 *
spastor 0:fcaad0dfa051 45 * @param line ADC line being read
spastor 0:fcaad0dfa051 46 * @param val pointer where the value read from the ADC will be stored
spastor 0:fcaad0dfa051 47 * @returns
spastor 0:fcaad0dfa051 48 * Success if the operation was successful,
spastor 0:fcaad0dfa051 49 * Failure otherwise
spastor 0:fcaad0dfa051 50 */
spastor 0:fcaad0dfa051 51 RadioStatus get_adc(XBee802::IoLine line, uint16_t* const val) const;
spastor 0:fcaad0dfa051 52
spastor 0:fcaad0dfa051 53 protected:
spastor 0:fcaad0dfa051 54 uint16_t _channel_mask;
spastor 0:fcaad0dfa051 55 uint8_t _sampled_data[MAX_IO_SAMPLE_802_LEN];
spastor 0:fcaad0dfa051 56 uint8_t _sampled_data_size;
spastor 0:fcaad0dfa051 57
spastor 0:fcaad0dfa051 58 inline bool dio_channels_present(void) const;
spastor 0:fcaad0dfa051 59 inline uint8_t get_dio_channels(void) const;
spastor 0:fcaad0dfa051 60 };
spastor 0:fcaad0dfa051 61
spastor 0:fcaad0dfa051 62 } /* namespace XBeeLib */
spastor 0:fcaad0dfa051 63
spastor 0:fcaad0dfa051 64 #endif /* _IO_IOSAMPLE802_H_ */