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/CmdNetworkId.cpp@1:71125aa00e33, 2016-02-04 (annotated)

Committer:
Mike Fiore
Date:
Thu Feb 04 12:36:36 2016 -0600
Revision:
1:71125aa00e33
add rest of source - version 2.0.0

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 "CmdNetworkId.h"
Mike Fiore 1:71125aa00e33 20
Mike Fiore 1:71125aa00e33 21 CmdNetworkId::CmdNetworkId(mDot* dot, mts::MTSSerial& serial) :
Mike Fiore 1:71125aa00e33 22 Command(dot, "Network ID", "AT+NI", "Configured Network EUI/Name (App EUI in LoraMac) AT+NI=0,hex AT+NI=1,network_name (Net ID = crc64(network_name)) (8 bytes)"),
Mike Fiore 1:71125aa00e33 23 _serial(serial)
Mike Fiore 1:71125aa00e33 24 {
Mike Fiore 1:71125aa00e33 25 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 1:71125aa00e33 26 _usage = "(0,(hex:8)),(1,(string:128))";
Mike Fiore 1:71125aa00e33 27 _queryable = true;
Mike Fiore 1:71125aa00e33 28 }
Mike Fiore 1:71125aa00e33 29
Mike Fiore 1:71125aa00e33 30 uint32_t CmdNetworkId::action(std::vector<std::string> args)
Mike Fiore 1:71125aa00e33 31 {
Mike Fiore 1:71125aa00e33 32 if (args.size() == 1)
Mike Fiore 1:71125aa00e33 33 {
Mike Fiore 1:71125aa00e33 34 if (_dot->getVerbose())
Mike Fiore 1:71125aa00e33 35 _serial.writef("Network ID: ");
Mike Fiore 1:71125aa00e33 36
Mike Fiore 1:71125aa00e33 37 _serial.writef("%s\r\n", mts::Text::bin2hexString(_dot->getNetworkId(), ":").c_str());
Mike Fiore 1:71125aa00e33 38
Mike Fiore 1:71125aa00e33 39 if (!_dot->getNetworkName().empty())
Mike Fiore 1:71125aa00e33 40 _serial.writef("Passphrase: '%s'\r\n", _dot->getNetworkName().c_str());
Mike Fiore 1:71125aa00e33 41 }
Mike Fiore 1:71125aa00e33 42 else
Mike Fiore 1:71125aa00e33 43 {
Mike Fiore 1:71125aa00e33 44 int32_t code;
Mike Fiore 1:71125aa00e33 45
Mike Fiore 1:71125aa00e33 46 if (args[1].find("1") == 0 && args[1].size() == 1)
Mike Fiore 1:71125aa00e33 47 {
Mike Fiore 1:71125aa00e33 48 std::string text;
Mike Fiore 1:71125aa00e33 49 if (args.size() > 3)
Mike Fiore 1:71125aa00e33 50 {
Mike Fiore 1:71125aa00e33 51 // passphrase was split on commas
Mike Fiore 1:71125aa00e33 52 for (size_t i = 2; i < args.size(); i++)
Mike Fiore 1:71125aa00e33 53 {
Mike Fiore 1:71125aa00e33 54 text.append(args[i]);
Mike Fiore 1:71125aa00e33 55 if (i < args.size() - 1)
Mike Fiore 1:71125aa00e33 56 text.append(",");
Mike Fiore 1:71125aa00e33 57 }
Mike Fiore 1:71125aa00e33 58 }
Mike Fiore 1:71125aa00e33 59 else
Mike Fiore 1:71125aa00e33 60 {
Mike Fiore 1:71125aa00e33 61 text = args[2];
Mike Fiore 1:71125aa00e33 62 }
Mike Fiore 1:71125aa00e33 63
Mike Fiore 1:71125aa00e33 64 if ((code = _dot->setNetworkName(text)) == mDot::MDOT_OK)
Mike Fiore 1:71125aa00e33 65 {
Mike Fiore 1:71125aa00e33 66 _serial.writef("Set Network Name: ");
Mike Fiore 1:71125aa00e33 67 _serial.writef("%s\r\n", text.c_str());
Mike Fiore 1:71125aa00e33 68 }
Mike Fiore 1:71125aa00e33 69 else
Mike Fiore 1:71125aa00e33 70 {
Mike Fiore 1:71125aa00e33 71 std::string error = mDot::getReturnCodeString(code) + " - " + _dot->getLastError();
Mike Fiore 1:71125aa00e33 72 setErrorMessage(error);
Mike Fiore 1:71125aa00e33 73 return 1;
Mike Fiore 1:71125aa00e33 74 }
Mike Fiore 1:71125aa00e33 75
Mike Fiore 1:71125aa00e33 76 }
Mike Fiore 1:71125aa00e33 77 else
Mike Fiore 1:71125aa00e33 78 {
Mike Fiore 1:71125aa00e33 79 std::vector<uint8_t> NewKey;
Mike Fiore 1:71125aa00e33 80 readByteArray(args[2], NewKey, EUI_LENGTH);
Mike Fiore 1:71125aa00e33 81 if ((code = _dot->setNetworkId(NewKey)) == mDot::MDOT_OK)
Mike Fiore 1:71125aa00e33 82 {
Mike Fiore 1:71125aa00e33 83 _serial.writef("Set Network ID: ");
Mike Fiore 1:71125aa00e33 84 _serial.writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
Mike Fiore 1:71125aa00e33 85 }
Mike Fiore 1:71125aa00e33 86 else
Mike Fiore 1:71125aa00e33 87 {
Mike Fiore 1:71125aa00e33 88 std::string error = mDot::getReturnCodeString(code) + " - " + _dot->getLastError();
Mike Fiore 1:71125aa00e33 89 setErrorMessage(error);
Mike Fiore 1:71125aa00e33 90 return 1;
Mike Fiore 1:71125aa00e33 91 }
Mike Fiore 1:71125aa00e33 92 }
Mike Fiore 1:71125aa00e33 93 }
Mike Fiore 1:71125aa00e33 94
Mike Fiore 1:71125aa00e33 95 return 0;
Mike Fiore 1:71125aa00e33 96 }
Mike Fiore 1:71125aa00e33 97
Mike Fiore 1:71125aa00e33 98 bool CmdNetworkId::verify(std::vector<std::string> args)
Mike Fiore 1:71125aa00e33 99 {
Mike Fiore 1:71125aa00e33 100 if (args.size() == 1)
Mike Fiore 1:71125aa00e33 101 return true;
Mike Fiore 1:71125aa00e33 102
Mike Fiore 1:71125aa00e33 103 if (args.size() == 3) {
Mike Fiore 1:71125aa00e33 104 if (args[1] != "0" && args[1] != "1") {
Mike Fiore 1:71125aa00e33 105 setErrorMessage("Invalid type, expects (0,1)");
Mike Fiore 1:71125aa00e33 106 return false;
Mike Fiore 1:71125aa00e33 107 }
Mike Fiore 1:71125aa00e33 108 if (args[1] == "0" && !isHexString(args[2], 8)) {
Mike Fiore 1:71125aa00e33 109 setErrorMessage("Invalid ID, expects (hex:8");
Mike Fiore 1:71125aa00e33 110 return false;
Mike Fiore 1:71125aa00e33 111 }
Mike Fiore 1:71125aa00e33 112
Mike Fiore 1:71125aa00e33 113 if (args[1] == "1" && args[2].size() < 8) {
Mike Fiore 1:71125aa00e33 114 setErrorMessage("Invalid name, expects minimum 8 characters");
Mike Fiore 1:71125aa00e33 115 return false;
Mike Fiore 1:71125aa00e33 116 }
Mike Fiore 1:71125aa00e33 117
Mike Fiore 1:71125aa00e33 118 if (args[1] == "1" && args[2].size() > 128) {
Mike Fiore 1:71125aa00e33 119 setErrorMessage("Invalid name, expects (string:128)");
Mike Fiore 1:71125aa00e33 120 return false;
Mike Fiore 1:71125aa00e33 121 }
Mike Fiore 1:71125aa00e33 122
Mike Fiore 1:71125aa00e33 123 return true;
Mike Fiore 1:71125aa00e33 124 }
Mike Fiore 1:71125aa00e33 125
Mike Fiore 1:71125aa00e33 126 setErrorMessage("Invalid arguments");
Mike Fiore 1:71125aa00e33 127 return false;
Mike Fiore 1:71125aa00e33 128 }