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/dot_util.cpp@5:97ed5f2f099e, 2016-10-07 (annotated)

Committer:
Mike Fiore
Date:
Fri Oct 07 10:38:54 2016 -0500
Revision:
5:97ed5f2f099e
Parent:
4:93579eb88fcd
Child:
7:724cb82a113e
add support for using network ID and KEY instead of name and passphrase

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mfiore 0:a151a6350d7f 1 #include "dot_util.h"
mfiore 0:a151a6350d7f 2
mfiore 0:a151a6350d7f 3 void display_config() {
mfiore 0:a151a6350d7f 4 // display configuration and library version information
mfiore 0:a151a6350d7f 5 logInfo("version: %s", dot->getId().c_str());
mfiore 0:a151a6350d7f 6 logInfo("general configuration");
mfiore 0:a151a6350d7f 7 logInfo("---------------------");
mfiore 0:a151a6350d7f 8 logInfo("\tdevice ID/EUI: %s", mts::Text::bin2hexString(dot->getDeviceId()).c_str());
mfiore 0:a151a6350d7f 9 logInfo("\tfrequency band: %s", mDot::FrequencyBandStr(dot->getFrequencyBand()).c_str());
mfiore 2:ffac7b141b72 10 if (dot->getFrequencySubBand() != mDot::FB_EU868) {
mfiore 1:c4915e00d2ce 11 logInfo("\tfrequency sub band: %u", dot->getFrequencySubBand());
mfiore 1:c4915e00d2ce 12 }
mfiore 0:a151a6350d7f 13 logInfo("\tpublic network: %s", dot->getPublicNetwork() == true ? "on" : "off");
mfiore 0:a151a6350d7f 14 logInfo("credentials configuration");
mfiore 0:a151a6350d7f 15 logInfo("-------------------------");
mfiore 0:a151a6350d7f 16 logInfo("\tnetwork name: %s", dot->getNetworkName().c_str());
mfiore 0:a151a6350d7f 17 logInfo("\tnetwork phrase: %s", dot->getNetworkPassphrase().c_str());
mfiore 4:93579eb88fcd 18 logInfo("\tnetwork EUI: %s", mts::Text::bin2hexString(dot->getNetworkId()).c_str());
mfiore 4:93579eb88fcd 19 logInfo("\tnetwork KEY: %s", mts::Text::bin2hexString(dot->getNetworkKey()).c_str());
mfiore 0:a151a6350d7f 20 logInfo("\tnetwork join mode: %s", mDot::JoinModeStr(dot->getJoinMode()).c_str());
mfiore 0:a151a6350d7f 21 logInfo("communication parameters");
mfiore 0:a151a6350d7f 22 logInfo("------------------------");
mfiore 0:a151a6350d7f 23 logInfo("\tacks: %s, %u attempts", dot->getAck() > 0 ? "on" : "off", dot->getAck());
mfiore 0:a151a6350d7f 24 logInfo("\tTX datarate: %s", mDot::DataRateStr(dot->getTxDataRate()).c_str());
mfiore 0:a151a6350d7f 25 logInfo("\tTX power: %lu dBm", dot->getTxPower());
mfiore 0:a151a6350d7f 26 logInfo("\tatnenna gain: %u dBm", dot->getAntennaGain());
mfiore 0:a151a6350d7f 27 }
mfiore 0:a151a6350d7f 28
Mike Fiore 5:97ed5f2f099e 29 void update_ota_config_name_phrase(std::string network_name, std::string network_passphrase, uint8_t frequency_sub_band, bool public_network, uint8_t ack) {
mfiore 0:a151a6350d7f 30 std::string current_network_name = dot->getNetworkName();
mfiore 0:a151a6350d7f 31 std::string current_network_passphrase = dot->getNetworkPassphrase();
mfiore 0:a151a6350d7f 32 uint8_t current_frequency_sub_band = dot->getFrequencySubBand();
mfiore 0:a151a6350d7f 33 bool current_public_network = dot->getPublicNetwork();
mfiore 0:a151a6350d7f 34 uint8_t current_ack = dot->getAck();
mfiore 0:a151a6350d7f 35
mfiore 0:a151a6350d7f 36 if (current_network_name != network_name) {
mfiore 0:a151a6350d7f 37 logInfo("changing network name from \"%s\" to \"%s\"", current_network_name.c_str(), network_name.c_str());
mfiore 0:a151a6350d7f 38 if (dot->setNetworkName(network_name) != mDot::MDOT_OK) {
mfiore 0:a151a6350d7f 39 logError("failed to set network name to \"%s\"", network_name.c_str());
mfiore 0:a151a6350d7f 40 }
mfiore 0:a151a6350d7f 41 }
mfiore 0:a151a6350d7f 42
mfiore 0:a151a6350d7f 43 if (current_network_passphrase != network_passphrase) {
mfiore 0:a151a6350d7f 44 logInfo("changing network passphrase from \"%s\" to \"%s\"", current_network_passphrase.c_str(), network_passphrase.c_str());
mfiore 0:a151a6350d7f 45 if (dot->setNetworkPassphrase(network_passphrase) != mDot::MDOT_OK) {
mfiore 0:a151a6350d7f 46 logError("failed to set network passphrase to \"%s\"", network_passphrase.c_str());
mfiore 0:a151a6350d7f 47 }
mfiore 0:a151a6350d7f 48 }
mfiore 0:a151a6350d7f 49
mfiore 0:a151a6350d7f 50 if (current_frequency_sub_band != frequency_sub_band) {
mfiore 0:a151a6350d7f 51 logInfo("changing frequency sub band from %u to %u", current_frequency_sub_band, frequency_sub_band);
mfiore 0:a151a6350d7f 52 if (dot->setFrequencySubBand(frequency_sub_band) != mDot::MDOT_OK) {
mfiore 0:a151a6350d7f 53 logError("failed to set frequency sub band to %u", frequency_sub_band);
mfiore 0:a151a6350d7f 54 }
mfiore 0:a151a6350d7f 55 }
mfiore 0:a151a6350d7f 56
mfiore 0:a151a6350d7f 57 if (current_public_network != public_network) {
mfiore 0:a151a6350d7f 58 logInfo("changing public network from %s to %s", current_public_network ? "true" : "false", public_network ? "true" : "false");
mfiore 0:a151a6350d7f 59 if (dot->setPublicNetwork(public_network) != mDot::MDOT_OK) {
mfiore 0:a151a6350d7f 60 logError("failed to set public network to %s", public_network ? "true" : "false");
mfiore 0:a151a6350d7f 61 }
mfiore 0:a151a6350d7f 62 }
mfiore 0:a151a6350d7f 63
mfiore 0:a151a6350d7f 64 if (current_ack != ack) {
mfiore 0:a151a6350d7f 65 logInfo("changing acks from %u to %u", current_ack, ack);
mfiore 0:a151a6350d7f 66 if (dot->setAck(ack) != mDot::MDOT_OK) {
mfiore 0:a151a6350d7f 67 logError("failed to set acks to %u", ack);
mfiore 0:a151a6350d7f 68 }
mfiore 0:a151a6350d7f 69 }
mfiore 0:a151a6350d7f 70 }
mfiore 0:a151a6350d7f 71
Mike Fiore 5:97ed5f2f099e 72 void update_ota_config_id_key(uint8_t *network_id, uint8_t *network_key, uint8_t frequency_sub_band, bool public_network, uint8_t ack) {
Mike Fiore 5:97ed5f2f099e 73 std::vector<uint8_t> current_network_id = dot->getNetworkId();
Mike Fiore 5:97ed5f2f099e 74 std::vector<uint8_t> current_network_key = dot->getNetworkKey();
Mike Fiore 5:97ed5f2f099e 75 uint8_t current_frequency_sub_band = dot->getFrequencySubBand();
Mike Fiore 5:97ed5f2f099e 76 bool current_public_network = dot->getPublicNetwork();
Mike Fiore 5:97ed5f2f099e 77 uint8_t current_ack = dot->getAck();
Mike Fiore 5:97ed5f2f099e 78
Mike Fiore 5:97ed5f2f099e 79 std::vector<uint8_t> network_id_vector(network_id, network_id + 8);
Mike Fiore 5:97ed5f2f099e 80 std::vector<uint8_t> network_key_vector(network_key, network_key + 16);
Mike Fiore 5:97ed5f2f099e 81
Mike Fiore 5:97ed5f2f099e 82 if (current_network_id != network_id_vector) {
Mike Fiore 5:97ed5f2f099e 83 logInfo("changing network ID from \"%s\" to \"%s\"", mts::Text::bin2hexString(current_network_id).c_str(), mts::Text::bin2hexString(network_id_vector).c_str());
Mike Fiore 5:97ed5f2f099e 84 if (dot->setNetworkId(network_id_vector) != mDot::MDOT_OK) {
Mike Fiore 5:97ed5f2f099e 85 logError("failed to set network ID to \"%s\"", mts::Text::bin2hexString(network_id_vector).c_str());
Mike Fiore 5:97ed5f2f099e 86 }
Mike Fiore 5:97ed5f2f099e 87 }
Mike Fiore 5:97ed5f2f099e 88
Mike Fiore 5:97ed5f2f099e 89 if (current_network_key != network_key_vector) {
Mike Fiore 5:97ed5f2f099e 90 logInfo("changing network KEY from \"%s\" to \"%s\"", mts::Text::bin2hexString(current_network_key).c_str(), mts::Text::bin2hexString(network_key_vector).c_str());
Mike Fiore 5:97ed5f2f099e 91 if (dot->setNetworkKey(network_key_vector) != mDot::MDOT_OK) {
Mike Fiore 5:97ed5f2f099e 92 logError("failed to set network KEY to \"%s\"", mts::Text::bin2hexString(network_key_vector).c_str());
Mike Fiore 5:97ed5f2f099e 93 }
Mike Fiore 5:97ed5f2f099e 94 }
Mike Fiore 5:97ed5f2f099e 95
Mike Fiore 5:97ed5f2f099e 96 if (current_frequency_sub_band != frequency_sub_band) {
Mike Fiore 5:97ed5f2f099e 97 logInfo("changing frequency sub band from %u to %u", current_frequency_sub_band, frequency_sub_band);
Mike Fiore 5:97ed5f2f099e 98 if (dot->setFrequencySubBand(frequency_sub_band) != mDot::MDOT_OK) {
Mike Fiore 5:97ed5f2f099e 99 logError("failed to set frequency sub band to %u", frequency_sub_band);
Mike Fiore 5:97ed5f2f099e 100 }
Mike Fiore 5:97ed5f2f099e 101 }
Mike Fiore 5:97ed5f2f099e 102
Mike Fiore 5:97ed5f2f099e 103 if (current_public_network != public_network) {
Mike Fiore 5:97ed5f2f099e 104 logInfo("changing public network from %s to %s", current_public_network ? "true" : "false", public_network ? "true" : "false");
Mike Fiore 5:97ed5f2f099e 105 if (dot->setPublicNetwork(public_network) != mDot::MDOT_OK) {
Mike Fiore 5:97ed5f2f099e 106 logError("failed to set public network to %s", public_network ? "true" : "false");
Mike Fiore 5:97ed5f2f099e 107 }
Mike Fiore 5:97ed5f2f099e 108 }
Mike Fiore 5:97ed5f2f099e 109
Mike Fiore 5:97ed5f2f099e 110 if (current_ack != ack) {
Mike Fiore 5:97ed5f2f099e 111 logInfo("changing acks from %u to %u", current_ack, ack);
Mike Fiore 5:97ed5f2f099e 112 if (dot->setAck(ack) != mDot::MDOT_OK) {
Mike Fiore 5:97ed5f2f099e 113 logError("failed to set acks to %u", ack);
Mike Fiore 5:97ed5f2f099e 114 }
Mike Fiore 5:97ed5f2f099e 115 }
Mike Fiore 5:97ed5f2f099e 116 }
Mike Fiore 5:97ed5f2f099e 117
mfiore 0:a151a6350d7f 118 void join_network() {
mfiore 0:a151a6350d7f 119 int32_t j_attempts = 0;
mfiore 0:a151a6350d7f 120 int32_t ret = mDot::MDOT_ERROR;
mfiore 0:a151a6350d7f 121
mfiore 0:a151a6350d7f 122 // attempt to join the network
mfiore 0:a151a6350d7f 123 while (ret != mDot::MDOT_OK) {
mfiore 0:a151a6350d7f 124 logInfo("attempt %d to join network", ++j_attempts);
mfiore 0:a151a6350d7f 125 ret = dot->joinNetwork();
mfiore 0:a151a6350d7f 126 if (ret != mDot::MDOT_OK) {
mfiore 0:a151a6350d7f 127 logError("failed to join network %d:%s", ret, mDot::getReturnCodeString(ret).c_str());
mfiore 0:a151a6350d7f 128 // in some frequency bands we need to wait until another channel is available before transmitting again
mfiore 0:a151a6350d7f 129 uint32_t delay_s = (dot->getNextTxMs() / 1000) + 1;
mfiore 0:a151a6350d7f 130 if (delay_s < 2) {
mfiore 0:a151a6350d7f 131 logInfo("waiting %lu s until next free channel", delay_s);
mfiore 0:a151a6350d7f 132 wait(delay_s);
mfiore 0:a151a6350d7f 133 } else {
mfiore 0:a151a6350d7f 134 logInfo("sleeping %lu s until next free channel", delay_s);
mfiore 0:a151a6350d7f 135 dot->sleep(delay_s, mDot::RTC_ALARM, false);
mfiore 0:a151a6350d7f 136 }
mfiore 0:a151a6350d7f 137 }
mfiore 0:a151a6350d7f 138 }
mfiore 0:a151a6350d7f 139 }
mfiore 0:a151a6350d7f 140
mfiore 0:a151a6350d7f 141 void sleep_wake_rtc_only(bool deepsleep) {
mfiore 0:a151a6350d7f 142 // in some frequency bands we need to wait until another channel is available before transmitting again
mfiore 0:a151a6350d7f 143 // wait at least 10s between transmissions
mfiore 0:a151a6350d7f 144 uint32_t delay_s = dot->getNextTxMs() / 1000;
mfiore 0:a151a6350d7f 145 if (delay_s < 10) {
mfiore 0:a151a6350d7f 146 delay_s = 10;
mfiore 0:a151a6350d7f 147 }
mfiore 0:a151a6350d7f 148
mfiore 0:a151a6350d7f 149 logInfo("%ssleeping %lus", deepsleep ? "deep" : "", delay_s);
mfiore 0:a151a6350d7f 150 logInfo("application will %s after waking up", deepsleep ? "execute from beginning" : "resume");
mfiore 0:a151a6350d7f 151
mfiore 0:a151a6350d7f 152 // go to sleep/deepsleep for delay_s seconds and wake using the RTC alarm
mfiore 0:a151a6350d7f 153 dot->sleep(delay_s, mDot::RTC_ALARM, deepsleep);
mfiore 0:a151a6350d7f 154 }
mfiore 0:a151a6350d7f 155
mfiore 0:a151a6350d7f 156 void sleep_wake_interrupt_only(bool deepsleep) {
mfiore 0:a151a6350d7f 157 #if defined (TARGET_XDOT_L151CC)
mfiore 0:a151a6350d7f 158 if (deepsleep) {
mfiore 0:a151a6350d7f 159 // for xDot, WAKE pin (connected to S2 on xDot-DK) is the only pin that can wake the processor from deepsleep
mfiore 0:a151a6350d7f 160 // it is automatically configured when INTERRUPT or RTC_ALARM_OR_INTERRUPT is the wakeup source and deepsleep is true in the mDot::sleep call
mfiore 0:a151a6350d7f 161 } else {
mfiore 0:a151a6350d7f 162 // configure WAKE pin (connected to S2 on xDot-DK) as the pin that will wake the xDot from low power modes
mfiore 0:a151a6350d7f 163 // other pins can be confgured instead: GPIO0-3 or UART_RX
mfiore 0:a151a6350d7f 164 dot->setWakePin(WAKE);
mfiore 0:a151a6350d7f 165 }
mfiore 0:a151a6350d7f 166
mfiore 2:ffac7b141b72 167 logInfo("%ssleeping until interrupt on %s pin", deepsleep ? "deep" : "", deepsleep ? "WAKE" : mDot::pinName2Str(dot->getWakePin()).c_str());
mfiore 0:a151a6350d7f 168 #else
mfiore 0:a151a6350d7f 169 if (deepsleep) {
mfiore 0:a151a6350d7f 170 // for mDot, XBEE_DIO7 pin is the only pin that can wake the processor from deepsleep
mfiore 0:a151a6350d7f 171 // it is automatically configured when INTERRUPT or RTC_ALARM_OR_INTERRUPT is the wakeup source and deepsleep is true in the mDot::sleep call
mfiore 0:a151a6350d7f 172 } else {
mfiore 0:a151a6350d7f 173 // configure XBEE_DIO7 pin as the pin that will wake the mDot from low power modes
mfiore 0:a151a6350d7f 174 // other pins can be confgured instead: XBEE_DIO2-6, XBEE_DI8, XBEE_DIN
mfiore 0:a151a6350d7f 175 dot->setWakePin(XBEE_DIO7);
mfiore 0:a151a6350d7f 176 }
mfiore 0:a151a6350d7f 177
mfiore 2:ffac7b141b72 178 logInfo("%ssleeping until interrupt on %s pin", deepsleep ? "deep" : "", deepsleep ? "DIO7" : mDot::pinName2Str(dot->getWakePin()).c_str());
mfiore 0:a151a6350d7f 179 #endif
mfiore 0:a151a6350d7f 180
mfiore 0:a151a6350d7f 181 logInfo("application will %s after waking up", deepsleep ? "execute from beginning" : "resume");
mfiore 0:a151a6350d7f 182
mfiore 0:a151a6350d7f 183 // go to sleep/deepsleep and wake on rising edge of configured wake pin (only the WAKE pin in deepsleep)
mfiore 0:a151a6350d7f 184 // since we're not waking on the RTC alarm, the interval is ignored
mfiore 0:a151a6350d7f 185 dot->sleep(0, mDot::INTERRUPT, deepsleep);
mfiore 0:a151a6350d7f 186 }
mfiore 0:a151a6350d7f 187
mfiore 0:a151a6350d7f 188 void sleep_wake_rtc_or_interrupt(bool deepsleep) {
mfiore 0:a151a6350d7f 189 // in some frequency bands we need to wait until another channel is available before transmitting again
mfiore 0:a151a6350d7f 190 // wait at least 10s between transmissions
mfiore 0:a151a6350d7f 191 uint32_t delay_s = dot->getNextTxMs() / 1000;
mfiore 0:a151a6350d7f 192 if (delay_s < 10) {
mfiore 0:a151a6350d7f 193 delay_s = 10;
mfiore 0:a151a6350d7f 194 }
mfiore 0:a151a6350d7f 195
mfiore 0:a151a6350d7f 196 #if defined (TARGET_XDOT_L151CC)
mfiore 0:a151a6350d7f 197 if (deepsleep) {
mfiore 0:a151a6350d7f 198 // for xDot, WAKE pin (connected to S2 on xDot-DK) is the only pin that can wake the processor from deepsleep
mfiore 0:a151a6350d7f 199 // it is automatically configured when INTERRUPT or RTC_ALARM_OR_INTERRUPT is the wakeup source and deepsleep is true in the mDot::sleep call
mfiore 0:a151a6350d7f 200 } else {
mfiore 0:a151a6350d7f 201 // configure WAKE pin (connected to S2 on xDot-DK) as the pin that will wake the xDot from low power modes
mfiore 0:a151a6350d7f 202 // other pins can be confgured instead: GPIO0-3 or UART_RX
mfiore 0:a151a6350d7f 203 dot->setWakePin(WAKE);
mfiore 0:a151a6350d7f 204 }
mfiore 0:a151a6350d7f 205
mfiore 2:ffac7b141b72 206 logInfo("%ssleeping %lus or until interrupt on %s pin", deepsleep ? "deep" : "", delay_s, deepsleep ? "WAKE" : mDot::pinName2Str(dot->getWakePin()).c_str());
mfiore 0:a151a6350d7f 207 #else
mfiore 0:a151a6350d7f 208 if (deepsleep) {
mfiore 0:a151a6350d7f 209 // for mDot, XBEE_DIO7 pin is the only pin that can wake the processor from deepsleep
mfiore 0:a151a6350d7f 210 // it is automatically configured when INTERRUPT or RTC_ALARM_OR_INTERRUPT is the wakeup source and deepsleep is true in the mDot::sleep call
mfiore 0:a151a6350d7f 211 } else {
mfiore 0:a151a6350d7f 212 // configure XBEE_DIO7 pin as the pin that will wake the mDot from low power modes
mfiore 0:a151a6350d7f 213 // other pins can be confgured instead: XBEE_DIO2-6, XBEE_DI8, XBEE_DIN
mfiore 0:a151a6350d7f 214 dot->setWakePin(XBEE_DIO7);
mfiore 0:a151a6350d7f 215 }
mfiore 0:a151a6350d7f 216
mfiore 2:ffac7b141b72 217 logInfo("%ssleeping %lus or until interrupt on %s pin", deepsleep ? "deep" : "", delay_s, deepsleep ? "DIO7" : mDot::pinName2Str(dot->getWakePin()).c_str());
mfiore 0:a151a6350d7f 218 #endif
mfiore 0:a151a6350d7f 219
mfiore 0:a151a6350d7f 220 logInfo("application will %s after waking up", deepsleep ? "execute from beginning" : "resume");
mfiore 0:a151a6350d7f 221
mfiore 0:a151a6350d7f 222 // go to sleep/deepsleep and wake using the RTC alarm after delay_s seconds or rising edge of configured wake pin (only the WAKE pin in deepsleep)
mfiore 0:a151a6350d7f 223 // whichever comes first will wake the xDot
mfiore 0:a151a6350d7f 224 dot->sleep(delay_s, mDot::RTC_ALARM_OR_INTERRUPT, deepsleep);
mfiore 0:a151a6350d7f 225 }
mfiore 0:a151a6350d7f 226
mfiore 0:a151a6350d7f 227 void send_data(std::vector<uint8_t> data) {
mfiore 0:a151a6350d7f 228 uint32_t ret;
mfiore 0:a151a6350d7f 229
mfiore 0:a151a6350d7f 230 ret = dot->send(data);
mfiore 0:a151a6350d7f 231 if (ret != mDot::MDOT_OK) {
mfiore 2:ffac7b141b72 232 logError("failed to send data to gateway [%d][%s]", ret, mDot::getReturnCodeString(ret).c_str());
mfiore 0:a151a6350d7f 233 } else {
mfiore 2:ffac7b141b72 234 logInfo("successfully sent data to gateway");
mfiore 0:a151a6350d7f 235 }
mfiore 0:a151a6350d7f 236 }