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@35:e17e00b8e022, 21 months ago (annotated)

Committer:
Jason Reiss
Date:
Fri Aug 12 11:08:59 2022 -0500
Revision:
35:e17e00b8e022
Parent:
28:c222ca8383f4
Child:
36:b586cd6e91f3
Update AT Version to 4.1.5

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 28:c222ca8383f4 6 Command("Adaptive Data Rate", "AT+ADR", "Enable/disable Adaptive Data Rate (0: off, 1: on), [ADR_ACK_LIMIT (1-127)], [ADR_ACK_DELAY (1-127)]", "(0,1), (1,127), (1,127)")
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 23:4f0a981c0349 18 CommandTerminal::Serial()->writef("%d, %d, %d\r\n",
Jason Reiss 23:4f0a981c0349 19 CommandTerminal::Dot()->getAdr(),
Jason Reiss 23:4f0a981c0349 20 CommandTerminal::Dot()->getAdrAckLimit(),
Jason Reiss 23:4f0a981c0349 21 CommandTerminal::Dot()->getAdrAckDelay());
Mike Fiore 1:e52ae6584f1c 22 }
Jason Reiss 23:4f0a981c0349 23 else if (args.size() > 1)
Mike Fiore 1:e52ae6584f1c 24 {
Mike Fiore 1:e52ae6584f1c 25 bool enable = (args[1] == "1");
Mike Fiore 14:f9a77400b622 26 if (CommandTerminal::Dot()->setAdr(enable) != mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 27 {
Mike Fiore 1:e52ae6584f1c 28 return 1;
Mike Fiore 1:e52ae6584f1c 29 }
Jason Reiss 23:4f0a981c0349 30
Jason Reiss 23:4f0a981c0349 31 if (args.size() > 2)
Jason Reiss 23:4f0a981c0349 32 {
Jason Reiss 23:4f0a981c0349 33 int input;
Jason Reiss 23:4f0a981c0349 34 sscanf(args[2].c_str(), "%d", &input);
Jason Reiss 23:4f0a981c0349 35 CommandTerminal::Dot()->setAdrAckLimit(input);
Jason Reiss 23:4f0a981c0349 36
Jason Reiss 23:4f0a981c0349 37 if (args.size() > 3)
Jason Reiss 23:4f0a981c0349 38 {
Jason Reiss 23:4f0a981c0349 39 sscanf(args[3].c_str(), "%d", &input);
Jason Reiss 23:4f0a981c0349 40 CommandTerminal::Dot()->setAdrAckDelay(input);
Jason Reiss 23:4f0a981c0349 41 }
Jason Reiss 23:4f0a981c0349 42 }
Mike Fiore 1:e52ae6584f1c 43 }
Mike Fiore 1:e52ae6584f1c 44
Mike Fiore 1:e52ae6584f1c 45 return 0;
Mike Fiore 1:e52ae6584f1c 46 }
Mike Fiore 1:e52ae6584f1c 47
jenkins@jenkinsdm1 18:63f098f042b2 48 bool CmdAdaptiveDataRate::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 49 {
Mike Fiore 1:e52ae6584f1c 50 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 51 return true;
Mike Fiore 1:e52ae6584f1c 52
Jason Reiss 28:c222ca8383f4 53 if (args[1] != "1" && args[1] != "0") {
Jason Reiss 28:c222ca8383f4 54 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 55 CommandTerminal::setErrorMessage("Invalid parameter, expects (0: off, 1: on)");
Jason Reiss 28:c222ca8383f4 56 #endif
Jason Reiss 28:c222ca8383f4 57 return false;
Jason Reiss 28:c222ca8383f4 58 }
Jason Reiss 28:c222ca8383f4 59
Jason Reiss 28:c222ca8383f4 60 int input;
Jason Reiss 28:c222ca8383f4 61
Jason Reiss 28:c222ca8383f4 62 if (args.size() == 2) {
Jason Reiss 28:c222ca8383f4 63 return true;
Jason Reiss 28:c222ca8383f4 64 } else {
Jason Reiss 28:c222ca8383f4 65 sscanf(args[2].c_str(), "%d", &input);
Jason Reiss 28:c222ca8383f4 66
Jason Reiss 28:c222ca8383f4 67 if (input < 1 || input > 127) {
Jason Reiss 28:c222ca8383f4 68 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 69 CommandTerminal::setErrorMessage("Invalid parameter, expects ADR_ACK_LIMIT (1-127)");
Jason Reiss 28:c222ca8383f4 70 #endif
Mike Fiore 1:e52ae6584f1c 71 return false;
Mike Fiore 1:e52ae6584f1c 72 }
Mike Fiore 1:e52ae6584f1c 73 }
Mike Fiore 1:e52ae6584f1c 74
Jason Reiss 23:4f0a981c0349 75 if (args.size() == 3)
Jason Reiss 23:4f0a981c0349 76 {
Jason Reiss 28:c222ca8383f4 77 return true;
Jason Reiss 28:c222ca8383f4 78 } else {
Jason Reiss 28:c222ca8383f4 79 sscanf(args[3].c_str(), "%d", &input);
Jason Reiss 28:c222ca8383f4 80 if (input < 1 || input > 127) {
Jason Reiss 28:c222ca8383f4 81 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 82 CommandTerminal::setErrorMessage("Invalid parameter, expects ADR_ACK_DELAY (1-127)");
Jason Reiss 28:c222ca8383f4 83 #endif
Jason Reiss 23:4f0a981c0349 84 return false;
Jason Reiss 23:4f0a981c0349 85 }
Jason Reiss 28:c222ca8383f4 86 }
Jason Reiss 23:4f0a981c0349 87
Jason Reiss 28:c222ca8383f4 88 if (args.size() == 4) {
Jason Reiss 23:4f0a981c0349 89 return true;
Jason Reiss 23:4f0a981c0349 90 }
Jason Reiss 23:4f0a981c0349 91
Jason Reiss 28:c222ca8383f4 92 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 93 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 94 #endif
Mike Fiore 1:e52ae6584f1c 95 return false;
Mike Fiore 1:e52ae6584f1c 96 }