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/CmdPublicNetwork.cpp@1:e52ae6584f1c, 2015-06-25 (annotated)

Committer:
Mike Fiore
Date:
Thu Jun 25 10:23:41 2015 -0500
Revision:
1:e52ae6584f1c
Child:
9:ff62b20f7000
update debug, add command source files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdPublicNetwork.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 1:e52ae6584f1c 3 CmdPublicNetwork::CmdPublicNetwork(mDot* dot, mts::MTSSerial& serial) :
Mike Fiore 1:e52ae6584f1c 4 Command(dot, "Public Network", "AT+PN", "Enable/disable public network mode. (0: off, 1: on)"), _serial(serial)
Mike Fiore 1:e52ae6584f1c 5 {
Mike Fiore 1:e52ae6584f1c 6 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 1:e52ae6584f1c 7 _usage = "(0,1)";
Mike Fiore 1:e52ae6584f1c 8 _queryable = true;
Mike Fiore 1:e52ae6584f1c 9 }
Mike Fiore 1:e52ae6584f1c 10
Mike Fiore 1:e52ae6584f1c 11 uint32_t CmdPublicNetwork::action(std::vector<std::string> args)
Mike Fiore 1:e52ae6584f1c 12 {
Mike Fiore 1:e52ae6584f1c 13 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 14 {
Mike Fiore 1:e52ae6584f1c 15 if (_dot->getVerbose())
Mike Fiore 1:e52ae6584f1c 16 _serial.writef("%s: ", name());
Mike Fiore 1:e52ae6584f1c 17
Mike Fiore 1:e52ae6584f1c 18 _serial.writef("%d\r\n", _dot->getPublicNetwork());
Mike Fiore 1:e52ae6584f1c 19 }
Mike Fiore 1:e52ae6584f1c 20 else if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 21 {
Mike Fiore 1:e52ae6584f1c 22 int32_t code;
Mike Fiore 1:e52ae6584f1c 23 bool enable = (args[1] == "1");
Mike Fiore 1:e52ae6584f1c 24
Mike Fiore 1:e52ae6584f1c 25 if ((code = _dot->setPublicNetwork(enable)) != mDot::MDOT_OK) {
Mike Fiore 1:e52ae6584f1c 26 std::string error = mDot::getReturnCodeString(code) + " - " + _dot->getLastError();
Mike Fiore 1:e52ae6584f1c 27 setErrorMessage(error);
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
Mike Fiore 1:e52ae6584f1c 35 bool CmdPublicNetwork::verify(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 1:e52ae6584f1c 42 if (args[1] != "1" && args[1] != "0") {
Mike Fiore 1:e52ae6584f1c 43 setErrorMessage("Invalid parameter, expects (0: off, 1: on)");
Mike Fiore 1:e52ae6584f1c 44 return false;
Mike Fiore 1:e52ae6584f1c 45 }
Mike Fiore 1:e52ae6584f1c 46
Mike Fiore 1:e52ae6584f1c 47 return true;
Mike Fiore 1:e52ae6584f1c 48 }
Mike Fiore 1:e52ae6584f1c 49
Mike Fiore 1:e52ae6584f1c 50 setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 51 return false;
Mike Fiore 1:e52ae6584f1c 52 }