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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 4:666017851052 1 #include "CmdWakeMode.h"
Mike Fiore 4:666017851052 2
Mike Fiore 14:f9a77400b622 3 CmdWakeMode::CmdWakeMode() :
Mike Fiore 14:f9a77400b622 4 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 14:f9a77400b622 5 Command("Wake Mode", "AT+WM", "Wakeup mode, INTERRUPT uses DIO7 as wake-up pin (0:INTERVAL,1:INTERRUPT,2:INTERVAL_OR_INTERRUPT)", "(0:INTERVAL,1:INTERRUPT,2:INTERVAL_OR_INTERRUPT)")
Mike Fiore 14:f9a77400b622 6 #else
Mike Fiore 14:f9a77400b622 7 Command("Wake Mode", "AT+WM", "Wakeup mode, INTERRUPT uses WAKE as wake-up pin (0:INTERVAL,1:INTERRUPT,2:INTERVAL_OR_INTERRUPT)", "(0:INTERVAL,1:INTERRUPT,2:INTERVAL_OR_INTERRUPT)")
Mike Fiore 14:f9a77400b622 8 #endif /* TARGET_MTS_MDOT_F411RE */
Mike Fiore 4:666017851052 9 {
Mike Fiore 4:666017851052 10 _queryable = true;
Mike Fiore 4:666017851052 11 }
Mike Fiore 4:666017851052 12
jenkins@jenkinsdm1 18:63f098f042b2 13 uint32_t CmdWakeMode::action(const std::vector<std::string>& args)
Mike Fiore 4:666017851052 14 {
Mike Fiore 4:666017851052 15 if (args.size() == 1)
Mike Fiore 4:666017851052 16 {
Mike Fiore 14:f9a77400b622 17 CommandTerminal::Serial()->writef("%lu\r\n", CommandTerminal::Dot()->getWakeMode());
Mike Fiore 4:666017851052 18 }
Mike Fiore 4:666017851052 19 else if (args.size() == 2)
Mike Fiore 4:666017851052 20 {
Mike Fiore 9:ff62b20f7000 21 int mode;
Mike Fiore 9:ff62b20f7000 22 sscanf(args[1].c_str(), "%d", &mode);
Mike Fiore 4:666017851052 23
Mike Fiore 14:f9a77400b622 24 if (CommandTerminal::Dot()->setWakeMode(mode) != mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 25 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Mike Fiore 4:666017851052 26 return 1;
Mike Fiore 4:666017851052 27 }
Mike Fiore 4:666017851052 28 }
Mike Fiore 4:666017851052 29
Mike Fiore 4:666017851052 30 return 0;
Mike Fiore 4:666017851052 31 }
Mike Fiore 4:666017851052 32
jenkins@jenkinsdm1 18:63f098f042b2 33 bool CmdWakeMode::verify(const std::vector<std::string>& args)
Mike Fiore 4:666017851052 34 {
Mike Fiore 4:666017851052 35 if (args.size() == 1)
Mike Fiore 4:666017851052 36 return true;
Mike Fiore 4:666017851052 37
Mike Fiore 4:666017851052 38 if (args.size() == 2) {
Mike Fiore 9:ff62b20f7000 39 int mode;
Mike Fiore 9:ff62b20f7000 40 if (sscanf(args[1].c_str(), "%d", &mode) != 1) {
Mike Fiore 14:f9a77400b622 41 CommandTerminal::setErrorMessage("Invalid argument");
Mike Fiore 4:666017851052 42 return false;
Mike Fiore 4:666017851052 43 }
Mike Fiore 4:666017851052 44
Mike Fiore 9:ff62b20f7000 45 if (mode != 0 && mode != 1 && mode != 2) {
Mike Fiore 14:f9a77400b622 46 CommandTerminal::setErrorMessage("Invalid mode, expects (0:INTERVAL,1:INTERRUPT,2:INTERVAL_OR_INTERRUPT)");
Mike Fiore 4:666017851052 47 return false;
Mike Fiore 4:666017851052 48 }
Mike Fiore 4:666017851052 49
Mike Fiore 4:666017851052 50 return true;
Mike Fiore 4:666017851052 51 }
Mike Fiore 4:666017851052 52
Mike Fiore 14:f9a77400b622 53 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 4:666017851052 54 return false;
Mike Fiore 4:666017851052 55 }