manual_example.cpp

00001 #include "dot_util.h"
00002 #include "RadioEvent.h"
00003  
00004 #if ACTIVE_EXAMPLE == MANUAL_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 /////////////////////////////////////////////////////////////
00023 static uint8_t network_address[] = { 0x01, 0x02, 0x03, 0x04 };
00024 static uint8_t network_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
00025 static uint8_t data_session_key[] = { 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04, 0x01, 0x02, 0x03, 0x04 };
00026 static uint8_t frequency_sub_band = 6;
00027 static bool public_network = false;
00028 static uint8_t ack = 1;
00029 static bool adr = true;
00030 
00031 // deepsleep consumes slightly less current than sleep
00032 // in sleep mode, IO state is maintained, RAM is retained, and application will resume after waking up
00033 // in deepsleep mode, IOs float, RAM is lost, and application will start from beginning after waking up
00034 // if deep_sleep == true, device will enter deepsleep mode
00035 static bool deep_sleep = true;
00036 
00037 mDot* dot = NULL;
00038 lora::ChannelPlan* plan = NULL;
00039 
00040 Serial pc(USBTX, USBRX);
00041 
00042 #if defined(TARGET_XDOT_L151CC)
00043 I2C i2c(I2C_SDA, I2C_SCL);
00044 ISL29011 lux(i2c);
00045 #else
00046 AnalogIn lux(XBEE_AD0);
00047 #endif
00048 
00049 int main() {
00050     // Custom event handler for automatically displaying RX data
00051     RadioEvent events;
00052 
00053     pc.baud(115200);
00054 
00055     mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
00056     
00057 #if CHANNEL_PLAN == CP_US915
00058     plan = new lora::ChannelPlan_US915();
00059 #elif CHANNEL_PLAN == CP_AU915
00060     plan = new lora::ChannelPlan_AU915();
00061 #elif CHANNEL_PLAN == CP_EU868
00062     plan = new lora::ChannelPlan_EU868();
00063 #elif CHANNEL_PLAN == CP_KR920
00064     plan = new lora::ChannelPlan_KR920();
00065 #elif CHANNEL_PLAN == CP_AS923
00066     plan = new lora::ChannelPlan_AS923();
00067 #elif CHANNEL_PLAN == CP_AS923_JAPAN
00068     plan = new lora::ChannelPlan_AS923_Japan();
00069 #elif CHANNEL_PLAN == CP_IN865
00070     plan = new lora::ChannelPlan_IN865();
00071 #endif
00072     assert(plan);
00073 
00074     dot = mDot::getInstance(plan);
00075     assert(dot);
00076 
00077     // attach the custom events handler
00078     dot->setEvents(&events);
00079 
00080     if (!dot->getStandbyFlag()) {
00081         logInfo("mbed-os library version: %d", MBED_LIBRARY_VERSION);
00082 
00083         // start from a well-known state
00084         logInfo("defaulting Dot configuration");
00085         dot->resetConfig();
00086         dot->resetNetworkSession();
00087 
00088         // make sure library logging is turned on
00089         dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
00090 
00091         // update configuration if necessary
00092         if (dot->getJoinMode() != mDot::MANUAL) {
00093             logInfo("changing network join mode to MANUAL");
00094             if (dot->setJoinMode(mDot::MANUAL) != mDot::MDOT_OK) {
00095                 logError("failed to set network join mode to MANUAL");
00096             }
00097         }
00098         // in MANUAL join mode there is no join request/response transaction
00099         // as long as the Dot is configured correctly and provisioned correctly on the gateway, it should be able to communicate
00100         // network address - 4 bytes (00000001 - FFFFFFFE)
00101         // network session key - 16 bytes
00102         // data session key - 16 bytes
00103         // to provision your Dot with a Conduit gateway, follow the following steps
00104         //   * ssh into the Conduit
00105         //   * provision the Dot using the lora-query application: http://www.multitech.net/developer/software/lora/lora-network-server/
00106         //      lora-query -a 01020304 A 0102030401020304 <your Dot's device ID> 01020304010203040102030401020304 01020304010203040102030401020304
00107         //   * if you change the network address, network session key, or data session key, make sure you update them on the gateway
00108         // to provision your Dot with a 3rd party gateway, see the gateway or network provider documentation
00109         update_manual_config(network_address, network_session_key, data_session_key, frequency_sub_band, public_network, ack);
00110 
00111         // enable or disable Adaptive Data Rate
00112         dot->setAdr(adr);
00113 
00114         // save changes to configuration
00115         logInfo("saving configuration");
00116         if (!dot->saveConfig()) {
00117             logError("failed to save configuration");
00118         }
00119 
00120         // display configuration
00121         display_config();
00122     } else {
00123         // restore the saved session if the dot woke from deepsleep mode
00124         // useful to use with deepsleep because session info is otherwise lost when the dot enters deepsleep
00125         logInfo("restoring network session from NVM");
00126         dot->restoreNetworkSession();
00127     }
00128     
00129 
00130     while (true) {
00131         uint16_t light;
00132         std::vector<uint8_t> tx_data;
00133 
00134 #if defined(TARGET_XDOT_L151CC)
00135         // configure the ISL29011 sensor on the xDot-DK for continuous ambient light sampling, 16 bit conversion, and maximum range
00136         lux.setMode(ISL29011::ALS_CONT);
00137         lux.setResolution(ISL29011::ADC_16BIT);
00138         lux.setRange(ISL29011::RNG_64000);
00139 
00140         // get the latest light sample and send it to the gateway
00141         light = lux.getData();
00142         tx_data.push_back((light >> 8) & 0xFF);
00143         tx_data.push_back(light & 0xFF);
00144         logInfo("light: %lu [0x%04X]", light, light);
00145         send_data(tx_data);
00146 
00147         // put the LSL29011 ambient light sensor into a low power state
00148         lux.setMode(ISL29011::PWR_DOWN);
00149 #else 
00150         // get some dummy data and send it to the gateway
00151         light = lux.read_u16();
00152         tx_data.push_back((light >> 8) & 0xFF);
00153         tx_data.push_back(light & 0xFF);
00154         logInfo("light: %lu [0x%04X]", light, light);
00155         send_data(tx_data);
00156 #endif
00157 
00158         // if going into deepsleep mode, save the session so we don't need to join again after waking up
00159         // not necessary if going into sleep mode since RAM is retained
00160         if (deep_sleep) {
00161             logInfo("saving network session to NVM");
00162             dot->saveNetworkSession();
00163         }
00164 
00165         // ONLY ONE of the three functions below should be uncommented depending on the desired wakeup method
00166         //sleep_wake_rtc_only(deep_sleep);
00167         //sleep_wake_interrupt_only(deep_sleep);
00168         sleep_wake_rtc_or_interrupt(deep_sleep);
00169     }
00170  
00171     return 0;
00172 }
00173 
00174 #endif