class_b_example.cpp

00001 #include "dot_util.h"
00002 #include "RadioEvent.h"
00003  
00004 #if ACTIVE_EXAMPLE == CLASS_B_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 = 1;
00030 static lora::NetworkType public_network = lora::PUBLIC_LORAWAN;
00031 static uint8_t join_delay = 5;
00032 static uint8_t ack = 3;
00033 static bool adr = true;
00034 
00035 // Number of ping slots to open per beacon interval - see mDot.h
00036 static uint8_t ping_periodicity = 4;
00037 
00038 mDot* dot = NULL;
00039 lora::ChannelPlan* plan = NULL;
00040 
00041 mbed::UnbufferedSerial pc(USBTX, USBRX);
00042 
00043 #if defined(TARGET_XDOT_L151CC)
00044 I2C i2c(I2C_SDA, I2C_SCL);
00045 ISL29011 lux(i2c);
00046 #else
00047 AnalogIn lux(XBEE_AD0);
00048 #endif
00049 
00050 int main() {
00051     // Custom event handler for automatically displaying RX data
00052     RadioEvent events;
00053 
00054     pc.baud(115200);
00055 
00056 #if defined(TARGET_XDOT_L151CC)
00057     i2c.frequency(400000);
00058 #endif
00059 
00060     mts::MTSLog::setLogLevel(mts::MTSLog::TRACE_LEVEL);
00061 
00062     // Create channel plan
00063     plan = create_channel_plan();
00064     assert(plan);
00065 
00066     dot = mDot::getInstance(plan);
00067     assert(dot);
00068 
00069     logInfo("mbed-os library version: %d.%d.%d", MBED_MAJOR_VERSION, MBED_MINOR_VERSION, MBED_PATCH_VERSION);
00070 
00071     // start from a well-known state
00072     logInfo("defaulting Dot configuration");
00073     dot->resetConfig();
00074     dot->resetNetworkSession();
00075 
00076     // make sure library logging is turned on
00077     dot->setLogLevel(mts::MTSLog::INFO_LEVEL);
00078 
00079     // attach the custom events handler
00080     dot->setEvents(&events);
00081 
00082     // update configuration if necessary
00083     if (dot->getJoinMode() != mDot::OTA) {
00084         logInfo("changing network join mode to OTA");
00085         if (dot->setJoinMode(mDot::OTA) != mDot::MDOT_OK) {
00086             logError("failed to set network join mode to OTA");
00087         }
00088     }
00089     // 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
00090     // only one method or the other should be used!
00091     // network ID = crc64(network name)
00092     // network KEY = cmac(network passphrase)
00093     update_ota_config_name_phrase(network_name, network_passphrase, frequency_sub_band, public_network, ack);
00094     //update_ota_config_id_key(network_id, network_key, frequency_sub_band, public_network, ack);
00095 
00096     // enable or disable Adaptive Data Rate
00097     dot->setAdr(adr);
00098 
00099     // Configure the join delay
00100     dot->setJoinDelay(join_delay);
00101 
00102     // Configure the class B ping periodicity
00103     dot->setPingPeriodicity(ping_periodicity);
00104 
00105     // save changes to configuration
00106     logInfo("saving configuration");
00107     if (!dot->saveConfig()) {
00108         logError("failed to save configuration");
00109     }
00110 
00111     // display configuration
00112     display_config();
00113 
00114     // join the network - must do this before attempting to switch to class B
00115     join_network();
00116 
00117     // configure the Dot for class B operation
00118     // the Dot must also be configured on the gateway for class B
00119     // use the lora-query application to do this on a Conduit: http://www.multitech.net/developer/software/lora/lora-network-server/
00120     // to provision your Dot for class B operation with a 3rd party gateway, see the gateway or network provider documentation
00121     // Note: we won't actually switch to class B until we receive a beacon (mDotEvent::BeaconRx fires)
00122     logInfo("changing network mode to class B");
00123 
00124     if (dot->setClass("B") != mDot::MDOT_OK) {
00125         logError("Failed to set network mode to class B");
00126         logInfo("Reset the MCU to try again");
00127         return 0;
00128     }
00129 
00130     // Start a timer to check the beacon was acquired
00131     LowPowerTimer bcn_timer;
00132     bcn_timer.start();
00133 
00134     while (true) {
00135         std::vector<uint8_t> tx_data;
00136         static bool send_uplink = true;
00137 
00138         // Check if we locked the beacon yet and send an uplink to notify the network server
00139         // To receive data from the gateway in class B ping slots, we must have received a beacon
00140         // already, and sent one uplink to signal to the network server that we are in class B mode
00141         if (events.BeaconLocked && send_uplink) {
00142             logInfo("Acquired a beacon lock");
00143 
00144             // Add a random delay before trying the uplink to avoid collisions w/ other motes
00145             srand(dot->getRadioRandom());
00146             uint32_t rand_delay = rand() % 5000;
00147             logInfo("Applying a random delay of %d ms before class notification uplink", rand_delay);
00148             ThisThread::sleep_for(std::chrono::milliseconds(rand_delay));
00149 
00150             // Ensure the link is idle before trying to transmit
00151             while (!dot->getIsIdle()) {
00152                 ThisThread::sleep_for(10ms);
00153             }
00154 
00155             if (send_data(tx_data) != mDot::MDOT_OK) {
00156                 logError("Failed to inform the network server we are in class B");
00157                 logInfo("Reset the MCU to try again");
00158                 return 0;
00159             }
00160 
00161             logInfo("Enqueued packets may now be scheduled on class B ping slots");
00162             send_uplink = false;
00163             bcn_timer.stop();
00164         } else if (!events.BeaconLocked) {
00165             logInfo("Waiting to receive a beacon..");
00166 
00167             if (bcn_timer.read() > lora::DEFAULT_BEACON_PERIOD) {
00168                 if (dot->setClass("B") != mDot::MDOT_OK) {
00169                     logError("Failed to set network mode to class B");
00170                     logInfo("Reset the MCU to try again");
00171                     return 0;
00172                 }
00173 
00174                 bcn_timer.reset();
00175             }
00176         }
00177         ThisThread::sleep_for(10s);
00178     }
00179 
00180     return 0;
00181 }
00182 
00183 #endif