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/IOSampleDM.h@9:780db84ce891, 2016-07-29 (annotated)

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hbujanda 6:06522f3a6642 1 /**
hbujanda 6:06522f3a6642 2 * Copyright (c) 2015 Digi International Inc.,
hbujanda 6:06522f3a6642 3 * All rights not expressly granted are reserved.
hbujanda 6:06522f3a6642 4 *
hbujanda 6:06522f3a6642 5 * This Source Code Form is subject to the terms of the Mozilla Public
hbujanda 6:06522f3a6642 6 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
hbujanda 6:06522f3a6642 7 * You can obtain one at http://mozilla.org/MPL/2.0/.
hbujanda 6:06522f3a6642 8 *
hbujanda 6:06522f3a6642 9 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
hbujanda 6:06522f3a6642 10 * =======================================================================
hbujanda 6:06522f3a6642 11 */
hbujanda 6:06522f3a6642 12
hbujanda 6:06522f3a6642 13 #ifndef _IO_IOSAMPLEDM_H_
hbujanda 6:06522f3a6642 14 #define _IO_IOSAMPLEDM_H_
hbujanda 6:06522f3a6642 15
hbujanda 6:06522f3a6642 16 #define MAX_IO_SAMPLE_DM_LEN (2 + 2 * 5)
hbujanda 6:06522f3a6642 17
hbujanda 6:06522f3a6642 18 namespace XBeeLib {
hbujanda 6:06522f3a6642 19
hbujanda 6:06522f3a6642 20 /** Class to handle the incoming IO Data Samples in ZigBee modules */
hbujanda 6:06522f3a6642 21 class IOSampleDM {
hbujanda 6:06522f3a6642 22 public:
hbujanda 6:06522f3a6642 23 /** Class constructor
hbujanda 6:06522f3a6642 24 * @param raw_data The IO Sample data, as returned by an "IS" command response or in the IoSampleRxZBDM (0x92) frames
hbujanda 6:06522f3a6642 25 * @param size size (in bytes) of raw_data.
hbujanda 6:06522f3a6642 26 */
hbujanda 6:06522f3a6642 27 IOSampleDM(const uint8_t* const raw_data = NULL, size_t size = 0);
hbujanda 6:06522f3a6642 28
hbujanda 6:06522f3a6642 29 /** Class destructor */
hbujanda 6:06522f3a6642 30 ~IOSampleDM();
hbujanda 6:06522f3a6642 31
hbujanda 6:06522f3a6642 32 /** get_dio - read the value of a DIO configured as digital input
hbujanda 6:06522f3a6642 33 *
hbujanda 6:06522f3a6642 34 * @param line DIO line being read
hbujanda 6:06522f3a6642 35 * @param val pointer where the DIO value read will be stored
hbujanda 6:06522f3a6642 36 * @returns
hbujanda 6:06522f3a6642 37 * Success if the operation was successful,
hbujanda 6:06522f3a6642 38 * Failure otherwise
hbujanda 6:06522f3a6642 39 */
hbujanda 6:06522f3a6642 40 RadioStatus get_dio(XBeeDM::IoLine line, DioVal* const dio_value) const;
hbujanda 6:06522f3a6642 41
hbujanda 6:06522f3a6642 42 /** get_adc - read the value of the espcified ADC line
hbujanda 6:06522f3a6642 43 *
hbujanda 6:06522f3a6642 44 * @param line ADC line being read
hbujanda 6:06522f3a6642 45 * @param val pointer where the value read from the ADC will be stored
hbujanda 6:06522f3a6642 46 * @returns
hbujanda 6:06522f3a6642 47 * Success if the operation was successful,
hbujanda 6:06522f3a6642 48 * Failure otherwise
hbujanda 6:06522f3a6642 49 */
hbujanda 6:06522f3a6642 50 RadioStatus get_adc(XBeeDM::IoLine line, uint16_t* const val) const;
hbujanda 6:06522f3a6642 51
hbujanda 6:06522f3a6642 52 /** is_valid - checks if the IOSampleDM object has at least one DIO or ADC sample.
hbujanda 6:06522f3a6642 53 * @returns true if valid, false otherwise
hbujanda 6:06522f3a6642 54 */
hbujanda 6:06522f3a6642 55 inline bool is_valid()
hbujanda 6:06522f3a6642 56 {
hbujanda 6:06522f3a6642 57 return _digital_mask != 0 || _analog_mask != 0;
hbujanda 6:06522f3a6642 58 }
hbujanda 6:06522f3a6642 59
hbujanda 6:06522f3a6642 60 protected:
hbujanda 6:06522f3a6642 61 uint16_t _digital_mask;
hbujanda 6:06522f3a6642 62 uint8_t _analog_mask;
hbujanda 6:06522f3a6642 63 uint8_t _sampled_data[MAX_IO_SAMPLE_DM_LEN];
hbujanda 6:06522f3a6642 64 uint8_t _sampled_data_size;
hbujanda 6:06522f3a6642 65
hbujanda 6:06522f3a6642 66 inline uint16_t get_digital_channels(void) const;
hbujanda 6:06522f3a6642 67 };
hbujanda 6:06522f3a6642 68
hbujanda 6:06522f3a6642 69 } /* namespace XBeeLib */
hbujanda 6:06522f3a6642 70
hbujanda 6:06522f3a6642 71 #endif /* _IO_IOSAMPLEDM_H_ */