MultiTech / Mbed OS Dot-AT-Firmware

AT command firmware for MultiTech Dot devices.

Fork of mDot_AT_firmware by MultiTech

Dot Library Not Included!

Because these example programs can be used for both mDot and xDot devices, the LoRa stack is not included. The libmDot library should be imported if building for mDot devices. The libxDot library should be imported if building for xDot devices. The AT firmware was last tested with mbed-os-5.4.7. Using a version past mbed-os-5.4.7 will cause the build to fail. The library used with the AT firmware has to match the mbed-os version.

Dot Library Version 3 Updates

Dot Library versions 3.x.x require a channel plan to be injected into the stack. The Dot-Examples and Dot-AT-Firmware do this by defining a macro called "CHANNEL_PLAN" that controls the channel plan that will be used in the examples. Available channel plans will be in the Dot Library repository in the plans folder.

Revision 20 and earlier of Dot-Examples and revision 15 and earlier of Dot-AT-Firmware should be used with Dot Library versions prior to 3.0.0.

Fota Library

Th Fota Library must be added to compile for mDot 3.1.0 with Fota support. Latest dev libraries and 3.2.0 release will include Fota with libmDot/libxDot.

AT Firmware Description

This AT Firmware is what ships on mDot and xDot devices. It provides an AT command interface for using the mDot or xDot for LoRa communication.

AT command documentation can be found on Multitech.com.

The firmware changelog can be found here. The library changelog 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.

Stable and development libraries are available for both mDot and xDot platforms. The library chosen must match the target platform. Compiling for the mDot platform with the xDot library or vice versa will not succeed.

mDot Library

Development library for mDot.

libmDot-dev

Stable library for mDot.

libmDot

xDot Library

Development library for xDot.

libxDot-dev

Stable library for xDot.

libxDot

CommandTerminal/Command.cpp@33:5c0252521669, 2021-01-29 (annotated)

