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

Committer:
jenkins@jenkinsdm1
Date:
Thu Mar 14 08:23:20 2019 -0500
Revision:
16:e76cec0eec43
Parent:
3:db75f686b8db 
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 "CmdGetSurveyDataFile.h"
Mike Fiore 1:71125aa00e33 20 #include "FileName.h"
Mike Fiore 1:71125aa00e33 21 #include "MTSLog.h"
Mike Fiore 1:71125aa00e33 22
Mike Fiore 1:71125aa00e33 23 CmdGetSurveyDataFile::CmdGetSurveyDataFile(mDot* dot, mts::MTSSerial& serial) :
Mike Fiore 1:71125aa00e33 24 Command(dot, "Get Survey Data File", "AT+GSDF", "Outputs the survey data file contents to the command port"), _serial(serial)
Mike Fiore 1:71125aa00e33 25 {
Mike Fiore 1:71125aa00e33 26 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 1:71125aa00e33 27 }
Mike Fiore 1:71125aa00e33 28
Mike Fiore 1:71125aa00e33 29 uint32_t CmdGetSurveyDataFile::action(std::vector<std::string> args)
Mike Fiore 1:71125aa00e33 30 {
Mike Fiore 1:71125aa00e33 31 mDot::mdot_file file;
Mike Fiore 1:71125aa00e33 32 int buf_size = 512;
Mike Fiore 1:71125aa00e33 33 char buf[buf_size];
Mike Fiore 3:db75f686b8db 34 int read = 0;
Mike Fiore 3:db75f686b8db 35 int read_size = 0;
Mike Fiore 1:71125aa00e33 36
Mike Fiore 1:71125aa00e33 37 file = _dot->openUserFile(file_name, mDot::FM_RDONLY);
Mike Fiore 1:71125aa00e33 38 if (file.fd < 0) {
Mike Fiore 1:71125aa00e33 39 setErrorMessage("Failed to open file");
Mike Fiore 1:71125aa00e33 40 return 1;
Mike Fiore 1:71125aa00e33 41 }
Mike Fiore 1:71125aa00e33 42
Mike Fiore 1:71125aa00e33 43 // print header line with column labels
Mike Fiore 1:71125aa00e33 44 _serial.writef("ID,Status,Lock,Lat,Long,Alt,Time,Gateways,Margin,RSSIdown,SNRdown,DataRate,Power\r\n");
Mike Fiore 1:71125aa00e33 45
Mike Fiore 1:71125aa00e33 46 while (read < file.size) {
Mike Fiore 1:71125aa00e33 47 read_size = (file.size - read) > buf_size ? buf_size : file.size - read;
Mike Fiore 1:71125aa00e33 48 int size = _dot->readUserFile(file, (void*)buf, read_size);
Mike Fiore 1:71125aa00e33 49 if (size < 0) {
Mike Fiore 1:71125aa00e33 50 setErrorMessage("Failed to read file");
Mike Fiore 1:71125aa00e33 51 _dot->closeUserFile(file);
Mike Fiore 1:71125aa00e33 52 return 1;
Mike Fiore 1:71125aa00e33 53 }
Mike Fiore 1:71125aa00e33 54
Mike Fiore 1:71125aa00e33 55 for (int i = 0; i < size; i++) {
Mike Fiore 1:71125aa00e33 56 if (buf[i] == '\n')
Mike Fiore 1:71125aa00e33 57 _serial.writef("\r\n");
Mike Fiore 1:71125aa00e33 58 else
Mike Fiore 1:71125aa00e33 59 _serial.writef("%c", buf[i]);
Mike Fiore 1:71125aa00e33 60 }
Mike Fiore 1:71125aa00e33 61
Mike Fiore 1:71125aa00e33 62 read += size;
Mike Fiore 1:71125aa00e33 63 }
Mike Fiore 1:71125aa00e33 64
Mike Fiore 1:71125aa00e33 65 _dot->closeUserFile(file);
Mike Fiore 1:71125aa00e33 66
Mike Fiore 1:71125aa00e33 67 return 0;
Mike Fiore 1:71125aa00e33 68 }