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

Dependencies:   XBeeLib mbed

Fork of XBeeZB_power_mngmnt_pin_sleep by Digi International Inc.

Description

This example characterizes a device that after taking samples from some sensors and sending the information collected through the radio, does nothing for a long period of time that could range from several minutes to several hours.
In that long period of inactivity it's not expected to have communication with the coordinator or other remote devices. The device will not be able to receive packets and should save as much power as possible, therefore the radio is set into low power.

The example does following cycle endlessly:

  • Some sensor is read. For demonstration, a counter is incremented.
  • For demonstration, a message containing the data collected during sampling stage is sent to a remote device.
  • After job has been done the radio will go to sleep:
  • First radio is requested to go to sleep. When radio finally sleeps, then the application waits for the time configured in the SLEEP_SECONDS define (40 seconds).
  • This time can be increased as desired.
  • After that time, the application will awake the radio through the On/Sleep pin and another cycle will start by taking a sample.

Setup

Application

Define RADIO_SLEEP_REQ and RADIO_ON_SLEEP in config.h file according to the mbed micro-controller GPIOs that will be used to control the XBee module power.

Hardware

It's necessary to wire following connections from the mbed micro-controller to the XBee radio according to the configuration done in the application:

  • From the mbed micro-controller RADIO_SLEEP_REQ to the XBee module SLEEP_RQ pin (pin 9 on THT modules, pin 10 on SMT modules) will allow the mbed micro-controller to request the radio to sleep or awake.
  • From the mbed micro-controller RADIO_ON_SLEEP to XBee module ON/SLEEP# pin (pin 13 on THT modules, pin 26 on SMT modules) will allow the mbed micro-controller to know if the radio is awake or slept.

Demo run

While the demo is running, you will see the frames sent by the XBee module through the serial console terminal.

Verify that the remote device is receiving the frames by accessing the "Console" tab of the XCTU.
If the frames are successfully sent, they will be displayed there, every 40 seconds.

     Sensor sample: 0, next sample in 40 seconds
     Sensor sample: 1, next sample in 40 seconds
Committer:
hbujanda
Date:
Fri Jul 29 12:15:54 2016 +0200
Revision:
8:2ed4afd4964b
Parent:
4:247facc3db2a
Automatic upload

Who changed what in which revision?

UserRevisionLine numberNew contents of line
spastor 3:a1a694348f09 1 /**
spastor 3:a1a694348f09 2 * Copyright (c) 2015 Digi International Inc.,
spastor 3:a1a694348f09 3 * All rights not expressly granted are reserved.
spastor 3:a1a694348f09 4 *
spastor 3:a1a694348f09 5 * This Source Code Form is subject to the terms of the Mozilla Public
spastor 3:a1a694348f09 6 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
spastor 3:a1a694348f09 7 * You can obtain one at http://mozilla.org/MPL/2.0/.
spastor 3:a1a694348f09 8 *
spastor 3:a1a694348f09 9 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
spastor 3:a1a694348f09 10 * =======================================================================
spastor 3:a1a694348f09 11 */
hbujanda 2:507c28e0461a 12
spastor 3:a1a694348f09 13 #ifndef __CONFIG_H_
hbujanda 2:507c28e0461a 14 #define __CONFIG_H_
hbujanda 2:507c28e0461a 15
hbujanda 2:507c28e0461a 16 /** Library configuration options */
hbujanda 2:507c28e0461a 17 #define ENABLE_LOGGING
hbujanda 2:507c28e0461a 18 #define ENABLE_ASSERTIONS
hbujanda 2:507c28e0461a 19 #define FRAME_BUFFER_SIZE 4
hbujanda 2:507c28e0461a 20 #define MAX_FRAME_PAYLOAD_LEN 128
hbujanda 2:507c28e0461a 21
hbujanda 2:507c28e0461a 22 #define SYNC_OPS_TIMEOUT_MS 2000
hbujanda 2:507c28e0461a 23
hbujanda 2:507c28e0461a 24 //#define RADIO_TX NC /* TODO: specify your setup's Serial TX pin connected to the XBee module DIN pin */
hbujanda 2:507c28e0461a 25 //#define RADIO_RX NC /* TODO: specify your setup's Serial RX pin connected to the XBee module DOUT pin */
hbujanda 2:507c28e0461a 26 //#define RADIO_RTS NC /* TODO: specify your setup's Serial RTS# pin connected to the XBee module RTS# pin */
hbujanda 2:507c28e0461a 27 //#define RADIO_CTS NC /* TODO: specify your setup's Serial CTS# pin connected to the XBee module CTS# pin */
hbujanda 2:507c28e0461a 28 //#define RADIO_RESET NC /* TODO: specify your setup's GPIO (output) connected to the XBee module's reset pin */
hbujanda 2:507c28e0461a 29 //#define RADIO_SLEEP_REQ NC /* TODO: specify your setup's GPIO (output) connected to the XBee module's SLEEP_RQ pin */
hbujanda 2:507c28e0461a 30 //#define RADIO_ON_SLEEP NC /* TODO: specify your setup's GPIO (input) connected to the XBee module's ON_SLEEP pin */
hbujanda 2:507c28e0461a 31 //#define DEBUG_TX NC /* TODO: specify your setup's Serial TX for debugging */
hbujanda 2:507c28e0461a 32 //#define DEBUG_RX NC /* TODO: specify your setup's Serial RX for debugging (optional) */
hbujanda 2:507c28e0461a 33
hbujanda 2:507c28e0461a 34 #if !defined(RADIO_TX)
hbujanda 2:507c28e0461a 35 #error "Please define RADIO_TX pin"
hbujanda 2:507c28e0461a 36 #endif
hbujanda 2:507c28e0461a 37
hbujanda 2:507c28e0461a 38 #if !defined(RADIO_RX)
hbujanda 2:507c28e0461a 39 #error "Please define RADIO_RX pin"
hbujanda 2:507c28e0461a 40 #endif
hbujanda 2:507c28e0461a 41
hbujanda 2:507c28e0461a 42 #if !defined(RADIO_RESET)
hbujanda 2:507c28e0461a 43 #define RADIO_RESET NC
hbujanda 2:507c28e0461a 44 #warning "RADIO_RESET not defined, defaulted to 'NC'"
hbujanda 2:507c28e0461a 45 #endif
hbujanda 2:507c28e0461a 46
hbujanda 2:507c28e0461a 47 #if defined(ENABLE_LOGGING)
hbujanda 2:507c28e0461a 48 #if !defined(DEBUG_TX)
hbujanda 2:507c28e0461a 49 #error "Please define DEBUG_TX"
hbujanda 2:507c28e0461a 50 #endif
hbujanda 2:507c28e0461a 51 #if !defined(DEBUG_RX)
hbujanda 2:507c28e0461a 52 #define DEBUG_RX NC
hbujanda 2:507c28e0461a 53 #warning "DEBUG_RX not defined, defaulted to 'NC'"
hbujanda 2:507c28e0461a 54 #endif
hbujanda 2:507c28e0461a 55 #endif
hbujanda 2:507c28e0461a 56
hbujanda 2:507c28e0461a 57 #endif /* __CONFIG_H_ */