Harry Chen / Mbed OS Dot-Examples

fp

Dependencies:   libmDot-mbed5 ISL29011

examples/src/manual_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?

UserRevisionLine numberNew contents of line
Mike Fiore 8:e667f4a507b1 1 #include "dot_util.h"
Mike Fiore 14:19fae4509473 2 #include "RadioEvent.h"
Mike Fiore 8:e667f4a507b1 3
Mike Fiore 8:e667f4a507b1 4 #if ACTIVE_EXAMPLE == MANUAL_EXAMPLE
Mike Fiore 8:e667f4a507b1 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 8:e667f4a507b1 18 /////////////////////////////////////////////////////////////
Mike Fiore 8:e667f4a507b1 19 // * these options must match the settings on your gateway //
Mike Fiore 8:e667f4a507b1 20 // * edit their values to match your configuration //
Mike Fiore 8:e667f4a507b1 21 // * frequency sub band is only relevant for the 915 bands //
Mike Fiore 8:e667f4a507b1 22 /////////////////////////////////////////////////////////////
Mike Fiore 8:e667f4a507b1 23 static uint8_t network_address[] = { 0x01, 0x02, 0x03, 0x04 };
Mike Fiore 8:e667f4a507b1 24 static uint8_t network_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
Mike Fiore 8:e667f4a507b1 25 static uint8_t data_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
Mike Fiore 8:e667f4a507b1 26 static uint8_t frequency_sub_band = 6;
Mike Fiore 8:e667f4a507b1 27 static bool public_network = false;
Mike Fiore 8:e667f4a507b1 28 static uint8_t ack = 1;
Mike Fiore 21:09d05faf0e13 29 static bool adr = true;
Mike Fiore 8:e667f4a507b1 30
Mike Fiore 8:e667f4a507b1 31 // deepsleep consumes slightly less current than sleep
Mike Fiore 8:e667f4a507b1 32 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
Mike Fiore 8:e667f4a507b1 33 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
Mike Fiore 8:e667f4a507b1 34 // if deep_sleep == true, device will enter deepsleep mode
Mike Fiore 8:e667f4a507b1 35 static bool deep_sleep = true;
Mike Fiore 8:e667f4a507b1 36
Mike Fiore 8:e667f4a507b1 37 mDot* dot = NULL;
Mike Fiore 21:09d05faf0e13 38 lora::ChannelPlan* plan = NULL;
Mike Fiore 8:e667f4a507b1 39
Mike Fiore 8:e667f4a507b1 40 Serial pc(USBTX, USBRX);
Mike Fiore 8:e667f4a507b1 41
Mike Fiore 8:e667f4a507b1 42 #if defined(TARGET_XDOT_L151CC)
Mike Fiore 8:e667f4a507b1 43 I2C i2c(I2C_SDA, I2C_SCL);
Mike Fiore 8:e667f4a507b1 44 ISL29011 lux(i2c);
Mike Fiore 8:e667f4a507b1 45 #else
Mike Fiore 8:e667f4a507b1 46 AnalogIn lux(XBEE_AD0);
Mike Fiore 8:e667f4a507b1 47 #endif
Mike Fiore 8:e667f4a507b1 48
Mike Fiore 8:e667f4a507b1 49 int main() {
Mike Fiore 14:19fae4509473 50 // Custom event handler for automatically displaying RX data
Mike Fiore 14:19fae4509473 51 RadioEvent events;
Mike Fiore 14:19fae4509473 52
Mike Fiore 8:e667f4a507b1 53 pc.baud(115200);
Mike Fiore 8:e667f4a507b1 54
Mike Fiore 8:e667f4a507b1 55 mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
Mike Fiore 8:e667f4a507b1 56
Mike Fiore 21:09d05faf0e13 57 #if CHANNEL_PLAN == CP_US915
Mike Fiore 21:09d05faf0e13 58 plan = new lora::ChannelPlan_US915();
Mike Fiore 21:09d05faf0e13 59 #elif CHANNEL_PLAN == CP_AU915
Mike Fiore 21:09d05faf0e13 60 plan = new lora::ChannelPlan_AU915();
Mike Fiore 21:09d05faf0e13 61 #elif CHANNEL_PLAN == CP_EU868
Mike Fiore 21:09d05faf0e13 62 plan = new lora::ChannelPlan_EU868();
Mike Fiore 21:09d05faf0e13 63 #elif CHANNEL_PLAN == CP_KR920
Mike Fiore 21:09d05faf0e13 64 plan = new lora::ChannelPlan_KR920();
Mike Fiore 21:09d05faf0e13 65 #elif CHANNEL_PLAN == CP_AS923
Mike Fiore 21:09d05faf0e13 66 plan = new lora::ChannelPlan_AS923();
Mike Fiore 21:09d05faf0e13 67 #elif CHANNEL_PLAN == CP_AS923_JAPAN
Mike Fiore 21:09d05faf0e13 68 plan = new lora::ChannelPlan_AS923_Japan();
mfiore 22:d9bc10bbc433 69 #elif CHANNEL_PLAN == CP_IN865
mfiore 22:d9bc10bbc433 70 plan = new lora::ChannelPlan_IN865();
Mike Fiore 21:09d05faf0e13 71 #endif
Mike Fiore 21:09d05faf0e13 72 assert(plan);
Mike Fiore 21:09d05faf0e13 73
Mike Fiore 21:09d05faf0e13 74 dot = mDot::getInstance(plan);
Mike Fiore 21:09d05faf0e13 75 assert(dot);
Mike Fiore 8:e667f4a507b1 76
Mike Fiore 14:19fae4509473 77 // attach the custom events handler
Mike Fiore 14:19fae4509473 78 dot->setEvents(&events);
Mike Fiore 14:19fae4509473 79
Mike Fiore 12:ec9768677cea 80 if (!dot->getStandbyFlag()) {
Mike Fiore 16:a3832552dfe1 81 logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
Mike Fiore 16:a3832552dfe1 82
Mike Fiore 12:ec9768677cea 83 // start from a well-known state
Mike Fiore 12:ec9768677cea 84 logInfo("defaulting Dot configuration");
Mike Fiore 12:ec9768677cea 85 dot->resetConfig();
Mike Fiore 12:ec9768677cea 86 dot->resetNetworkSession();
Mike Fiore 8:e667f4a507b1 87
Mike Fiore 12:ec9768677cea 88 // make sure library logging is turned on
Mike Fiore 12:ec9768677cea 89 dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
Mike Fiore 12:ec9768677cea 90
Mike Fiore 12:ec9768677cea 91 // update configuration if necessary
Mike Fiore 12:ec9768677cea 92 if (dot->getJoinMode() != mDot::MANUAL) {
Mike Fiore 12:ec9768677cea 93 logInfo("changing network join mode to MANUAL");
Mike Fiore 12:ec9768677cea 94 if (dot->setJoinMode(mDot::MANUAL) != mDot::MDOT_OK) {
Mike Fiore 12:ec9768677cea 95 logError("failed to set network join mode to MANUAL");
Mike Fiore 12:ec9768677cea 96 }
Mike Fiore 8:e667f4a507b1 97 }
Mike Fiore 12:ec9768677cea 98 // in MANUAL join mode there is no join request/response transaction
Mike Fiore 12:ec9768677cea 99 // as long as the Dot is configured correctly and provisioned correctly on the gateway, it should be able to communicate
Mike Fiore 12:ec9768677cea 100 // network address - 4 bytes (00000001 - FFFFFFFE)
Mike Fiore 12:ec9768677cea 101 // network session key - 16 bytes
Mike Fiore 12:ec9768677cea 102 // data session key - 16 bytes
Mike Fiore 12:ec9768677cea 103 // to provision your Dot with a Conduit gateway, follow the following steps
Mike Fiore 12:ec9768677cea 104 // * ssh into the Conduit
Mike Fiore 12:ec9768677cea 105 // * provision the Dot using the lora-query application: http://www.multitech.net/developer/software/lora/lora-network-server/
Mike Fiore 12:ec9768677cea 106 // lora-query -a 01020304 A 0102030401020304 <your Dot's device ID> 01020304010203040102030401020304 01020304010203040102030401020304
Mike Fiore 12:ec9768677cea 107 // * if you change the network address, network session key, or data session key, make sure you update them on the gateway
Mike Fiore 12:ec9768677cea 108 // to provision your Dot with a 3rd party gateway, see the gateway or network provider documentation
Mike Fiore 12:ec9768677cea 109 update_manual_config(network_address, network_session_key, data_session_key, frequency_sub_band, public_network, ack);
Mike Fiore 8:e667f4a507b1 110
Mike Fiore 21:09d05faf0e13 111 // enable or disable Adaptive Data Rate
Mike Fiore 21:09d05faf0e13 112 dot->setAdr(adr);
Mike Fiore 21:09d05faf0e13 113
Mike Fiore 12:ec9768677cea 114 // save changes to configuration
Mike Fiore 12:ec9768677cea 115 logInfo("saving configuration");
Mike Fiore 12:ec9768677cea 116 if (!dot->saveConfig()) {
Mike Fiore 12:ec9768677cea 117 logError("failed to save configuration");
Mike Fiore 12:ec9768677cea 118 }
Mike Fiore 9:72d3203279b2 119
Mike Fiore 12:ec9768677cea 120 // display configuration
Mike Fiore 12:ec9768677cea 121 display_config();
Mike Fiore 12:ec9768677cea 122 } else {
Mike Fiore 12:ec9768677cea 123 // restore the saved session if the dot woke from deepsleep mode
Mike Fiore 12:ec9768677cea 124 // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
Mike Fiore 8:e667f4a507b1 125 logInfo("restoring network session from NVM");
Mike Fiore 8:e667f4a507b1 126 dot->restoreNetworkSession();
Mike Fiore 8:e667f4a507b1 127 }
Mike Fiore 8:e667f4a507b1 128
Mike Fiore 8:e667f4a507b1 129
Mike Fiore 8:e667f4a507b1 130 while (true) {
Mike Fiore 8:e667f4a507b1 131 uint16_t light;
Mike Fiore 8:e667f4a507b1 132 std::vector<uint8_t> tx_data;
Mike Fiore 8:e667f4a507b1 133
Mike Fiore 8:e667f4a507b1 134 #if defined(TARGET_XDOT_L151CC)
Mike Fiore 8:e667f4a507b1 135 // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
Mike Fiore 8:e667f4a507b1 136 lux.setMode(ISL29011::ALS_CONT);
Mike Fiore 8:e667f4a507b1 137 lux.setResolution(ISL29011::ADC_16BIT);
Mike Fiore 8:e667f4a507b1 138 lux.setRange(ISL29011::RNG_64000);
Mike Fiore 8:e667f4a507b1 139
Mike Fiore 8:e667f4a507b1 140 // get the latest light sample and send it to the gateway
Mike Fiore 8:e667f4a507b1 141 light = lux.getData();
Mike Fiore 8:e667f4a507b1 142 tx_data.push_back((light >> 8) & 0xFF);
Mike Fiore 8:e667f4a507b1 143 tx_data.push_back(light & 0xFF);
Mike Fiore 8:e667f4a507b1 144 logInfo("light: %lu [0x%04X]", light, light);
Mike Fiore 8:e667f4a507b1 145 send_data(tx_data);
Mike Fiore 8:e667f4a507b1 146
Mike Fiore 8:e667f4a507b1 147 // put the LSL29011 ambient light sensor into a low power state
Mike Fiore 8:e667f4a507b1 148 lux.setMode(ISL29011::PWR_DOWN);
Mike Fiore 8:e667f4a507b1 149 #else
Mike Fiore 8:e667f4a507b1 150 // get some dummy data and send it to the gateway
Mike Fiore 8:e667f4a507b1 151 light = lux.read_u16();
Mike Fiore 8:e667f4a507b1 152 tx_data.push_back((light >> 8) & 0xFF);
Mike Fiore 8:e667f4a507b1 153 tx_data.push_back(light & 0xFF);
Mike Fiore 8:e667f4a507b1 154 logInfo("light: %lu [0x%04X]", light, light);
Mike Fiore 8:e667f4a507b1 155 send_data(tx_data);
Mike Fiore 8:e667f4a507b1 156 #endif
Mike Fiore 8:e667f4a507b1 157
Mike Fiore 8:e667f4a507b1 158 // if going into deepsleep mode, save the session so we don't need to join again after waking up
Mike Fiore 8:e667f4a507b1 159 // not necessary if going into sleep mode since RAM is retained
Mike Fiore 8:e667f4a507b1 160 if (deep_sleep) {
Mike Fiore 8:e667f4a507b1 161 logInfo("saving network session to NVM");
Mike Fiore 8:e667f4a507b1 162 dot->saveNetworkSession();
Mike Fiore 8:e667f4a507b1 163 }
Mike Fiore 8:e667f4a507b1 164
Mike Fiore 8:e667f4a507b1 165 // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
Mike Fiore 8:e667f4a507b1 166 //sleep_wake_rtc_only(deep_sleep);
Mike Fiore 8:e667f4a507b1 167 //sleep_wake_interrupt_only(deep_sleep);
Mike Fiore 8:e667f4a507b1 168 sleep_wake_rtc_or_interrupt(deep_sleep);
Mike Fiore 8:e667f4a507b1 169 }
Mike Fiore 8:e667f4a507b1 170
Mike Fiore 8:e667f4a507b1 171 return 0;
Mike Fiore 8:e667f4a507b1 172 }
Mike Fiore 8:e667f4a507b1 173
Mike Fiore 8:e667f4a507b1 174 #endif