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@26:35c201bc5205, 2019-05-03 (annotated)

Committer:
jreiss
Date:
Fri May 03 18:49:18 2019 +0000
Revision:
26:35c201bc5205
Parent:
23:4f0a981c0349
Child:
27:5fafd3b26ac3
Update to Dot 3.2.1 release; Remove AutoSleep command; Update mbed-os to 5.11.1;

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