Bryce Himebaugh / Mbed OS xdot_reference

Here it is ...

Dependencies:   libxDot-mbed5 TSL2561

Fork of Dot-Examples by MultiTech

examples/src/ota_example.cpp@31:b990f61b9ee0, 2018-07-11 (annotated)

Committer:
David Gutsch dgutsch@umail.iu.edu
Date:
Wed Jul 11 13:40:54 2018 -0400
Revision:
31:b990f61b9ee0
Parent:
30:0059ae42ff02
Child:
32:cc05a2e80969
fixing serial code

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 /////////////////////////////////////////////////////////////
dgutsch 30:0059ae42ff02 25 static std::string network_name = "MTCDT-19400691";
dgutsch 30:0059ae42ff02 26 static std::string network_passphrase = "MTCDT-19400691";
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 };
dgutsch 30:0059ae42ff02 29 static uint8_t frequency_sub_band = 1;
dgutsch 30:0059ae42ff02 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
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 44
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 45 Serial pc(PA_9, PA_10);
mfiore 0:a151a6350d7f 46
mfiore 0:a151a6350d7f 47 int main() {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 48 pc.baud(115200);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 49 pc.printf("main started \r\n");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 50 // Custom event handler for automatically displaying RX data
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 51 RadioEvent events;
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 52
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 53
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 54
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 55 pc.printf("baud rate set \r\n");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 56
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 57 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 58
Mike Fiore 21:09d05faf0e13 59 #if CHANNEL_PLAN == CP_US915
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 60 plan = new lora::ChannelPlan_US915();
Mike Fiore 21:09d05faf0e13 61 #elif CHANNEL_PLAN == CP_AU915
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 62 plan = new lora::ChannelPlan_AU915();
Mike Fiore 21:09d05faf0e13 63 #elif CHANNEL_PLAN == CP_EU868
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 64 plan = new lora::ChannelPlan_EU868();
Mike Fiore 21:09d05faf0e13 65 #elif CHANNEL_PLAN == CP_KR920
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 66 plan = new lora::ChannelPlan_KR920();
Mike Fiore 21:09d05faf0e13 67 #elif CHANNEL_PLAN == CP_AS923
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 68 plan = new lora::ChannelPlan_AS923();
Mike Fiore 21:09d05faf0e13 69 #elif CHANNEL_PLAN == CP_AS923_JAPAN
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 70 plan = new lora::ChannelPlan_AS923_Japan();
mfiore 22:d9bc10bbc433 71 #elif CHANNEL_PLAN == CP_IN865
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 72 plan = new lora::ChannelPlan_IN865();
Mike Fiore 21:09d05faf0e13 73 #endif
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 74 assert(plan);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 75
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 76 dot = mDot::getInstance(plan);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 77 assert(dot);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 78
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 79 // attach the custom events handler
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 80 dot->setEvents(&events);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 81
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 82 if (!dot->getStandbyFlag()) {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 83 logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 84
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 85 // start from a well-known state
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 86 logInfo("defaulting Dot configuration");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 87 dot->resetConfig();
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 88 dot->resetNetworkSession();
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 89
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 90 // make sure library logging is turned on
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 91 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 92
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 93 // update configuration if necessary
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 94 if (dot->getJoinMode() != mDot::OTA) {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 95 logInfo("changing network join mode to OTA");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 96 if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 97 logError("failed to set network join mode to OTA");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 98 }
mfiore 0:a151a6350d7f 99 }
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 100 // 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
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 101 // only one method or the other should be used!
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 102 // network ID = crc64(network name)
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 103 // network KEY = cmac(network passphrase)
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 104 //update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);// use the line below
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 105 update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack); ///
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 106
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 107 // configure network link checks
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 108 // 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
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 109 // check the link every count packets
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 110 // declare the Dot disconnected after threshold failed link checks
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 111 // 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
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 112 update_network_link_check_config(3, 5);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 113
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 114 // enable or disable Adaptive Data Rate
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 115 dot->setAdr(adr);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 116
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 117 // Configure the join delay
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 118 dot->setJoinDelay(join_delay);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 119
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 120 // save changes to configuration
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 121 logInfo("saving configuration");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 122 if (!dot->saveConfig()) {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 123 logError("failed to save configuration");
mfiore 0:a151a6350d7f 124 }
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 125
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 126 // display configuration
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 127 display_config();
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 128 } else {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 129 // restore the saved session if the dot woke from deepsleep mode
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 130 // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 131 logInfo("restoring network session from NVM");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 132 dot->restoreNetworkSession();
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 133 }
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 134
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 135 uint8_t counter = 0;
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 136 while (true) {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 137 std::vector<uint8_t> tx_data;
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 138
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 139 // join network if not joined
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 140 if (!dot->getNetworkJoinStatus()) {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 141 join_network();
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 142 }
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 143
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 144 tx_data.push_back(++counter);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 145 logInfo("sending uplink with data = %d", counter);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 146 send_data(tx_data);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 147
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 148 // if going into deepsleep mode, save the session so we don't need to join again after waking up
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 149 // not necessary if going into sleep mode since RAM is retained
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 150 if (deep_sleep) {
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 151 logInfo("saving network session to NVM");
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 152 dot->saveNetworkSession();
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 153 }
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 154
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 155 // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 156 //sleep_wake_rtc_only(deep_sleep);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 157 //sleep_wake_interrupt_only(deep_sleep);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 158 sleep_wake_rtc_or_interrupt(deep_sleep);
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 159 }
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 160
David Gutsch dgutsch@umail.iu.edu 31:b990f61b9ee0 161 return 0;
mfiore 0:a151a6350d7f 162 }
mfiore 0:a151a6350d7f 163
mfiore 0:a151a6350d7f 164 #endif