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

Mode/Mode.h@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
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 #ifndef __MODE_H__
Mike Fiore 1:71125aa00e33 20 #define __MODE_H__
Mike Fiore 1:71125aa00e33 21
Mike Fiore 1:71125aa00e33 22 #include "DOGS102.h"
Mike Fiore 1:71125aa00e33 23 #include "ButtonHandler.h"
Mike Fiore 1:71125aa00e33 24 #include "mDot.h"
Mike Fiore 1:71125aa00e33 25 #include "LoRaHandler.h"
Mike Fiore 1:71125aa00e33 26 #include "GPSPARSER.h"
Mike Fiore 1:71125aa00e33 27 #include "SensorHandler.h"
Mike Fiore 1:71125aa00e33 28 #include "ISL29011.h"
Mike Fiore 1:71125aa00e33 29 #include "MMA845x.h"
Mike Fiore 1:71125aa00e33 30 #include "MPL3115A2.h"
Mike Fiore 1:71125aa00e33 31 #include "FileName.h"
jenkins@jenkinsdm1 12:05435282f899 32 #include "ChannelPlans.h"
Mike Fiore 1:71125aa00e33 33
Mike Fiore 1:71125aa00e33 34 class Mode {
Mike Fiore 1:71125aa00e33 35 public:
Mike Fiore 1:71125aa00e33 36 typedef enum {
Mike Fiore 1:71125aa00e33 37 single = 0,
Mike Fiore 1:71125aa00e33 38 sweep
Mike Fiore 1:71125aa00e33 39 } DataType;
Mike Fiore 1:71125aa00e33 40
Mike Fiore 1:71125aa00e33 41 typedef struct {
Mike Fiore 1:71125aa00e33 42 DataType type;
Mike Fiore 1:71125aa00e33 43 int32_t index;
Mike Fiore 1:71125aa00e33 44 bool status;
Mike Fiore 1:71125aa00e33 45 bool gps_lock;
Mike Fiore 1:71125aa00e33 46 int32_t gps_sats;
Mike Fiore 1:71125aa00e33 47 GPSPARSER::longitude gps_longitude;
Mike Fiore 1:71125aa00e33 48 GPSPARSER::latitude gps_latitude;
Mike Fiore 1:71125aa00e33 49 int16_t gps_altitude;
Mike Fiore 1:71125aa00e33 50 struct tm gps_time;
Mike Fiore 1:71125aa00e33 51 LoRaHandler::LoRaLink link;
Mike Fiore 1:71125aa00e33 52 uint8_t data_rate;
Mike Fiore 1:71125aa00e33 53 uint32_t power;
Mike Fiore 1:71125aa00e33 54 } DataItem;
Mike Fiore 1:71125aa00e33 55
Mike Fiore 1:71125aa00e33 56 typedef struct {
Mike Fiore 1:71125aa00e33 57 MMA845x_DATA accel_data;
Mike Fiore 1:71125aa00e33 58 MPL3115A2_DATA baro_data;
Mike Fiore 1:71125aa00e33 59 uint16_t lux_data_raw;
Mike Fiore 1:71125aa00e33 60 uint32_t pressure_raw;
Mike Fiore 1:71125aa00e33 61 float light;
Mike Fiore 1:71125aa00e33 62 float pressure;
Mike Fiore 1:71125aa00e33 63 float altitude;
Mike Fiore 1:71125aa00e33 64 float temperature;
Mike Fiore 1:71125aa00e33 65 } SensorItem;
Mike Fiore 1:71125aa00e33 66
Mike Fiore 1:71125aa00e33 67 Mode(DOGS102* lcd, ButtonHandler* buttons, mDot* dot, LoRaHandler* lora, GPSPARSER* gps, SensorHandler* sensors);
Mike Fiore 1:71125aa00e33 68 ~Mode();
Mike Fiore 1:71125aa00e33 69
Mike Fiore 1:71125aa00e33 70 virtual bool start() = 0;
Mike Fiore 1:71125aa00e33 71
Mike Fiore 1:71125aa00e33 72 protected:
Mike Fiore 1:71125aa00e33 73 bool deleteDataFile();
Mike Fiore 1:71125aa00e33 74 bool appendDataFile(const DataItem& data);
Mike Fiore 1:71125aa00e33 75 void updateData(DataItem& data, DataType type, bool status);
Mike Fiore 1:71125aa00e33 76 void updateSensorData(SensorItem& data);
Mike Fiore 1:71125aa00e33 77 uint32_t getIndex(DataType type);
Mike Fiore 1:71125aa00e33 78
Mike Fiore 1:71125aa00e33 79 std::vector<uint8_t> formatSurveyData(DataItem& data);
Mike Fiore 1:71125aa00e33 80 std::vector<uint8_t> formatSensorData(SensorItem& data);
Mike Fiore 1:71125aa00e33 81
Mike Fiore 1:71125aa00e33 82 DOGS102* _lcd;
Mike Fiore 1:71125aa00e33 83 ButtonHandler* _buttons;
Mike Fiore 1:71125aa00e33 84 mDot* _dot;
Mike Fiore 1:71125aa00e33 85 LoRaHandler* _lora;
Mike Fiore 1:71125aa00e33 86 GPSPARSER* _gps;
Mike Fiore 1:71125aa00e33 87 SensorHandler* _sensors;
Mike Fiore 1:71125aa00e33 88 osThreadId _main_id;
Mike Fiore 1:71125aa00e33 89 uint32_t _index;
Mike Fiore 1:71125aa00e33 90 uint8_t _band;
Mike Fiore 1:71125aa00e33 91 uint8_t _sub_band;
Mike Fiore 1:71125aa00e33 92 uint8_t _data_rate;
Mike Fiore 1:71125aa00e33 93 uint32_t _power;
Mike Fiore 1:71125aa00e33 94 uint32_t _next_tx;
Mike Fiore 1:71125aa00e33 95 ButtonHandler::ButtonEvent _be;
Mike Fiore 1:71125aa00e33 96 LoRaHandler::LoRaStatus _ls;
Mike Fiore 1:71125aa00e33 97 LoRaHandler::LoRaLink _link_check_result;
Mike Fiore 1:71125aa00e33 98 uint8_t _state;
Mike Fiore 1:71125aa00e33 99 bool _send_data;
Mike Fiore 1:71125aa00e33 100 bool _gps_available;
Mike Fiore 1:71125aa00e33 101 uint8_t _initial_data_rate;
Mike Fiore 1:71125aa00e33 102 uint8_t _initial_power;
Mike Fiore 1:71125aa00e33 103 };
Mike Fiore 1:71125aa00e33 104
Mike Fiore 1:71125aa00e33 105 #endif