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/CmdNetworkJoinMode.cpp@14:f9a77400b622, 2016-11-04 (annotated)

Committer:
Mike Fiore
Date:
Fri Nov 04 14:25:43 2016 -0500
Revision:
14:f9a77400b622
Parent:
9:ff62b20f7000
Child:
18:63f098f042b2
update from git revision 2.0.16

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdNetworkJoinMode.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 14:f9a77400b622 3 CmdNetworkJoinMode::CmdNetworkJoinMode() :
Mike Fiore 14:f9a77400b622 4 Command("Network Join Mode", "AT+NJM", "0: Manual configuration, 1: OTA Network Join, 2: Auto OTA Network Join on start up, 3: Peer-to-Peer (default: 1)", "(0-3)")
Mike Fiore 1:e52ae6584f1c 5 {
Mike Fiore 1:e52ae6584f1c 6 _queryable = true;
Mike Fiore 1:e52ae6584f1c 7 }
Mike Fiore 1:e52ae6584f1c 8
Mike Fiore 1:e52ae6584f1c 9 uint32_t CmdNetworkJoinMode::action(std::vector<std::string> args)
Mike Fiore 1:e52ae6584f1c 10 {
Mike Fiore 14:f9a77400b622 11 if (args.size() == 1) {
Mike Fiore 14:f9a77400b622 12 CommandTerminal::Serial()->writef("%u\r\n", CommandTerminal::Dot()->getJoinMode());
Mike Fiore 1:e52ae6584f1c 13 }
Mike Fiore 1:e52ae6584f1c 14 else if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 15 {
Mike Fiore 1:e52ae6584f1c 16 uint8_t mode = (args[1] == "1") ? 1 : 0;
Mike Fiore 1:e52ae6584f1c 17 mode = (args[1] == "2" ? 2 : mode);
Mike Fiore 9:ff62b20f7000 18 mode = (args[1] == "3" ? 3 : mode);
Mike Fiore 14:f9a77400b622 19
Mike Fiore 14:f9a77400b622 20 if (CommandTerminal::Dot()->setJoinMode(mode) != mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 21 {
Mike Fiore 14:f9a77400b622 22 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Mike Fiore 1:e52ae6584f1c 23 return 1;
Mike Fiore 1:e52ae6584f1c 24 }
Mike Fiore 9:ff62b20f7000 25
Mike Fiore 1:e52ae6584f1c 26 }
Mike Fiore 1:e52ae6584f1c 27
Mike Fiore 1:e52ae6584f1c 28 return 0;
Mike Fiore 1:e52ae6584f1c 29 }
Mike Fiore 1:e52ae6584f1c 30
Mike Fiore 1:e52ae6584f1c 31 bool CmdNetworkJoinMode::verify(std::vector<std::string> args)
Mike Fiore 1:e52ae6584f1c 32 {
Mike Fiore 1:e52ae6584f1c 33 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 34 return true;
Mike Fiore 1:e52ae6584f1c 35
Mike Fiore 1:e52ae6584f1c 36 if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 37 {
Mike Fiore 9:ff62b20f7000 38 if (!(args[1] == "0" || args[1] == "1" || args[1] == "2" || args[1] == "3"))
Mike Fiore 1:e52ae6584f1c 39 {
Mike Fiore 14:f9a77400b622 40 CommandTerminal::setErrorMessage("Invalid parameter, expects (0: Manual, 1: OTA, 2: Auto OTA, 3:Peer-to-Peer)");
Mike Fiore 1:e52ae6584f1c 41 return false;
Mike Fiore 1:e52ae6584f1c 42 }
Mike Fiore 1:e52ae6584f1c 43
Mike Fiore 1:e52ae6584f1c 44 return true;
Mike Fiore 1:e52ae6584f1c 45 }
Mike Fiore 1:e52ae6584f1c 46
Mike Fiore 14:f9a77400b622 47 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 48 return false;
Mike Fiore 1:e52ae6584f1c 49 }