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/CmdJoinRequest.cpp@33:5c0252521669, 2021-01-29 (annotated)

Committer:
Jason Reiss
Date:
Fri Jan 29 13:04:32 2021 -0600
Revision:
33:5c0252521669
Parent:
28:c222ca8383f4
Child:
36:b586cd6e91f3
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdJoinRequest.h"
Mike Fiore 1:e52ae6584f1c 2 #include "CommandTerminal.h"
Mike Fiore 1:e52ae6584f1c 3
Jason Reiss 28:c222ca8383f4 4 CmdJoinRequest::CmdJoinRequest() :
Jason Reiss 28:c222ca8383f4 5 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 6 Command("Join Network", "AT+JOIN", "Join network, provide argument of '1' to force join (acquire network address and session keys)", "(force:1)")
Jason Reiss 27:5fafd3b26ac3 7 #else
Jason Reiss 28:c222ca8383f4 8 Command("AT+JOIN")
Jason Reiss 27:5fafd3b26ac3 9 #endif
Jason Reiss 28:c222ca8383f4 10 {
Mike Fiore 14:f9a77400b622 11
Mike Fiore 1:e52ae6584f1c 12 }
Mike Fiore 1:e52ae6584f1c 13
jenkins@jenkinsdm1 18:63f098f042b2 14 uint32_t CmdJoinRequest::action(const std::vector<std::string>& args) {
Jason Reiss 23:4f0a981c0349 15 // Detach the serial rx irq handler temporarily here to allow for deep sleep
Jason Reiss 23:4f0a981c0349 16 //CommandTerminal::Serial()->detach();
Jason Reiss 27:5fafd3b26ac3 17
Mike Fiore 1:e52ae6584f1c 18 std::string buf;
Mike Fiore 1:e52ae6584f1c 19
Mike Fiore 1:e52ae6584f1c 20 if (args.size() > 1 && args[1] == "1")
Mike Fiore 14:f9a77400b622 21 CommandTerminal::Dot()->resetNetworkSession();
Mike Fiore 1:e52ae6584f1c 22
Mike Fiore 14:f9a77400b622 23 if (CommandTerminal::Dot()->getJoinMode() == 0) {
Mike Fiore 14:f9a77400b622 24 CommandTerminal::Serial()->writef("Join not necessary for Manual Join Mode\r\n");
Jason Reiss 23:4f0a981c0349 25 //CommandTerminal::Serial()->attach();
Mike Fiore 14:f9a77400b622 26 return 0;
Mike Fiore 14:f9a77400b622 27 } else if (CommandTerminal::Dot()->getJoinMode() == 3) {
Mike Fiore 14:f9a77400b622 28 CommandTerminal::Serial()->writef("Join not necessary for Peer-to-Peer\r\n");
Jason Reiss 23:4f0a981c0349 29 //CommandTerminal::Serial()->attach();
Mike Fiore 9:ff62b20f7000 30 return 0;
Mike Fiore 9:ff62b20f7000 31 }
Mike Fiore 9:ff62b20f7000 32
Mike Fiore 14:f9a77400b622 33 int32_t code = CommandTerminal::Dot()->joinNetworkOnce();
Mike Fiore 1:e52ae6584f1c 34
Mike Fiore 1:e52ae6584f1c 35 if (code == mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 36 CommandTerminal::Serial()->writef("Successfully joined network\r\n");
Jason Reiss 23:4f0a981c0349 37 //CommandTerminal::Serial()->attach();
Mike Fiore 1:e52ae6584f1c 38 return 0;
Mike Fiore 1:e52ae6584f1c 39 } else {
Jason Reiss 28:c222ca8383f4 40 // std::string error = mDot::getReturnCodeString(code) + " - " + CommandTerminal::Dot()->getLastError();
Jason Reiss 28:c222ca8383f4 41 // CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
Mike Fiore 1:e52ae6584f1c 42 }
Mike Fiore 1:e52ae6584f1c 43
Jason Reiss 23:4f0a981c0349 44 //CommandTerminal::Serial()->attach();
Mike Fiore 1:e52ae6584f1c 45 return 1;
Mike Fiore 1:e52ae6584f1c 46 }
Mike Fiore 1:e52ae6584f1c 47
jenkins@jenkinsdm1 18:63f098f042b2 48 bool CmdJoinRequest::verify(const std::vector<std::string>& args) {
Mike Fiore 1:e52ae6584f1c 49 if (args.size() == 1 || (args.size() == 2 && args[1] == "1"))
Mike Fiore 1:e52ae6584f1c 50 return true;
Mike Fiore 1:e52ae6584f1c 51
Jason Reiss 28:c222ca8383f4 52 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 53 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 54 #endif
Mike Fiore 1:e52ae6584f1c 55 return false;
Mike Fiore 1:e52ae6584f1c 56 }