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

Committer:
Jason Reiss
Date:
Fri Sep 11 13:16:33 2020 -0500
Revision:
27:5fafd3b26ac3
Parent:
23:4f0a981c0349
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 "CmdRxOutput.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 14:f9a77400b622 3 CmdRxOutput::CmdRxOutput() :
Jason Reiss 27:5fafd3b26ac3 4 Command("Rx Output", "AT+RXO",
Jason Reiss 27:5fafd3b26ac3 5 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 6 "Set the Rx output type (0:hexadecimal, 1:raw, 2:extended, 3:extended_hex)",
Jason Reiss 27:5fafd3b26ac3 7 #else
Jason Reiss 27:5fafd3b26ac3 8 "",
Jason Reiss 27:5fafd3b26ac3 9 #endif
Jason Reiss 27:5fafd3b26ac3 10 "(0-3)")
Mike Fiore 1:e52ae6584f1c 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 CmdRxOutput::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("%u\r\n", CommandTerminal::Dot()->getRxOutput());
Mike Fiore 1:e52ae6584f1c 20 }
Mike Fiore 1:e52ae6584f1c 21 else if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 22 {
Jason Reiss 23:4f0a981c0349 23 uint8_t output = 0xFF;
Jason Reiss 23:4f0a981c0349 24
Jason Reiss 23:4f0a981c0349 25 if(args[1] == "0") output = 0;
Jason Reiss 23:4f0a981c0349 26 else if(args[1] == "1") output = 1;
Jason Reiss 23:4f0a981c0349 27 else if(args[1] == "2") output = 2;
Jason Reiss 27:5fafd3b26ac3 28 else if(args[1] == "3") output = 3;
Jason Reiss 23:4f0a981c0349 29
Mike Fiore 14:f9a77400b622 30 if (CommandTerminal::Dot()->setRxOutput(output) != mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 31 {
Mike Fiore 14:f9a77400b622 32 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Mike Fiore 1:e52ae6584f1c 33 return 1;
Mike Fiore 1:e52ae6584f1c 34 }
Mike Fiore 1:e52ae6584f1c 35 }
Mike Fiore 1:e52ae6584f1c 36
Mike Fiore 1:e52ae6584f1c 37 return 0;
Mike Fiore 1:e52ae6584f1c 38 }
Mike Fiore 1:e52ae6584f1c 39
jenkins@jenkinsdm1 18:63f098f042b2 40 bool CmdRxOutput::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 41 {
Mike Fiore 1:e52ae6584f1c 42 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 43 return true;
Mike Fiore 1:e52ae6584f1c 44
Mike Fiore 1:e52ae6584f1c 45 if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 46 {
Jason Reiss 27:5fafd3b26ac3 47 if (!(args[1] == "0" || args[1] == "1" || args[1] == "2" || args[1] == "3")) {
Jason Reiss 27:5fafd3b26ac3 48 CommandTerminal::setErrorMessage("Invalid type, expects (0:hexadecimal, 1:raw, 2:extended, 3:extended_hex)");
Mike Fiore 1:e52ae6584f1c 49 return false;
Mike Fiore 1:e52ae6584f1c 50 }
Mike Fiore 1:e52ae6584f1c 51
Mike Fiore 1:e52ae6584f1c 52 return true;
Mike Fiore 1:e52ae6584f1c 53 }
Mike Fiore 1:e52ae6584f1c 54
Mike Fiore 14:f9a77400b622 55 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 56 return false;
Mike Fiore 1:e52ae6584f1c 57 }