Harry Chen / Mbed OS Dot-Examples

fp

Dependencies:   libmDot-mbed5 ISL29011

examples/src/fota_example.cpp@40:71d8df33ef7d, 2020-01-06 (annotated)

Committer:
harryyyy
Date:
Mon Jan 06 08:17:12 2020 +0000
Revision:
40:71d8df33ef7d
Parent:
36:f1053cb17d4f 
fp

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jason Reiss 36:f1053cb17d4f 1 #include "dot_util.h"
Jason Reiss 36:f1053cb17d4f 2 #include "RadioEvent.h"
Jason Reiss 36:f1053cb17d4f 3
Jason Reiss 36:f1053cb17d4f 4 #if ACTIVE_EXAMPLE == FOTA_EXAMPLE
Jason Reiss 36:f1053cb17d4f 5
Jason Reiss 36:f1053cb17d4f 6 /////////////////////////////////////////////////////////////////////////////
Jason Reiss 36:f1053cb17d4f 7 // -------------------- DOT LIBRARY REQUIRED ------------------------------//
Jason Reiss 36:f1053cb17d4f 8 // * Because these example programs can be used for both mDot and xDot //
Jason Reiss 36:f1053cb17d4f 9 // devices, the LoRa stack is not included. The libmDot library should //
Jason Reiss 36:f1053cb17d4f 10 // be imported if building for mDot devices. The libxDot library //
Jason Reiss 36:f1053cb17d4f 11 // should be imported if building for xDot devices. //
Jason Reiss 36:f1053cb17d4f 12 // * https://developer.mbed.org/teams/MultiTech/code/libmDot-dev-mbed5/ //
Jason Reiss 36:f1053cb17d4f 13 // * https://developer.mbed.org/teams/MultiTech/code/libmDot-mbed5/ //
Jason Reiss 36:f1053cb17d4f 14 // * https://developer.mbed.org/teams/MultiTech/code/libxDot-dev-mbed5/ //
Jason Reiss 36:f1053cb17d4f 15 // * https://developer.mbed.org/teams/MultiTech/code/libxDot-mbed5/ //
Jason Reiss 36:f1053cb17d4f 16 /////////////////////////////////////////////////////////////////////////////
Jason Reiss 36:f1053cb17d4f 17
Jason Reiss 36:f1053cb17d4f 18
Jason Reiss 36:f1053cb17d4f 19 ////////////////////////////////////////////////////////////////////////////
Jason Reiss 36:f1053cb17d4f 20 // -------------------- DEFINITIONS REQUIRED ---------------------------- //
Jason Reiss 36:f1053cb17d4f 21 // mDot - add define for FOTA in mbed_app.json or on command line //
Jason Reiss 36:f1053cb17d4f 22 // Command line //
Jason Reiss 36:f1053cb17d4f 23 // mbed compile -t GCC_ARM -m MTS_MDOT_F411RE -DFOTA=1 //
Jason Reiss 36:f1053cb17d4f 24 // mbed_app.json //
Jason Reiss 36:f1053cb17d4f 25 // { //
Jason Reiss 36:f1053cb17d4f 26 // "macros": [ //
Jason Reiss 36:f1053cb17d4f 27 // "FOTA=1" //
Jason Reiss 36:f1053cb17d4f 28 // ] //
Jason Reiss 36:f1053cb17d4f 29 // } //
Jason Reiss 36:f1053cb17d4f 30 // //
Jason Reiss 36:f1053cb17d4f 31 // xDot - DO NOT define FOTA, there is no file system support available //
Jason Reiss 36:f1053cb17d4f 32 // Only multicast is supported for xDot, external MCU and Flash //
Jason Reiss 36:f1053cb17d4f 33 // are required to support Fragmentation //
Jason Reiss 36:f1053cb17d4f 34 ////////////////////////////////////////////////////////////////////////////
Jason Reiss 36:f1053cb17d4f 35
Jason Reiss 36:f1053cb17d4f 36
Jason Reiss 36:f1053cb17d4f 37 /////////////////////////////////////////////////////////////
Jason Reiss 36:f1053cb17d4f 38 // * these options must match the settings on your gateway //
Jason Reiss 36:f1053cb17d4f 39 // * edit their values to match your configuration //
Jason Reiss 36:f1053cb17d4f 40 // * frequency sub band is only relevant for the 915 bands //
Jason Reiss 36:f1053cb17d4f 41 // * either the network name and passphrase can be used or //
Jason Reiss 36:f1053cb17d4f 42 // the network ID (8 bytes) and KEY (16 bytes) //
Jason Reiss 36:f1053cb17d4f 43 /////////////////////////////////////////////////////////////
Jason Reiss 36:f1053cb17d4f 44
Jason Reiss 36:f1053cb17d4f 45 static std::string network_name = "MultiTech";
Jason Reiss 36:f1053cb17d4f 46 static std::string network_passphrase = "MultiTech";
Jason Reiss 36:f1053cb17d4f 47 static uint8_t network_id[] = { 0x6C, 0x4E, 0xEF, 0x66, 0xF4, 0x79, 0x86, 0xA6 };
Jason Reiss 36:f1053cb17d4f 48 static uint8_t network_key[] = { 0x1F, 0x33, 0xA1, 0x70, 0xA5, 0xF1, 0xFD, 0xA0, 0xAB, 0x69, 0x7A, 0xAE, 0x2B, 0x95, 0x91, 0x6B };
Jason Reiss 36:f1053cb17d4f 49 static uint8_t frequency_sub_band = 0;
Jason Reiss 36:f1053cb17d4f 50 static lora::NetworkType network_type = lora::PUBLIC_LORAWAN;
Jason Reiss 36:f1053cb17d4f 51 static uint8_t join_delay = 5;
Jason Reiss 36:f1053cb17d4f 52 static uint8_t ack = 1;
Jason Reiss 36:f1053cb17d4f 53 static bool adr = true;
Jason Reiss 36:f1053cb17d4f 54
Jason Reiss 36:f1053cb17d4f 55 mDot* dot = NULL;
Jason Reiss 36:f1053cb17d4f 56 lora::ChannelPlan* plan = NULL;
Jason Reiss 36:f1053cb17d4f 57
Jason Reiss 36:f1053cb17d4f 58 Serial pc(USBTX, USBRX);
Jason Reiss 36:f1053cb17d4f 59
Jason Reiss 36:f1053cb17d4f 60 #if defined(TARGET_XDOT_L151CC)
Jason Reiss 36:f1053cb17d4f 61 I2C i2c(I2C_SDA, I2C_SCL);
Jason Reiss 36:f1053cb17d4f 62 ISL29011 lux(i2c);
Jason Reiss 36:f1053cb17d4f 63 #else
Jason Reiss 36:f1053cb17d4f 64 AnalogIn lux(XBEE_AD0);
Jason Reiss 36:f1053cb17d4f 65 #endif
Jason Reiss 36:f1053cb17d4f 66
Jason Reiss 36:f1053cb17d4f 67 int main() {
Jason Reiss 36:f1053cb17d4f 68 // Custom event handler for automatically displaying RX data
Jason Reiss 36:f1053cb17d4f 69 RadioEvent events;
Jason Reiss 36:f1053cb17d4f 70
Jason Reiss 36:f1053cb17d4f 71 pc.baud(115200);
Jason Reiss 36:f1053cb17d4f 72
Jason Reiss 36:f1053cb17d4f 73 #if defined(TARGET_XDOT_L151CC)
Jason Reiss 36:f1053cb17d4f 74 i2c.frequency(400000);
Jason Reiss 36:f1053cb17d4f 75 #endif
Jason Reiss 36:f1053cb17d4f 76
Jason Reiss 36:f1053cb17d4f 77 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
Jason Reiss 36:f1053cb17d4f 78
Jason Reiss 36:f1053cb17d4f 79 #if CHANNEL_PLAN == CP_US915
Jason Reiss 36:f1053cb17d4f 80 plan = new lora::ChannelPlan_US915();
Jason Reiss 36:f1053cb17d4f 81 #elif CHANNEL_PLAN == CP_AU915
Jason Reiss 36:f1053cb17d4f 82 plan = new lora::ChannelPlan_AU915();
Jason Reiss 36:f1053cb17d4f 83 #elif CHANNEL_PLAN == CP_EU868
Jason Reiss 36:f1053cb17d4f 84 plan = new lora::ChannelPlan_EU868();
Jason Reiss 36:f1053cb17d4f 85 #elif CHANNEL_PLAN == CP_KR920
Jason Reiss 36:f1053cb17d4f 86 plan = new lora::ChannelPlan_KR920();
Jason Reiss 36:f1053cb17d4f 87 #elif CHANNEL_PLAN == CP_AS923
Jason Reiss 36:f1053cb17d4f 88 plan = new lora::ChannelPlan_AS923();
Jason Reiss 36:f1053cb17d4f 89 #elif CHANNEL_PLAN == CP_AS923_JAPAN
Jason Reiss 36:f1053cb17d4f 90 plan = new lora::ChannelPlan_AS923_Japan();
Jason Reiss 36:f1053cb17d4f 91 #elif CHANNEL_PLAN == CP_IN865
Jason Reiss 36:f1053cb17d4f 92 plan = new lora::ChannelPlan_IN865();
Jason Reiss 36:f1053cb17d4f 93 #endif
Jason Reiss 36:f1053cb17d4f 94 assert(plan);
Jason Reiss 36:f1053cb17d4f 95
Jason Reiss 36:f1053cb17d4f 96 dot = mDot::getInstance(plan);
Jason Reiss 36:f1053cb17d4f 97 assert(dot);
Jason Reiss 36:f1053cb17d4f 98
Jason Reiss 36:f1053cb17d4f 99 logInfo("mbed-os library version: %d.%d.%d", MBED_MAJOR_VERSION, MBED_MINOR_VERSION, MBED_PATCH_VERSION);
Jason Reiss 36:f1053cb17d4f 100
Jason Reiss 36:f1053cb17d4f 101 // Initialize FOTA singleton
Jason Reiss 36:f1053cb17d4f 102 Fota::getInstance(dot);
Jason Reiss 36:f1053cb17d4f 103
Jason Reiss 36:f1053cb17d4f 104
Jason Reiss 36:f1053cb17d4f 105 // start from a well-known state
Jason Reiss 36:f1053cb17d4f 106 logInfo("defaulting Dot configuration");
Jason Reiss 36:f1053cb17d4f 107 dot->resetConfig();
Jason Reiss 36:f1053cb17d4f 108 dot->resetNetworkSession();
Jason Reiss 36:f1053cb17d4f 109
Jason Reiss 36:f1053cb17d4f 110 // make sure library logging is turned on
Jason Reiss 36:f1053cb17d4f 111 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
Jason Reiss 36:f1053cb17d4f 112
Jason Reiss 36:f1053cb17d4f 113 // attach the custom events handler
Jason Reiss 36:f1053cb17d4f 114 dot->setEvents(&events);
Jason Reiss 36:f1053cb17d4f 115
Jason Reiss 36:f1053cb17d4f 116 // update configuration if necessary
Jason Reiss 36:f1053cb17d4f 117 if (dot->getJoinMode() != mDot::OTA) {
Jason Reiss 36:f1053cb17d4f 118 logInfo("changing network join mode to OTA");
Jason Reiss 36:f1053cb17d4f 119 if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
Jason Reiss 36:f1053cb17d4f 120 logError("failed to set network join mode to OTA");
Jason Reiss 36:f1053cb17d4f 121 }
Jason Reiss 36:f1053cb17d4f 122 }
Jason Reiss 36:f1053cb17d4f 123 // 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
Jason Reiss 36:f1053cb17d4f 124 // only one method or the other should be used!
Jason Reiss 36:f1053cb17d4f 125 // network ID = crc64(network name)
Jason Reiss 36:f1053cb17d4f 126 // network KEY = cmac(network passphrase)
Jason Reiss 36:f1053cb17d4f 127 update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, network_type, ack);
Jason Reiss 36:f1053cb17d4f 128 //update_ota_config_id_key(network_id, network_key, frequency_sub_band, network_type, ack);
Jason Reiss 36:f1053cb17d4f 129
Jason Reiss 36:f1053cb17d4f 130 // configure the Dot for class C operation
Jason Reiss 36:f1053cb17d4f 131 // the Dot must also be configured on the gateway for class C
Jason Reiss 36:f1053cb17d4f 132 // use the lora-query application to do this on a Conduit: http://www.multitech.net/developer/software/lora/lora-network-server/
Jason Reiss 36:f1053cb17d4f 133 // to provision your Dot for class C operation with a 3rd party gateway, see the gateway or network provider documentation
Jason Reiss 36:f1053cb17d4f 134 logInfo("changing network mode to class C");
Jason Reiss 36:f1053cb17d4f 135 if (dot->setClass("C") != mDot::MDOT_OK) {
Jason Reiss 36:f1053cb17d4f 136 logError("failed to set network mode to class C");
Jason Reiss 36:f1053cb17d4f 137 }
Jason Reiss 36:f1053cb17d4f 138
Jason Reiss 36:f1053cb17d4f 139 // enable or disable Adaptive Data Rate
Jason Reiss 36:f1053cb17d4f 140 dot->setAdr(adr);
Jason Reiss 36:f1053cb17d4f 141
Jason Reiss 36:f1053cb17d4f 142 // Configure the join delay
Jason Reiss 36:f1053cb17d4f 143 dot->setJoinDelay(join_delay);
Jason Reiss 36:f1053cb17d4f 144
Jason Reiss 36:f1053cb17d4f 145 // save changes to configuration
Jason Reiss 36:f1053cb17d4f 146 logInfo("saving configuration");
Jason Reiss 36:f1053cb17d4f 147 if (!dot->saveConfig()) {
Jason Reiss 36:f1053cb17d4f 148 logError("failed to save configuration");
Jason Reiss 36:f1053cb17d4f 149 }
Jason Reiss 36:f1053cb17d4f 150
Jason Reiss 36:f1053cb17d4f 151 // display configuration
Jason Reiss 36:f1053cb17d4f 152 display_config();
Jason Reiss 36:f1053cb17d4f 153
Jason Reiss 36:f1053cb17d4f 154 while (true) {
Jason Reiss 36:f1053cb17d4f 155 uint16_t light;
Jason Reiss 36:f1053cb17d4f 156 std::vector<uint8_t> tx_data;
Jason Reiss 36:f1053cb17d4f 157
Jason Reiss 36:f1053cb17d4f 158 // join network if not joined
Jason Reiss 36:f1053cb17d4f 159 if (!dot->getNetworkJoinStatus()) {
Jason Reiss 36:f1053cb17d4f 160 join_network();
Jason Reiss 36:f1053cb17d4f 161 }
Jason Reiss 36:f1053cb17d4f 162
Jason Reiss 36:f1053cb17d4f 163 #if defined(TARGET_XDOT_L151CC)
Jason Reiss 36:f1053cb17d4f 164 // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
Jason Reiss 36:f1053cb17d4f 165 lux.setMode(ISL29011::ALS_CONT);
Jason Reiss 36:f1053cb17d4f 166 lux.setResolution(ISL29011::ADC_16BIT);
Jason Reiss 36:f1053cb17d4f 167 lux.setRange(ISL29011::RNG_64000);
Jason Reiss 36:f1053cb17d4f 168
Jason Reiss 36:f1053cb17d4f 169 // get the latest light sample and send it to the gateway
Jason Reiss 36:f1053cb17d4f 170 light = lux.getData();
Jason Reiss 36:f1053cb17d4f 171 tx_data.push_back((light >> 8) & 0xFF);
Jason Reiss 36:f1053cb17d4f 172 tx_data.push_back(light & 0xFF);
Jason Reiss 36:f1053cb17d4f 173 logInfo("light: %lu [0x%04X]", light, light);
Jason Reiss 36:f1053cb17d4f 174 send_data(tx_data);
Jason Reiss 36:f1053cb17d4f 175
Jason Reiss 36:f1053cb17d4f 176 // put the LSL29011 ambient light sensor into a low power state
Jason Reiss 36:f1053cb17d4f 177 lux.setMode(ISL29011::PWR_DOWN);
Jason Reiss 36:f1053cb17d4f 178 #else
Jason Reiss 36:f1053cb17d4f 179 // get some dummy data and send it to the gateway
Jason Reiss 36:f1053cb17d4f 180 light = lux.read_u16();
Jason Reiss 36:f1053cb17d4f 181 tx_data.push_back((light >> 8) & 0xFF);
Jason Reiss 36:f1053cb17d4f 182 tx_data.push_back(light & 0xFF);
Jason Reiss 36:f1053cb17d4f 183 logInfo("light: %lu [0x%04X]", light, light);
Jason Reiss 36:f1053cb17d4f 184 send_data(tx_data);
Jason Reiss 36:f1053cb17d4f 185 #endif
Jason Reiss 36:f1053cb17d4f 186
Jason Reiss 36:f1053cb17d4f 187 // the Dot can't sleep in class C mode
Jason Reiss 36:f1053cb17d4f 188 // it must be waiting for data from the gateway
Jason Reiss 36:f1053cb17d4f 189 // send data every 30s
Jason Reiss 36:f1053cb17d4f 190 if (Fota::getInstance()->timeToStart() != 0) {
Jason Reiss 36:f1053cb17d4f 191 logInfo("waiting for 30s");
Jason Reiss 36:f1053cb17d4f 192 wait(30);
Jason Reiss 36:f1053cb17d4f 193 } else {
Jason Reiss 36:f1053cb17d4f 194 // Reduce uplinks during FOTA, dot cannot receive while transmitting
Jason Reiss 36:f1053cb17d4f 195 // Too many lost packets will cause FOTA to fail
Jason Reiss 36:f1053cb17d4f 196 logInfo("FOTA starting in %d seconds", Fota::getInstance()->timeToStart());
Jason Reiss 36:f1053cb17d4f 197 logInfo("waiting for 300s");
Jason Reiss 36:f1053cb17d4f 198 wait(300);
Jason Reiss 36:f1053cb17d4f 199 }
Jason Reiss 36:f1053cb17d4f 200
Jason Reiss 36:f1053cb17d4f 201 }
Jason Reiss 36:f1053cb17d4f 202
Jason Reiss 36:f1053cb17d4f 203 return 0;
Jason Reiss 36:f1053cb17d4f 204 }
Jason Reiss 36:f1053cb17d4f 205
Jason Reiss 36:f1053cb17d4f 206 #endif
Jason Reiss 36:f1053cb17d4f 207