Bryce Himebaugh / Mbed OS xdot_reference

Here it is ...

Dependencies:   libxDot-mbed5 TSL2561

Fork of Dot-Examples by MultiTech

examples/src/ota_example.cpp@17:d4f82e16de5f, 2016-11-01 (annotated)

Committer:
mfiore
Date:
Tue Nov 01 21:07:22 2016 +0000
Revision:
17:d4f82e16de5f
Parent:
16:a3832552dfe1
Child:
21:09d05faf0e13
update to mbed-os 5.1.5 (compatible with latest Dot 2.x library <2.0.16) and add note about Dot library requirement

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 /////////////////////////////////////////////////////////////
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;
mfiore 0:a151a6350d7f 32
mfiore 0:a151a6350d7f 33 // deepsleep consumes slightly less current than sleep
mfiore 0:a151a6350d7f 34 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
mfiore 0:a151a6350d7f 35 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
mfiore 0:a151a6350d7f 36 // if deep_sleep == true, device will enter deepsleep mode
mfiore 0:a151a6350d7f 37 static bool deep_sleep = false;
mfiore 0:a151a6350d7f 38
mfiore 0:a151a6350d7f 39 mDot* dot = NULL;
mfiore 0:a151a6350d7f 40
mfiore 0:a151a6350d7f 41 Serial pc(USBTX, USBRX);
mfiore 0:a151a6350d7f 42
mfiore 0:a151a6350d7f 43 #if defined(TARGET_XDOT_L151CC)
mfiore 0:a151a6350d7f 44 I2C i2c(I2C_SDA, I2C_SCL);
mfiore 0:a151a6350d7f 45 ISL29011 lux(i2c);
mfiore 0:a151a6350d7f 46 #else
mfiore 0:a151a6350d7f 47 AnalogIn lux(XBEE_AD0);
mfiore 0:a151a6350d7f 48 #endif
mfiore 0:a151a6350d7f 49
mfiore 0:a151a6350d7f 50 int main() {
Mike Fiore 14:19fae4509473 51 // Custom event handler for automatically displaying RX data
Mike Fiore 14:19fae4509473 52 RadioEvent events;
Mike Fiore 14:19fae4509473 53
mfiore 0:a151a6350d7f 54 pc.baud(115200);
mfiore 0:a151a6350d7f 55
mfiore 0:a151a6350d7f 56 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
mfiore 0:a151a6350d7f 57
mfiore 0:a151a6350d7f 58 dot = mDot::getInstance();
mfiore 0:a151a6350d7f 59
Mike Fiore 14:19fae4509473 60 // attach the custom events handler
Mike Fiore 14:19fae4509473 61 dot->setEvents(&events);
Mike Fiore 14:19fae4509473 62
Mike Fiore 12:ec9768677cea 63 if (!dot->getStandbyFlag()) {
Mike Fiore 16:a3832552dfe1 64 logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
Mike Fiore 16:a3832552dfe1 65
Mike Fiore 12:ec9768677cea 66 // start from a well-known state
Mike Fiore 12:ec9768677cea 67 logInfo("defaulting Dot configuration");
Mike Fiore 12:ec9768677cea 68 dot->resetConfig();
Mike Fiore 12:ec9768677cea 69 dot->resetNetworkSession();
mfiore 0:a151a6350d7f 70
Mike Fiore 12:ec9768677cea 71 // make sure library logging is turned on
Mike Fiore 12:ec9768677cea 72 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
Mike Fiore 12:ec9768677cea 73
Mike Fiore 12:ec9768677cea 74 // update configuration if necessary
Mike Fiore 12:ec9768677cea 75 if (dot->getJoinMode() != mDot::OTA) {
Mike Fiore 12:ec9768677cea 76 logInfo("changing network join mode to OTA");
Mike Fiore 12:ec9768677cea 77 if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
Mike Fiore 12:ec9768677cea 78 logError("failed to set network join mode to OTA");
Mike Fiore 12:ec9768677cea 79 }
mfiore 0:a151a6350d7f 80 }
Mike Fiore 12:ec9768677cea 81 // 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 82 // only one method or the other should be used!
Mike Fiore 12:ec9768677cea 83 // network ID = crc64(network name)
Mike Fiore 12:ec9768677cea 84 // network KEY = cmac(network passphrase)
Mike Fiore 12:ec9768677cea 85 update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
Mike Fiore 12:ec9768677cea 86 //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
Mike Fiore 15:364df461110f 87
Mike Fiore 15:364df461110f 88 // configure network link checks
Mike Fiore 15:364df461110f 89 // 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 90 // check the link every count packets
Mike Fiore 15:364df461110f 91 // declare the Dot disconnected after threshold failed link checks
Mike Fiore 15:364df461110f 92 // for count = 3 and threshold = 5, the Dot will be considered disconnected after 15 missed packets in a row
Mike Fiore 15:364df461110f 93 update_network_link_check_config(3, 5);
Mike Fiore 9:72d3203279b2 94
Mike Fiore 12:ec9768677cea 95 // save changes to configuration
Mike Fiore 12:ec9768677cea 96 logInfo("saving configuration");
Mike Fiore 12:ec9768677cea 97 if (!dot->saveConfig()) {
Mike Fiore 12:ec9768677cea 98 logError("failed to save configuration");
Mike Fiore 12:ec9768677cea 99 }
mfiore 0:a151a6350d7f 100
Mike Fiore 12:ec9768677cea 101 // display configuration
Mike Fiore 12:ec9768677cea 102 display_config();
Mike Fiore 12:ec9768677cea 103 } else {
Mike Fiore 12:ec9768677cea 104 // restore the saved session if the dot woke from deepsleep mode
Mike Fiore 12:ec9768677cea 105 // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
mfiore 0:a151a6350d7f 106 logInfo("restoring network session from NVM");
mfiore 0:a151a6350d7f 107 dot->restoreNetworkSession();
mfiore 0:a151a6350d7f 108 }
Mike Fiore 9:72d3203279b2 109
mfiore 0:a151a6350d7f 110 while (true) {
mfiore 0:a151a6350d7f 111 uint16_t light;
mfiore 0:a151a6350d7f 112 std::vector<uint8_t> tx_data;
mfiore 0:a151a6350d7f 113
mfiore 0:a151a6350d7f 114 // join network if not joined
mfiore 0:a151a6350d7f 115 if (!dot->getNetworkJoinStatus()) {
mfiore 0:a151a6350d7f 116 join_network();
mfiore 0:a151a6350d7f 117 }
mfiore 0:a151a6350d7f 118
mfiore 0:a151a6350d7f 119 #if defined(TARGET_XDOT_L151CC)
mfiore 0:a151a6350d7f 120 // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
mfiore 0:a151a6350d7f 121 lux.setMode(ISL29011::ALS_CONT);
mfiore 0:a151a6350d7f 122 lux.setResolution(ISL29011::ADC_16BIT);
mfiore 0:a151a6350d7f 123 lux.setRange(ISL29011::RNG_64000);
mfiore 0:a151a6350d7f 124
mfiore 0:a151a6350d7f 125 // get the latest light sample and send it to the gateway
mfiore 0:a151a6350d7f 126 light = lux.getData();
mfiore 0:a151a6350d7f 127 tx_data.push_back((light >> 8) & 0xFF);
mfiore 0:a151a6350d7f 128 tx_data.push_back(light & 0xFF);
mfiore 0:a151a6350d7f 129 logInfo("light: %lu [0x%04X]", light, light);
mfiore 0:a151a6350d7f 130 send_data(tx_data);
mfiore 0:a151a6350d7f 131
mfiore 0:a151a6350d7f 132 // put the LSL29011 ambient light sensor into a low power state
mfiore 0:a151a6350d7f 133 lux.setMode(ISL29011::PWR_DOWN);
mfiore 0:a151a6350d7f 134 #else
mfiore 0:a151a6350d7f 135 // get some dummy data and send it to the gateway
mfiore 0:a151a6350d7f 136 light = lux.read_u16();
mfiore 0:a151a6350d7f 137 tx_data.push_back((light >> 8) & 0xFF);
mfiore 0:a151a6350d7f 138 tx_data.push_back(light & 0xFF);
mfiore 0:a151a6350d7f 139 logInfo("light: %lu [0x%04X]", light, light);
mfiore 0:a151a6350d7f 140 send_data(tx_data);
mfiore 0:a151a6350d7f 141 #endif
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);
mfiore 0:a151a6350d7f 154 }
mfiore 0:a151a6350d7f 155
mfiore 0:a151a6350d7f 156 return 0;
mfiore 0:a151a6350d7f 157 }
mfiore 0:a151a6350d7f 158
mfiore 0:a151a6350d7f 159 #endif