ota_example.cpp

00001 #include "dot_util.h"
00002 #include "RadioEvent.h"
00003  
00004 #if ACTIVE_EXAMPLE == OTA_EXAMPLE
00005 
00006 /////////////////////////////////////////////////////////////////////////////
00007 // -------------------- DOT LIBRARY REQUIRED ------------------------------//
00008 // * Because these example programs can be used for both mDot and xDot     //
00009 //     devices, the LoRa stack is not included. The libmDot library should //
00010 //     be imported if building for mDot devices. The libxDot library       //
00011 //     should be imported if building for xDot devices.                    //
00012 // * https://developer.mbed.org/teams/MultiTech/code/libmDot-dev-mbed5/    //
00013 // * https://developer.mbed.org/teams/MultiTech/code/libmDot-mbed5/        //
00014 // * https://developer.mbed.org/teams/MultiTech/code/libxDot-dev-mbed5/    //
00015 // * https://developer.mbed.org/teams/MultiTech/code/libxDot-mbed5/        //
00016 /////////////////////////////////////////////////////////////////////////////
00017 
00018 /////////////////////////////////////////////////////////////
00019 // * these options must match the settings on your gateway //
00020 // * edit their values to match your configuration         //
00021 // * frequency sub band is only relevant for the 915 bands //
00022 // * either the network name and passphrase can be used or //
00023 //     the network ID (8 bytes) and KEY (16 bytes)         //
00024 /////////////////////////////////////////////////////////////
00025 static std::string network_name = "MultiTech";
00026 static std::string network_passphrase = "MultiTech";
00027 static uint8_t network_id[] = { 0x6C, 0x4E, 0xEF, 0x66, 0xF4, 0x79, 0x86, 0xA6 };
00028 static uint8_t network_key[] = { 0x1F, 0x33, 0xA1, 0x70, 0xA5, 0xF1, 0xFD, 0xA0, 0xAB, 0x69, 0x7A, 0xAE, 0x2B, 0x95, 0x91, 0x6B };
00029 static uint8_t frequency_sub_band = 0;
00030 static lora::NetworkType network_type = lora::PUBLIC_LORAWAN;
00031 static uint8_t join_delay = 5;
00032 static uint8_t ack = 0;
00033 static bool adr = true;
00034 
00035 // deepsleep consumes slightly less current than sleep
00036 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
00037 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
00038 // if deep_sleep == true, device will enter deepsleep mode
00039 static bool deep_sleep = false;
00040 
00041 mDot* dot = NULL;
00042 lora::ChannelPlan* plan = NULL;
00043 
00044 Serial pc(USBTX, USBRX);
00045 
00046 #if defined(TARGET_XDOT_L151CC)
00047 I2C i2c(I2C_SDA, I2C_SCL);
00048 ISL29011 lux(i2c);
00049 #else
00050 AnalogIn lux(XBEE_AD0);
00051 #endif
00052 
00053 int main() {
00054     // Custom event handler for automatically displaying RX data
00055     RadioEvent events;
00056 
00057     pc.baud(115200);
00058 
00059 #if defined(TARGET_XDOT_L151CC)
00060     i2c.frequency(400000);
00061 #endif
00062 
00063     mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
00064     
00065 #if CHANNEL_PLAN == CP_US915
00066     plan = new lora::ChannelPlan_US915();
00067 #elif CHANNEL_PLAN == CP_AU915
00068     plan = new lora::ChannelPlan_AU915();
00069 #elif CHANNEL_PLAN == CP_EU868
00070     plan = new lora::ChannelPlan_EU868();
00071 #elif CHANNEL_PLAN == CP_KR920
00072     plan = new lora::ChannelPlan_KR920();
00073 #elif CHANNEL_PLAN == CP_AS923
00074     plan = new lora::ChannelPlan_AS923();
00075 #elif CHANNEL_PLAN == CP_AS923_JAPAN
00076     plan = new lora::ChannelPlan_AS923_Japan();
00077 #elif CHANNEL_PLAN == CP_IN865
00078     plan = new lora::ChannelPlan_IN865();
00079 #endif
00080     assert(plan);
00081 
00082     dot = mDot::getInstance(plan);
00083     assert(dot);
00084 
00085     // attach the custom events handler
00086     dot->setEvents(&events);
00087 
00088     if (!dot->getStandbyFlag()) {
00089         logInfo("mbed-os library version: %d.%d.%d", MBED_MAJOR_VERSION, MBED_MINOR_VERSION, MBED_PATCH_VERSION);
00090 
00091         // start from a well-known state
00092         logInfo("defaulting Dot configuration");
00093         dot->resetConfig();
00094         dot->resetNetworkSession();
00095 
00096         // make sure library logging is turned on
00097         dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
00098 
00099         // update configuration if necessary
00100         if (dot->getJoinMode() != mDot::OTA) {
00101             logInfo("changing network join mode to OTA");
00102             if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
00103                 logError("failed to set network join mode to OTA");
00104             }
00105         }
00106         // 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
00107         // only one method or the other should be used!
00108         // network ID = crc64(network name)
00109         // network KEY = cmac(network passphrase)
00110         update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, network_type, ack);
00111         //update_ota_config_id_key(network_id, network_key, frequency_sub_band, network_type, ack);
00112 
00113         // configure network link checks
00114         // 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
00115         // check the link every count packets
00116         // declare the Dot disconnected after threshold failed link checks
00117         // 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
00118         update_network_link_check_config(3, 5);
00119 
00120         // enable or disable Adaptive Data Rate
00121         dot->setAdr(adr);
00122 
00123         // Configure the join delay
00124         dot->setJoinDelay(join_delay);
00125 
00126         // save changes to configuration
00127         logInfo("saving configuration");
00128         if (!dot->saveConfig()) {
00129             logError("failed to save configuration");
00130         }
00131 
00132         // display configuration
00133         display_config();
00134     } else {
00135         // restore the saved session if the dot woke from deepsleep mode
00136         // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
00137         logInfo("restoring network session from NVM");
00138         dot->restoreNetworkSession();
00139     }
00140 
00141     while (true) {
00142         uint16_t light;
00143         std::vector<uint8_t> tx_data;
00144 
00145         // join network if not joined
00146         if (!dot->getNetworkJoinStatus()) {
00147             join_network();
00148         }
00149 
00150 #if defined(TARGET_XDOT_L151CC)
00151         // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
00152         lux.setMode(ISL29011::ALS_CONT);
00153         lux.setResolution(ISL29011::ADC_16BIT);
00154         lux.setRange(ISL29011::RNG_64000);
00155 
00156         // get the latest light sample and send it to the gateway
00157         light = lux.getData();
00158         tx_data.push_back((light >> 8) & 0xFF);
00159         tx_data.push_back(light & 0xFF);
00160         logInfo("light: %lu [0x%04X]", light, light);
00161         send_data(tx_data);
00162 
00163         // put the LSL29011 ambient light sensor into a low power state
00164         lux.setMode(ISL29011::PWR_DOWN);
00165 #else 
00166         // get some dummy data and send it to the gateway
00167         light = lux.read_u16();
00168         tx_data.push_back((light >> 8) & 0xFF);
00169         tx_data.push_back(light & 0xFF);
00170         logInfo("light: %lu [0x%04X]", light, light);
00171         send_data(tx_data);
00172 #endif
00173 
00174         // if going into deepsleep mode, save the session so we don't need to join again after waking up
00175         // not necessary if going into sleep mode since RAM is retained
00176         if (deep_sleep) {
00177             logInfo("saving network session to NVM");
00178             dot->saveNetworkSession();
00179         }
00180 
00181         // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
00182         //sleep_wake_rtc_only(deep_sleep);
00183         //sleep_wake_interrupt_only(deep_sleep);
00184         sleep_wake_rtc_or_interrupt(deep_sleep);
00185     }
00186  
00187     return 0;
00188 }
00189 
00190 #endif