Digi International Inc. / Mbed 2 deprecated XBeeDM_power_mngmnt_asyncr_cyclic_sleep

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

Dependencies:   XBeeLib mbed

Fork of XBeeZB_power_mngmnt_cyclic_sleep by Digi International Inc.

Description

This example characterizes a device that needs to be continuously joined to the coordinator so it doesn't lose any incoming packets. A fast response to packets is not required so radio can sleep for some time to save power while the coordinator buffers its packets.

The example configures the radio to poll its coordinator every 5 seconds if there is any packet for it.
If there is one or more, it awakes and send the packets to the mbed micro-controller.

Note that in DigiMesh modules, the polling mechanism required in this example is restricted to devices one hop away (Point to Multipoint delivery); it will not work fine across a DigiMesh network.

Setup

Network

You need to set up a coordinator in the network so it buffers the packets send to our local XBee device while it's sleeping.
A module configured as coordinator requires:

  • 'Coordinator Enable (CE)' parameter set to 1.
  • 'Cyclic Sleep Period (SP)' parameter set as the local XBee device.
    In the example it is set to 5000 which represent 5000 ms or 5 seconds.
    In the coordinator, when using X-CTU for configuration, the SP parameter has to be entered as the desired sleep time divided by 10 and in hexadecimal so to cope with the example it should be 5000 / 10 = 500 = 0x1F4 -> 1F4
  • 'Time Before Sleep (ST)' parameter set as the local XBee device; 500 ms = 0x1F4.
  • 'Transmit Options (TO)' parameter set to 0x40 so delivery method is Point to Multipoint.

Demo run

While it is running, send a packet to the device:

  • Go to the "Console" tab of the XCTU connected to the coordinator.
  • Press the "Add API frame to the list" button.
  • Press "Create using API Frame generator" button.
  • Select "DigiMesh" protocol and "0x10 Transmit Request" Frame Type.
  • Paste the Local XBee device 64-bit address in the "64-bit dest. address" text box. (You can copy it from the application banner).
  • In the "Options" text box, type 0x40 to select delivery method as Point To Multipoint (you can skip this if you configured atTO accordingly)
  • In the "RF data" text box, select the ASCII box and type "Hello XBee!".
  • Press OK, Add Frame.
  • Select the frame and press the "Send selected frame" button to send the frame ("Hello XBee!") to the XBee network.

Once the XBee device receives the frame, the radio will wake up to send it to mbed micro-controller, which will process and print the received data.

Verify that the XBee module has received the frame by accessing the serial console terminal. If it was successful, the "Hello XBee!" message will be displayed there.

After that, the radio will go to sleep again until new data is received.

Files at this revision

API Documentation at this revision

Revision 8:f7fdee8c39a4, committed 2016-07-29

Comitter:
hbujanda
Date:
Fri Jul 29 12:15:41 2016 +0200
Parent:
7:0b34ce30516a
Commit message:
Automatic upload

Changed in this revision

XBeeLib.lib Show annotated file Show diff for this revision Revisions of this file
main.cpp Show annotated file Show diff for this revision Revisions of this file
mbed.bld Show annotated file Show diff for this revision Revisions of this file 
diff -r 0b34ce30516a -r f7fdee8c39a4 XBeeLib.lib
--- a/XBeeLib.lib	Thu Jul 28 10:36:50 2016 +0000
+++ b/XBeeLib.lib	Fri Jul 29 12:15:41 2016 +0200
@@ -1,1 +1,1 @@
-http://developer.mbed.org/teams/Digi-International-Inc/code/XBeeLib/#06522f3a6642
+http://developer.mbed.org/teams/Digi-International-Inc/code/XBeeLib/#b5f4a0e92249

diff -r 0b34ce30516a -r f7fdee8c39a4 main.cpp
--- a/main.cpp	Thu Jul 28 10:36:50 2016 +0000
+++ b/main.cpp	Fri Jul 29 12:15:41 2016 +0200
@@ -33,9 +33,8 @@
 
 #define REMOTE_NODE_ADDR64_MSB  ((uint32_t)0x0013A200)
 
-//#error "Replace next define with the LSB of the remote module's 64-bit address (SL parameter)"
-//#define REMOTE_NODE_ADDR64_LSB  ((uint32_t)0x01234567)
-#define REMOTE_NODE_ADDR64_LSB  ((uint32_t)0x40F86A88)
+#error "Replace next define with the LSB of the remote module's 64-bit address (SL parameter)"
+#define REMOTE_NODE_ADDR64_LSB  ((uint32_t)0x01234567)
 
 #define REMOTE_NODE_ADDR64      UINT64(REMOTE_NODE_ADDR64_MSB, REMOTE_NODE_ADDR64_LSB)
 

diff -r 0b34ce30516a -r f7fdee8c39a4 mbed.bld
--- a/mbed.bld	Thu Jul 28 10:36:50 2016 +0000
+++ b/mbed.bld	Fri Jul 29 12:15:41 2016 +0200
@@ -1,1 +1,1 @@
-http://mbed.org/users/mbed_official/code/mbed/builds/f9eeca106725
\ No newline at end of file
+http://mbed.org/users/mbed_official/code/mbed/builds/487b796308b0
\ No newline at end of file