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/ModeJoin.cpp@16:e76cec0eec43, 2019-03-14 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Thu Mar 14 08:23:20 2019 -0500
Revision:
16:e76cec0eec43
Parent:
12:05435282f899 
dotbox-firmware revision 3.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 "ModeJoin.h"
Mike Fiore 1:71125aa00e33 20 #include "MTSLog.h"
Mike Fiore 1:71125aa00e33 21 #include "MTSText.h"
Mike Fiore 1:71125aa00e33 22
Mike Fiore 1:71125aa00e33 23 ModeJoin::ModeJoin(DOGS102* lcd, ButtonHandler* buttons, mDot* dot, LoRaHandler* lora, GPSPARSER* gps, SensorHandler* sensors)
Mike Fiore 1:71125aa00e33 24 : Mode(lcd, buttons, dot, lora, gps, sensors),
Mike Fiore 1:71125aa00e33 25 _join(lcd, _band),
Mike Fiore 1:71125aa00e33 26 _joined(false)
Mike Fiore 1:71125aa00e33 27 {}
Mike Fiore 1:71125aa00e33 28
Mike Fiore 1:71125aa00e33 29 ModeJoin::~ModeJoin() {}
Mike Fiore 1:71125aa00e33 30
Mike Fiore 1:71125aa00e33 31 bool ModeJoin::start() {
Mike Fiore 1:71125aa00e33 32 bool joining = false;
Mike Fiore 1:71125aa00e33 33
Mike Fiore 1:71125aa00e33 34 // clear any stale signals
Mike Fiore 1:71125aa00e33 35 osSignalClear(_main_id, buttonSignal | loraSignal);
Mike Fiore 1:71125aa00e33 36
jreiss 5:10ea08959743 37 if (_dot->getJoinMode() == mDot::MANUAL) {
jreiss 5:10ea08959743 38 // already joined
jreiss 5:10ea08959743 39 return true;
jreiss 5:10ea08959743 40 }
jreiss 5:10ea08959743 41
Mike Fiore 1:71125aa00e33 42 _initial_data_rate = _dot->getTxDataRate();
Mike Fiore 1:71125aa00e33 43 _initial_power = _dot->getTxPower();
Mike Fiore 1:71125aa00e33 44
Mike Fiore 7:a31236c2e75c 45 _data_rate = mDot::DR0;
Mike Fiore 1:71125aa00e33 46 _power = 20;
Mike Fiore 1:71125aa00e33 47 _joined = false;
Mike Fiore 1:71125aa00e33 48
Mike Fiore 1:71125aa00e33 49 display();
Mike Fiore 1:71125aa00e33 50
Mike Fiore 1:71125aa00e33 51 _dot->setTxDataRate(_data_rate);
Mike Fiore 1:71125aa00e33 52 _dot->setTxPower(_power);
Mike Fiore 1:71125aa00e33 53 _lora->resetJoinAttempts();
Mike Fiore 1:71125aa00e33 54
Mike Fiore 1:71125aa00e33 55 while (! _joined) {
Mike Fiore 1:71125aa00e33 56 _next_tx = _dot->getNextTxMs();
Mike Fiore 1:71125aa00e33 57 if (! joining && _next_tx > 0) {
Mike Fiore 1:71125aa00e33 58 logInfo("next tx %lu ms", _next_tx);
Mike Fiore 1:71125aa00e33 59 _join.updateStatus("Waiting...");
Mike Fiore 1:71125aa00e33 60 _join.updateCountdown(_next_tx / 1000);
Mike Fiore 1:71125aa00e33 61 } else if (! joining) {
Mike Fiore 1:71125aa00e33 62 logInfo("attempting to join");
Mike Fiore 1:71125aa00e33 63 joining = true;
Mike Fiore 1:71125aa00e33 64 display();
Mike Fiore 1:71125aa00e33 65 _lora->join();
Mike Fiore 1:71125aa00e33 66 }
Mike Fiore 1:71125aa00e33 67
Mike Fiore 1:71125aa00e33 68 osEvent e = Thread::signal_wait(0, 250);
Mike Fiore 1:71125aa00e33 69 if (e.status == osEventSignal) {
Mike Fiore 1:71125aa00e33 70 if (e.value.signals & buttonSignal) {
Mike Fiore 1:71125aa00e33 71 _be = _buttons->getButtonEvent();
Mike Fiore 1:71125aa00e33 72 switch (_be) {
Mike Fiore 1:71125aa00e33 73 case ButtonHandler::sw1_press:
Mike Fiore 1:71125aa00e33 74 _dot->setTxDataRate(_initial_data_rate);
Mike Fiore 1:71125aa00e33 75 _dot->setTxPower(_initial_power);
Mike Fiore 1:71125aa00e33 76 return false;
Mike Fiore 1:71125aa00e33 77 case ButtonHandler::sw2_press:
Mike Fiore 1:71125aa00e33 78 break;
Mike Fiore 1:71125aa00e33 79 case ButtonHandler::sw1_hold:
Mike Fiore 1:71125aa00e33 80 _dot->setTxDataRate(_initial_data_rate);
Mike Fiore 1:71125aa00e33 81 _dot->setTxPower(_initial_power);
Mike Fiore 1:71125aa00e33 82 return false;
Mike Fiore 1:71125aa00e33 83 }
Mike Fiore 1:71125aa00e33 84 }
Mike Fiore 1:71125aa00e33 85 if (e.value.signals & loraSignal) {
Mike Fiore 1:71125aa00e33 86 _ls = _lora->getStatus();
Mike Fiore 1:71125aa00e33 87 switch (_ls) {
Mike Fiore 1:71125aa00e33 88 case LoRaHandler::join_success:
Mike Fiore 1:71125aa00e33 89 _join.updateStatus("Join Success!");
Mike Fiore 1:71125aa00e33 90 _join.displayCancel(false);
Mike Fiore 1:71125aa00e33 91 logInfo("joined");
Mike Fiore 1:71125aa00e33 92 _joined = true;
Mike Fiore 1:71125aa00e33 93 osDelay(2000);
Mike Fiore 1:71125aa00e33 94 _dot->setTxDataRate(_initial_data_rate);
Mike Fiore 1:71125aa00e33 95 _dot->setTxPower(_initial_power);
Mike Fiore 1:71125aa00e33 96 return true;
Mike Fiore 1:71125aa00e33 97
Mike Fiore 1:71125aa00e33 98 case LoRaHandler::join_failure:
Mike Fiore 1:71125aa00e33 99 logInfo("failed to join");
Mike Fiore 1:71125aa00e33 100 joining = false;
Mike Fiore 1:71125aa00e33 101 break;
Mike Fiore 1:71125aa00e33 102 }
Mike Fiore 1:71125aa00e33 103 }
Mike Fiore 1:71125aa00e33 104 }
Mike Fiore 1:71125aa00e33 105 }
Mike Fiore 1:71125aa00e33 106
Mike Fiore 1:71125aa00e33 107 _dot->setTxDataRate(_initial_data_rate);
Mike Fiore 1:71125aa00e33 108 _dot->setTxPower(_initial_power);
Mike Fiore 1:71125aa00e33 109 return false;
Mike Fiore 1:71125aa00e33 110 }
Mike Fiore 1:71125aa00e33 111
Mike Fiore 1:71125aa00e33 112 void ModeJoin::display() {
Mike Fiore 1:71125aa00e33 113 _join.display();
Mike Fiore 1:71125aa00e33 114 _join.updateStatus("Joining...");
Mike Fiore 1:71125aa00e33 115 if (_dot->getJoinMode() == mDot::MANUAL) {
Mike Fiore 1:71125aa00e33 116 _join.updateId(mts::Text::bin2hexString(_dot->getNetworkId()));
Mike Fiore 1:71125aa00e33 117 _join.updateKey(mts::Text::bin2hexString(_dot->getNetworkKey()));
Mike Fiore 1:71125aa00e33 118 } else {
Mike Fiore 1:71125aa00e33 119 _join.updateId(_dot->getNetworkName());
Mike Fiore 1:71125aa00e33 120 _join.updateKey(_dot->getNetworkPassphrase());
Mike Fiore 1:71125aa00e33 121 }
jenkins@jenkinsdm1 12:05435282f899 122 if (lora::ChannelPlan::IsPlanFixed(_band)) {
Mike Fiore 1:71125aa00e33 123 _sub_band = _dot->getFrequencySubBand();
Mike Fiore 1:71125aa00e33 124 _join.updateFsb(_sub_band);
Mike Fiore 1:71125aa00e33 125 }
Mike Fiore 7:a31236c2e75c 126 _join.updateRate(_dot->getTxDataRate());
Mike Fiore 1:71125aa00e33 127 _join.updatePower(_power);
Mike Fiore 1:71125aa00e33 128 _join.updateAttempt(_lora->getJoinAttempts());
Mike Fiore 1:71125aa00e33 129 }