L-Tek / Mbed OS Dot-Examples

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   libxDot-dev-mbed5-deprecated ISL29011

Fork of Dot-Examples by MultiTech

Dot-Examples rev. 31:7ec180e84cb6 have been tested with xdot-library 3.0.0-19-gb6c0ba2 and mbed-os-5.6.2

examples/src/auto_ota_example.cpp@31:7ec180e84cb6, 2017-10-13 (annotated)

Committer:
gorazdko
Date:
Fri Oct 13 05:53:06 2017 +0000
Revision:
31:7ec180e84cb6
Parent:
27:c817ae2629e5 
examples tested with xdot-library 3.0.0-19-gb6c0ba2 and mbed-os-5.5.7

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 == AUTO_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 /////////////////////////////////////////////////////////////
mfiore 3:0e3e776e2862 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;
mfiore 0:a151a6350d7f 30 static bool public_network = false;
Mike Fiore 15:364df461110f 31 static uint8_t ack = 0;
Mike Fiore 21:09d05faf0e13 32 static bool adr = true;
mfiore 0:a151a6350d7f 33
mfiore 0:a151a6350d7f 34 // deepsleep consumes slightly less current than sleep
mfiore 0:a151a6350d7f 35 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
mfiore 0:a151a6350d7f 36 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
mfiore 0:a151a6350d7f 37 // if deep_sleep == true, device will enter deepsleep mode
mfiore 1:c4915e00d2ce 38 static bool deep_sleep = true;
mfiore 0:a151a6350d7f 39
mfiore 0:a151a6350d7f 40 mDot* dot = NULL;
Mike Fiore 21:09d05faf0e13 41 lora::ChannelPlan* plan = NULL;
mfiore 0:a151a6350d7f 42
mfiore 0:a151a6350d7f 43 Serial pc(USBTX, USBRX);
mfiore 0:a151a6350d7f 44
gorazdko 27:c817ae2629e5 45
gorazdko 26:79d1af6752dd 46 #ifdef TARGET_FF1705_L151CC
gorazdko 27:c817ae2629e5 47 AnalogIn lux(A0);
gorazdko 27:c817ae2629e5 48 #elif defined(TARGET_XDOT_L151CC)
mfiore 0:a151a6350d7f 49 I2C i2c(I2C_SDA, I2C_SCL);
mfiore 0:a151a6350d7f 50 ISL29011 lux(i2c);
mfiore 0:a151a6350d7f 51 #else
mfiore 0:a151a6350d7f 52 AnalogIn lux(XBEE_AD0);
mfiore 0:a151a6350d7f 53 #endif
mfiore 0:a151a6350d7f 54
mfiore 0:a151a6350d7f 55 int main() {
Mike Fiore 14:19fae4509473 56 // Custom event handler for automatically displaying RX data
Mike Fiore 14:19fae4509473 57 RadioEvent events;
Mike Fiore 14:19fae4509473 58
mfiore 0:a151a6350d7f 59 pc.baud(115200);
mfiore 0:a151a6350d7f 60
mfiore 0:a151a6350d7f 61 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
mfiore 0:a151a6350d7f 62
Mike Fiore 21:09d05faf0e13 63 #if CHANNEL_PLAN == CP_US915
Mike Fiore 21:09d05faf0e13 64 plan = new lora::ChannelPlan_US915();
Mike Fiore 21:09d05faf0e13 65 #elif CHANNEL_PLAN == CP_AU915
Mike Fiore 21:09d05faf0e13 66 plan = new lora::ChannelPlan_AU915();
Mike Fiore 21:09d05faf0e13 67 #elif CHANNEL_PLAN == CP_EU868
Mike Fiore 21:09d05faf0e13 68 plan = new lora::ChannelPlan_EU868();
Mike Fiore 21:09d05faf0e13 69 #elif CHANNEL_PLAN == CP_KR920
Mike Fiore 21:09d05faf0e13 70 plan = new lora::ChannelPlan_KR920();
Mike Fiore 21:09d05faf0e13 71 #elif CHANNEL_PLAN == CP_AS923
Mike Fiore 21:09d05faf0e13 72 plan = new lora::ChannelPlan_AS923();
Mike Fiore 21:09d05faf0e13 73 #elif CHANNEL_PLAN == CP_AS923_JAPAN
Mike Fiore 21:09d05faf0e13 74 plan = new lora::ChannelPlan_AS923_Japan();
mfiore 22:d9bc10bbc433 75 #elif CHANNEL_PLAN == CP_IN865
mfiore 22:d9bc10bbc433 76 plan = new lora::ChannelPlan_IN865();
Mike Fiore 21:09d05faf0e13 77 #endif
Mike Fiore 21:09d05faf0e13 78 assert(plan);
Mike Fiore 21:09d05faf0e13 79
Mike Fiore 21:09d05faf0e13 80 dot = mDot::getInstance(plan);
Mike Fiore 21:09d05faf0e13 81 assert(dot);
mfiore 0:a151a6350d7f 82
Mike Fiore 14:19fae4509473 83 // attach the custom events handler
Mike Fiore 14:19fae4509473 84 dot->setEvents(&events);
Mike Fiore 14:19fae4509473 85
Mike Fiore 12:ec9768677cea 86 if (!dot->getStandbyFlag()) {
Mike Fiore 16:a3832552dfe1 87 logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
Mike Fiore 16:a3832552dfe1 88
Mike Fiore 12:ec9768677cea 89 // start from a well-known state
Mike Fiore 12:ec9768677cea 90 logInfo("defaulting Dot configuration");
Mike Fiore 12:ec9768677cea 91 dot->resetConfig();
Mike Fiore 12:ec9768677cea 92 dot->resetNetworkSession();
Mike Fiore 12:ec9768677cea 93
Mike Fiore 12:ec9768677cea 94 // make sure library logging is turned on
Mike Fiore 12:ec9768677cea 95 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
mfiore 0:a151a6350d7f 96
Mike Fiore 12:ec9768677cea 97 // update configuration if necessary
Mike Fiore 12:ec9768677cea 98 // in AUTO_OTA mode the session is automatically saved, so saveNetworkSession and restoreNetworkSession are not needed
Mike Fiore 12:ec9768677cea 99 if (dot->getJoinMode() != mDot::AUTO_OTA) {
Mike Fiore 12:ec9768677cea 100 logInfo("changing network join mode to AUTO_OTA");
Mike Fiore 12:ec9768677cea 101 if (dot->setJoinMode(mDot::AUTO_OTA) != mDot::MDOT_OK) {
Mike Fiore 12:ec9768677cea 102 logError("failed to set network join mode to AUTO_OTA");
Mike Fiore 12:ec9768677cea 103 }
mfiore 0:a151a6350d7f 104 }
Mike Fiore 12:ec9768677cea 105 // 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 106 // only one method or the other should be used!
Mike Fiore 12:ec9768677cea 107 // network ID = crc64(network name)
Mike Fiore 12:ec9768677cea 108 // network KEY = cmac(network passphrase)
Mike Fiore 12:ec9768677cea 109 update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
Mike Fiore 12:ec9768677cea 110 //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
Mike Fiore 12:ec9768677cea 111
Mike Fiore 15:364df461110f 112 // configure network link checks
Mike Fiore 15:364df461110f 113 // 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 114 // check the link every count packets
Mike Fiore 15:364df461110f 115 // declare the Dot disconnected after threshold failed link checks
Mike Fiore 21:09d05faf0e13 116 // 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 117 update_network_link_check_config(3, 5);
Mike Fiore 15:364df461110f 118
Mike Fiore 21:09d05faf0e13 119 // enable or disable Adaptive Data Rate
Mike Fiore 21:09d05faf0e13 120 dot->setAdr(adr);
Mike Fiore 21:09d05faf0e13 121
Mike Fiore 12:ec9768677cea 122 // save changes to configuration
Mike Fiore 12:ec9768677cea 123 logInfo("saving configuration");
Mike Fiore 12:ec9768677cea 124 if (!dot->saveConfig()) {
Mike Fiore 12:ec9768677cea 125 logError("failed to save configuration");
Mike Fiore 12:ec9768677cea 126 }
Mike Fiore 12:ec9768677cea 127
Mike Fiore 12:ec9768677cea 128 // display configuration
Mike Fiore 12:ec9768677cea 129 display_config();
mfiore 0:a151a6350d7f 130 }
mfiore 0:a151a6350d7f 131
mfiore 0:a151a6350d7f 132 while (true) {
mfiore 0:a151a6350d7f 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
gorazdko 27:c817ae2629e5 141
gorazdko 26:79d1af6752dd 142
gorazdko 27:c817ae2629e5 143 #if defined(TARGET_XDOT_L151CC) && !defined(TARGET_FF1705_L151CC)
mfiore 0:a151a6350d7f 144 // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
mfiore 0:a151a6350d7f 145 lux.setMode(ISL29011::ALS_CONT);
mfiore 0:a151a6350d7f 146 lux.setResolution(ISL29011::ADC_16BIT);
mfiore 0:a151a6350d7f 147 lux.setRange(ISL29011::RNG_64000);
mfiore 0:a151a6350d7f 148
mfiore 0:a151a6350d7f 149 // get the latest light sample and send it to the gateway
mfiore 0:a151a6350d7f 150 light = lux.getData();
mfiore 0:a151a6350d7f 151 tx_data.push_back((light >> 8) & 0xFF);
mfiore 0:a151a6350d7f 152 tx_data.push_back(light & 0xFF);
mfiore 0:a151a6350d7f 153 logInfo("light: %lu [0x%04X]", light, light);
mfiore 0:a151a6350d7f 154 send_data(tx_data);
mfiore 0:a151a6350d7f 155
mfiore 0:a151a6350d7f 156 // put the LSL29011 ambient light sensor into a low power state
mfiore 0:a151a6350d7f 157 lux.setMode(ISL29011::PWR_DOWN);
mfiore 0:a151a6350d7f 158 #else
mfiore 0:a151a6350d7f 159 // get some dummy data and send it to the gateway
mfiore 0:a151a6350d7f 160 light = lux.read_u16();
mfiore 0:a151a6350d7f 161 tx_data.push_back((light >> 8) & 0xFF);
mfiore 0:a151a6350d7f 162 tx_data.push_back(light & 0xFF);
mfiore 0:a151a6350d7f 163 logInfo("light: %lu [0x%04X]", light, light);
mfiore 0:a151a6350d7f 164 send_data(tx_data);
mfiore 0:a151a6350d7f 165 #endif
mfiore 0:a151a6350d7f 166
mfiore 0:a151a6350d7f 167 // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
mfiore 0:a151a6350d7f 168 //sleep_wake_rtc_only(deep_sleep);
mfiore 0:a151a6350d7f 169 //sleep_wake_interrupt_only(deep_sleep);
mfiore 0:a151a6350d7f 170 sleep_wake_rtc_or_interrupt(deep_sleep);
mfiore 0:a151a6350d7f 171 }
mfiore 0:a151a6350d7f 172
mfiore 0:a151a6350d7f 173 return 0;
mfiore 0:a151a6350d7f 174 }
mfiore 0:a151a6350d7f 175
mfiore 0:a151a6350d7f 176 #endif