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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 14:f9a77400b622 1 #include "CmdMacCmd.h"
Mike Fiore 14:f9a77400b622 2 #include "CommandTerminal.h"
Mike Fiore 14:f9a77400b622 3
Mike Fiore 14:f9a77400b622 4 CmdMacCmd::CmdMacCmd()
Mike Fiore 14:f9a77400b622 5 :
Mike Fiore 14:f9a77400b622 6 Command("MAC Command", "AT+MAC", "Inject MAC command to MAC layer or read uplink MAC command buffer, pass '0' argument to clear buffer", "(hex:242)")
Mike Fiore 14:f9a77400b622 7 {
Mike Fiore 14:f9a77400b622 8 }
Mike Fiore 14:f9a77400b622 9
jenkins@jenkinsdm1 18:63f098f042b2 10 uint32_t CmdMacCmd::action(const std::vector<std::string>& args) {
Mike Fiore 14:f9a77400b622 11
Mike Fiore 14:f9a77400b622 12 if (args.size() == 1) {
Mike Fiore 14:f9a77400b622 13 std::vector<uint8_t> cmds = CommandTerminal::Dot()->getMacCommands();
Mike Fiore 14:f9a77400b622 14
jenkins@jenkinsdm1 16:d5cf2af81a6d 15 if (cmds.size() > 0) {
Mike Fiore 14:f9a77400b622 16 for (size_t i = 0; i < cmds.size(); i++) {
Mike Fiore 14:f9a77400b622 17 CommandTerminal::Serial()->writef("%02x", cmds[i]);
Mike Fiore 14:f9a77400b622 18 }
Mike Fiore 14:f9a77400b622 19 CommandTerminal::Serial()->writef("\r\n");
Mike Fiore 14:f9a77400b622 20 }
Mike Fiore 14:f9a77400b622 21
Mike Fiore 14:f9a77400b622 22 } else {
Mike Fiore 14:f9a77400b622 23 if (args[1].size() == 1 && args[1] == "0") {
Mike Fiore 14:f9a77400b622 24 CommandTerminal::Dot()->clearMacCommands();
Mike Fiore 14:f9a77400b622 25 } else {
Mike Fiore 14:f9a77400b622 26 std::vector<uint8_t> data;
Mike Fiore 14:f9a77400b622 27 int32_t code;
Mike Fiore 14:f9a77400b622 28 int temp;
Mike Fiore 14:f9a77400b622 29 uint32_t length = args[1].size();
Mike Fiore 14:f9a77400b622 30
Mike Fiore 14:f9a77400b622 31 // Convert the ASCII hex data to binary...
Mike Fiore 14:f9a77400b622 32 for (uint32_t i = 0; i < length; i += 2) {
Mike Fiore 14:f9a77400b622 33 sscanf(&args[1][i], "%2x", &temp);
Mike Fiore 14:f9a77400b622 34 data.push_back(temp);
Mike Fiore 14:f9a77400b622 35 }
Mike Fiore 14:f9a77400b622 36
Mike Fiore 14:f9a77400b622 37 if ((code = CommandTerminal::Dot()->injectMacCommand(data)) != mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 38 std::string error = mDot::getReturnCodeString(code);
Mike Fiore 14:f9a77400b622 39
Mike Fiore 14:f9a77400b622 40 if (code != mDot::MDOT_NOT_JOINED)
Mike Fiore 14:f9a77400b622 41 error += +" - " + CommandTerminal::Dot()->getLastError();
Mike Fiore 14:f9a77400b622 42
Mike Fiore 14:f9a77400b622 43 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
Mike Fiore 14:f9a77400b622 44 return 1;
Mike Fiore 14:f9a77400b622 45 }
Mike Fiore 14:f9a77400b622 46 }
Mike Fiore 14:f9a77400b622 47 }
Mike Fiore 14:f9a77400b622 48
Mike Fiore 14:f9a77400b622 49 return 0;
Mike Fiore 14:f9a77400b622 50 }
Mike Fiore 14:f9a77400b622 51
jenkins@jenkinsdm1 18:63f098f042b2 52 bool CmdMacCmd::verify(const std::vector<std::string>& args) {
Mike Fiore 14:f9a77400b622 53 if (args.size() == 1) {
Mike Fiore 14:f9a77400b622 54 return true;
Mike Fiore 14:f9a77400b622 55 } else if (args.size() == 2) {
Mike Fiore 14:f9a77400b622 56
Mike Fiore 14:f9a77400b622 57 if (args[1].size() == 1 && args[1] == "0") {
Mike Fiore 14:f9a77400b622 58 return true;
Mike Fiore 14:f9a77400b622 59 } else if (args[1].size() > 484 || !isHexString(args[1], args[1].size() / 2)) {
Mike Fiore 14:f9a77400b622 60 CommandTerminal::setErrorMessage("Invalid hex string, (hex:242)");
Mike Fiore 14:f9a77400b622 61 return false;
Mike Fiore 14:f9a77400b622 62 }
Mike Fiore 14:f9a77400b622 63
Mike Fiore 14:f9a77400b622 64 return true;
Mike Fiore 14:f9a77400b622 65 }
Mike Fiore 14:f9a77400b622 66
Mike Fiore 14:f9a77400b622 67 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 14:f9a77400b622 68 return false;
Mike Fiore 14:f9a77400b622 69 }
Mike Fiore 14:f9a77400b622 70