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/Command.h@12:05435282f899, 2018-10-09 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Tue Oct 09 13:49:30 2018 -0500
Revision:
12:05435282f899
Parent:
1:71125aa00e33 
dotbox-firmware revision 3.1.1

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 /**
Mike Fiore 1:71125aa00e33 20 ******************************************************************************
Mike Fiore 1:71125aa00e33 21 * File Name : Command.h
Mike Fiore 1:71125aa00e33 22 * Date : 18/04/2014 10:57:12
Mike Fiore 1:71125aa00e33 23 * Description : This file provides code for command line prompt
Mike Fiore 1:71125aa00e33 24 ******************************************************************************
Mike Fiore 1:71125aa00e33 25 *
Mike Fiore 1:71125aa00e33 26 * COPYRIGHT(c) 2014 MultiTech Systems, Inc.
Mike Fiore 1:71125aa00e33 27 *
Mike Fiore 1:71125aa00e33 28 * Redistribution and use in source and binary forms, with or without modification,
Mike Fiore 1:71125aa00e33 29 * are permitted provided that the following conditions are met:
Mike Fiore 1:71125aa00e33 30 * 1. Redistributions of source code must retain the above copyright notice,
Mike Fiore 1:71125aa00e33 31 * this list of conditions and the following disclaimer.
Mike Fiore 1:71125aa00e33 32 * 2. Redistributions in binary form must reproduce the above copyright notice,
Mike Fiore 1:71125aa00e33 33 * this list of conditions and the following disclaimer in the documentation
Mike Fiore 1:71125aa00e33 34 * and/or other materials provided with the distribution.
Mike Fiore 1:71125aa00e33 35 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Mike Fiore 1:71125aa00e33 36 * may be used to endorse or promote products derived from this software
Mike Fiore 1:71125aa00e33 37 * without specific prior written permission.
Mike Fiore 1:71125aa00e33 38 *
Mike Fiore 1:71125aa00e33 39 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Mike Fiore 1:71125aa00e33 40 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Mike Fiore 1:71125aa00e33 41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Mike Fiore 1:71125aa00e33 42 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Mike Fiore 1:71125aa00e33 43 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Mike Fiore 1:71125aa00e33 44 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Mike Fiore 1:71125aa00e33 45 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Mike Fiore 1:71125aa00e33 46 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Mike Fiore 1:71125aa00e33 47 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Mike Fiore 1:71125aa00e33 48 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Mike Fiore 1:71125aa00e33 49 *
Mike Fiore 1:71125aa00e33 50 ******************************************************************************
Mike Fiore 1:71125aa00e33 51 */
Mike Fiore 1:71125aa00e33 52
Mike Fiore 1:71125aa00e33 53 #include "mbed.h"
Mike Fiore 1:71125aa00e33 54 #include "mDot.h"
Mike Fiore 1:71125aa00e33 55 #include "MTSSerial.h"
Mike Fiore 1:71125aa00e33 56 #include "MTSText.h"
Mike Fiore 1:71125aa00e33 57 #include <cstdlib>
Mike Fiore 1:71125aa00e33 58 #include <string>
Mike Fiore 1:71125aa00e33 59 #include <vector>
Mike Fiore 1:71125aa00e33 60 #include "limits.h"
jenkins@jenkinsdm1 12:05435282f899 61 #include "ChannelPlans.h"
Mike Fiore 1:71125aa00e33 62
Mike Fiore 1:71125aa00e33 63 /* Define to prevent recursive inclusion -------------------------------------*/
Mike Fiore 1:71125aa00e33 64 #ifndef __command_H
Mike Fiore 1:71125aa00e33 65 #define __command_H
Mike Fiore 1:71125aa00e33 66
Mike Fiore 1:71125aa00e33 67 #define KEY_LENGTH 16
Mike Fiore 1:71125aa00e33 68 #define EUI_LENGTH 8
Mike Fiore 1:71125aa00e33 69 #define PASSPHRASE_LENGTH 128
Mike Fiore 1:71125aa00e33 70
Mike Fiore 1:71125aa00e33 71 class Command {
Mike Fiore 1:71125aa00e33 72
Mike Fiore 1:71125aa00e33 73 public:
Mike Fiore 1:71125aa00e33 74
Mike Fiore 1:71125aa00e33 75 Command(mDot* dot);
Mike Fiore 1:71125aa00e33 76 Command(mDot* dot, const char* name, const char* text, const char* desc);
Mike Fiore 1:71125aa00e33 77 virtual ~Command() {};
Mike Fiore 1:71125aa00e33 78
Mike Fiore 1:71125aa00e33 79 const char* name() const { return _name; };
Mike Fiore 1:71125aa00e33 80 const char* text() const { return _text; };
Mike Fiore 1:71125aa00e33 81 const char* desc() const { return _desc; };
Mike Fiore 1:71125aa00e33 82 const char* help() const { return _help.c_str(); };
Mike Fiore 1:71125aa00e33 83
Mike Fiore 1:71125aa00e33 84 virtual uint32_t action(std::vector<std::string> args) = 0;
Mike Fiore 1:71125aa00e33 85 virtual bool verify(std::vector<std::string> args);
Mike Fiore 1:71125aa00e33 86 const std::string usage() const;
Mike Fiore 1:71125aa00e33 87 std::string& errorMessage();
Mike Fiore 1:71125aa00e33 88 const bool queryable();
Mike Fiore 1:71125aa00e33 89
Mike Fiore 1:71125aa00e33 90 static const char newline[];
Mike Fiore 1:71125aa00e33 91 static void readByteArray(const std::string& input, std::vector<uint8_t>& out, size_t len);
Mike Fiore 1:71125aa00e33 92
Mike Fiore 1:71125aa00e33 93 static bool isHexString(const std::string& str, size_t bytes);
Mike Fiore 1:71125aa00e33 94 static bool isBaudRate(uint32_t baud);
Mike Fiore 1:71125aa00e33 95
Mike Fiore 1:71125aa00e33 96 protected:
Mike Fiore 1:71125aa00e33 97
Mike Fiore 1:71125aa00e33 98 void setErrorMessage(const char* message);
Mike Fiore 1:71125aa00e33 99 void setErrorMessage(const std::string& message);
Mike Fiore 1:71125aa00e33 100 std::string _help;
Mike Fiore 1:71125aa00e33 101 std::string _usage;
Mike Fiore 1:71125aa00e33 102 bool _queryable;
Mike Fiore 1:71125aa00e33 103 mDot* _dot;
Mike Fiore 1:71125aa00e33 104
Mike Fiore 1:71125aa00e33 105 private:
Mike Fiore 1:71125aa00e33 106
Mike Fiore 1:71125aa00e33 107 const char* _name;
Mike Fiore 1:71125aa00e33 108 const char* _text;
Mike Fiore 1:71125aa00e33 109 const char* _desc;
Mike Fiore 1:71125aa00e33 110 std::string _errorMessage;
Mike Fiore 1:71125aa00e33 111
Mike Fiore 1:71125aa00e33 112 };
Mike Fiore 1:71125aa00e33 113
Mike Fiore 1:71125aa00e33 114 #endif /*__ command_H */
Mike Fiore 1:71125aa00e33 115
Mike Fiore 1:71125aa00e33 116 /************************ (C) COPYRIGHT MultiTech Systems, Inc *****END OF FILE****/