Committer:
Jason Reiss
Date:
Fri Jan 29 13:04:32 2021 -0600
Revision:
33:5c0252521669
Parent:
28:c222ca8383f4
Child:
36:b586cd6e91f3
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "Command.h"
Mike Fiore 1:e52ae6584f1c 2 #include <algorithm>
Mike Fiore 1:e52ae6584f1c 3
Mike Fiore 1:e52ae6584f1c 4 const char Command::newline[] = "\r\n";
Mike Fiore 1:e52ae6584f1c 5
Jason Reiss 28:c222ca8383f4 6 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 7 Command::Command() : _name(""), _text(""), _desc(""), _usage("NONE")
Jason Reiss 28:c222ca8383f4 8 #else
Jason Reiss 28:c222ca8383f4 9 Command::Command() : _text("")
Jason Reiss 28:c222ca8383f4 10 #endif
Mike Fiore 1:e52ae6584f1c 11 {
Mike Fiore 1:e52ae6584f1c 12 _queryable = false;
Mike Fiore 1:e52ae6584f1c 13 }
Mike Fiore 1:e52ae6584f1c 14
Jason Reiss 28:c222ca8383f4 15 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 16 Command::Command(const char* name, const char* text, const char* desc, const char* usage) :
Mike Fiore 14:f9a77400b622 17 _name(name), _text(text), _desc(desc), _usage(usage)
Jason Reiss 28:c222ca8383f4 18 #else
Jason Reiss 28:c222ca8383f4 19 Command::Command(const char* text) :
Jason Reiss 28:c222ca8383f4 20 _text(text)
Jason Reiss 28:c222ca8383f4 21 #endif
Mike Fiore 1:e52ae6584f1c 22 {
Mike Fiore 14:f9a77400b622 23 _queryable = false;
Mike Fiore 1:e52ae6584f1c 24 }
Mike Fiore 1:e52ae6584f1c 25
Jason Reiss 28:c222ca8383f4 26 bool Command::verify(const std::vector<std::string>& args) {
Jason Reiss 28:c222ca8383f4 27 if (args.size() == 1)
Jason Reiss 28:c222ca8383f4 28 return true;
Jason Reiss 28:c222ca8383f4 29
Jason Reiss 28:c222ca8383f4 30 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 31 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 32 #endif
Jason Reiss 28:c222ca8383f4 33 return false;
Jason Reiss 28:c222ca8383f4 34 }
Jason Reiss 28:c222ca8383f4 35
Jason Reiss 28:c222ca8383f4 36
Jason Reiss 28:c222ca8383f4 37 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 9:ff62b20f7000 38 std::string Command::usage() const
Mike Fiore 1:e52ae6584f1c 39 {
Mike Fiore 1:e52ae6584f1c 40 std::string usage(_text);
Mike Fiore 1:e52ae6584f1c 41 usage.append(": ");
Mike Fiore 1:e52ae6584f1c 42 usage.append(_usage);
Mike Fiore 1:e52ae6584f1c 43 return usage;
Mike Fiore 1:e52ae6584f1c 44 }
Jason Reiss 28:c222ca8383f4 45 #endif
Mike Fiore 1:e52ae6584f1c 46
Mike Fiore 9:ff62b20f7000 47 bool Command::queryable() const
Mike Fiore 1:e52ae6584f1c 48 {
Mike Fiore 1:e52ae6584f1c 49 return _queryable;
Mike Fiore 1:e52ae6584f1c 50 }
Mike Fiore 1:e52ae6584f1c 51
Mike Fiore 1:e52ae6584f1c 52 void Command::readByteArray(const std::string& input, std::vector<uint8_t>& out, size_t len)
Mike Fiore 1:e52ae6584f1c 53 {
Mike Fiore 1:e52ae6584f1c 54 // if input length is greater than expected byte output
Mike Fiore 1:e52ae6584f1c 55 // there must be a delimiter included
Mike Fiore 1:e52ae6584f1c 56 if (input.length() > len * 2)
Mike Fiore 1:e52ae6584f1c 57 {
Mike Fiore 1:e52ae6584f1c 58 std::vector < std::string > bytes;
Jason Reiss 28:c222ca8383f4 59
Jason Reiss 28:c222ca8383f4 60
Jason Reiss 28:c222ca8383f4 61 char delims[] = " :-.";
Jason Reiss 28:c222ca8383f4 62
Jason Reiss 28:c222ca8383f4 63 for (int i = 0; i < sizeof(delims); ++i) {
Jason Reiss 28:c222ca8383f4 64 if (input.find(delims[i]) != std::string::npos) {
Jason Reiss 28:c222ca8383f4 65 bytes = mts::Text::split(input, delims[i]);
Jason Reiss 28:c222ca8383f4 66 break;
Jason Reiss 28:c222ca8383f4 67 }
Jason Reiss 28:c222ca8383f4 68 }
Mike Fiore 1:e52ae6584f1c 69
Mike Fiore 1:e52ae6584f1c 70 if (bytes.size() != len) {
Mike Fiore 1:e52ae6584f1c 71 return;
Mike Fiore 1:e52ae6584f1c 72 }
Mike Fiore 1:e52ae6584f1c 73
Mike Fiore 9:ff62b20f7000 74 int temp;
Mike Fiore 1:e52ae6584f1c 75 // Read in the key components...
Mike Fiore 1:e52ae6584f1c 76 for (size_t i = 0; i < len; i++)
Mike Fiore 1:e52ae6584f1c 77 {
Mike Fiore 1:e52ae6584f1c 78 sscanf(bytes[i].c_str(), "%02x", &temp);
Mike Fiore 1:e52ae6584f1c 79 out.push_back(temp);
Mike Fiore 1:e52ae6584f1c 80 }
Mike Fiore 1:e52ae6584f1c 81 }
Mike Fiore 1:e52ae6584f1c 82 else
Mike Fiore 1:e52ae6584f1c 83 {
Mike Fiore 1:e52ae6584f1c 84 // no delims
Mike Fiore 9:ff62b20f7000 85 int temp;
Mike Fiore 1:e52ae6584f1c 86
Mike Fiore 1:e52ae6584f1c 87 // Read in the key components...
Mike Fiore 1:e52ae6584f1c 88 for (size_t i = 0; i < len; i++)
Mike Fiore 1:e52ae6584f1c 89 {
Mike Fiore 1:e52ae6584f1c 90 if (i * 2 < input.size())
Mike Fiore 1:e52ae6584f1c 91 {
Mike Fiore 1:e52ae6584f1c 92 sscanf(input.substr(i * 2).c_str(), "%02x", &temp);
Mike Fiore 1:e52ae6584f1c 93 out.push_back(temp);
Mike Fiore 1:e52ae6584f1c 94 }
Mike Fiore 1:e52ae6584f1c 95 }
Mike Fiore 1:e52ae6584f1c 96 }
Mike Fiore 1:e52ae6584f1c 97 }
Mike Fiore 1:e52ae6584f1c 98
Mike Fiore 1:e52ae6584f1c 99 bool Command::isHexString(const std::string& str, size_t bytes) {
Mike Fiore 9:ff62b20f7000 100 int numDelims = bytes - 1;
Mike Fiore 1:e52ae6584f1c 101 size_t minSize = bytes * 2;
Mike Fiore 1:e52ae6584f1c 102 size_t maxSize = minSize + numDelims;
Mike Fiore 1:e52ae6584f1c 103
Mike Fiore 1:e52ae6584f1c 104 if (str.size() == minSize) {
Mike Fiore 1:e52ae6584f1c 105 return str.find_first_not_of("0123456789abcdefABCDEF") == std::string::npos;
Mike Fiore 1:e52ae6584f1c 106 }
Mike Fiore 1:e52ae6584f1c 107 else if (str.size() == maxSize) {
Jason Reiss 28:c222ca8383f4 108 char delims[] = ":-.";
Jason Reiss 28:c222ca8383f4 109 if (str.find_first_of(delims) == std::string::npos) {
Mike Fiore 1:e52ae6584f1c 110 // no delim found
Mike Fiore 1:e52ae6584f1c 111 return false;
Mike Fiore 1:e52ae6584f1c 112 }
Jason Reiss 28:c222ca8383f4 113
Jason Reiss 28:c222ca8383f4 114 for (int i = 0; i < sizeof(delims); ++i) {
Jason Reiss 28:c222ca8383f4 115 if (str.find(delims[i]) != std::string::npos && std::count(str.begin(), str.end(), delims[i]) != numDelims) {
Jason Reiss 28:c222ca8383f4 116 return false;
Jason Reiss 28:c222ca8383f4 117 }
Mike Fiore 1:e52ae6584f1c 118 }
Mike Fiore 1:e52ae6584f1c 119
Mike Fiore 1:e52ae6584f1c 120 return str.find_first_not_of("0123456789abcdefABCDEF:-.") == std::string::npos;
Mike Fiore 1:e52ae6584f1c 121 }
Mike Fiore 1:e52ae6584f1c 122
Mike Fiore 1:e52ae6584f1c 123 return false;
Mike Fiore 1:e52ae6584f1c 124 }
Mike Fiore 1:e52ae6584f1c 125
Jason Reiss 28:c222ca8383f4 126
Jason Reiss 28:c222ca8383f4 127 int Command::strToDataRate(const std::string& str)
Jason Reiss 28:c222ca8383f4 128 {
Jason Reiss 28:c222ca8383f4 129 std::string dr = mts::Text::toUpper(str);
Jason Reiss 28:c222ca8383f4 130
Jason Reiss 28:c222ca8383f4 131 int datarate = -1;
Jason Reiss 28:c222ca8383f4 132 uint8_t i;
Jason Reiss 28:c222ca8383f4 133
Jason Reiss 28:c222ca8383f4 134 int res = sscanf(dr.c_str(), "%d", &datarate);
Jason Reiss 28:c222ca8383f4 135
Jason Reiss 28:c222ca8383f4 136 if (res == 0) {
Jason Reiss 28:c222ca8383f4 137 for (i = 0; i < 24; i++) {
Jason Reiss 28:c222ca8383f4 138 if (mDot::DataRateStr(i).find(dr) != std::string::npos) {
Jason Reiss 28:c222ca8383f4 139 datarate = i;
Jason Reiss 28:c222ca8383f4 140 break;
Jason Reiss 28:c222ca8383f4 141 }
Jason Reiss 28:c222ca8383f4 142 }
Jason Reiss 28:c222ca8383f4 143 }
Jason Reiss 28:c222ca8383f4 144 return datarate;
Jason Reiss 28:c222ca8383f4 145 }
Jason Reiss 28:c222ca8383f4 146
Jason Reiss 28:c222ca8383f4 147
Jason Reiss 28:c222ca8383f4 148 bool Command::printRecvData()
Jason Reiss 28:c222ca8383f4 149 {
Jason Reiss 28:c222ca8383f4 150 bool recvd = false;
Jason Reiss 28:c222ca8383f4 151 std::vector<uint8_t> rx_data;
Jason Reiss 28:c222ca8383f4 152 if (CommandTerminal::Dot()->recv(rx_data) == mDot::MDOT_OK) {
Jason Reiss 28:c222ca8383f4 153 if (!rx_data.empty()) {
Jason Reiss 28:c222ca8383f4 154 recvd = true;
Jason Reiss 28:c222ca8383f4 155 std::string formatted_data = CommandTerminal::formatPacketData(rx_data, CommandTerminal::Dot()->getRxOutput());
Jason Reiss 28:c222ca8383f4 156 CommandTerminal::Serial()->write(formatted_data.c_str(), formatted_data.length());
Jason Reiss 28:c222ca8383f4 157 CommandTerminal::Serial()->write(Command::newline, sizeof(Command::newline));
Jason Reiss 28:c222ca8383f4 158 }
Jason Reiss 28:c222ca8383f4 159 }
Jason Reiss 28:c222ca8383f4 160 return recvd;
Jason Reiss 28:c222ca8383f4 161 }