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@27:5fafd3b26ac3, 2020-09-11 (annotated)

Committer:
Jason Reiss
Date:
Fri Sep 11 13:16:33 2020 -0500
Revision:
27:5fafd3b26ac3
Parent:
23:4f0a981c0349
Child:
28:c222ca8383f4
Update to Dot 3.3.6

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