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/CmdPreserveSession.cpp@9:ff62b20f7000, 2016-04-04 (annotated)

Committer:
Mike Fiore
Date:
Mon Apr 04 09:00:31 2016 -0500
Revision:
9:ff62b20f7000
Child:
14:f9a77400b622
update to version 1.0.8 of AT firmware

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 9:ff62b20f7000 1 /*
Mike Fiore 9:ff62b20f7000 2 * CmdPreserveSession.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 "CmdPreserveSession.h"
Mike Fiore 9:ff62b20f7000 9
Mike Fiore 9:ff62b20f7000 10 CmdPreserveSession::CmdPreserveSession(mDot* dot, mts::MTSSerial& serial)
Mike Fiore 9:ff62b20f7000 11 :
Mike Fiore 9:ff62b20f7000 12 Command(dot, "Preserve Session", "AT+PS", "Save network session info through reset or power down in AUTO_OTA mode (0:off, 1:on)"),
Mike Fiore 9:ff62b20f7000 13 _serial(serial)
Mike Fiore 9:ff62b20f7000 14 {
Mike Fiore 9:ff62b20f7000 15 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 9:ff62b20f7000 16 _usage = "(0,1)";
Mike Fiore 9:ff62b20f7000 17 _queryable = true;
Mike Fiore 9:ff62b20f7000 18 }
Mike Fiore 9:ff62b20f7000 19
Mike Fiore 9:ff62b20f7000 20 CmdPreserveSession::~CmdPreserveSession()
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
Mike Fiore 9:ff62b20f7000 25 uint32_t CmdPreserveSession::action(std::vector<std::string> args) {
Mike Fiore 9:ff62b20f7000 26
Mike Fiore 9:ff62b20f7000 27 if (args.size() == 1) {
Mike Fiore 9:ff62b20f7000 28 if (_dot->getVerbose())
Mike Fiore 9:ff62b20f7000 29 _serial.writef("Preserve Session: ");
Mike Fiore 9:ff62b20f7000 30
Mike Fiore 9:ff62b20f7000 31 _serial.writef("%u\r\n", _dot->getPreserveSession());
Mike Fiore 9:ff62b20f7000 32 } else {
Mike Fiore 9:ff62b20f7000 33 _dot->setPreserveSession(args[1] == "1");
Mike Fiore 9:ff62b20f7000 34 }
Mike Fiore 9:ff62b20f7000 35
Mike Fiore 9:ff62b20f7000 36 return mDot::MDOT_OK;
Mike Fiore 9:ff62b20f7000 37 }
Mike Fiore 9:ff62b20f7000 38
Mike Fiore 9:ff62b20f7000 39 bool CmdPreserveSession::verify(std::vector<std::string> args) {
Mike Fiore 9:ff62b20f7000 40 if (args.size() == 1)
Mike Fiore 9:ff62b20f7000 41 return true;
Mike Fiore 9:ff62b20f7000 42
Mike Fiore 9:ff62b20f7000 43 if (args.size() == 2) {
Mike Fiore 9:ff62b20f7000 44
Mike Fiore 9:ff62b20f7000 45 if (args[1] != "1" && args[1] != "0") {
Mike Fiore 9:ff62b20f7000 46 setErrorMessage("Invalid parameter, expects (0: off, 1: on)");
Mike Fiore 9:ff62b20f7000 47 return false;
Mike Fiore 9:ff62b20f7000 48 }
Mike Fiore 9:ff62b20f7000 49
Mike Fiore 9:ff62b20f7000 50 return true;
Mike Fiore 9:ff62b20f7000 51 }
Mike Fiore 9:ff62b20f7000 52
Mike Fiore 9:ff62b20f7000 53 setErrorMessage("Invalid arguments");
Mike Fiore 9:ff62b20f7000 54 return false;
Mike Fiore 9:ff62b20f7000 55 }