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@35:e17e00b8e022, 20 months ago (annotated)

Committer:
Jason Reiss
Date:
Fri Aug 12 11:08:59 2022 -0500
Revision:
35:e17e00b8e022
Parent:
28:c222ca8383f4
Child:
36:b586cd6e91f3
Update AT Version to 4.1.5

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