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@36:b586cd6e91f3, 8 months ago (annotated)

Committer:
Jason Reiss
Date:
Fri Sep 08 08:34:24 2023 -0500
Revision:
36:b586cd6e91f3
Parent:
28:c222ca8383f4 
Update AT Version to 4.2.1

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 36:b586cd6e91f3 6 Command("Join Network", "AT+JOIN", "Join network, provide argument of '1' to force join (acquire network address and session keys)", "(force:1,usetxdr:2)")
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;
Jason Reiss 36:b586cd6e91f3 19 uint32_t ret = 0;
Mike Fiore 1:e52ae6584f1c 20
Mike Fiore 1:e52ae6584f1c 21 if (args.size() > 1 && args[1] == "1")
Mike Fiore 14:f9a77400b622 22 CommandTerminal::Dot()->resetNetworkSession();
Mike Fiore 1:e52ae6584f1c 23
Mike Fiore 14:f9a77400b622 24 if (CommandTerminal::Dot()->getJoinMode() == 0) {
Mike Fiore 14:f9a77400b622 25 CommandTerminal::Serial()->writef("Join not necessary for Manual Join Mode\r\n");
Jason Reiss 23:4f0a981c0349 26 //CommandTerminal::Serial()->attach();
Mike Fiore 14:f9a77400b622 27 return 0;
Mike Fiore 14:f9a77400b622 28 } else if (CommandTerminal::Dot()->getJoinMode() == 3) {
Mike Fiore 14:f9a77400b622 29 CommandTerminal::Serial()->writef("Join not necessary for Peer-to-Peer\r\n");
Jason Reiss 23:4f0a981c0349 30 //CommandTerminal::Serial()->attach();
Mike Fiore 9:ff62b20f7000 31 return 0;
Jason Reiss 36:b586cd6e91f3 32 } else {
Mike Fiore 9:ff62b20f7000 33
Jason Reiss 36:b586cd6e91f3 34 if (args.size() > 1 && args[1] == "2")
Jason Reiss 36:b586cd6e91f3 35 CommandTerminal::Dot()->setDisableAutoJoinDatarate(true);
Jason Reiss 36:b586cd6e91f3 36
Jason Reiss 36:b586cd6e91f3 37 int32_t code = CommandTerminal::Dot()->joinNetworkOnce();
Mike Fiore 1:e52ae6584f1c 38
Jason Reiss 36:b586cd6e91f3 39 if (code == mDot::MDOT_OK) {
Jason Reiss 36:b586cd6e91f3 40 CommandTerminal::Serial()->writef("Successfully joined network\r\n");
Jason Reiss 36:b586cd6e91f3 41 //CommandTerminal::Serial()->attach();
Jason Reiss 36:b586cd6e91f3 42
Jason Reiss 36:b586cd6e91f3 43 } else {
Jason Reiss 36:b586cd6e91f3 44 ret = 1;
Jason Reiss 36:b586cd6e91f3 45 // std::string error = mDot::getReturnCodeString(code) + " - " + CommandTerminal::Dot()->getLastError();
Jason Reiss 36:b586cd6e91f3 46 // CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
Jason Reiss 36:b586cd6e91f3 47 }
Jason Reiss 36:b586cd6e91f3 48
Jason Reiss 36:b586cd6e91f3 49 if (args.size() > 1 && args[1] == "2")
Jason Reiss 36:b586cd6e91f3 50 CommandTerminal::Dot()->setDisableAutoJoinDatarate(false);
Jason Reiss 36:b586cd6e91f3 51
Mike Fiore 1:e52ae6584f1c 52 }
Mike Fiore 1:e52ae6584f1c 53
Jason Reiss 23:4f0a981c0349 54 //CommandTerminal::Serial()->attach();
Jason Reiss 36:b586cd6e91f3 55 return ret;
Mike Fiore 1:e52ae6584f1c 56 }
Mike Fiore 1:e52ae6584f1c 57
jenkins@jenkinsdm1 18:63f098f042b2 58 bool CmdJoinRequest::verify(const std::vector<std::string>& args) {
Jason Reiss 36:b586cd6e91f3 59 if (args.size() == 1 || (args.size() == 2 && (args[1] == "1" || args[1] == "2")))
Mike Fiore 1:e52ae6584f1c 60 return true;
Mike Fiore 1:e52ae6584f1c 61
Jason Reiss 28:c222ca8383f4 62 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 63 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 64 #endif
Mike Fiore 1:e52ae6584f1c 65 return false;
Mike Fiore 1:e52ae6584f1c 66 }