fp
Dependencies: libmDot-mbed5 ISL29011
examples/src/ota_example.cpp@22:d9bc10bbc433, 2017-06-29 (annotated)
- Committer:
- mfiore
- Date:
- Thu Jun 29 15:31:22 2017 +0000
- Revision:
- 22:d9bc10bbc433
- Parent:
- 21:09d05faf0e13
- Child:
- 25:56f7775c702f
support IN865 channel plan. update mbed-os to 5.4.7
Who changed what in which revision?
User | Revision | Line number | New 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; |
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 | 0:a151a6350d7f | 38 | static bool deep_sleep = false; |
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 | |
mfiore | 0:a151a6350d7f | 45 | #if defined(TARGET_XDOT_L151CC) |
mfiore | 0:a151a6350d7f | 46 | I2C i2c(I2C_SDA, I2C_SCL); |
mfiore | 0:a151a6350d7f | 47 | ISL29011 lux(i2c); |
mfiore | 0:a151a6350d7f | 48 | #else |
mfiore | 0:a151a6350d7f | 49 | AnalogIn lux(XBEE_AD0); |
mfiore | 0:a151a6350d7f | 50 | #endif |
mfiore | 0:a151a6350d7f | 51 | |
mfiore | 0:a151a6350d7f | 52 | int main() { |
Mike Fiore |
14:19fae4509473 | 53 | // Custom event handler for automatically displaying RX data |
Mike Fiore |
14:19fae4509473 | 54 | RadioEvent events; |
Mike Fiore |
14:19fae4509473 | 55 | |
mfiore | 0:a151a6350d7f | 56 | pc.baud(115200); |
mfiore | 0:a151a6350d7f | 57 | |
mfiore | 0:a151a6350d7f | 58 | mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL); |
mfiore | 0:a151a6350d7f | 59 | |
Mike Fiore |
21:09d05faf0e13 | 60 | #if CHANNEL_PLAN == CP_US915 |
Mike Fiore |
21:09d05faf0e13 | 61 | plan = new lora::ChannelPlan_US915(); |
Mike Fiore |
21:09d05faf0e13 | 62 | #elif CHANNEL_PLAN == CP_AU915 |
Mike Fiore |
21:09d05faf0e13 | 63 | plan = new lora::ChannelPlan_AU915(); |
Mike Fiore |
21:09d05faf0e13 | 64 | #elif CHANNEL_PLAN == CP_EU868 |
Mike Fiore |
21:09d05faf0e13 | 65 | plan = new lora::ChannelPlan_EU868(); |
Mike Fiore |
21:09d05faf0e13 | 66 | #elif CHANNEL_PLAN == CP_KR920 |
Mike Fiore |
21:09d05faf0e13 | 67 | plan = new lora::ChannelPlan_KR920(); |
Mike Fiore |
21:09d05faf0e13 | 68 | #elif CHANNEL_PLAN == CP_AS923 |
Mike Fiore |
21:09d05faf0e13 | 69 | plan = new lora::ChannelPlan_AS923(); |
Mike Fiore |
21:09d05faf0e13 | 70 | #elif CHANNEL_PLAN == CP_AS923_JAPAN |
Mike Fiore |
21:09d05faf0e13 | 71 | plan = new lora::ChannelPlan_AS923_Japan(); |
mfiore | 22:d9bc10bbc433 | 72 | #elif CHANNEL_PLAN == CP_IN865 |
mfiore | 22:d9bc10bbc433 | 73 | plan = new lora::ChannelPlan_IN865(); |
Mike Fiore |
21:09d05faf0e13 | 74 | #endif |
Mike Fiore |
21:09d05faf0e13 | 75 | assert(plan); |
Mike Fiore |
21:09d05faf0e13 | 76 | |
Mike Fiore |
21:09d05faf0e13 | 77 | dot = mDot::getInstance(plan); |
Mike Fiore |
21:09d05faf0e13 | 78 | assert(dot); |
mfiore | 0:a151a6350d7f | 79 | |
Mike Fiore |
14:19fae4509473 | 80 | // attach the custom events handler |
Mike Fiore |
14:19fae4509473 | 81 | dot->setEvents(&events); |
Mike Fiore |
14:19fae4509473 | 82 | |
Mike Fiore |
12:ec9768677cea | 83 | if (!dot->getStandbyFlag()) { |
Mike Fiore |
16:a3832552dfe1 | 84 | logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION); |
Mike Fiore |
16:a3832552dfe1 | 85 | |
Mike Fiore |
12:ec9768677cea | 86 | // start from a well-known state |
Mike Fiore |
12:ec9768677cea | 87 | logInfo("defaulting Dot configuration"); |
Mike Fiore |
12:ec9768677cea | 88 | dot->resetConfig(); |
Mike Fiore |
12:ec9768677cea | 89 | dot->resetNetworkSession(); |
mfiore | 0:a151a6350d7f | 90 | |
Mike Fiore |
12:ec9768677cea | 91 | // make sure library logging is turned on |
Mike Fiore |
12:ec9768677cea | 92 | dot->setLogLevel(mts::MTSLog::INFO_LEVEL); |
Mike Fiore |
12:ec9768677cea | 93 | |
Mike Fiore |
12:ec9768677cea | 94 | // update configuration if necessary |
Mike Fiore |
12:ec9768677cea | 95 | if (dot->getJoinMode() != mDot::OTA) { |
Mike Fiore |
12:ec9768677cea | 96 | logInfo("changing network join mode to OTA"); |
Mike Fiore |
12:ec9768677cea | 97 | if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) { |
Mike Fiore |
12:ec9768677cea | 98 | logError("failed to set network join mode to OTA"); |
Mike Fiore |
12:ec9768677cea | 99 | } |
mfiore | 0:a151a6350d7f | 100 | } |
Mike Fiore |
12:ec9768677cea | 101 | // 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 | 102 | // only one method or the other should be used! |
Mike Fiore |
12:ec9768677cea | 103 | // network ID = crc64(network name) |
Mike Fiore |
12:ec9768677cea | 104 | // network KEY = cmac(network passphrase) |
Mike Fiore |
12:ec9768677cea | 105 | update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack); |
Mike Fiore |
12:ec9768677cea | 106 | //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack); |
Mike Fiore |
15:364df461110f | 107 | |
Mike Fiore |
15:364df461110f | 108 | // configure network link checks |
Mike Fiore |
15:364df461110f | 109 | // 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 | 110 | // check the link every count packets |
Mike Fiore |
15:364df461110f | 111 | // declare the Dot disconnected after threshold failed link checks |
Mike Fiore |
21:09d05faf0e13 | 112 | // 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 | 113 | update_network_link_check_config(3, 5); |
Mike Fiore |
21:09d05faf0e13 | 114 | |
Mike Fiore |
21:09d05faf0e13 | 115 | // enable or disable Adaptive Data Rate |
Mike Fiore |
21:09d05faf0e13 | 116 | dot->setAdr(adr); |
Mike Fiore |
9:72d3203279b2 | 117 | |
Mike Fiore |
12:ec9768677cea | 118 | // save changes to configuration |
Mike Fiore |
12:ec9768677cea | 119 | logInfo("saving configuration"); |
Mike Fiore |
12:ec9768677cea | 120 | if (!dot->saveConfig()) { |
Mike Fiore |
12:ec9768677cea | 121 | logError("failed to save configuration"); |
Mike Fiore |
12:ec9768677cea | 122 | } |
mfiore | 0:a151a6350d7f | 123 | |
Mike Fiore |
12:ec9768677cea | 124 | // display configuration |
Mike Fiore |
12:ec9768677cea | 125 | display_config(); |
Mike Fiore |
12:ec9768677cea | 126 | } else { |
Mike Fiore |
12:ec9768677cea | 127 | // restore the saved session if the dot woke from deepsleep mode |
Mike Fiore |
12:ec9768677cea | 128 | // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep |
mfiore | 0:a151a6350d7f | 129 | logInfo("restoring network session from NVM"); |
mfiore | 0:a151a6350d7f | 130 | dot->restoreNetworkSession(); |
mfiore | 0:a151a6350d7f | 131 | } |
Mike Fiore |
9:72d3203279b2 | 132 | |
mfiore | 0:a151a6350d7f | 133 | while (true) { |
mfiore | 0:a151a6350d7f | 134 | uint16_t light; |
mfiore | 0:a151a6350d7f | 135 | std::vector<uint8_t> tx_data; |
mfiore | 0:a151a6350d7f | 136 | |
mfiore | 0:a151a6350d7f | 137 | // join network if not joined |
mfiore | 0:a151a6350d7f | 138 | if (!dot->getNetworkJoinStatus()) { |
mfiore | 0:a151a6350d7f | 139 | join_network(); |
mfiore | 0:a151a6350d7f | 140 | } |
mfiore | 0:a151a6350d7f | 141 | |
mfiore | 0:a151a6350d7f | 142 | #if defined(TARGET_XDOT_L151CC) |
mfiore | 0:a151a6350d7f | 143 | // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range |
mfiore | 0:a151a6350d7f | 144 | lux.setMode(ISL29011::ALS_CONT); |
mfiore | 0:a151a6350d7f | 145 | lux.setResolution(ISL29011::ADC_16BIT); |
mfiore | 0:a151a6350d7f | 146 | lux.setRange(ISL29011::RNG_64000); |
mfiore | 0:a151a6350d7f | 147 | |
mfiore | 0:a151a6350d7f | 148 | // get the latest light sample and send it to the gateway |
mfiore | 0:a151a6350d7f | 149 | light = lux.getData(); |
mfiore | 0:a151a6350d7f | 150 | tx_data.push_back((light >> 8) & 0xFF); |
mfiore | 0:a151a6350d7f | 151 | tx_data.push_back(light & 0xFF); |
mfiore | 0:a151a6350d7f | 152 | logInfo("light: %lu [0x%04X]", light, light); |
mfiore | 0:a151a6350d7f | 153 | send_data(tx_data); |
mfiore | 0:a151a6350d7f | 154 | |
mfiore | 0:a151a6350d7f | 155 | // put the LSL29011 ambient light sensor into a low power state |
mfiore | 0:a151a6350d7f | 156 | lux.setMode(ISL29011::PWR_DOWN); |
mfiore | 0:a151a6350d7f | 157 | #else |
mfiore | 0:a151a6350d7f | 158 | // get some dummy data and send it to the gateway |
mfiore | 0:a151a6350d7f | 159 | light = lux.read_u16(); |
mfiore | 0:a151a6350d7f | 160 | tx_data.push_back((light >> 8) & 0xFF); |
mfiore | 0:a151a6350d7f | 161 | tx_data.push_back(light & 0xFF); |
mfiore | 0:a151a6350d7f | 162 | logInfo("light: %lu [0x%04X]", light, light); |
mfiore | 0:a151a6350d7f | 163 | send_data(tx_data); |
mfiore | 0:a151a6350d7f | 164 | #endif |
mfiore | 0:a151a6350d7f | 165 | |
mfiore | 0:a151a6350d7f | 166 | // if going into deepsleep mode, save the session so we don't need to join again after waking up |
mfiore | 0:a151a6350d7f | 167 | // not necessary if going into sleep mode since RAM is retained |
mfiore | 0:a151a6350d7f | 168 | if (deep_sleep) { |
mfiore | 0:a151a6350d7f | 169 | logInfo("saving network session to NVM"); |
mfiore | 0:a151a6350d7f | 170 | dot->saveNetworkSession(); |
mfiore | 0:a151a6350d7f | 171 | } |
mfiore | 0:a151a6350d7f | 172 | |
mfiore | 0:a151a6350d7f | 173 | // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method |
mfiore | 0:a151a6350d7f | 174 | //sleep_wake_rtc_only(deep_sleep); |
mfiore | 0:a151a6350d7f | 175 | //sleep_wake_interrupt_only(deep_sleep); |
mfiore | 0:a151a6350d7f | 176 | sleep_wake_rtc_or_interrupt(deep_sleep); |
mfiore | 0:a151a6350d7f | 177 | } |
mfiore | 0:a151a6350d7f | 178 | |
mfiore | 0:a151a6350d7f | 179 | return 0; |
mfiore | 0:a151a6350d7f | 180 | } |
mfiore | 0:a151a6350d7f | 181 | |
mfiore | 0:a151a6350d7f | 182 | #endif |