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@18:63f098f042b2, 2019-03-08 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Fri Mar 08 11:37:37 2019 -0600
Revision:
18:63f098f042b2
Parent:
16:d5cf2af81a6d
Child:
27:5fafd3b26ac3
mdot-firmware revision 3.1.0

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