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/LayoutJoin.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
jenkins@jenkinsdm1 12:05435282f899 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 "LayoutJoin.h"
Mike Fiore 1:71125aa00e33 20
Mike Fiore 1:71125aa00e33 21 LayoutJoin::LayoutJoin(DOGS102* lcd, uint8_t band)
Mike Fiore 1:71125aa00e33 22 : Layout(lcd),
Mike Fiore 1:71125aa00e33 23 _lId(0, 1, "NI="),
Mike Fiore 1:71125aa00e33 24 _lKey(0, 2, "NK="),
Mike Fiore 1:71125aa00e33 25 _lFsb(0, 3, "FSB="),
Mike Fiore 1:71125aa00e33 26 _lRate(0, 5, "DR="),
Mike Fiore 1:71125aa00e33 27 _lPower(6, 5, "P="),
Mike Fiore 1:71125aa00e33 28 _lAttempt(11, 5, "A="),
Mike Fiore 1:71125aa00e33 29 _fStatus(0, 0, 17),
Mike Fiore 1:71125aa00e33 30 _fId(3, 1, 14),
Mike Fiore 1:71125aa00e33 31 _fKey(3, 2, 14),
Mike Fiore 1:71125aa00e33 32 _fFsb(4, 3, 2),
Mike Fiore 1:71125aa00e33 33 _fRate(3, 5, 2),
Mike Fiore 1:71125aa00e33 34 _fPower(8, 5, 2),
Mike Fiore 1:71125aa00e33 35 _fAttempt(13, 5, 4),
Mike Fiore 1:71125aa00e33 36 _fCountdown(0, 7, 9),
Mike Fiore 1:71125aa00e33 37 _fCountdownLabel(0, 6, 17),
Mike Fiore 1:71125aa00e33 38 _fCancel(11, 7, 6),
Mike Fiore 1:71125aa00e33 39 _band(band)
Mike Fiore 1:71125aa00e33 40 {}
Mike Fiore 1:71125aa00e33 41
Mike Fiore 1:71125aa00e33 42 LayoutJoin::~LayoutJoin() {}
Mike Fiore 1:71125aa00e33 43
Mike Fiore 1:71125aa00e33 44 void LayoutJoin::display() {
Mike Fiore 1:71125aa00e33 45 clear();
Mike Fiore 1:71125aa00e33 46 startUpdate();
Mike Fiore 1:71125aa00e33 47
Mike Fiore 1:71125aa00e33 48 writeLabel(_lId);
Mike Fiore 1:71125aa00e33 49 writeLabel(_lKey);
jenkins@jenkinsdm1 12:05435282f899 50 if (lora::ChannelPlan::IsPlanFixed(_band)) {
Mike Fiore 1:71125aa00e33 51 writeLabel(_lFsb);
Mike Fiore 1:71125aa00e33 52 }
Mike Fiore 1:71125aa00e33 53 writeLabel(_lRate);
Mike Fiore 1:71125aa00e33 54 writeLabel(_lPower);
Mike Fiore 1:71125aa00e33 55 writeLabel(_lAttempt);
Mike Fiore 1:71125aa00e33 56
Mike Fiore 1:71125aa00e33 57 displayCancel();
Mike Fiore 1:71125aa00e33 58
Mike Fiore 1:71125aa00e33 59 endUpdate();
Mike Fiore 1:71125aa00e33 60 }
Mike Fiore 1:71125aa00e33 61
Mike Fiore 1:71125aa00e33 62 void LayoutJoin::updateId(std::string id) {
Mike Fiore 1:71125aa00e33 63 writeField(_fId, id, true);
Mike Fiore 1:71125aa00e33 64 }
Mike Fiore 1:71125aa00e33 65
Mike Fiore 1:71125aa00e33 66 void LayoutJoin::updateKey(std::string key) {
Mike Fiore 1:71125aa00e33 67 writeField(_fKey, key, true);
Mike Fiore 1:71125aa00e33 68 }
Mike Fiore 1:71125aa00e33 69
Mike Fiore 1:71125aa00e33 70 void LayoutJoin::updateFsb(uint8_t band) {
Mike Fiore 1:71125aa00e33 71 char buf[8];
Mike Fiore 1:71125aa00e33 72 size_t size;
Mike Fiore 1:71125aa00e33 73
Mike Fiore 1:71125aa00e33 74 size = snprintf(buf, sizeof(buf), "%u", band);
Mike Fiore 1:71125aa00e33 75 writeField(_fFsb, buf, size, true);
Mike Fiore 1:71125aa00e33 76 }
Mike Fiore 1:71125aa00e33 77
Mike Fiore 7:a31236c2e75c 78 void LayoutJoin::updateRate(uint8_t rate) {
Mike Fiore 7:a31236c2e75c 79 char buf[8];
Mike Fiore 7:a31236c2e75c 80 size_t size;
Mike Fiore 7:a31236c2e75c 81
Mike Fiore 7:a31236c2e75c 82 size = snprintf(buf, sizeof(buf), "%u", rate);
Mike Fiore 7:a31236c2e75c 83 writeField(_fRate, buf, size, true);
Mike Fiore 1:71125aa00e33 84 }
Mike Fiore 1:71125aa00e33 85
Mike Fiore 1:71125aa00e33 86 void LayoutJoin::updatePower(uint32_t power) {
Mike Fiore 1:71125aa00e33 87 char buf[16];
Mike Fiore 1:71125aa00e33 88 size_t size;
Mike Fiore 1:71125aa00e33 89
Mike Fiore 1:71125aa00e33 90 size = snprintf(buf, sizeof(buf), "%lu", power);
Mike Fiore 1:71125aa00e33 91 writeField(_fPower, buf, size, true);
Mike Fiore 1:71125aa00e33 92 }
Mike Fiore 1:71125aa00e33 93
Mike Fiore 1:71125aa00e33 94 void LayoutJoin::updateAttempt(uint32_t attempt) {
Mike Fiore 1:71125aa00e33 95 char buf[16];
Mike Fiore 1:71125aa00e33 96 size_t size;
Mike Fiore 1:71125aa00e33 97
Mike Fiore 1:71125aa00e33 98 size = snprintf(buf, sizeof(buf), "%lu", attempt);
Mike Fiore 1:71125aa00e33 99 writeField(_fAttempt, buf, size, true);
Mike Fiore 1:71125aa00e33 100 }
Mike Fiore 1:71125aa00e33 101
Mike Fiore 1:71125aa00e33 102 void LayoutJoin::updateStatus(std::string status) {
Mike Fiore 1:71125aa00e33 103 writeField(_fStatus, status, true);
Mike Fiore 1:71125aa00e33 104 }
Mike Fiore 1:71125aa00e33 105
Mike Fiore 1:71125aa00e33 106 void LayoutJoin::updateCountdown(uint32_t seconds) {
Mike Fiore 1:71125aa00e33 107 char buf[16];
Mike Fiore 1:71125aa00e33 108 size_t size;
Mike Fiore 1:71125aa00e33 109
Mike Fiore 1:71125aa00e33 110 // make sure the string version is used
Mike Fiore 1:71125aa00e33 111 writeField(_fCountdownLabel, string("No Free Channel"), true);
Mike Fiore 1:71125aa00e33 112 size = snprintf(buf, sizeof(buf), "%lu s", seconds);
Mike Fiore 1:71125aa00e33 113 writeField(_fCountdown, buf, size, true);
Mike Fiore 1:71125aa00e33 114 }
Mike Fiore 1:71125aa00e33 115
Mike Fiore 1:71125aa00e33 116 void LayoutJoin::displayCancel(bool display) {
Mike Fiore 1:71125aa00e33 117 std::string str;
Mike Fiore 1:71125aa00e33 118 if (display)
Mike Fiore 1:71125aa00e33 119 str = "Cancel";
Mike Fiore 1:71125aa00e33 120 else
Mike Fiore 1:71125aa00e33 121 str = string(17, ' ');
Mike Fiore 1:71125aa00e33 122
Mike Fiore 1:71125aa00e33 123 writeField(_fCancel, str, true);
Mike Fiore 1:71125aa00e33 124 }
Mike Fiore 1:71125aa00e33 125
Mike Fiore 7:a31236c2e75c 126 void LayoutJoin::updateJoinFsb(uint8_t band) {
Mike Fiore 7:a31236c2e75c 127 char buf[8];
Mike Fiore 7:a31236c2e75c 128 size_t size;
Mike Fiore 7:a31236c2e75c 129
Mike Fiore 7:a31236c2e75c 130 size = snprintf(buf, sizeof(buf), "%u", band);
Mike Fiore 7:a31236c2e75c 131 writeField(_fFsb, buf, size, true);
Mike Fiore 7:a31236c2e75c 132 size = snprintf(buf, sizeof(buf), " %u", band);
Mike Fiore 7:a31236c2e75c 133 writeField(_fCancel, buf, size, true);
Mike Fiore 7:a31236c2e75c 134 }
Mike Fiore 7:a31236c2e75c 135
Mike Fiore 7:a31236c2e75c 136 void LayoutJoin::displayEditFsb(uint8_t rate, uint32_t power, uint8_t band, string key, string id){
Mike Fiore 7:a31236c2e75c 137 clear();
Mike Fiore 7:a31236c2e75c 138 startUpdate();
Mike Fiore 7:a31236c2e75c 139
Mike Fiore 7:a31236c2e75c 140 writeLabel(_lId);
Mike Fiore 7:a31236c2e75c 141 writeLabel(_lKey);
Mike Fiore 7:a31236c2e75c 142 writeLabel(_lFsb);
Mike Fiore 7:a31236c2e75c 143 writeLabel(_lRate);
Mike Fiore 7:a31236c2e75c 144 writeLabel(_lPower);
Mike Fiore 7:a31236c2e75c 145 writeField(_fCountdown, string("Join"), true);
Mike Fiore 7:a31236c2e75c 146 updateId(id);
Mike Fiore 7:a31236c2e75c 147 updateKey(key);
Mike Fiore 7:a31236c2e75c 148 updateJoinFsb(band);
Mike Fiore 7:a31236c2e75c 149 updateRate(rate);
Mike Fiore 7:a31236c2e75c 150 updatePower(power);
Mike Fiore 7:a31236c2e75c 151
Mike Fiore 7:a31236c2e75c 152 endUpdate();
Mike Fiore 7:a31236c2e75c 153 }