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/CmdTxPower.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
Child:
36:b586cd6e91f3
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdTxPower.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 14:f9a77400b622 3 CmdTxPower::CmdTxPower() :
Jason Reiss 28:c222ca8383f4 4 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 5 Command("Tx Power", "AT+TXP", "Set the radio TX power before antenna gain in dBm", "(Depends on Channel Plan)")
Jason Reiss 27:5fafd3b26ac3 6 #else
Jason Reiss 28:c222ca8383f4 7 Command("AT+TXP")
Jason Reiss 27:5fafd3b26ac3 8 #endif
Jason Reiss 28:c222ca8383f4 9 {
Mike Fiore 1:e52ae6584f1c 10 _queryable = true;
Mike Fiore 1:e52ae6584f1c 11 }
Mike Fiore 1:e52ae6584f1c 12
jenkins@jenkinsdm1 18:63f098f042b2 13 uint32_t CmdTxPower::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 14 {
Mike Fiore 1:e52ae6584f1c 15 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 16 {
Mike Fiore 14:f9a77400b622 17 CommandTerminal::Serial()->writef("%lu\r\n", CommandTerminal::Dot()->getTxPower());
Mike Fiore 1:e52ae6584f1c 18 }
Mike Fiore 1:e52ae6584f1c 19 else if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 20 {
Mike Fiore 9:ff62b20f7000 21 int power = 0;
Mike Fiore 9:ff62b20f7000 22 sscanf(args[1].c_str(), "%d", &power);
Mike Fiore 1:e52ae6584f1c 23
Mike Fiore 14:f9a77400b622 24 if (CommandTerminal::Dot()->setTxPower(power) != mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 25 {
Mike Fiore 1:e52ae6584f1c 26 return 1;
Mike Fiore 1:e52ae6584f1c 27 }
Mike Fiore 1:e52ae6584f1c 28 }
Mike Fiore 1:e52ae6584f1c 29
Mike Fiore 1:e52ae6584f1c 30 return 0;
Mike Fiore 1:e52ae6584f1c 31 }
Mike Fiore 1:e52ae6584f1c 32
jenkins@jenkinsdm1 18:63f098f042b2 33 bool CmdTxPower::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 34 {
Mike Fiore 1:e52ae6584f1c 35 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 36 return true;
Mike Fiore 1:e52ae6584f1c 37
Mike Fiore 1:e52ae6584f1c 38 if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 39 {
Mike Fiore 9:ff62b20f7000 40 int power = 0;
Mike Fiore 9:ff62b20f7000 41 if (sscanf(args[1].c_str(), "%d", &power) != 1) {
Jason Reiss 28:c222ca8383f4 42 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 43 CommandTerminal::setErrorMessage("Invalid argument");
Jason Reiss 28:c222ca8383f4 44 #endif
Mike Fiore 1:e52ae6584f1c 45 return false;
Mike Fiore 1:e52ae6584f1c 46 }
Mike Fiore 1:e52ae6584f1c 47
jenkins@jenkinsdm1 16:d5cf2af81a6d 48 if (power < CommandTerminal::Dot()->getMinTxPower() || power > CommandTerminal::Dot()->getMaxTxPower())
Mike Fiore 1:e52ae6584f1c 49 {
Jason Reiss 28:c222ca8383f4 50 #if MTS_CMD_TERM_VERBOSE
jenkins@jenkinsdm1 16:d5cf2af81a6d 51 char buf[8];
jenkins@jenkinsdm1 16:d5cf2af81a6d 52 std::string error = "Invalid power, expects ";
jenkins@jenkinsdm1 16:d5cf2af81a6d 53 snprintf(buf, sizeof(buf), "(%d-%d)", CommandTerminal::Dot()->getMinTxPower(), CommandTerminal::Dot()->getMaxTxPower());
jenkins@jenkinsdm1 16:d5cf2af81a6d 54 error.append(buf);
jenkins@jenkinsdm1 16:d5cf2af81a6d 55 CommandTerminal::setErrorMessage(error);
Jason Reiss 28:c222ca8383f4 56 #endif
Mike Fiore 1:e52ae6584f1c 57 return false;
Mike Fiore 1:e52ae6584f1c 58 }
Mike Fiore 1:e52ae6584f1c 59
Mike Fiore 1:e52ae6584f1c 60 return true;
Mike Fiore 1:e52ae6584f1c 61 }
Mike Fiore 1:e52ae6584f1c 62
Jason Reiss 28:c222ca8383f4 63 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 64 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 65 #endif
Mike Fiore 1:e52ae6584f1c 66 return false;
Mike Fiore 1:e52ae6584f1c 67 }
Mike Fiore 1:e52ae6584f1c 68