MultiTech / Mbed OS MTDOT-BOX-EVB-Factory-Firmware

Factory firmware for the MultiTech Dotbox (MTDOT-BOX) and EVB (MTDOT-EVB) products.

Dependencies:   NCP5623B GpsParser ISL29011 libmDot-mbed5 MTS-Serial MMA845x DOGS102 MPL3115A2

MTDOT-BOX/EVB Firmware Description

This Firmware is what ships on DotBox and EVB devices. It is intended to be used as a proof of concept and site survey tool for planning LoRa deployments. The firmware provides a number of different modes of operation:

  • Configuration - Use AT commands to configure network credentials, TX power, TX data rate, view the survey data file, etc.
  • Survey Single - Test network connectivity at current location at a specific TX power and TX data rate. Uplink information, downlink information, and GPS information are saved to the survey data file and can also be sent to the gateway.
  • Survey Sweep - Test network connectivity at current location across a range of TX powers and TX data rates. Uplink information, downlink information, and GPS information for each survey in the sweep are saved to the survey data file and can also be sent to the gateway.
  • LoRa Demo - Gather data from onboard sensors and display it on the screen in real time. Send packets containing sensor data to the gateway either on an interval or when triggered by the user. GPS data is not transmitted.
  • Survey GPS - Gather sensor and GPS data and transmit it to the gateway either on an interval or when triggered by the user. Add padding to packets, switch frequency sub bands, TX power, TX data rate, and more all without exiting Survey GPS Mode.
  • View Data - View the survey data file on the screen one survey at a time.

Additional documentation and information for the MTDOT-BOX/EVB Factory Firmware can be found here.


Dot Libraries

Dot Library Limitations

The commit messages in libmDot-mbed5 and libmDot-dev-mbed5 specify the version of the Dot library the commit contains and the version of mbed-os it was compiled against. We recommend building your application with the version of mbed-os specified in the commit message of the version of the Dot library you're using. This will ensure that you don't run into any runtime issues caused by differences in the mbed-os versions.

Development library for mDot.

[Repository '/teams/MultiTech/code/libmDot-dev-mbed5/' not found]

Stable library for mDot.

Import librarylibmDot-mbed5

Stable version of the mDot library for mbed 5. This version of the library is suitable for deployment scenarios. See lastest commit message for version of mbed-os library that has been tested against.

Last commit 25 Mar 2020 by MultiTech

Mode/ModeDemo.cpp@7:a31236c2e75c, 2016-11-04 (annotated)

