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/CmdSendStringOnInterval.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 
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdSendStringOnInterval.h"
Mike Fiore 1:e52ae6584f1c 2 #include "CommandTerminal.h"
Mike Fiore 1:e52ae6584f1c 3
Jason Reiss 28:c222ca8383f4 4 CmdSendStringOnInterval::CmdSendStringOnInterval() :
Jason Reiss 28:c222ca8383f4 5 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 6 Command("Send On Interval", "AT+SENDI", "Sends supplied packet data on interval between sends, output any received packets (escape sequence: +++)", "(1-2147483647) ms,(string:242)")
Jason Reiss 27:5fafd3b26ac3 7 #else
Jason Reiss 28:c222ca8383f4 8 Command("AT+SENDI")
Jason Reiss 27:5fafd3b26ac3 9 #endif
Jason Reiss 28:c222ca8383f4 10 {
Mike Fiore 14:f9a77400b622 11
Mike Fiore 1:e52ae6584f1c 12 }
Mike Fiore 1:e52ae6584f1c 13
jenkins@jenkinsdm1 18:63f098f042b2 14 uint32_t CmdSendStringOnInterval::action(const std::vector<std::string>& args) {
Jason Reiss 23:4f0a981c0349 15
Mike Fiore 1:e52ae6584f1c 16 int32_t code;
Mike Fiore 9:ff62b20f7000 17 int interval;
Jason Reiss 27:5fafd3b26ac3 18 std::string* text = new std::string();
Mike Fiore 1:e52ae6584f1c 19
Mike Fiore 9:ff62b20f7000 20 sscanf(args[1].c_str(), "%d", &interval);
Mike Fiore 1:e52ae6584f1c 21
Mike Fiore 2:e5eebd74d36d 22 for (size_t i = 2; i < args.size(); i++) {
Jason Reiss 27:5fafd3b26ac3 23 text->append(args[i]);
Mike Fiore 2:e5eebd74d36d 24 if (i != args.size() - 1)
Jason Reiss 27:5fafd3b26ac3 25 text->append(",");
Mike Fiore 2:e5eebd74d36d 26 }
Jason Reiss 27:5fafd3b26ac3 27
Jason Reiss 27:5fafd3b26ac3 28 std::vector<uint8_t> data(text->begin(), text->end());
Jason Reiss 27:5fafd3b26ac3 29 std::vector<uint8_t> mt;
Jason Reiss 27:5fafd3b26ac3 30 delete text;
Mike Fiore 2:e5eebd74d36d 31
Mike Fiore 1:e52ae6584f1c 32 while (true) {
Mike Fiore 14:f9a77400b622 33 if (CommandTerminal::Dot()->getJoinMode() == mDot::AUTO_OTA) {
Mike Fiore 1:e52ae6584f1c 34 Timer timer;
Mike Fiore 1:e52ae6584f1c 35 timer.start();
Mike Fiore 14:f9a77400b622 36 while (!CommandTerminal::Dot()->getNetworkJoinStatus()) {
Mike Fiore 14:f9a77400b622 37 CommandTerminal::Serial()->writef("Joining network... ");
Mike Fiore 14:f9a77400b622 38 if (CommandTerminal::Dot()->joinNetworkOnce() == mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 39 CommandTerminal::Serial()->writef("Network Joined\r\n");
Mike Fiore 1:e52ae6584f1c 40 } else {
Mike Fiore 14:f9a77400b622 41 CommandTerminal::Serial()->writef("%s\r\n", CommandTerminal::Dot()->getLastError().c_str());
Mike Fiore 1:e52ae6584f1c 42 }
Mike Fiore 1:e52ae6584f1c 43
Mike Fiore 14:f9a77400b622 44 if (CommandTerminal::waitForEscape(CommandTerminal::Dot()->getNextTxMs())) {
Mike Fiore 1:e52ae6584f1c 45 return 0;
Mike Fiore 1:e52ae6584f1c 46 }
Mike Fiore 1:e52ae6584f1c 47 }
Mike Fiore 14:f9a77400b622 48 } else if (!CommandTerminal::Dot()->getNetworkJoinStatus()) {
Mike Fiore 14:f9a77400b622 49 CommandTerminal::setErrorMessage(mDot::getReturnCodeString(mDot::MDOT_NOT_JOINED));
Mike Fiore 1:e52ae6584f1c 50 return 1;
Mike Fiore 1:e52ae6584f1c 51 }
Mike Fiore 1:e52ae6584f1c 52
Mike Fiore 14:f9a77400b622 53 if ((code = CommandTerminal::Dot()->send(data, CommandTerminal::Dot()->getTxWait())) != mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 54 std::string error = CommandTerminal::Dot()->getLastError();
Mike Fiore 1:e52ae6584f1c 55
Mike Fiore 1:e52ae6584f1c 56 if (code == mDot::MDOT_INVALID_PARAM) {
Mike Fiore 1:e52ae6584f1c 57 return 1;
Mike Fiore 1:e52ae6584f1c 58 } else {
Mike Fiore 14:f9a77400b622 59 CommandTerminal::Serial()->writef("%s\r\n", error.c_str());
Mike Fiore 1:e52ae6584f1c 60 }
Mike Fiore 1:e52ae6584f1c 61 }
Mike Fiore 1:e52ae6584f1c 62
Mike Fiore 1:e52ae6584f1c 63 if (code == mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 64 if (CommandTerminal::waitForEscape(3000, CommandTerminal::Dot(), CommandTerminal::WAIT_SEND)) {
Mike Fiore 1:e52ae6584f1c 65 return 0;
Mike Fiore 1:e52ae6584f1c 66 }
Mike Fiore 1:e52ae6584f1c 67
Mike Fiore 14:f9a77400b622 68 if (CommandTerminal::Dot()->getTxWait() || CommandTerminal::Dot()->getAck() > 0) {
Jason Reiss 28:c222ca8383f4 69 printRecvData();
Mike Fiore 14:f9a77400b622 70 } else if (!CommandTerminal::Dot()->getTxWait()) {
Mike Fiore 14:f9a77400b622 71 CommandTerminal::Dot()->cancelRxWindow();
Mike Fiore 1:e52ae6584f1c 72 }
Mike Fiore 1:e52ae6584f1c 73 }
Mike Fiore 1:e52ae6584f1c 74
Mike Fiore 1:e52ae6584f1c 75 if (CommandTerminal::waitForEscape(interval)) {
Mike Fiore 1:e52ae6584f1c 76 return 0;
Mike Fiore 1:e52ae6584f1c 77 }
Mike Fiore 1:e52ae6584f1c 78 }
Mike Fiore 1:e52ae6584f1c 79 }
Mike Fiore 1:e52ae6584f1c 80
jenkins@jenkinsdm1 18:63f098f042b2 81 bool CmdSendStringOnInterval::verify(const std::vector<std::string>& args) {
Mike Fiore 2:e5eebd74d36d 82 if (args.size() >= 3) {
Mike Fiore 9:ff62b20f7000 83 int interval;
Mike Fiore 2:e5eebd74d36d 84 size_t size = 0;
Mike Fiore 2:e5eebd74d36d 85
Mike Fiore 9:ff62b20f7000 86 if (sscanf(args[1].c_str(), "%d", &interval) != 1) {
Jason Reiss 28:c222ca8383f4 87 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 88 CommandTerminal::setErrorMessage("Invalid argument");
Jason Reiss 28:c222ca8383f4 89 #endif
Mike Fiore 1:e52ae6584f1c 90 return false;
Mike Fiore 1:e52ae6584f1c 91 }
Mike Fiore 1:e52ae6584f1c 92
Mike Fiore 14:f9a77400b622 93 if (interval < 1 || interval > INT_MAX-1) {
Jason Reiss 28:c222ca8383f4 94 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 95 CommandTerminal::setErrorMessage("Invalid interval, expects (1-2147483646) ms");
Jason Reiss 28:c222ca8383f4 96 #endif
Mike Fiore 1:e52ae6584f1c 97 return false;
Mike Fiore 1:e52ae6584f1c 98 }
Mike Fiore 1:e52ae6584f1c 99
Mike Fiore 9:ff62b20f7000 100 for (size_t i = 2; i < args.size() - 1; i++)
Mike Fiore 4:666017851052 101 size += args[i].size() + 1;
Mike Fiore 2:e5eebd74d36d 102 if (size > 242) {
Jason Reiss 28:c222ca8383f4 103 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 104 CommandTerminal::setErrorMessage("Invalid packet, expects (string:242)");
Jason Reiss 28:c222ca8383f4 105 #endif
Mike Fiore 1:e52ae6584f1c 106 return false;
Mike Fiore 1:e52ae6584f1c 107 }
Mike Fiore 1:e52ae6584f1c 108
Mike Fiore 1:e52ae6584f1c 109 return true;
Mike Fiore 1:e52ae6584f1c 110 }
Mike Fiore 1:e52ae6584f1c 111
Jason Reiss 28:c222ca8383f4 112 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 113 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 114 #endif
Mike Fiore 1:e52ae6584f1c 115 return false;
Mike Fiore 1:e52ae6584f1c 116 }