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. Check the commit messages of the Dot library version used to find the correct mbed-os version to use with it. The mbed-os version must match the version used in that version of Dot library or it will likely cause it to fail to compile or have unexpected problems while running.

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@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 "CmdJoinRequest.h"
Mike Fiore 1:e52ae6584f1c 2 #include "CommandTerminal.h"
Mike Fiore 1:e52ae6584f1c 3
Mike Fiore 14:f9a77400b622 4 CmdJoinRequest::CmdJoinRequest()
Mike Fiore 1:e52ae6584f1c 5 :
Mike Fiore 14:f9a77400b622 6 Command("Join Network", "AT+JOIN", "Join network, provide argument of '1' to force join (acquire network address and session keys)", "(force:1)") {
Mike Fiore 14:f9a77400b622 7
Mike Fiore 1:e52ae6584f1c 8 }
Mike Fiore 1:e52ae6584f1c 9
Mike Fiore 1:e52ae6584f1c 10 uint32_t CmdJoinRequest::action(std::vector<std::string> args) {
Mike Fiore 14:f9a77400b622 11
Mike Fiore 1:e52ae6584f1c 12 std::string buf;
Mike Fiore 1:e52ae6584f1c 13
Mike Fiore 1:e52ae6584f1c 14 if (args.size() > 1 && args[1] == "1")
Mike Fiore 14:f9a77400b622 15 CommandTerminal::Dot()->resetNetworkSession();
Mike Fiore 1:e52ae6584f1c 16
Mike Fiore 14:f9a77400b622 17 if (CommandTerminal::Dot()->getJoinMode() == 0) {
Mike Fiore 14:f9a77400b622 18 CommandTerminal::Serial()->writef("Join not necessary for Manual Join Mode\r\n");
Mike Fiore 14:f9a77400b622 19 return 0;
Mike Fiore 14:f9a77400b622 20 } else if (CommandTerminal::Dot()->getJoinMode() == 3) {
Mike Fiore 14:f9a77400b622 21 CommandTerminal::Serial()->writef("Join not necessary for Peer-to-Peer\r\n");
Mike Fiore 9:ff62b20f7000 22 return 0;
Mike Fiore 9:ff62b20f7000 23 }
Mike Fiore 9:ff62b20f7000 24
Mike Fiore 14:f9a77400b622 25 int32_t code = CommandTerminal::Dot()->joinNetworkOnce();
Mike Fiore 1:e52ae6584f1c 26
Mike Fiore 1:e52ae6584f1c 27 if (code == mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 28 CommandTerminal::Serial()->writef("Successfully joined network\r\n");
Mike Fiore 1:e52ae6584f1c 29 return 0;
Mike Fiore 1:e52ae6584f1c 30 } else {
Mike Fiore 14:f9a77400b622 31 std::string error = mDot::getReturnCodeString(code) + " - " + CommandTerminal::Dot()->getLastError();
Mike Fiore 14:f9a77400b622 32 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
Mike Fiore 1:e52ae6584f1c 33 }
Mike Fiore 1:e52ae6584f1c 34
Mike Fiore 1:e52ae6584f1c 35 return 1;
Mike Fiore 1:e52ae6584f1c 36 }
Mike Fiore 1:e52ae6584f1c 37
Mike Fiore 1:e52ae6584f1c 38 bool CmdJoinRequest::verify(std::vector<std::string> args) {
Mike Fiore 1:e52ae6584f1c 39 if (args.size() == 1 || (args.size() == 2 && args[1] == "1"))
Mike Fiore 1:e52ae6584f1c 40 return true;
Mike Fiore 1:e52ae6584f1c 41
Mike Fiore 14:f9a77400b622 42 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 43 return false;
Mike Fiore 1:e52ae6584f1c 44 }