Committer:
Mike Fiore
Date:
Fri Nov 04 17:27:05 2016 -0500
Revision:
7:a31236c2e75c
Parent:
1:71125aa00e33
Child:
12:05435282f899
update from git revision 2.1.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:71125aa00e33 1 /* Copyright (c) <2016> <MultiTech Systems>, MIT License
Mike Fiore 1:71125aa00e33 2 *
Mike Fiore 1:71125aa00e33 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Mike Fiore 1:71125aa00e33 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Mike Fiore 1:71125aa00e33 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Mike Fiore 1:71125aa00e33 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Mike Fiore 1:71125aa00e33 7 * furnished to do so, subject to the following conditions:
Mike Fiore 1:71125aa00e33 8 *
Mike Fiore 1:71125aa00e33 9 * The above copyright notice and this permission notice shall be included in all copies or
Mike Fiore 1:71125aa00e33 10 * substantial portions of the Software.
Mike Fiore 1:71125aa00e33 11 *
Mike Fiore 1:71125aa00e33 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Mike Fiore 1:71125aa00e33 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Mike Fiore 1:71125aa00e33 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Mike Fiore 1:71125aa00e33 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Mike Fiore 1:71125aa00e33 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Mike Fiore 1:71125aa00e33 17 */
Mike Fiore 1:71125aa00e33 18
Mike Fiore 1:71125aa00e33 19 #include "ModeDemo.h"
Mike Fiore 1:71125aa00e33 20 #include "MTSLog.h"
Mike Fiore 1:71125aa00e33 21
Mike Fiore 1:71125aa00e33 22 // 10 s, 30 s, 1 min, 5 min, 10 min, 15 min, 30 min 1 hour
Mike Fiore 1:71125aa00e33 23 const uint32_t ModeDemo::_intervals[] = { 10, 30, 60, 5 * 60, 10 * 60, 15 * 60, 30 * 60 };
Mike Fiore 1:71125aa00e33 24
Mike Fiore 1:71125aa00e33 25 ModeDemo::ModeDemo(DOGS102* lcd, ButtonHandler* buttons, mDot* dot, LoRaHandler* lora, GPSPARSER* gps, SensorHandler* sensors)
Mike Fiore 1:71125aa00e33 26 : Mode(lcd, buttons, dot, lora, gps, sensors),
Mike Fiore 1:71125aa00e33 27 _help(lcd),
Mike Fiore 1:71125aa00e33 28 _sam(lcd),
Mike Fiore 1:71125aa00e33 29 _interval(0)
Mike Fiore 1:71125aa00e33 30 {}
Mike Fiore 1:71125aa00e33 31
Mike Fiore 1:71125aa00e33 32 ModeDemo::~ModeDemo() {}
Mike Fiore 1:71125aa00e33 33
Mike Fiore 1:71125aa00e33 34 bool ModeDemo::start() {
Mike Fiore 1:71125aa00e33 35 bool send = false;
Mike Fiore 1:71125aa00e33 36 bool no_channel = false;
Mike Fiore 1:71125aa00e33 37
Mike Fiore 1:71125aa00e33 38 // clear any stale signals
Mike Fiore 1:71125aa00e33 39 osSignalClear(_main_id, buttonSignal | loraSignal);
Mike Fiore 1:71125aa00e33 40
Mike Fiore 1:71125aa00e33 41 _initial_data_rate = _dot->getTxDataRate();
Mike Fiore 1:71125aa00e33 42
Mike Fiore 1:71125aa00e33 43 // use configured data rate and power if possible
Mike Fiore 7:a31236c2e75c 44 if ((_band == mDot::FB_US915 || _band == mDot::FB_AU915) && (_initial_data_rate == mDot::DR0 || _initial_data_rate == mDot::SF_10)) {
Mike Fiore 7:a31236c2e75c 45 if(_initial_data_rate == mDot::DR0){
Mike Fiore 7:a31236c2e75c 46 logInfo("using DR1 instead of DR0 - DR0 max packet size is too small for data");
Mike Fiore 7:a31236c2e75c 47 _dot->setTxDataRate(mDot::DR1);
Mike Fiore 7:a31236c2e75c 48 }else{
Mike Fiore 7:a31236c2e75c 49 logInfo("using SF_9 instead of SF_10 - SF_10 max packet size is too small for data");
Mike Fiore 7:a31236c2e75c 50 _dot->setTxDataRate(mDot::SF_9);
Mike Fiore 7:a31236c2e75c 51 }
Mike Fiore 1:71125aa00e33 52 }
Mike Fiore 1:71125aa00e33 53
Mike Fiore 1:71125aa00e33 54 _state = show_help;
Mike Fiore 1:71125aa00e33 55 displayHelp();
Mike Fiore 1:71125aa00e33 56
Mike Fiore 1:71125aa00e33 57 while (true) {
Mike Fiore 1:71125aa00e33 58 osEvent e = Thread::signal_wait(0, 250);
Mike Fiore 1:71125aa00e33 59 if (e.status == osEventSignal) {
Mike Fiore 1:71125aa00e33 60 if (e.value.signals & buttonSignal) {
Mike Fiore 1:71125aa00e33 61 _be = _buttons->getButtonEvent();
Mike Fiore 1:71125aa00e33 62
Mike Fiore 1:71125aa00e33 63 switch (_be) {
Mike Fiore 1:71125aa00e33 64 case ButtonHandler::sw1_press:
Mike Fiore 1:71125aa00e33 65 switch (_state) {
Mike Fiore 1:71125aa00e33 66 case show_help:
Mike Fiore 1:71125aa00e33 67 _state = sampling;
Mike Fiore 1:71125aa00e33 68 _mode = trigger;
Mike Fiore 1:71125aa00e33 69 _sam.display();
Mike Fiore 1:71125aa00e33 70 _sam.updateSw1(" Send");
Mike Fiore 1:71125aa00e33 71 _sam.updateSw2("Back");
Mike Fiore 1:71125aa00e33 72 break;
Mike Fiore 1:71125aa00e33 73 case sampling:
Mike Fiore 1:71125aa00e33 74 if (_mode == trigger) {
Mike Fiore 1:71125aa00e33 75 if (_dot->getNextTxMs() > 0)
Mike Fiore 1:71125aa00e33 76 no_channel = true;
Mike Fiore 1:71125aa00e33 77 else
Mike Fiore 1:71125aa00e33 78 send = true;
Mike Fiore 1:71125aa00e33 79 } else {
Mike Fiore 1:71125aa00e33 80 _interval = (_interval + 1) % (sizeof(_intervals) / sizeof(uint32_t));
Mike Fiore 1:71125aa00e33 81 _sam.updateInterval(_intervals[_interval]);
Mike Fiore 1:71125aa00e33 82 }
Mike Fiore 1:71125aa00e33 83 break;
Mike Fiore 1:71125aa00e33 84 }
Mike Fiore 1:71125aa00e33 85 break;
Mike Fiore 1:71125aa00e33 86
Mike Fiore 1:71125aa00e33 87 case ButtonHandler::sw2_press:
Mike Fiore 1:71125aa00e33 88 switch (_state) {
Mike Fiore 1:71125aa00e33 89 case show_help:
Mike Fiore 1:71125aa00e33 90 _state = sampling;
Mike Fiore 1:71125aa00e33 91 _mode = interval;
Mike Fiore 1:71125aa00e33 92 _send_timer.start();
Mike Fiore 1:71125aa00e33 93 _sam.display();
Mike Fiore 1:71125aa00e33 94 _sam.updateSw1("Interval");
Mike Fiore 1:71125aa00e33 95 _sam.updateSw2("Back");
Mike Fiore 1:71125aa00e33 96 _sam.updateInterval(_intervals[_interval]);
Mike Fiore 1:71125aa00e33 97 break;
Mike Fiore 1:71125aa00e33 98 case sampling:
Mike Fiore 1:71125aa00e33 99 no_channel = false;
Mike Fiore 1:71125aa00e33 100 send = false;
Mike Fiore 1:71125aa00e33 101 _send_timer.stop();
Mike Fiore 1:71125aa00e33 102 _send_timer.reset();
Mike Fiore 1:71125aa00e33 103 _state = show_help;
Mike Fiore 1:71125aa00e33 104 displayHelp();
Mike Fiore 1:71125aa00e33 105 break;
Mike Fiore 1:71125aa00e33 106 }
Mike Fiore 1:71125aa00e33 107 break;
Mike Fiore 1:71125aa00e33 108 case ButtonHandler::sw1_hold:
Mike Fiore 1:71125aa00e33 109 _send_timer.stop();
Mike Fiore 1:71125aa00e33 110 _send_timer.reset();
Mike Fiore 7:a31236c2e75c 111 if (_band == mDot::FB_US915 || _band == mDot::FB_AU915) {
Mike Fiore 1:71125aa00e33 112 _dot->setTxDataRate(_initial_data_rate);
Mike Fiore 7:a31236c2e75c 113 }
Mike Fiore 1:71125aa00e33 114 return true;
Mike Fiore 1:71125aa00e33 115 }
Mike Fiore 1:71125aa00e33 116 }
Mike Fiore 1:71125aa00e33 117 if (e.value.signals & loraSignal) {
Mike Fiore 1:71125aa00e33 118 _ls = _lora->getStatus();
Mike Fiore 1:71125aa00e33 119 switch (_ls) {
Mike Fiore 1:71125aa00e33 120 case LoRaHandler::send_success:
Mike Fiore 1:71125aa00e33 121 switch (_state) {
Mike Fiore 1:71125aa00e33 122 case sampling:
Mike Fiore 1:71125aa00e33 123 if (_mode == trigger) {
Mike Fiore 1:71125aa00e33 124 _sam.updateSw1(" Send");
Mike Fiore 1:71125aa00e33 125 _sam.updateInfo(" ");
Mike Fiore 1:71125aa00e33 126 } else {
Mike Fiore 1:71125aa00e33 127 _sam.updateSw1("Interval");
Mike Fiore 1:71125aa00e33 128 _sam.updateInterval(_intervals[_interval]);
Mike Fiore 1:71125aa00e33 129 }
Mike Fiore 1:71125aa00e33 130 _sam.updateSw2("Back");
Mike Fiore 1:71125aa00e33 131 break;
Mike Fiore 1:71125aa00e33 132 }
Mike Fiore 1:71125aa00e33 133 break;
Mike Fiore 1:71125aa00e33 134
Mike Fiore 1:71125aa00e33 135 case LoRaHandler::send_failure:
Mike Fiore 1:71125aa00e33 136 switch (_state) {
Mike Fiore 1:71125aa00e33 137 case sampling:
Mike Fiore 1:71125aa00e33 138 if (_mode == trigger) {
Mike Fiore 1:71125aa00e33 139 _sam.updateSw1(" Send");
Mike Fiore 1:71125aa00e33 140 _sam.updateInfo(" ");
Mike Fiore 1:71125aa00e33 141 } else {
Mike Fiore 1:71125aa00e33 142 _sam.updateSw1("Interval");
Mike Fiore 1:71125aa00e33 143 _sam.updateInterval(_intervals[_interval]);
Mike Fiore 1:71125aa00e33 144 }
Mike Fiore 1:71125aa00e33 145 _sam.updateSw2("Back");
Mike Fiore 1:71125aa00e33 146 break;
Mike Fiore 1:71125aa00e33 147 }
Mike Fiore 1:71125aa00e33 148 break;
Mike Fiore 1:71125aa00e33 149 }
Mike Fiore 1:71125aa00e33 150 }
Mike Fiore 1:71125aa00e33 151 }
Mike Fiore 1:71125aa00e33 152
Mike Fiore 1:71125aa00e33 153 if (_send_timer.read_ms() > _intervals[_interval] * 1000) {
Mike Fiore 1:71125aa00e33 154 _send_timer.reset();
Mike Fiore 1:71125aa00e33 155 if (_dot->getNextTxMs() > 0)
Mike Fiore 1:71125aa00e33 156 no_channel = true;
Mike Fiore 1:71125aa00e33 157 else
Mike Fiore 1:71125aa00e33 158 send = true;
Mike Fiore 1:71125aa00e33 159 }
Mike Fiore 1:71125aa00e33 160 if (no_channel) {
Mike Fiore 1:71125aa00e33 161 uint32_t t = _dot->getNextTxMs();
Mike Fiore 1:71125aa00e33 162 if (t > 0) {
Mike Fiore 1:71125aa00e33 163 logInfo("next tx %lu ms", t);
Mike Fiore 1:71125aa00e33 164 _sam.updateCountdown(t / 1000);
Mike Fiore 1:71125aa00e33 165 } else {
Mike Fiore 1:71125aa00e33 166 no_channel = false;
Mike Fiore 1:71125aa00e33 167 send = true;
Mike Fiore 1:71125aa00e33 168 }
Mike Fiore 1:71125aa00e33 169 }
Mike Fiore 1:71125aa00e33 170 if (send) {
Mike Fiore 1:71125aa00e33 171 std::vector<uint8_t> s_data = formatSensorData(_data);
Mike Fiore 1:71125aa00e33 172 logInfo("sending data %s %d", _dot->DataRateStr(_dot->getTxDataRate()).c_str(), _dot->getTxPower());
Mike Fiore 1:71125aa00e33 173 _sam.updateInfo("Sending...");
Mike Fiore 1:71125aa00e33 174 _sam.updateSw1(" ");
Mike Fiore 1:71125aa00e33 175 _sam.updateSw2(" ");
Mike Fiore 1:71125aa00e33 176 send = false;
Mike Fiore 1:71125aa00e33 177 // we don't care if the server actually gets this packet or not
Mike Fiore 1:71125aa00e33 178 // we won't retry anyway
Mike Fiore 1:71125aa00e33 179 _dot->setAck(0);
Mike Fiore 1:71125aa00e33 180 _dot->setTxWait(false);
Mike Fiore 1:71125aa00e33 181 _lora->send(s_data);
Mike Fiore 1:71125aa00e33 182 osDelay(500);
Mike Fiore 1:71125aa00e33 183 }
Mike Fiore 1:71125aa00e33 184 if(_state != show_help){
Mike Fiore 1:71125aa00e33 185 updateSensorData(_data);
Mike Fiore 1:71125aa00e33 186 _sam.updateAccelerationX(_data.accel_data._x);
Mike Fiore 1:71125aa00e33 187 _sam.updateAccelerationY(_data.accel_data._y);
Mike Fiore 1:71125aa00e33 188 _sam.updateAccelerationZ(_data.accel_data._z);
Mike Fiore 1:71125aa00e33 189 _sam.updatePressure(_data.pressure);
Mike Fiore 1:71125aa00e33 190 _sam.updateAltitude(_data.altitude);
Mike Fiore 1:71125aa00e33 191 _sam.updateTemperature(_data.temperature);
Mike Fiore 1:71125aa00e33 192 _sam.updateLight(_data.light);
Mike Fiore 1:71125aa00e33 193 }
Mike Fiore 1:71125aa00e33 194 }
Mike Fiore 1:71125aa00e33 195 }
Mike Fiore 1:71125aa00e33 196
Mike Fiore 1:71125aa00e33 197 void ModeDemo::displayHelp() {
Mike Fiore 1:71125aa00e33 198 _help.display();
Mike Fiore 1:71125aa00e33 199 _help.updateMode("LoRa Demo");
Mike Fiore 1:71125aa00e33 200 _help.updateDescription("Select TX Method");
Mike Fiore 1:71125aa00e33 201 _help.updateSw1(" Trigger");
Mike Fiore 1:71125aa00e33 202 _help.updateSw2("Interval");
Mike Fiore 1:71125aa00e33 203 }
Mike Fiore 1:71125aa00e33 204