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 bool public_network = false;
00031 static uint8_t ack = 0;
00032 static bool adr = true;
00033 
00034 // deepsleep consumes slightly less current than sleep
00035 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
00036 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
00037 // if deep_sleep == true, device will enter deepsleep mode
00038 static bool deep_sleep = false;
00039 
00040 mDot* dot = NULL;
00041 lora::ChannelPlan* plan = NULL;
00042 
00043 Serial pc(USBTX, USBRX);
00044 
00045 #if defined(TARGET_XDOT_L151CC)
00046 I2C i2c(I2C_SDA, I2C_SCL);
00047 ISL29011 lux(i2c);
00048 #else
00049 AnalogIn lux(XBEE_AD0);
00050 #endif
00051 
00052 int main() {
00053     // Custom event handler for automatically displaying RX data
00054     RadioEvent events;
00055 
00056     pc.baud(115200);
00057 
00058     mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
00059     
00060 #if CHANNEL_PLAN == CP_US915
00061     plan = new lora::ChannelPlan_US915();
00062 #elif CHANNEL_PLAN == CP_AU915
00063     plan = new lora::ChannelPlan_AU915();
00064 #elif CHANNEL_PLAN == CP_EU868
00065     plan = new lora::ChannelPlan_EU868();
00066 #elif CHANNEL_PLAN == CP_KR920
00067     plan = new lora::ChannelPlan_KR920();
00068 #elif CHANNEL_PLAN == CP_AS923
00069     plan = new lora::ChannelPlan_AS923();
00070 #elif CHANNEL_PLAN == CP_AS923_JAPAN
00071     plan = new lora::ChannelPlan_AS923_Japan();
00072 #elif CHANNEL_PLAN == CP_IN865
00073     plan = new lora::ChannelPlan_IN865();
00074 #endif
00075     assert(plan);
00076 
00077     dot = mDot::getInstance(plan);
00078     assert(dot);
00079 
00080     // attach the custom events handler
00081     dot->setEvents(&events);
00082 
00083     if (!dot->getStandbyFlag()) {
00084         logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
00085 
00086         // start from a well-known state
00087         logInfo("defaulting Dot configuration");
00088         dot->resetConfig();
00089         dot->resetNetworkSession();
00090 
00091         // make sure library logging is turned on
00092         dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
00093 
00094         // update configuration if necessary
00095         if (dot->getJoinMode() != mDot::OTA) {
00096             logInfo("changing network join mode to OTA");
00097             if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
00098                 logError("failed to set network join mode to OTA");
00099             }
00100         }
00101         // 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
00102         // only one method or the other should be used!
00103         // network ID = crc64(network name)
00104         // network KEY = cmac(network passphrase)
00105         update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
00106         //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
00107 
00108         // configure network link checks
00109         // 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
00110         // check the link every count packets
00111         // declare the Dot disconnected after threshold failed link checks
00112         // 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
00113         update_network_link_check_config(3, 5);
00114 
00115         // enable or disable Adaptive Data Rate
00116         dot->setAdr(adr);
00117     
00118         // save changes to configuration
00119         logInfo("saving configuration");
00120         if (!dot->saveConfig()) {
00121             logError("failed to save configuration");
00122         }
00123 
00124         // display configuration
00125         display_config();
00126     } else {
00127         // restore the saved session if the dot woke from deepsleep mode
00128         // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
00129         logInfo("restoring network session from NVM");
00130         dot->restoreNetworkSession();
00131     }
00132 
00133     while (true) {
00134         uint16_t light;
00135         std::vector<uint8_t> tx_data;
00136 
00137         // join network if not joined
00138         if (!dot->getNetworkJoinStatus()) {
00139             join_network();
00140         }
00141 
00142 #if defined(TARGET_XDOT_L151CC)
00143         // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
00144         lux.setMode(ISL29011::ALS_CONT);
00145         lux.setResolution(ISL29011::ADC_16BIT);
00146         lux.setRange(ISL29011::RNG_64000);
00147 
00148         // get the latest light sample and send it to the gateway
00149         light = lux.getData();
00150         tx_data.push_back((light >> 8) & 0xFF);
00151         tx_data.push_back(light & 0xFF);
00152         logInfo("light: %lu [0x%04X]", light, light);
00153         send_data(tx_data);
00154 
00155         // put the LSL29011 ambient light sensor into a low power state
00156         lux.setMode(ISL29011::PWR_DOWN);
00157 #else 
00158         // get some dummy data and send it to the gateway
00159         light = lux.read_u16();
00160         tx_data.push_back((light >> 8) & 0xFF);
00161         tx_data.push_back(light & 0xFF);
00162         logInfo("light: %lu [0x%04X]", light, light);
00163         send_data(tx_data);
00164 #endif
00165 
00166         // if going into deepsleep mode, save the session so we don't need to join again after waking up
00167         // not necessary if going into sleep mode since RAM is retained
00168         if (deep_sleep) {
00169             logInfo("saving network session to NVM");
00170             dot->saveNetworkSession();
00171         }
00172 
00173         // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
00174         //sleep_wake_rtc_only(deep_sleep);
00175         //sleep_wake_interrupt_only(deep_sleep);
00176         sleep_wake_rtc_or_interrupt(deep_sleep);
00177     }
00178  
00179     return 0;
00180 }
00181 
00182 #endif