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/CmdTxFrequency.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 1:e52ae6584f1c 1 #include "CmdTxFrequency.h"
Mike Fiore 1:e52ae6584f1c 2 #include <climits>
Mike Fiore 1:e52ae6584f1c 3
Mike Fiore 14:f9a77400b622 4
Mike Fiore 14:f9a77400b622 5 CmdTxFrequency::CmdTxFrequency() :
Jason Reiss 27:5fafd3b26ac3 6 Command("Tx Frequency", "AT+TXF",
Jason Reiss 27:5fafd3b26ac3 7 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 8 "Set Tx frequency",
Jason Reiss 27:5fafd3b26ac3 9 #else
Jason Reiss 27:5fafd3b26ac3 10 "",
Jason Reiss 27:5fafd3b26ac3 11 #endif
Jason Reiss 27:5fafd3b26ac3 12 "SEE PLAN") {
Mike Fiore 1:e52ae6584f1c 13 _queryable = true;
Mike Fiore 1:e52ae6584f1c 14 }
Mike Fiore 1:e52ae6584f1c 15
jenkins@jenkinsdm1 18:63f098f042b2 16 uint32_t CmdTxFrequency::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 {
Mike Fiore 14:f9a77400b622 20 CommandTerminal::Serial()->writef("%lu\r\n", CommandTerminal::Dot()->getTxFrequency());
Mike Fiore 1:e52ae6584f1c 21 }
Mike Fiore 1:e52ae6584f1c 22 else if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 23 {
Mike Fiore 9:ff62b20f7000 24 int frequency = 0;
Mike Fiore 1:e52ae6584f1c 25
Mike Fiore 9:ff62b20f7000 26 sscanf(args[1].c_str(), "%d", &frequency);
Mike Fiore 14:f9a77400b622 27 if (CommandTerminal::Dot()->setTxFrequency(frequency) != mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 28 {
Mike Fiore 14:f9a77400b622 29 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Mike Fiore 1:e52ae6584f1c 30 return 1;
Mike Fiore 1:e52ae6584f1c 31 }
Mike Fiore 1:e52ae6584f1c 32 }
Mike Fiore 1:e52ae6584f1c 33
Mike Fiore 1:e52ae6584f1c 34 return 0;
Mike Fiore 1:e52ae6584f1c 35 }
Mike Fiore 1:e52ae6584f1c 36
jenkins@jenkinsdm1 18:63f098f042b2 37 bool CmdTxFrequency::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 38 {
Mike Fiore 1:e52ae6584f1c 39 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 40 return true;
Mike Fiore 1:e52ae6584f1c 41
Mike Fiore 1:e52ae6584f1c 42 if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 43 {
Mike Fiore 9:ff62b20f7000 44 int frequency = ULONG_MAX;
Mike Fiore 9:ff62b20f7000 45 if (sscanf(args[1].c_str(), "%d", &frequency) != 1) {
Mike Fiore 14:f9a77400b622 46 CommandTerminal::setErrorMessage("Invalid argument");
Mike Fiore 1:e52ae6584f1c 47 return false;
Mike Fiore 1:e52ae6584f1c 48 }
Mike Fiore 1:e52ae6584f1c 49
Mike Fiore 14:f9a77400b622 50 if (frequency != 0 && (frequency < int(CommandTerminal::Dot()->getMinFrequency()) || frequency > int(CommandTerminal::Dot()->getMaxFrequency()))) {
jenkins@jenkinsdm1 16:d5cf2af81a6d 51 char tmp[256];
jenkins@jenkinsdm1 16:d5cf2af81a6d 52 sprintf(tmp, "Invalid frequency, expects (0,%lu-%lu)", CommandTerminal::Dot()->getMinFrequency(), CommandTerminal::Dot()->getMaxFrequency());
jenkins@jenkinsdm1 16:d5cf2af81a6d 53 CommandTerminal::setErrorMessage(tmp);
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
Mike Fiore 14:f9a77400b622 60 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 61 return false;
Mike Fiore 1:e52ae6584f1c 62 }
Mike Fiore 1:e52ae6584f1c 63