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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 9:ff62b20f7000 1 #include "CmdAntennaGain.h"
Mike Fiore 9:ff62b20f7000 2
Jason Reiss 27:5fafd3b26ac3 3 CmdAntennaGain::CmdAntennaGain() : Command("Antenna Gain", "AT+ANT",
Jason Reiss 27:5fafd3b26ac3 4 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 5 "Gain in dBi of installed antenna (-128-127)",
Jason Reiss 27:5fafd3b26ac3 6 #else
Jason Reiss 27:5fafd3b26ac3 7 "",
Jason Reiss 27:5fafd3b26ac3 8 #endif
Jason Reiss 27:5fafd3b26ac3 9 "(-128-127)")
Mike Fiore 9:ff62b20f7000 10 {
Mike Fiore 9:ff62b20f7000 11 _queryable = true;
Mike Fiore 9:ff62b20f7000 12 }
Mike Fiore 9:ff62b20f7000 13
jenkins@jenkinsdm1 18:63f098f042b2 14 uint32_t CmdAntennaGain::action(const std::vector<std::string>& args)
Mike Fiore 9:ff62b20f7000 15 {
Mike Fiore 9:ff62b20f7000 16 if (args.size() == 1)
Mike Fiore 9:ff62b20f7000 17 {
Mike Fiore 14:f9a77400b622 18 CommandTerminal::Serial()->writef("%d\r\n", CommandTerminal::Dot()->getAntennaGain());
Mike Fiore 9:ff62b20f7000 19 }
Mike Fiore 9:ff62b20f7000 20 else if (args.size() == 2)
Mike Fiore 9:ff62b20f7000 21 {
Jason Reiss 27:5fafd3b26ac3 22
Mike Fiore 9:ff62b20f7000 23 int gain;
Mike Fiore 9:ff62b20f7000 24 sscanf(args[1].c_str(), "%d", &gain);
Mike Fiore 9:ff62b20f7000 25
Mike Fiore 14:f9a77400b622 26 if (CommandTerminal::Dot()->setAntennaGain(gain) != mDot::MDOT_OK)
Mike Fiore 9:ff62b20f7000 27 {
Mike Fiore 14:f9a77400b622 28 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
Mike Fiore 9:ff62b20f7000 29 return 1;
Mike Fiore 9:ff62b20f7000 30 }
Mike Fiore 9:ff62b20f7000 31 }
Mike Fiore 9:ff62b20f7000 32
Mike Fiore 9:ff62b20f7000 33 return 0;
Mike Fiore 9:ff62b20f7000 34 }
Mike Fiore 9:ff62b20f7000 35
jenkins@jenkinsdm1 18:63f098f042b2 36 bool CmdAntennaGain::verify(const std::vector<std::string>& args)
Mike Fiore 9:ff62b20f7000 37 {
Mike Fiore 9:ff62b20f7000 38 if (args.size() == 1)
Mike Fiore 9:ff62b20f7000 39 return true;
Mike Fiore 9:ff62b20f7000 40
Mike Fiore 9:ff62b20f7000 41 if (args.size() == 2)
Mike Fiore 9:ff62b20f7000 42 {
Mike Fiore 9:ff62b20f7000 43 int gain;
Mike Fiore 9:ff62b20f7000 44 if (sscanf(args[1].c_str(), "%d", &gain) != 1) {
Mike Fiore 14:f9a77400b622 45 CommandTerminal::setErrorMessage("Invalid argument");
Mike Fiore 9:ff62b20f7000 46 return false;
Mike Fiore 9:ff62b20f7000 47 }
Mike Fiore 9:ff62b20f7000 48
Mike Fiore 9:ff62b20f7000 49 if (gain < -128 || gain > 127) {
jenkins@jenkinsdm1 18:63f098f042b2 50 CommandTerminal::setErrorMessage("Invalid gain, expects (-128-127)");
Mike Fiore 9:ff62b20f7000 51 return false;
Mike Fiore 9:ff62b20f7000 52 }
Mike Fiore 9:ff62b20f7000 53
Mike Fiore 9:ff62b20f7000 54 return true;
Mike Fiore 9:ff62b20f7000 55 }
Mike Fiore 9:ff62b20f7000 56
Mike Fiore 14:f9a77400b622 57 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 9:ff62b20f7000 58 return false;
Mike Fiore 9:ff62b20f7000 59 }