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

CommandTerminal/CmdTxDataRate.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 #include "CmdTxDataRate.h"
Mike Fiore 7:a31236c2e75c 19 #include "MTSText.h"
Mike Fiore 7:a31236c2e75c 20 #include "MTSLog.h"
Mike Fiore 1:71125aa00e33 21
Mike Fiore 7:a31236c2e75c 22 CmdTxDataRate::CmdTxDataRate(mDot* dot, mts::MTSSerial& serial)
Mike Fiore 7:a31236c2e75c 23 :
Mike Fiore 7:a31236c2e75c 24 Command(dot, "Tx Data Rate", "AT+TXDR", "Set the Tx data rate for all channels"),
Mike Fiore 7:a31236c2e75c 25 _serial(serial)
Mike Fiore 1:71125aa00e33 26 {
Mike Fiore 1:71125aa00e33 27 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 1:71125aa00e33 28
Mike Fiore 7:a31236c2e75c 29 if (_dot->getFrequencyBand() == mDot::FB_EU868)
Mike Fiore 7:a31236c2e75c 30 _usage = "(7-12|DR0-DR7)";
Mike Fiore 1:71125aa00e33 31 else
Mike Fiore 7:a31236c2e75c 32 _usage = "(7-10|DR0-DR4|DR8-DR13)";
Mike Fiore 7:a31236c2e75c 33
Mike Fiore 1:71125aa00e33 34 _queryable = true;
Mike Fiore 1:71125aa00e33 35 }
Mike Fiore 1:71125aa00e33 36
Mike Fiore 7:a31236c2e75c 37 uint32_t CmdTxDataRate::action(std::vector<std::string> args) {
Mike Fiore 1:71125aa00e33 38 if (args.size() == 1)
Mike Fiore 7:a31236c2e75c 39 {
Mike Fiore 1:71125aa00e33 40 if (_dot->getVerbose())
Mike Fiore 1:71125aa00e33 41 _serial.writef("Tx Data Rate: ");
Mike Fiore 1:71125aa00e33 42
Mike Fiore 7:a31236c2e75c 43 _serial.writef("DR%d - %s\r\n", _dot->getTxDataRate(), _dot->getDateRateDetails(_dot->getTxDataRate()).c_str());
Mike Fiore 7:a31236c2e75c 44 } else if (args.size() == 2) {
Mike Fiore 7:a31236c2e75c 45 std::string dr = mts::Text::toUpper(args[1]);
Mike Fiore 1:71125aa00e33 46 int32_t code;
Mike Fiore 7:a31236c2e75c 47 int datarate = -1;
Mike Fiore 1:71125aa00e33 48 uint8_t i;
Mike Fiore 1:71125aa00e33 49
Mike Fiore 7:a31236c2e75c 50 int res = sscanf(dr.c_str(), "%d", &datarate);
Mike Fiore 7:a31236c2e75c 51
Mike Fiore 7:a31236c2e75c 52 if (res == 0) {
Mike Fiore 7:a31236c2e75c 53 for (i = 0; i < 24; i++) {
Mike Fiore 7:a31236c2e75c 54 if (mDot::DataRateStr(i).find(dr) != std::string::npos) {
Mike Fiore 7:a31236c2e75c 55 datarate = i;
Mike Fiore 7:a31236c2e75c 56 break;
Mike Fiore 7:a31236c2e75c 57 }
Mike Fiore 7:a31236c2e75c 58 }
Mike Fiore 7:a31236c2e75c 59 } else {
Mike Fiore 7:a31236c2e75c 60 if (datarate > 6) {
Mike Fiore 7:a31236c2e75c 61 // Convert SF to DR
Mike Fiore 7:a31236c2e75c 62 if (_dot->getFrequencyBand() == mDot::FB_US915 || _dot->getFrequencyBand() == mDot::FB_AU915 ) {
Mike Fiore 7:a31236c2e75c 63 datarate = 10 - datarate;
Mike Fiore 7:a31236c2e75c 64 } else {
Mike Fiore 7:a31236c2e75c 65 datarate = 12 - datarate;
Mike Fiore 7:a31236c2e75c 66 }
Mike Fiore 1:71125aa00e33 67 }
Mike Fiore 1:71125aa00e33 68 }
Mike Fiore 1:71125aa00e33 69
Mike Fiore 7:a31236c2e75c 70 if ((code = _dot->setTxDataRate(datarate)) != mDot::MDOT_OK) {
Mike Fiore 7:a31236c2e75c 71 setErrorMessage(_dot->getLastError());
Mike Fiore 1:71125aa00e33 72 return 1;
Mike Fiore 1:71125aa00e33 73 }
Mike Fiore 1:71125aa00e33 74 }
Mike Fiore 1:71125aa00e33 75
Mike Fiore 1:71125aa00e33 76 return 0;
Mike Fiore 1:71125aa00e33 77 }
Mike Fiore 1:71125aa00e33 78
Mike Fiore 7:a31236c2e75c 79 bool CmdTxDataRate::verify(std::vector<std::string> args) {
Mike Fiore 1:71125aa00e33 80 if (args.size() == 1)
Mike Fiore 1:71125aa00e33 81 return true;
Mike Fiore 1:71125aa00e33 82
Mike Fiore 7:a31236c2e75c 83 if (args.size() == 2) {
Mike Fiore 7:a31236c2e75c 84 std::string dr = mts::Text::toUpper(args[1]);
Mike Fiore 7:a31236c2e75c 85
Mike Fiore 1:71125aa00e33 86 uint8_t i;
Mike Fiore 1:71125aa00e33 87 int datarate = -1;
Mike Fiore 7:a31236c2e75c 88
Mike Fiore 7:a31236c2e75c 89 int res = sscanf(dr.c_str(), "%d", &datarate);
Mike Fiore 7:a31236c2e75c 90
Mike Fiore 7:a31236c2e75c 91 if (res == 0) {
Mike Fiore 7:a31236c2e75c 92 for (i = 0; i < 24; i++) {
Mike Fiore 7:a31236c2e75c 93
Mike Fiore 7:a31236c2e75c 94 if (mDot::DataRateStr(i).find(dr) != std::string::npos) {
Mike Fiore 7:a31236c2e75c 95 uint8_t _dr = i;
Mike Fiore 7:a31236c2e75c 96
Mike Fiore 7:a31236c2e75c 97 if (_dr > 15) {
Mike Fiore 7:a31236c2e75c 98 _dr = 12 + (mDot::SF_12 - _dr);
Mike Fiore 7:a31236c2e75c 99
Mike Fiore 7:a31236c2e75c 100 if (_dot->getFrequencyBand() == mDot::FB_EU868) {
Mike Fiore 7:a31236c2e75c 101 if (_dr == mDot::SF_7H) {
Mike Fiore 7:a31236c2e75c 102 _dr = mDot::DR6;
Mike Fiore 7:a31236c2e75c 103 } else if (_dr == mDot::SF_FSK) {
Mike Fiore 7:a31236c2e75c 104 _dr = mDot::DR7;
Mike Fiore 7:a31236c2e75c 105 } else {
Mike Fiore 7:a31236c2e75c 106 _dr = 12 - _dr;
Mike Fiore 7:a31236c2e75c 107 }
Mike Fiore 7:a31236c2e75c 108 } else {
Mike Fiore 7:a31236c2e75c 109
Mike Fiore 7:a31236c2e75c 110 _dr = 10 - _dr;
Mike Fiore 7:a31236c2e75c 111 }
Mike Fiore 7:a31236c2e75c 112 }
Mike Fiore 7:a31236c2e75c 113
Mike Fiore 7:a31236c2e75c 114 datarate = _dr;
Mike Fiore 7:a31236c2e75c 115 break;
Mike Fiore 7:a31236c2e75c 116 }
Mike Fiore 7:a31236c2e75c 117 }
Mike Fiore 7:a31236c2e75c 118 } else {
Mike Fiore 7:a31236c2e75c 119 if ((_dot->getFrequencyBand() == mDot::FB_US915 || _dot->getFrequencyBand() == mDot::FB_AU915) && datarate > 10) {
Mike Fiore 7:a31236c2e75c 120 datarate = -1;
Mike Fiore 7:a31236c2e75c 121 } else if (_dot->getFrequencyBand() == mDot::FB_EU868 && datarate > 12) {
Mike Fiore 7:a31236c2e75c 122 datarate = -1;
Mike Fiore 7:a31236c2e75c 123 } else if (datarate > 6) {
Mike Fiore 7:a31236c2e75c 124 // Convert SF to DR
Mike Fiore 7:a31236c2e75c 125 if (_dot->getFrequencyBand() == mDot::FB_US915 || _dot->getFrequencyBand() == mDot::FB_AU915 ) {
Mike Fiore 7:a31236c2e75c 126 datarate = 10 - datarate;
Mike Fiore 7:a31236c2e75c 127 } else {
Mike Fiore 7:a31236c2e75c 128 datarate = 12 - datarate;
Mike Fiore 7:a31236c2e75c 129 }
Mike Fiore 1:71125aa00e33 130 }
Mike Fiore 1:71125aa00e33 131 }
Mike Fiore 1:71125aa00e33 132
Mike Fiore 7:a31236c2e75c 133 if (_dot->getFrequencyBand() == mDot::FB_US915 || _dot->getFrequencyBand() == mDot::FB_AU915 ) {
Mike Fiore 7:a31236c2e75c 134 // DR8-13 used for P2P modes
Mike Fiore 7:a31236c2e75c 135 if (datarate < 0 || datarate > 13 || (datarate >= 5 && datarate <= 7)) {
Mike Fiore 7:a31236c2e75c 136 setErrorMessage("Invalid data rate, expects (7-10|DR0-DR4|DR8-DR13)");
Mike Fiore 7:a31236c2e75c 137 return false;
Mike Fiore 7:a31236c2e75c 138 }
Mike Fiore 7:a31236c2e75c 139 } else {
Mike Fiore 7:a31236c2e75c 140 if (datarate < 0 || datarate > 7) {
Mike Fiore 7:a31236c2e75c 141 setErrorMessage("Invalid data rate, expects (7-12|DR0-DR7)");
Mike Fiore 1:71125aa00e33 142 return false;
Mike Fiore 1:71125aa00e33 143 }
Mike Fiore 1:71125aa00e33 144 }
Mike Fiore 1:71125aa00e33 145
Mike Fiore 1:71125aa00e33 146 return true;
Mike Fiore 1:71125aa00e33 147 }
Mike Fiore 1:71125aa00e33 148
Mike Fiore 1:71125aa00e33 149 setErrorMessage("Invalid arguments");
Mike Fiore 1:71125aa00e33 150 return false;
Mike Fiore 1:71125aa00e33 151 }