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@28:c222ca8383f4, 2020-11-19 (annotated)

Committer:
Jason Reiss
Date:
Thu Nov 19 09:58:25 2020 -0600
Revision:
28:c222ca8383f4
Parent:
27:5fafd3b26ac3 
update to Dot 4.0.0 release

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