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/CmdAppPort.cpp@33:5c0252521669, 2021-01-29 (annotated)

Committer:
Jason Reiss
Date:
Fri Jan 29 13:04:32 2021 -0600
Revision:
33:5c0252521669
Parent:
28:c222ca8383f4 
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 9:ff62b20f7000 1 /*
Mike Fiore 9:ff62b20f7000 2 * CmdAppPort.cpp
Mike Fiore 9:ff62b20f7000 3 *
Mike Fiore 9:ff62b20f7000 4 * Created on: Nov 4, 2015
Mike Fiore 9:ff62b20f7000 5 * Author: jreiss
Mike Fiore 9:ff62b20f7000 6 */
Mike Fiore 9:ff62b20f7000 7
Mike Fiore 9:ff62b20f7000 8 #include "CmdAppPort.h"
Mike Fiore 9:ff62b20f7000 9
Jason Reiss 28:c222ca8383f4 10 CmdAppPort::CmdAppPort() :
Jason Reiss 28:c222ca8383f4 11 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 12 Command("App Port", "AT+AP", "Port used for application data (1 - 223)", "(1-223)")
Jason Reiss 27:5fafd3b26ac3 13 #else
Jason Reiss 28:c222ca8383f4 14 Command("AT+AP")
Jason Reiss 27:5fafd3b26ac3 15 #endif
Mike Fiore 9:ff62b20f7000 16 {
Mike Fiore 9:ff62b20f7000 17 _queryable = true;
Mike Fiore 9:ff62b20f7000 18 }
Mike Fiore 9:ff62b20f7000 19
Mike Fiore 9:ff62b20f7000 20 CmdAppPort::~CmdAppPort()
Mike Fiore 9:ff62b20f7000 21 {
Mike Fiore 9:ff62b20f7000 22 // TODO Auto-generated destructor stub
Mike Fiore 9:ff62b20f7000 23 }
Mike Fiore 9:ff62b20f7000 24
jenkins@jenkinsdm1 18:63f098f042b2 25 uint32_t CmdAppPort::action(const std::vector<std::string>& args) {
Mike Fiore 9:ff62b20f7000 26 if (args.size() == 1) {
Mike Fiore 14:f9a77400b622 27 CommandTerminal::Serial()->writef("%u\r\n", CommandTerminal::Dot()->getAppPort());
Mike Fiore 9:ff62b20f7000 28 } else if (args.size() == 2) {
Jason Reiss 27:5fafd3b26ac3 29
Mike Fiore 9:ff62b20f7000 30 int appPort;
Mike Fiore 9:ff62b20f7000 31 sscanf(args[1].c_str(), "%d", &appPort);
Mike Fiore 9:ff62b20f7000 32
Mike Fiore 14:f9a77400b622 33 if (CommandTerminal::Dot()->setAppPort(appPort) != mDot::MDOT_OK) {
Mike Fiore 9:ff62b20f7000 34 return 1;
Mike Fiore 9:ff62b20f7000 35 }
Mike Fiore 9:ff62b20f7000 36 }
Mike Fiore 9:ff62b20f7000 37 return 0;
Mike Fiore 9:ff62b20f7000 38 }
Mike Fiore 9:ff62b20f7000 39
jenkins@jenkinsdm1 18:63f098f042b2 40 bool CmdAppPort::verify(const std::vector<std::string>& args) {
Mike Fiore 9:ff62b20f7000 41 if (args.size() == 1)
Mike Fiore 9:ff62b20f7000 42 return true;
Mike Fiore 9:ff62b20f7000 43
Mike Fiore 9:ff62b20f7000 44 if (args.size() == 2) {
Mike Fiore 9:ff62b20f7000 45
Mike Fiore 9:ff62b20f7000 46 int appPort;
Mike Fiore 9:ff62b20f7000 47 if (sscanf(args[1].c_str(), "%d", &appPort) == 1) {
Mike Fiore 9:ff62b20f7000 48 if (appPort > 223 || appPort < 1) {
Jason Reiss 28:c222ca8383f4 49 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 50 CommandTerminal::setErrorMessage("Invalid app port, expects (1-223)");
Jason Reiss 28:c222ca8383f4 51 #endif
Mike Fiore 9:ff62b20f7000 52 return false;
Mike Fiore 9:ff62b20f7000 53 }
Mike Fiore 9:ff62b20f7000 54 return true;
Mike Fiore 9:ff62b20f7000 55 }
Mike Fiore 9:ff62b20f7000 56 }
Mike Fiore 9:ff62b20f7000 57
Jason Reiss 28:c222ca8383f4 58 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 59 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 60 #endif
Mike Fiore 9:ff62b20f7000 61 return false;
Mike Fiore 9:ff62b20f7000 62 }