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@18:63f098f042b2, 2019-03-08 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Fri Mar 08 11:37:37 2019 -0600
Revision:
18:63f098f042b2
Parent:
14:f9a77400b622
Child:
27:5fafd3b26ac3
mdot-firmware revision 3.1.0

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 14:f9a77400b622 3 CmdPublicNetwork::CmdPublicNetwork() :
jenkins@jenkinsdm1 18:63f098f042b2 4 Command("Network Mode", "AT+PN", "Set public network mode (0: PRIVATE_MTS, 1: PUBLIC_LORAWAN, 2: PRIVATE_LORAWAN)", "(0-2)")
Mike Fiore 1:e52ae6584f1c 5 {
Mike Fiore 1:e52ae6584f1c 6 _queryable = true;
Mike Fiore 1:e52ae6584f1c 7 }
Mike Fiore 1:e52ae6584f1c 8
jenkins@jenkinsdm1 18:63f098f042b2 9 uint32_t CmdPublicNetwork::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 10 {
Mike Fiore 1:e52ae6584f1c 11 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 12 {
Mike Fiore 14:f9a77400b622 13 CommandTerminal::Serial()->writef("%d\r\n", CommandTerminal::Dot()->getPublicNetwork());
Mike Fiore 1:e52ae6584f1c 14 }
Mike Fiore 1:e52ae6584f1c 15 else if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 16 {
jenkins@jenkinsdm1 18:63f098f042b2 17 uint8_t mode = lora::PRIVATE_MTS;
Mike Fiore 1:e52ae6584f1c 18
jenkins@jenkinsdm1 18:63f098f042b2 19 if (args[1] == "1") {
jenkins@jenkinsdm1 18:63f098f042b2 20 mode = lora::PUBLIC_LORAWAN;
jenkins@jenkinsdm1 18:63f098f042b2 21 } else if (args[1] == "2") {
jenkins@jenkinsdm1 18:63f098f042b2 22 mode = lora::PRIVATE_LORAWAN;
jenkins@jenkinsdm1 18:63f098f042b2 23 }
jenkins@jenkinsdm1 18:63f098f042b2 24
jenkins@jenkinsdm1 18:63f098f042b2 25 if (CommandTerminal::Dot()->setPublicNetwork(mode) != mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 26 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Mike Fiore 1:e52ae6584f1c 27 return 1;
Mike Fiore 1:e52ae6584f1c 28 }
Mike Fiore 1:e52ae6584f1c 29 }
Mike Fiore 1:e52ae6584f1c 30
Mike Fiore 1:e52ae6584f1c 31 return 0;
Mike Fiore 1:e52ae6584f1c 32 }
Mike Fiore 1:e52ae6584f1c 33
jenkins@jenkinsdm1 18:63f098f042b2 34 bool CmdPublicNetwork::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 35 {
Mike Fiore 1:e52ae6584f1c 36 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 37 return true;
Mike Fiore 1:e52ae6584f1c 38
Mike Fiore 1:e52ae6584f1c 39 if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 40 {
jenkins@jenkinsdm1 18:63f098f042b2 41 if (args[1] != "2" && args[1] != "1" && args[1] != "0") {
jenkins@jenkinsdm1 18:63f098f042b2 42 CommandTerminal::setErrorMessage("Invalid parameter, expects (0: PRIVATE_MTS, 1: PUBLIC_LORAWAN, 2: PRIVATE_LORAWAN)");
Mike Fiore 1:e52ae6584f1c 43 return false;
Mike Fiore 1:e52ae6584f1c 44 }
Mike Fiore 1:e52ae6584f1c 45
Mike Fiore 1:e52ae6584f1c 46 return true;
Mike Fiore 1:e52ae6584f1c 47 }
Mike Fiore 1:e52ae6584f1c 48
Mike Fiore 14:f9a77400b622 49 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 50 return false;
Mike Fiore 1:e52ae6584f1c 51 }