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/ota_example.cpp@42:20f6b29a9903, 2021-05-25 (annotated)

Committer:
Taylor Heck
Date:
Tue May 25 09:54:33 2021 -0500
Revision:
42:20f6b29a9903
Parent:
39:76f8a75ed3ec 
Target mbed-os 6 and Dot Library version 4.

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"
Jason Reiss 39:76f8a75ed3ec 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 28:558b703f621f 25 static std::string network_name = "MultiTech";
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 31:b1d5811e3d5d 30 static lora::NetworkType network_type = 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
Taylor Heck 42:20f6b29a9903 44 mbed::UnbufferedSerial pc(USBTX, USBRX);
mfiore 0:a151a6350d7f 45
Evan Hosseini 30:2f5ae37e6c47 46 #if defined(TARGET_XDOT_L151CC)
Evan Hosseini 30:2f5ae37e6c47 47 I2C i2c(I2C_SDA, I2C_SCL);
Evan Hosseini 30:2f5ae37e6c47 48 ISL29011 lux(i2c);
Evan Hosseini 30:2f5ae37e6c47 49 #else
Evan Hosseini 30:2f5ae37e6c47 50 AnalogIn lux(XBEE_AD0);
Evan Hosseini 30:2f5ae37e6c47 51 #endif
Evan Hosseini 30:2f5ae37e6c47 52
mfiore 0:a151a6350d7f 53 int main() {
Mike Fiore 14:19fae4509473 54 // Custom event handler for automatically displaying RX data
Mike Fiore 14:19fae4509473 55 RadioEvent events;
Mike Fiore 14:19fae4509473 56
mfiore 0:a151a6350d7f 57 pc.baud(115200);
mfiore 0:a151a6350d7f 58
Evan Hosseini 30:2f5ae37e6c47 59 #if defined(TARGET_XDOT_L151CC)
Evan Hosseini 30:2f5ae37e6c47 60 i2c.frequency(400000);
Evan Hosseini 30:2f5ae37e6c47 61 #endif
Evan Hosseini 30:2f5ae37e6c47 62
mfiore 0:a151a6350d7f 63 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
Jason Reiss 39:76f8a75ed3ec 64
Taylor Heck 42:20f6b29a9903 65 // Create channel plan
Taylor Heck 42:20f6b29a9903 66 plan = create_channel_plan();
Mike Fiore 21:09d05faf0e13 67 assert(plan);
Mike Fiore 21:09d05faf0e13 68
Mike Fiore 21:09d05faf0e13 69 dot = mDot::getInstance(plan);
Mike Fiore 21:09d05faf0e13 70 assert(dot);
mfiore 0:a151a6350d7f 71
Mike Fiore 14:19fae4509473 72 // attach the custom events handler
Mike Fiore 14:19fae4509473 73 dot->setEvents(&events);
Mike Fiore 14:19fae4509473 74
Jason Reiss 39:76f8a75ed3ec 75 if (!dot->getStandbyFlag() && !dot->getPreserveSession()) {
jreiss 33:15ea8f985c54 76 logInfo("mbed-os library version: %d.%d.%d", MBED_MAJOR_VERSION, MBED_MINOR_VERSION, MBED_PATCH_VERSION);
Mike Fiore 16:a3832552dfe1 77
Mike Fiore 12:ec9768677cea 78 // start from a well-known state
Mike Fiore 12:ec9768677cea 79 logInfo("defaulting Dot configuration");
Mike Fiore 12:ec9768677cea 80 dot->resetConfig();
Mike Fiore 12:ec9768677cea 81 dot->resetNetworkSession();
mfiore 0:a151a6350d7f 82
Mike Fiore 12:ec9768677cea 83 // make sure library logging is turned on
Mike Fiore 12:ec9768677cea 84 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
Mike Fiore 12:ec9768677cea 85
Mike Fiore 12:ec9768677cea 86 // update configuration if necessary
Mike Fiore 12:ec9768677cea 87 if (dot->getJoinMode() != mDot::OTA) {
Mike Fiore 12:ec9768677cea 88 logInfo("changing network join mode to OTA");
Mike Fiore 12:ec9768677cea 89 if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
Mike Fiore 12:ec9768677cea 90 logError("failed to set network join mode to OTA");
Mike Fiore 12:ec9768677cea 91 }
mfiore 0:a151a6350d7f 92 }
Jason Reiss 39:76f8a75ed3ec 93
Jason Reiss 39:76f8a75ed3ec 94 // To preserve session over power-off or reset enable this flag
Jason Reiss 39:76f8a75ed3ec 95 // dot->setPreserveSession(true);
Jason Reiss 39:76f8a75ed3ec 96
Mike Fiore 12:ec9768677cea 97 // 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 98 // only one method or the other should be used!
Mike Fiore 12:ec9768677cea 99 // network ID = crc64(network name)
Mike Fiore 12:ec9768677cea 100 // network KEY = cmac(network passphrase)
Evan Hosseini 31:b1d5811e3d5d 101 update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, network_type, ack);
Evan Hosseini 31:b1d5811e3d5d 102 //update_ota_config_id_key(network_id, network_key, frequency_sub_band, network_type, ack);
Mike Fiore 15:364df461110f 103
Mike Fiore 15:364df461110f 104 // configure network link checks
Mike Fiore 15:364df461110f 105 // 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 106 // check the link every count packets
Mike Fiore 15:364df461110f 107 // declare the Dot disconnected after threshold failed link checks
Mike Fiore 21:09d05faf0e13 108 // 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 109 update_network_link_check_config(3, 5);
Mike Fiore 21:09d05faf0e13 110
Mike Fiore 21:09d05faf0e13 111 // enable or disable Adaptive Data Rate
Mike Fiore 21:09d05faf0e13 112 dot->setAdr(adr);
Evan Hosseini 25:56f7775c702f 113
Evan Hosseini 25:56f7775c702f 114 // Configure the join delay
Evan Hosseini 25:56f7775c702f 115 dot->setJoinDelay(join_delay);
Evan Hosseini 25:56f7775c702f 116
Mike Fiore 12:ec9768677cea 117 // save changes to configuration
Mike Fiore 12:ec9768677cea 118 logInfo("saving configuration");
Mike Fiore 12:ec9768677cea 119 if (!dot->saveConfig()) {
Mike Fiore 12:ec9768677cea 120 logError("failed to save configuration");
Mike Fiore 12:ec9768677cea 121 }
mfiore 0:a151a6350d7f 122
Mike Fiore 12:ec9768677cea 123 // display configuration
Mike Fiore 12:ec9768677cea 124 display_config();
Mike Fiore 12:ec9768677cea 125 } else {
Mike Fiore 12:ec9768677cea 126 // restore the saved session if the dot woke from deepsleep mode
Mike Fiore 12:ec9768677cea 127 // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
mfiore 0:a151a6350d7f 128 logInfo("restoring network session from NVM");
mfiore 0:a151a6350d7f 129 dot->restoreNetworkSession();
mfiore 0:a151a6350d7f 130 }
Mike Fiore 9:72d3203279b2 131
mfiore 0:a151a6350d7f 132 while (true) {
Evan Hosseini 30:2f5ae37e6c47 133 uint16_t light;
mfiore 0:a151a6350d7f 134 std::vector<uint8_t> tx_data;
mfiore 0:a151a6350d7f 135
mfiore 0:a151a6350d7f 136 // join network if not joined
mfiore 0:a151a6350d7f 137 if (!dot->getNetworkJoinStatus()) {
mfiore 0:a151a6350d7f 138 join_network();
mfiore 0:a151a6350d7f 139 }
mfiore 0:a151a6350d7f 140
Evan Hosseini 30:2f5ae37e6c47 141 #if defined(TARGET_XDOT_L151CC)
Evan Hosseini 30:2f5ae37e6c47 142 // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
Evan Hosseini 30:2f5ae37e6c47 143 lux.setMode(ISL29011::ALS_CONT);
Evan Hosseini 30:2f5ae37e6c47 144 lux.setResolution(ISL29011::ADC_16BIT);
Evan Hosseini 30:2f5ae37e6c47 145 lux.setRange(ISL29011::RNG_64000);
Evan Hosseini 30:2f5ae37e6c47 146
Evan Hosseini 30:2f5ae37e6c47 147 // get the latest light sample and send it to the gateway
Evan Hosseini 30:2f5ae37e6c47 148 light = lux.getData();
Evan Hosseini 30:2f5ae37e6c47 149 tx_data.push_back((light >> 8) & 0xFF);
Evan Hosseini 30:2f5ae37e6c47 150 tx_data.push_back(light & 0xFF);
Evan Hosseini 30:2f5ae37e6c47 151 logInfo("light: %lu [0x%04X]", light, light);
mfiore 0:a151a6350d7f 152 send_data(tx_data);
mfiore 0:a151a6350d7f 153
Evan Hosseini 30:2f5ae37e6c47 154 // put the LSL29011 ambient light sensor into a low power state
Evan Hosseini 30:2f5ae37e6c47 155 lux.setMode(ISL29011::PWR_DOWN);
Jason Reiss 39:76f8a75ed3ec 156 #else
Evan Hosseini 30:2f5ae37e6c47 157 // get some dummy data and send it to the gateway
Evan Hosseini 30:2f5ae37e6c47 158 light = lux.read_u16();
Evan Hosseini 30:2f5ae37e6c47 159 tx_data.push_back((light >> 8) & 0xFF);
Evan Hosseini 30:2f5ae37e6c47 160 tx_data.push_back(light & 0xFF);
Evan Hosseini 30:2f5ae37e6c47 161 logInfo("light: %lu [0x%04X]", light, light);
Evan Hosseini 30:2f5ae37e6c47 162 send_data(tx_data);
Evan Hosseini 30:2f5ae37e6c47 163 #endif
Evan Hosseini 30:2f5ae37e6c47 164
mfiore 0:a151a6350d7f 165 // if going into deepsleep mode, save the session so we don't need to join again after waking up
mfiore 0:a151a6350d7f 166 // not necessary if going into sleep mode since RAM is retained
mfiore 0:a151a6350d7f 167 if (deep_sleep) {
mfiore 0:a151a6350d7f 168 logInfo("saving network session to NVM");
mfiore 0:a151a6350d7f 169 dot->saveNetworkSession();
mfiore 0:a151a6350d7f 170 }
mfiore 0:a151a6350d7f 171
mfiore 0:a151a6350d7f 172 // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
mfiore 0:a151a6350d7f 173 //sleep_wake_rtc_only(deep_sleep);
mfiore 0:a151a6350d7f 174 //sleep_wake_interrupt_only(deep_sleep);
mfiore 0:a151a6350d7f 175 sleep_wake_rtc_or_interrupt(deep_sleep);
mfiore 0:a151a6350d7f 176 }
Jason Reiss 39:76f8a75ed3ec 177
mfiore 0:a151a6350d7f 178 return 0;
mfiore 0:a151a6350d7f 179 }
mfiore 0:a151a6350d7f 180
mfiore 0:a151a6350d7f 181 #endif