Digi International Inc. / Mbed 2 deprecated XBeeDM_power_mngmnt_pin_sleep

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

main.cpp

Committer:
hbujanda
Date:
2016-07-29
Revision:
8:2ed4afd4964b
Parent:
7:adbc169e77b2

File content as of revision 8:2ed4afd4964b:

/**
 * Copyright (c) 2015 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */

#include "mbed.h"
#include "XBeeLib.h"
#if defined(ENABLE_LOGGING)
#include "DigiLoggerMbedSerial.h"
using namespace DigiLog;
#endif

using namespace XBeeLib;

#define SLEEP_SECONDS			(40)	/* 40 seconds, for demo */

#if !defined(RADIO_SLEEP_REQ)
    #error "Please define RADIO_SLEEP_REQ pin in config.h"
#endif
#if !defined(RADIO_ON_SLEEP)
    #error "Please define RADIO_ON_SLEEP pin in config.h"
#endif

Serial *log_serial;

DigitalOut* sleep_req = NULL;
DigitalIn* on_sleep = NULL;

bool is_radio_sleeping()
{
    assert(on_sleep != NULL);

    return on_sleep->read() == 0;
}

void sleep_radio()
{
    assert(sleep_req != NULL);

    sleep_req->write(1);
}

void awake_radio()
{
    assert(sleep_req != NULL);

    sleep_req->write(0);

    /* Wait until radio awakes. Typically 14 mS */
    while(is_radio_sleeping());
}

static void send_sample(XBeeDM& xbee)
{
    char data[60];
    static uint16_t sample = 0;
    const uint16_t data_len = sprintf(data, "\r\nSensor sample: %u, next sample in %lu seconds\r\n",
								 sample++, (uint32_t)SLEEP_SECONDS);

    const TxStatus txStatus = xbee.send_data_broadcast((const uint8_t *)data, data_len);
    if (txStatus == TxStatusSuccess)
        log_serial->printf("send_data OK\r\n");
    else
        log_serial->printf("send_data failed with %d\r\n", (int) txStatus);
}

int main()
{
    AtCmdFrame::AtCmdResp cmdresp;

    /* Configure cpu pins to control the radio power management pins:
     *     - RADIO_SLEEP_REQ: This pin connected to the radio SLEEP_RQ pin (pin 9 on THT modules, pin 10 on SMT modules) will
     *                   allow the cpu to request the radio to sleep or awake.
     *     - RADIO_ON_SLEEP: This pin connected to radio ON/SLEEP# pin (pin 13 on THT modules, pin 26 on SMT modules) will
     *                  allow the cpu to know if the radio is awaked or sleept.
     */
    sleep_req = new DigitalOut(RADIO_SLEEP_REQ);
    on_sleep = new DigitalIn(RADIO_ON_SLEEP);

    log_serial = new Serial(DEBUG_TX, DEBUG_RX);
    log_serial->baud(9600);
    log_serial->printf("Sample application to demo pin sleep power management with the XBeeDM\r\n\r\n");
    log_serial->printf(XB_LIB_BANNER);

#if defined(ENABLE_LOGGING)
    new DigiLoggerMbedSerial(log_serial, LogLevelInfo);
#endif

    XBeeDM xbee = XBeeDM(RADIO_TX, RADIO_RX, RADIO_RESET, NC, NC, 9600);

    RadioStatus radioStatus = xbee.init();
    MBED_ASSERT(radioStatus == Success);

    /* Configure Sleep mode */
    cmdresp = xbee.set_param("SM", 1); /* Pin Hibernate */
    if (cmdresp != AtCmdFrame::AtCmdRespOk) {
        log_serial->printf("SM Failed!!\r\n");
    }

    /* Start sending samples */
    while (1) {
        /* Awake the radio */
        awake_radio();

        send_sample(xbee);

        /* Sleep the radio again */
        sleep_radio();

        wait(SLEEP_SECONDS);
    }

    delete(log_serial);
}