Bryce Himebaugh / Mbed OS xdot_reference

Here it is ...

Dependencies:   libxDot-mbed5 TSL2561

Fork of Dot-Examples by MultiTech

examples/src/ota_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:
27:e0a958990785
Updates for the dot 3.1 release

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mfiore 0:a151a6350d7f 1 #include "dot_util.h"
Mike Fiore 14:19fae4509473 2 #include "RadioEvent.h"
mfiore 0:a151a6350d7f 3
mfiore 0:a151a6350d7f 4 #if ACTIVE_EXAMPLE == OTA_EXAMPLE
mfiore 0:a151a6350d7f 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 5:97ed5f2f099e 18 /////////////////////////////////////////////////////////////
Mike Fiore 5:97ed5f2f099e 19 // * these options must match the settings on your gateway //
Mike Fiore 5:97ed5f2f099e 20 // * edit their values to match your configuration //
Mike Fiore 5:97ed5f2f099e 21 // * frequency sub band is only relevant for the 915 bands //
Mike Fiore 5:97ed5f2f099e 22 // * either the network name and passphrase can be used or //
Mike Fiore 5:97ed5f2f099e 23 // the network ID (8 bytes) and KEY (16 bytes) //
Mike Fiore 5:97ed5f2f099e 24 /////////////////////////////////////////////////////////////
Evan Hosseini 25:56f7775c702f 25 static std::string network_name = "Packers-aep14x";
mfiore 3:0e3e776e2862 26 static std::string network_passphrase = "MultiTech";
Mike Fiore 5:97ed5f2f099e 27 static uint8_t network_id[] = { 0x6C, 0x4E, 0xEF, 0x66, 0xF4, 0x79, 0x86, 0xA6 };
Mike Fiore 5:97ed5f2f099e 28 static uint8_t network_key[] = { 0x1F, 0x33, 0xA1, 0x70, 0xA5, 0xF1, 0xFD, 0xA0, 0xAB, 0x69, 0x7A, 0xAE, 0x2B, 0x95, 0x91, 0x6B };
mfiore 3:0e3e776e2862 29 static uint8_t frequency_sub_band = 0;
Evan Hosseini 25:56f7775c702f 30 static lora::NetworkType public_network = lora::PUBLIC_LORAWAN;
Evan Hosseini 25:56f7775c702f 31 static uint8_t join_delay = 5;
Mike Fiore 15:364df461110f 32 static uint8_t ack = 0;
Mike Fiore 21:09d05faf0e13 33 static bool adr = true;
mfiore 0:a151a6350d7f 34
mfiore 0:a151a6350d7f 35 // deepsleep consumes slightly less current than sleep
mfiore 0:a151a6350d7f 36 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
mfiore 0:a151a6350d7f 37 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
mfiore 0:a151a6350d7f 38 // if deep_sleep == true, device will enter deepsleep mode
mfiore 0:a151a6350d7f 39 static bool deep_sleep = false;
mfiore 0:a151a6350d7f 40
mfiore 0:a151a6350d7f 41 mDot* dot = NULL;
Mike Fiore 21:09d05faf0e13 42 lora::ChannelPlan* plan = NULL;
mfiore 0:a151a6350d7f 43
mfiore 0:a151a6350d7f 44 Serial pc(USBTX, USBRX);
mfiore 0:a151a6350d7f 45
mfiore 0:a151a6350d7f 46 int main() {
Mike Fiore 14:19fae4509473 47 // Custom event handler for automatically displaying RX data
Mike Fiore 14:19fae4509473 48 RadioEvent events;
Mike Fiore 14:19fae4509473 49
mfiore 0:a151a6350d7f 50 pc.baud(115200);
mfiore 0:a151a6350d7f 51
mfiore 0:a151a6350d7f 52 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
mfiore 0:a151a6350d7f 53
Mike Fiore 21:09d05faf0e13 54 #if CHANNEL_PLAN == CP_US915
Mike Fiore 21:09d05faf0e13 55 plan = new lora::ChannelPlan_US915();
Mike Fiore 21:09d05faf0e13 56 #elif CHANNEL_PLAN == CP_AU915
Mike Fiore 21:09d05faf0e13 57 plan = new lora::ChannelPlan_AU915();
Mike Fiore 21:09d05faf0e13 58 #elif CHANNEL_PLAN == CP_EU868
Mike Fiore 21:09d05faf0e13 59 plan = new lora::ChannelPlan_EU868();
Mike Fiore 21:09d05faf0e13 60 #elif CHANNEL_PLAN == CP_KR920
Mike Fiore 21:09d05faf0e13 61 plan = new lora::ChannelPlan_KR920();
Mike Fiore 21:09d05faf0e13 62 #elif CHANNEL_PLAN == CP_AS923
Mike Fiore 21:09d05faf0e13 63 plan = new lora::ChannelPlan_AS923();
Mike Fiore 21:09d05faf0e13 64 #elif CHANNEL_PLAN == CP_AS923_JAPAN
Mike Fiore 21:09d05faf0e13 65 plan = new lora::ChannelPlan_AS923_Japan();
mfiore 22:d9bc10bbc433 66 #elif CHANNEL_PLAN == CP_IN865
mfiore 22:d9bc10bbc433 67 plan = new lora::ChannelPlan_IN865();
Mike Fiore 21:09d05faf0e13 68 #endif
Mike Fiore 21:09d05faf0e13 69 assert(plan);
Mike Fiore 21:09d05faf0e13 70
Mike Fiore 21:09d05faf0e13 71 dot = mDot::getInstance(plan);
Mike Fiore 21:09d05faf0e13 72 assert(dot);
mfiore 0:a151a6350d7f 73
Mike Fiore 14:19fae4509473 74 // attach the custom events handler
Mike Fiore 14:19fae4509473 75 dot->setEvents(&events);
Mike Fiore 14:19fae4509473 76
Mike Fiore 12:ec9768677cea 77 if (!dot->getStandbyFlag()) {
Mike Fiore 16:a3832552dfe1 78 logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
Mike Fiore 16:a3832552dfe1 79
Mike Fiore 12:ec9768677cea 80 // start from a well-known state
Mike Fiore 12:ec9768677cea 81 logInfo("defaulting Dot configuration");
Mike Fiore 12:ec9768677cea 82 dot->resetConfig();
Mike Fiore 12:ec9768677cea 83 dot->resetNetworkSession();
mfiore 0:a151a6350d7f 84
Mike Fiore 12:ec9768677cea 85 // make sure library logging is turned on
Mike Fiore 12:ec9768677cea 86 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
Mike Fiore 12:ec9768677cea 87
Mike Fiore 12:ec9768677cea 88 // update configuration if necessary
Mike Fiore 12:ec9768677cea 89 if (dot->getJoinMode() != mDot::OTA) {
Mike Fiore 12:ec9768677cea 90 logInfo("changing network join mode to OTA");
Mike Fiore 12:ec9768677cea 91 if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
Mike Fiore 12:ec9768677cea 92 logError("failed to set network join mode to OTA");
Mike Fiore 12:ec9768677cea 93 }
mfiore 0:a151a6350d7f 94 }
Mike Fiore 12:ec9768677cea 95 // in OTA and AUTO_OTA join modes, the credentials can be passed to the library as a name and passphrase or an ID and KEY
Mike Fiore 12:ec9768677cea 96 // only one method or the other should be used!
Mike Fiore 12:ec9768677cea 97 // network ID = crc64(network name)
Mike Fiore 12:ec9768677cea 98 // network KEY = cmac(network passphrase)
Mike Fiore 12:ec9768677cea 99 update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
Mike Fiore 12:ec9768677cea 100 //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
Mike Fiore 15:364df461110f 101
Mike Fiore 15:364df461110f 102 // configure network link checks
Mike Fiore 15:364df461110f 103 // network link checks are a good alternative to requiring the gateway to ACK every packet and should allow a single gateway to handle more Dots
Mike Fiore 15:364df461110f 104 // check the link every count packets
Mike Fiore 15:364df461110f 105 // declare the Dot disconnected after threshold failed link checks
Mike Fiore 21:09d05faf0e13 106 // for count = 3 and threshold = 5, the Dot will ask for a link check response every 5 packets and will consider the connection lost if it fails to receive 3 responses in a row
Mike Fiore 15:364df461110f 107 update_network_link_check_config(3, 5);
Mike Fiore 21:09d05faf0e13 108
Mike Fiore 21:09d05faf0e13 109 // enable or disable Adaptive Data Rate
Mike Fiore 21:09d05faf0e13 110 dot->setAdr(adr);
Evan Hosseini 25:56f7775c702f 111
Evan Hosseini 25:56f7775c702f 112 // Configure the join delay
Evan Hosseini 25:56f7775c702f 113 dot->setJoinDelay(join_delay);
Evan Hosseini 25:56f7775c702f 114
Mike Fiore 12:ec9768677cea 115 // save changes to configuration
Mike Fiore 12:ec9768677cea 116 logInfo("saving configuration");
Mike Fiore 12:ec9768677cea 117 if (!dot->saveConfig()) {
Mike Fiore 12:ec9768677cea 118 logError("failed to save configuration");
Mike Fiore 12:ec9768677cea 119 }
mfiore 0:a151a6350d7f 120
Mike Fiore 12:ec9768677cea 121 // display configuration
Mike Fiore 12:ec9768677cea 122 display_config();
Mike Fiore 12:ec9768677cea 123 } else {
Mike Fiore 12:ec9768677cea 124 // restore the saved session if the dot woke from deepsleep mode
Mike Fiore 12:ec9768677cea 125 // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
mfiore 0:a151a6350d7f 126 logInfo("restoring network session from NVM");
mfiore 0:a151a6350d7f 127 dot->restoreNetworkSession();
mfiore 0:a151a6350d7f 128 }
Mike Fiore 9:72d3203279b2 129
Evan Hosseini 25:56f7775c702f 130 uint8_t counter = 0;
mfiore 0:a151a6350d7f 131 while (true) {
mfiore 0:a151a6350d7f 132 std::vector<uint8_t> tx_data;
mfiore 0:a151a6350d7f 133
mfiore 0:a151a6350d7f 134 // join network if not joined
mfiore 0:a151a6350d7f 135 if (!dot->getNetworkJoinStatus()) {
mfiore 0:a151a6350d7f 136 join_network();
mfiore 0:a151a6350d7f 137 }
mfiore 0:a151a6350d7f 138
Evan Hosseini 25:56f7775c702f 139 tx_data.push_back(++counter);
Evan Hosseini 25:56f7775c702f 140 logInfo("sending uplink with data = %d", counter);
mfiore 0:a151a6350d7f 141 send_data(tx_data);
mfiore 0:a151a6350d7f 142
mfiore 0:a151a6350d7f 143 // if going into deepsleep mode, save the session so we don't need to join again after waking up
mfiore 0:a151a6350d7f 144 // not necessary if going into sleep mode since RAM is retained
mfiore 0:a151a6350d7f 145 if (deep_sleep) {
mfiore 0:a151a6350d7f 146 logInfo("saving network session to NVM");
mfiore 0:a151a6350d7f 147 dot->saveNetworkSession();
mfiore 0:a151a6350d7f 148 }
mfiore 0:a151a6350d7f 149
mfiore 0:a151a6350d7f 150 // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
mfiore 0:a151a6350d7f 151 //sleep_wake_rtc_only(deep_sleep);
mfiore 0:a151a6350d7f 152 //sleep_wake_interrupt_only(deep_sleep);
mfiore 0:a151a6350d7f 153 sleep_wake_rtc_or_interrupt(deep_sleep);
Evan Hosseini 25:56f7775c702f 154
Evan Hosseini 25:56f7775c702f 155 logInfo("Did we ever return from our slumber???");
mfiore 0:a151a6350d7f 156 }
mfiore 0:a151a6350d7f 157
mfiore 0:a151a6350d7f 158 return 0;
mfiore 0:a151a6350d7f 159 }
mfiore 0:a151a6350d7f 160
mfiore 0:a151a6350d7f 161 #endif