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/CmdPingPeriod.cpp@26:35c201bc5205, 2019-05-03 (annotated)

Committer:
jreiss
Date:
Fri May 03 18:49:18 2019 +0000
Revision:
26:35c201bc5205
Parent:
23:4f0a981c0349
Child:
27:5fafd3b26ac3
Update to Dot 3.2.1 release; Remove AutoSleep command; Update mbed-os to 5.11.1;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jason Reiss 23:4f0a981c0349 1 #include "CmdPingPeriod.h"
Jason Reiss 23:4f0a981c0349 2
Jason Reiss 23:4f0a981c0349 3 CmdPingPeriod::CmdPingPeriod() :
Jason Reiss 23:4f0a981c0349 4 Command("Ping Periodicity", "AT+PP", "Set the periodicity of class B ping slots as number of pings per interval = 2^(7-periodicity)", "(0-7)")
Jason Reiss 23:4f0a981c0349 5 {
Jason Reiss 23:4f0a981c0349 6 _queryable = true;
Jason Reiss 23:4f0a981c0349 7 }
Jason Reiss 23:4f0a981c0349 8
Jason Reiss 23:4f0a981c0349 9 uint32_t CmdPingPeriod::action(const std::vector<std::string>& args)
Jason Reiss 23:4f0a981c0349 10 {
Jason Reiss 23:4f0a981c0349 11 mDot* dot = CommandTerminal::Dot();
Jason Reiss 23:4f0a981c0349 12 if (args.size() == 1) {
Jason Reiss 23:4f0a981c0349 13 CommandTerminal::Serial()->writef("%u\r\n", dot->getPingPeriodicity());
Jason Reiss 23:4f0a981c0349 14 } else if (args.size() == 2) {
Jason Reiss 23:4f0a981c0349 15 uint32_t periodicity;
Jason Reiss 23:4f0a981c0349 16 sscanf(args[1].c_str(), "%lu", &periodicity);
Jason Reiss 23:4f0a981c0349 17
Jason Reiss 23:4f0a981c0349 18 if (dot->setPingPeriodicity(static_cast<uint8_t>(periodicity)) != mDot::MDOT_OK) {
Jason Reiss 23:4f0a981c0349 19 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
Jason Reiss 23:4f0a981c0349 20 return 1;
Jason Reiss 23:4f0a981c0349 21 }
Jason Reiss 23:4f0a981c0349 22 }
Jason Reiss 23:4f0a981c0349 23
Jason Reiss 23:4f0a981c0349 24 return 0;
Jason Reiss 23:4f0a981c0349 25 }
Jason Reiss 23:4f0a981c0349 26
Jason Reiss 23:4f0a981c0349 27 bool CmdPingPeriod::verify(const std::vector<std::string>& args)
Jason Reiss 23:4f0a981c0349 28 {
Jason Reiss 23:4f0a981c0349 29 if (args.size() == 1)
Jason Reiss 23:4f0a981c0349 30 return true;
Jason Reiss 23:4f0a981c0349 31
Jason Reiss 23:4f0a981c0349 32 if (args.size() == 2) {
Jason Reiss 23:4f0a981c0349 33 uint32_t periodicity;
Jason Reiss 23:4f0a981c0349 34 if (sscanf(args[1].c_str(), "%lu", &periodicity) == 1) {
Jason Reiss 23:4f0a981c0349 35 if (periodicity > 7) {
Jason Reiss 23:4f0a981c0349 36 CommandTerminal::setErrorMessage("Invalid periodicity, expects (0-7)");
Jason Reiss 23:4f0a981c0349 37 return false;
Jason Reiss 23:4f0a981c0349 38 }
Jason Reiss 23:4f0a981c0349 39
Jason Reiss 23:4f0a981c0349 40 return true;
Jason Reiss 23:4f0a981c0349 41 }
Jason Reiss 23:4f0a981c0349 42 }
Jason Reiss 23:4f0a981c0349 43
Jason Reiss 23:4f0a981c0349 44 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 23:4f0a981c0349 45 return false;
Jason Reiss 23:4f0a981c0349 46 }