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

Layout/LayoutData.cpp@16:e76cec0eec43, 2019-03-14 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Thu Mar 14 08:23:20 2019 -0500
Revision:
16:e76cec0eec43
Parent:
7:a31236c2e75c 
dotbox-firmware revision 3.1.2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 7:a31236c2e75c 1 /* Copyright (c) <2016> <MultiTech Systems>, MIT License
Mike Fiore 7:a31236c2e75c 2 *
Mike Fiore 7:a31236c2e75c 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Mike Fiore 7:a31236c2e75c 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Mike Fiore 7:a31236c2e75c 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Mike Fiore 7:a31236c2e75c 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Mike Fiore 7:a31236c2e75c 7 * furnished to do so, subject to the following conditions:
Mike Fiore 7:a31236c2e75c 8 *
Mike Fiore 7:a31236c2e75c 9 * The above copyright notice and this permission notice shall be included in all copies or
Mike Fiore 7:a31236c2e75c 10 * substantial portions of the Software.
Mike Fiore 7:a31236c2e75c 11 *
Mike Fiore 7:a31236c2e75c 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Mike Fiore 7:a31236c2e75c 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Mike Fiore 7:a31236c2e75c 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Mike Fiore 7:a31236c2e75c 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Mike Fiore 7:a31236c2e75c 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Mike Fiore 7:a31236c2e75c 17 */
Mike Fiore 7:a31236c2e75c 18
Mike Fiore 7:a31236c2e75c 19 #include "LayoutData.h"
Mike Fiore 7:a31236c2e75c 20
Mike Fiore 7:a31236c2e75c 21 LayoutData::LayoutData(DOGS102* lcd)
Mike Fiore 7:a31236c2e75c 22 : Layout(lcd),
Mike Fiore 7:a31236c2e75c 23 _lDr(8, 0, "DR"),
Mike Fiore 7:a31236c2e75c 24 _lPwr(13, 0, "P"),
Mike Fiore 7:a31236c2e75c 25 _lUp(0, 1, "UP Mgn"),
Mike Fiore 7:a31236c2e75c 26 _lGw(10, 1, "Gw"),
Mike Fiore 7:a31236c2e75c 27 _lDown(0, 2, "DWN -"),
Mike Fiore 7:a31236c2e75c 28 _lSurveyFailed(0, 1, "Survey Failed"),
Mike Fiore 7:a31236c2e75c 29 _lDbm(9, 2, "dbm"),
Mike Fiore 7:a31236c2e75c 30 _lAlt(0, 6, "Alt"),
Mike Fiore 7:a31236c2e75c 31 _fId(0, 0, 5),
Mike Fiore 7:a31236c2e75c 32 _fDr(10, 0, 2),
Mike Fiore 7:a31236c2e75c 33 _fPwr(14, 0, 2),
Mike Fiore 7:a31236c2e75c 34 _fUpMargin(7, 1, 2),
Mike Fiore 7:a31236c2e75c 35 _fGw(13, 1, 2),
Mike Fiore 7:a31236c2e75c 36 _fRssiDown(5, 2, 3),
Mike Fiore 7:a31236c2e75c 37 _fSnrDown(13, 2, 4),
Mike Fiore 7:a31236c2e75c 38 _fGpsLat(0, 4, 17),
Mike Fiore 7:a31236c2e75c 39 _fGpsLong(0, 3, 17),
Mike Fiore 7:a31236c2e75c 40 _fGpsTime(0, 5, 17),
Mike Fiore 7:a31236c2e75c 41 _fAlt(4,6,13),
Mike Fiore 7:a31236c2e75c 42 _fSw1(12, 7, 4),
Mike Fiore 7:a31236c2e75c 43 _fSw2(0, 7, 4)
Mike Fiore 7:a31236c2e75c 44 {}
Mike Fiore 7:a31236c2e75c 45
Mike Fiore 7:a31236c2e75c 46 LayoutData::~LayoutData() {}
Mike Fiore 7:a31236c2e75c 47
Mike Fiore 7:a31236c2e75c 48 void LayoutData::display(){
Mike Fiore 7:a31236c2e75c 49 clear();
Mike Fiore 7:a31236c2e75c 50 startUpdate();
Mike Fiore 7:a31236c2e75c 51 writeLabel(_lDr);
Mike Fiore 7:a31236c2e75c 52 writeLabel(_lPwr);
Mike Fiore 7:a31236c2e75c 53 endUpdate();
Mike Fiore 7:a31236c2e75c 54 }
Mike Fiore 7:a31236c2e75c 55
Mike Fiore 7:a31236c2e75c 56 void LayoutData::noData(){
Mike Fiore 7:a31236c2e75c 57 clear();
Mike Fiore 7:a31236c2e75c 58 writeField(_fGpsLong, string(" No Survey Data"), true);
Mike Fiore 7:a31236c2e75c 59 }
Mike Fiore 7:a31236c2e75c 60
Mike Fiore 7:a31236c2e75c 61 void LayoutData::errorData(){
Mike Fiore 7:a31236c2e75c 62 clear();
Mike Fiore 7:a31236c2e75c 63 writeField(_fGpsLong, string(" Error opening,"), true);
Mike Fiore 7:a31236c2e75c 64 writeField(_fGpsLat, string("survey data file."), true);
Mike Fiore 7:a31236c2e75c 65 }
Mike Fiore 7:a31236c2e75c 66
Mike Fiore 7:a31236c2e75c 67 void LayoutData::updateSw1(string str){
Mike Fiore 7:a31236c2e75c 68 writeField(_fSw1, str, true);
Mike Fiore 7:a31236c2e75c 69 }
Mike Fiore 7:a31236c2e75c 70
Mike Fiore 7:a31236c2e75c 71 void LayoutData::updateSw2(string str){
Mike Fiore 7:a31236c2e75c 72 writeField(_fSw2, str, true);
Mike Fiore 7:a31236c2e75c 73 }
Mike Fiore 7:a31236c2e75c 74
Mike Fiore 7:a31236c2e75c 75 bool LayoutData::updateAll(singleLine& line){
Mike Fiore 7:a31236c2e75c 76 clear();
Mike Fiore 7:a31236c2e75c 77 startUpdate();
Mike Fiore 7:a31236c2e75c 78 //this data should always exist
Mike Fiore 7:a31236c2e75c 79 writeLabel(_lDr);
Mike Fiore 7:a31236c2e75c 80 writeLabel(_lPwr);
Mike Fiore 7:a31236c2e75c 81 writeField(_fId, line.id, true);
Mike Fiore 7:a31236c2e75c 82 writeField(_fDr, line.dataRate, true);
Mike Fiore 7:a31236c2e75c 83 writeField(_fPwr, line.power, true);
Mike Fiore 7:a31236c2e75c 84 //check if survey pass/fail
Mike Fiore 7:a31236c2e75c 85 if(line.status=="S") {
Mike Fiore 7:a31236c2e75c 86 writeLabel(_lUp);
Mike Fiore 7:a31236c2e75c 87 writeLabel(_lDown);
Mike Fiore 7:a31236c2e75c 88 writeLabel(_lGw);
Mike Fiore 7:a31236c2e75c 89 writeLabel(_lDbm);
Mike Fiore 7:a31236c2e75c 90 writeField(_fGw, line.gateways, true);
Mike Fiore 7:a31236c2e75c 91 writeField(_fUpMargin, line.margin, true);
Mike Fiore 7:a31236c2e75c 92 writeField(_fRssiDown, line.rssiD, true);
Mike Fiore 7:a31236c2e75c 93 writeField(_fSnrDown, line.snrD, true);
Mike Fiore 7:a31236c2e75c 94 } else writeLabel(_lSurveyFailed);
Mike Fiore 7:a31236c2e75c 95 //check if gps data exists
Mike Fiore 7:a31236c2e75c 96 if(line.lock!="0") {
Mike Fiore 7:a31236c2e75c 97 writeLabel(_lAlt);
Mike Fiore 7:a31236c2e75c 98 writeField(_fGpsLat, line.lat, true);
Mike Fiore 7:a31236c2e75c 99 writeField(_fGpsLong, line.lng, true);
Mike Fiore 7:a31236c2e75c 100 writeField(_fGpsTime, line.time, true);
Mike Fiore 7:a31236c2e75c 101 writeField(_fAlt, line.alt + " m", true);
Mike Fiore 7:a31236c2e75c 102 } else writeField(_fGpsLong, string("No GPS Data"), true);
Mike Fiore 7:a31236c2e75c 103 endUpdate();
Mike Fiore 7:a31236c2e75c 104 }