Jose Rios / Mbed OS xdot-test

Basic xdot code to check how many memory is available for user APP after initializing libxdot lorawan stack

examples/src/manual_example.cpp@25:56f7775c702f, 2018-03-14 (annotated)

Committer:
Evan Hosseini
Date:
Wed Mar 14 14:38:08 2018 -0500
Revision:
25:56f7775c702f
Parent:
22:d9bc10bbc433
Child:
29:9e2c0d990ace
Updates for the dot 3.1 release

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 8:e667f4a507b1 1 #include "dot_util.h"
Mike Fiore 14:19fae4509473 2 #include "RadioEvent.h"
Mike Fiore 8:e667f4a507b1 3
Mike Fiore 8:e667f4a507b1 4 #if ACTIVE_EXAMPLE == MANUAL_EXAMPLE
Mike Fiore 8:e667f4a507b1 5
mfiore 17:d4f82e16de5f 6 /////////////////////////////////////////////////////////////////////////////
mfiore 17:d4f82e16de5f 7 // -------------------- DOT LIBRARY REQUIRED ------------------------------//
mfiore 17:d4f82e16de5f 8 // * Because these example programs can be used for both mDot and xDot //
mfiore 17:d4f82e16de5f 9 // devices, the LoRa stack is not included. The libmDot library should //
mfiore 17:d4f82e16de5f 10 // be imported if building for mDot devices. The libxDot library //
mfiore 17:d4f82e16de5f 11 // should be imported if building for xDot devices. //
mfiore 17:d4f82e16de5f 12 // * https://developer.mbed.org/teams/MultiTech/code/libmDot-dev-mbed5/ //
mfiore 17:d4f82e16de5f 13 // * https://developer.mbed.org/teams/MultiTech/code/libmDot-mbed5/ //
mfiore 17:d4f82e16de5f 14 // * https://developer.mbed.org/teams/MultiTech/code/libxDot-dev-mbed5/ //
mfiore 17:d4f82e16de5f 15 // * https://developer.mbed.org/teams/MultiTech/code/libxDot-mbed5/ //
mfiore 17:d4f82e16de5f 16 /////////////////////////////////////////////////////////////////////////////
mfiore 17:d4f82e16de5f 17
Mike Fiore 8:e667f4a507b1 18 /////////////////////////////////////////////////////////////
Mike Fiore 8:e667f4a507b1 19 // * these options must match the settings on your gateway //
Mike Fiore 8:e667f4a507b1 20 // * edit their values to match your configuration //
Mike Fiore 8:e667f4a507b1 21 // * frequency sub band is only relevant for the 915 bands //
Mike Fiore 8:e667f4a507b1 22 /////////////////////////////////////////////////////////////
Mike Fiore 8:e667f4a507b1 23 static uint8_t network_address[] = { 0x01, 0x02, 0x03, 0x04 };
Mike Fiore 8:e667f4a507b1 24 static uint8_t network_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
Mike Fiore 8:e667f4a507b1 25 static uint8_t data_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
Mike Fiore 8:e667f4a507b1 26 static uint8_t frequency_sub_band = 6;
Evan Hosseini 25:56f7775c702f 27 static lora::NetworkType public_network = lora::PUBLIC_LORAWAN;
Evan Hosseini 25:56f7775c702f 28 static uint8_t join_delay = 5;
Mike Fiore 8:e667f4a507b1 29 static uint8_t ack = 1;
Mike Fiore 21:09d05faf0e13 30 static bool adr = true;
Mike Fiore 8:e667f4a507b1 31
Mike Fiore 8:e667f4a507b1 32 // deepsleep consumes slightly less current than sleep
Mike Fiore 8:e667f4a507b1 33 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
Mike Fiore 8:e667f4a507b1 34 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
Mike Fiore 8:e667f4a507b1 35 // if deep_sleep == true, device will enter deepsleep mode
Mike Fiore 8:e667f4a507b1 36 static bool deep_sleep = true;
Mike Fiore 8:e667f4a507b1 37
Mike Fiore 8:e667f4a507b1 38 mDot* dot = NULL;
Mike Fiore 21:09d05faf0e13 39 lora::ChannelPlan* plan = NULL;
Mike Fiore 8:e667f4a507b1 40
Mike Fiore 8:e667f4a507b1 41 Serial pc(USBTX, USBRX);
Mike Fiore 8:e667f4a507b1 42
Mike Fiore 8:e667f4a507b1 43 int main() {
Mike Fiore 14:19fae4509473 44 // Custom event handler for automatically displaying RX data
Mike Fiore 14:19fae4509473 45 RadioEvent events;
Mike Fiore 14:19fae4509473 46
Mike Fiore 8:e667f4a507b1 47 pc.baud(115200);
Mike Fiore 8:e667f4a507b1 48
Mike Fiore 8:e667f4a507b1 49 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
Mike Fiore 8:e667f4a507b1 50
Mike Fiore 21:09d05faf0e13 51 #if CHANNEL_PLAN == CP_US915
Mike Fiore 21:09d05faf0e13 52 plan = new lora::ChannelPlan_US915();
Mike Fiore 21:09d05faf0e13 53 #elif CHANNEL_PLAN == CP_AU915
Mike Fiore 21:09d05faf0e13 54 plan = new lora::ChannelPlan_AU915();
Mike Fiore 21:09d05faf0e13 55 #elif CHANNEL_PLAN == CP_EU868
Mike Fiore 21:09d05faf0e13 56 plan = new lora::ChannelPlan_EU868();
Mike Fiore 21:09d05faf0e13 57 #elif CHANNEL_PLAN == CP_KR920
Mike Fiore 21:09d05faf0e13 58 plan = new lora::ChannelPlan_KR920();
Mike Fiore 21:09d05faf0e13 59 #elif CHANNEL_PLAN == CP_AS923
Mike Fiore 21:09d05faf0e13 60 plan = new lora::ChannelPlan_AS923();
Mike Fiore 21:09d05faf0e13 61 #elif CHANNEL_PLAN == CP_AS923_JAPAN
Mike Fiore 21:09d05faf0e13 62 plan = new lora::ChannelPlan_AS923_Japan();
mfiore 22:d9bc10bbc433 63 #elif CHANNEL_PLAN == CP_IN865
mfiore 22:d9bc10bbc433 64 plan = new lora::ChannelPlan_IN865();
Mike Fiore 21:09d05faf0e13 65 #endif
Mike Fiore 21:09d05faf0e13 66 assert(plan);
Mike Fiore 21:09d05faf0e13 67
Mike Fiore 21:09d05faf0e13 68 dot = mDot::getInstance(plan);
Mike Fiore 21:09d05faf0e13 69 assert(dot);
Mike Fiore 8:e667f4a507b1 70
Mike Fiore 14:19fae4509473 71 // attach the custom events handler
Mike Fiore 14:19fae4509473 72 dot->setEvents(&events);
Mike Fiore 14:19fae4509473 73
Mike Fiore 12:ec9768677cea 74 if (!dot->getStandbyFlag()) {
Mike Fiore 16:a3832552dfe1 75 logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
Mike Fiore 16:a3832552dfe1 76
Mike Fiore 12:ec9768677cea 77 // start from a well-known state
Mike Fiore 12:ec9768677cea 78 logInfo("defaulting Dot configuration");
Mike Fiore 12:ec9768677cea 79 dot->resetConfig();
Mike Fiore 12:ec9768677cea 80 dot->resetNetworkSession();
Mike Fiore 8:e667f4a507b1 81
Mike Fiore 12:ec9768677cea 82 // make sure library logging is turned on
Mike Fiore 12:ec9768677cea 83 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
Mike Fiore 12:ec9768677cea 84
Mike Fiore 12:ec9768677cea 85 // update configuration if necessary
Mike Fiore 12:ec9768677cea 86 if (dot->getJoinMode() != mDot::MANUAL) {
Mike Fiore 12:ec9768677cea 87 logInfo("changing network join mode to MANUAL");
Mike Fiore 12:ec9768677cea 88 if (dot->setJoinMode(mDot::MANUAL) != mDot::MDOT_OK) {
Mike Fiore 12:ec9768677cea 89 logError("failed to set network join mode to MANUAL");
Mike Fiore 12:ec9768677cea 90 }
Mike Fiore 8:e667f4a507b1 91 }
Mike Fiore 12:ec9768677cea 92 // in MANUAL join mode there is no join request/response transaction
Mike Fiore 12:ec9768677cea 93 // as long as the Dot is configured correctly and provisioned correctly on the gateway, it should be able to communicate
Mike Fiore 12:ec9768677cea 94 // network address - 4 bytes (00000001 - FFFFFFFE)
Mike Fiore 12:ec9768677cea 95 // network session key - 16 bytes
Mike Fiore 12:ec9768677cea 96 // data session key - 16 bytes
Mike Fiore 12:ec9768677cea 97 // to provision your Dot with a Conduit gateway, follow the following steps
Mike Fiore 12:ec9768677cea 98 // * ssh into the Conduit
Mike Fiore 12:ec9768677cea 99 // * provision the Dot using the lora-query application: http://www.multitech.net/developer/software/lora/lora-network-server/
Mike Fiore 12:ec9768677cea 100 // lora-query -a 01020304 A 0102030401020304 <your Dot's device ID> 01020304010203040102030401020304 01020304010203040102030401020304
Mike Fiore 12:ec9768677cea 101 // * if you change the network address, network session key, or data session key, make sure you update them on the gateway
Mike Fiore 12:ec9768677cea 102 // to provision your Dot with a 3rd party gateway, see the gateway or network provider documentation
Mike Fiore 12:ec9768677cea 103 update_manual_config(network_address, network_session_key, data_session_key, frequency_sub_band, public_network, ack);
Mike Fiore 8:e667f4a507b1 104
Mike Fiore 21:09d05faf0e13 105 // enable or disable Adaptive Data Rate
Mike Fiore 21:09d05faf0e13 106 dot->setAdr(adr);
Mike Fiore 21:09d05faf0e13 107
Evan Hosseini 25:56f7775c702f 108 // Configure the join delay
Evan Hosseini 25:56f7775c702f 109 dot->setJoinDelay(join_delay);
Evan Hosseini 25:56f7775c702f 110
Mike Fiore 12:ec9768677cea 111 // save changes to configuration
Mike Fiore 12:ec9768677cea 112 logInfo("saving configuration");
Mike Fiore 12:ec9768677cea 113 if (!dot->saveConfig()) {
Mike Fiore 12:ec9768677cea 114 logError("failed to save configuration");
Mike Fiore 12:ec9768677cea 115 }
Mike Fiore 9:72d3203279b2 116
Mike Fiore 12:ec9768677cea 117 // display configuration
Mike Fiore 12:ec9768677cea 118 display_config();
Mike Fiore 12:ec9768677cea 119 } else {
Mike Fiore 12:ec9768677cea 120 // restore the saved session if the dot woke from deepsleep mode
Mike Fiore 12:ec9768677cea 121 // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
Mike Fiore 8:e667f4a507b1 122 logInfo("restoring network session from NVM");
Mike Fiore 8:e667f4a507b1 123 dot->restoreNetworkSession();
Mike Fiore 8:e667f4a507b1 124 }
Mike Fiore 8:e667f4a507b1 125
Mike Fiore 8:e667f4a507b1 126
Evan Hosseini 25:56f7775c702f 127 uint8_t counter = 0;
Mike Fiore 8:e667f4a507b1 128 while (true) {
Mike Fiore 8:e667f4a507b1 129 std::vector<uint8_t> tx_data;
Mike Fiore 8:e667f4a507b1 130
Evan Hosseini 25:56f7775c702f 131 tx_data.push_back(++counter);
Evan Hosseini 25:56f7775c702f 132 logInfo("sending uplink with data = %d", counter);
Mike Fiore 8:e667f4a507b1 133 send_data(tx_data);
Mike Fiore 8:e667f4a507b1 134
Mike Fiore 8:e667f4a507b1 135 // if going into deepsleep mode, save the session so we don't need to join again after waking up
Mike Fiore 8:e667f4a507b1 136 // not necessary if going into sleep mode since RAM is retained
Mike Fiore 8:e667f4a507b1 137 if (deep_sleep) {
Mike Fiore 8:e667f4a507b1 138 logInfo("saving network session to NVM");
Mike Fiore 8:e667f4a507b1 139 dot->saveNetworkSession();
Mike Fiore 8:e667f4a507b1 140 }
Mike Fiore 8:e667f4a507b1 141
Mike Fiore 8:e667f4a507b1 142 // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
Mike Fiore 8:e667f4a507b1 143 //sleep_wake_rtc_only(deep_sleep);
Mike Fiore 8:e667f4a507b1 144 //sleep_wake_interrupt_only(deep_sleep);
Mike Fiore 8:e667f4a507b1 145 sleep_wake_rtc_or_interrupt(deep_sleep);
Mike Fiore 8:e667f4a507b1 146 }
Mike Fiore 8:e667f4a507b1 147
Mike Fiore 8:e667f4a507b1 148 return 0;
Mike Fiore 8:e667f4a507b1 149 }
Mike Fiore 8:e667f4a507b1 150
Mike Fiore 8:e667f4a507b1 151 #endif