Jose Rios / Mbed OS xdot-test

Basic xdot code to check how many memory is available for user APP after initializing libxdot lorawan stack

examples/src/manual_example.cpp@42:20f6b29a9903, 2021-05-25 (annotated)

Committer:
Taylor Heck
Date:
Tue May 25 09:54:33 2021 -0500
Revision:
42:20f6b29a9903
Parent:
33:15ea8f985c54 
Target mbed-os 6 and Dot Library version 4.

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