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/CmdAdaptiveDataRate.cpp@42:23e2df6714f4, 6 months ago (annotated)

Committer:
Jason Reiss
Date:
Wed Dec 06 13:33:52 2023 -0600
Revision:
42:23e2df6714f4
Parent:
36:b586cd6e91f3 
TestMode: reset appnonce to 0 on reset to accomodate LCTT 3.12.0 and earlier. If the test suite changes to test AppNonce loaded from NVM this will fail tests.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdAdaptiveDataRate.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 1:e52ae6584f1c 3
Mike Fiore 14:f9a77400b622 4 CmdAdaptiveDataRate::CmdAdaptiveDataRate() :
Jason Reiss 28:c222ca8383f4 5 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 36:b586cd6e91f3 6 Command("Adaptive Data Rate", "AT+ADR", "Enable/disable ADR(0:off,1: on),[ADR_ACK_LIMIT(1-127)],[ADR_ACK_DELAY(1-127)],Auto Inc DR(0:off,1:on)", "(0,1),(1,127),(1,127),(0,1)")
Jason Reiss 27:5fafd3b26ac3 7 #else
Jason Reiss 28:c222ca8383f4 8 Command("AT+ADR")
Jason Reiss 27:5fafd3b26ac3 9 #endif
Mike Fiore 1:e52ae6584f1c 10 {
Mike Fiore 1:e52ae6584f1c 11 _queryable = true;
Mike Fiore 1:e52ae6584f1c 12 }
Mike Fiore 1:e52ae6584f1c 13
jenkins@jenkinsdm1 18:63f098f042b2 14 uint32_t CmdAdaptiveDataRate::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 15 {
Mike Fiore 1:e52ae6584f1c 16 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 17 {
Jason Reiss 36:b586cd6e91f3 18 CommandTerminal::Serial()->writef("%d, %d, %d, %d\r\n",
Jason Reiss 23:4f0a981c0349 19 CommandTerminal::Dot()->getAdr(),
Jason Reiss 23:4f0a981c0349 20 CommandTerminal::Dot()->getAdrAckLimit(),
Jason Reiss 36:b586cd6e91f3 21 CommandTerminal::Dot()->getAdrAckDelay(),
Jason Reiss 36:b586cd6e91f3 22 !CommandTerminal::Dot()->getDisableIncrementDR());
Mike Fiore 1:e52ae6584f1c 23 }
Jason Reiss 23:4f0a981c0349 24 else if (args.size() > 1)
Mike Fiore 1:e52ae6584f1c 25 {
Mike Fiore 1:e52ae6584f1c 26 bool enable = (args[1] == "1");
Mike Fiore 14:f9a77400b622 27 if (CommandTerminal::Dot()->setAdr(enable) != mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 28 {
Mike Fiore 1:e52ae6584f1c 29 return 1;
Mike Fiore 1:e52ae6584f1c 30 }
Jason Reiss 23:4f0a981c0349 31
Jason Reiss 23:4f0a981c0349 32 if (args.size() > 2)
Jason Reiss 23:4f0a981c0349 33 {
Jason Reiss 23:4f0a981c0349 34 int input;
Jason Reiss 23:4f0a981c0349 35 sscanf(args[2].c_str(), "%d", &input);
Jason Reiss 23:4f0a981c0349 36 CommandTerminal::Dot()->setAdrAckLimit(input);
Jason Reiss 23:4f0a981c0349 37
Jason Reiss 23:4f0a981c0349 38 if (args.size() > 3)
Jason Reiss 23:4f0a981c0349 39 {
Jason Reiss 23:4f0a981c0349 40 sscanf(args[3].c_str(), "%d", &input);
Jason Reiss 23:4f0a981c0349 41 CommandTerminal::Dot()->setAdrAckDelay(input);
Jason Reiss 23:4f0a981c0349 42 }
Jason Reiss 36:b586cd6e91f3 43
Jason Reiss 36:b586cd6e91f3 44 if ((args.size() > 4) && (args[4] == "0" || args[4] == "1")) {
Jason Reiss 36:b586cd6e91f3 45 // input 1:on = false because setting true disables
Jason Reiss 36:b586cd6e91f3 46 CommandTerminal::Dot()->setDisableIncrementDR(args[4] == "0");
Jason Reiss 36:b586cd6e91f3 47 }
Jason Reiss 23:4f0a981c0349 48 }
Mike Fiore 1:e52ae6584f1c 49 }
Mike Fiore 1:e52ae6584f1c 50
Mike Fiore 1:e52ae6584f1c 51 return 0;
Mike Fiore 1:e52ae6584f1c 52 }
Mike Fiore 1:e52ae6584f1c 53
jenkins@jenkinsdm1 18:63f098f042b2 54 bool CmdAdaptiveDataRate::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 55 {
Mike Fiore 1:e52ae6584f1c 56 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 57 return true;
Mike Fiore 1:e52ae6584f1c 58
Jason Reiss 28:c222ca8383f4 59 if (args[1] != "1" && args[1] != "0") {
Jason Reiss 28:c222ca8383f4 60 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 36:b586cd6e91f3 61 CommandTerminal::setErrorMessage("Invalid parameter1, expects (0: off, 1: on)");
Jason Reiss 28:c222ca8383f4 62 #endif
Jason Reiss 28:c222ca8383f4 63 return false;
Jason Reiss 28:c222ca8383f4 64 }
Jason Reiss 36:b586cd6e91f3 65
Jason Reiss 28:c222ca8383f4 66 int input;
Jason Reiss 28:c222ca8383f4 67
Jason Reiss 28:c222ca8383f4 68 if (args.size() == 2) {
Jason Reiss 28:c222ca8383f4 69 return true;
Jason Reiss 28:c222ca8383f4 70 } else {
Jason Reiss 28:c222ca8383f4 71 sscanf(args[2].c_str(), "%d", &input);
Jason Reiss 28:c222ca8383f4 72
Jason Reiss 28:c222ca8383f4 73 if (input < 1 || input > 127) {
Jason Reiss 28:c222ca8383f4 74 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 36:b586cd6e91f3 75 CommandTerminal::setErrorMessage("Invalid parameter2, expects ADR_ACK_LIMIT (1-127)");
Jason Reiss 28:c222ca8383f4 76 #endif
Mike Fiore 1:e52ae6584f1c 77 return false;
Mike Fiore 1:e52ae6584f1c 78 }
Mike Fiore 1:e52ae6584f1c 79 }
Mike Fiore 1:e52ae6584f1c 80
Jason Reiss 23:4f0a981c0349 81 if (args.size() == 3)
Jason Reiss 23:4f0a981c0349 82 {
Jason Reiss 28:c222ca8383f4 83 return true;
Jason Reiss 28:c222ca8383f4 84 } else {
Jason Reiss 28:c222ca8383f4 85 sscanf(args[3].c_str(), "%d", &input);
Jason Reiss 28:c222ca8383f4 86 if (input < 1 || input > 127) {
Jason Reiss 28:c222ca8383f4 87 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 36:b586cd6e91f3 88 CommandTerminal::setErrorMessage("Invalid parameter3, expects ADR_ACK_DELAY (1-127)");
Jason Reiss 28:c222ca8383f4 89 #endif
Jason Reiss 23:4f0a981c0349 90 return false;
Jason Reiss 23:4f0a981c0349 91 }
Jason Reiss 28:c222ca8383f4 92 }
Jason Reiss 23:4f0a981c0349 93
Jason Reiss 28:c222ca8383f4 94 if (args.size() == 4) {
Jason Reiss 23:4f0a981c0349 95 return true;
Jason Reiss 23:4f0a981c0349 96 }
Jason Reiss 23:4f0a981c0349 97
Jason Reiss 36:b586cd6e91f3 98 if (args[4] != "0" && args[4] != "1") {
Jason Reiss 36:b586cd6e91f3 99 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 36:b586cd6e91f3 100 CommandTerminal::setErrorMessage("Invalid parameter4, expects (0: off, 1: on)");
Jason Reiss 36:b586cd6e91f3 101 #endif
Jason Reiss 36:b586cd6e91f3 102 return false;
Jason Reiss 36:b586cd6e91f3 103 }
Jason Reiss 36:b586cd6e91f3 104
Jason Reiss 36:b586cd6e91f3 105 if (args.size() == 5) {
Jason Reiss 36:b586cd6e91f3 106 return true;
Jason Reiss 36:b586cd6e91f3 107 }
Jason Reiss 36:b586cd6e91f3 108
Jason Reiss 28:c222ca8383f4 109 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 110 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 111 #endif
Mike Fiore 1:e52ae6584f1c 112 return false;
Mike Fiore 1:e52ae6584f1c 113 }