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/CmdDataSessionKey.cpp@1:e52ae6584f1c, 2015-06-25 (annotated)

Committer:
Mike Fiore
Date:
Thu Jun 25 10:23:41 2015 -0500
Revision:
1:e52ae6584f1c
Child:
9:ff62b20f7000
update debug, add command source files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdDataSessionKey.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 1:e52ae6584f1c 3 CmdDataSessionKey::CmdDataSessionKey(mDot* dot, mts::MTSSerial& serial) :
Mike Fiore 1:e52ae6584f1c 4 Command(dot, "Data Session Key", "AT+DSK", "Data session encryption key (16 bytes)"), _serial(serial)
Mike Fiore 1:e52ae6584f1c 5 {
Mike Fiore 1:e52ae6584f1c 6 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 1:e52ae6584f1c 7 _usage = "(hex:16)";
Mike Fiore 1:e52ae6584f1c 8 _queryable = true;
Mike Fiore 1:e52ae6584f1c 9 }
Mike Fiore 1:e52ae6584f1c 10
Mike Fiore 1:e52ae6584f1c 11 uint32_t CmdDataSessionKey::action(std::vector<std::string> args)
Mike Fiore 1:e52ae6584f1c 12 {
Mike Fiore 1:e52ae6584f1c 13 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 14 {
Mike Fiore 1:e52ae6584f1c 15 if (_dot->getVerbose())
Mike Fiore 1:e52ae6584f1c 16 _serial.writef("Data Session Key: ");
Mike Fiore 1:e52ae6584f1c 17 _serial.writef("%s\r\n", mts::Text::bin2hexString(_dot->getDataSessionKey(), ".").c_str());
Mike Fiore 1:e52ae6584f1c 18 }
Mike Fiore 1:e52ae6584f1c 19 else if (args.size() == 2)
Mike Fiore 1:e52ae6584f1c 20 {
Mike Fiore 1:e52ae6584f1c 21 int32_t code;
Mike Fiore 1:e52ae6584f1c 22 std::vector<uint8_t> NewKey;
Mike Fiore 1:e52ae6584f1c 23
Mike Fiore 1:e52ae6584f1c 24 // Read in the key components...
Mike Fiore 1:e52ae6584f1c 25 readByteArray(args[1], NewKey, KEY_LENGTH);
Mike Fiore 1:e52ae6584f1c 26
Mike Fiore 1:e52ae6584f1c 27 if ((code = _dot->setDataSessionKey(NewKey)) == mDot::MDOT_OK) {
Mike Fiore 1:e52ae6584f1c 28 _serial.writef("Set Data Session Key: ");
Mike Fiore 1:e52ae6584f1c 29 _serial.writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
Mike Fiore 1:e52ae6584f1c 30 } else {
Mike Fiore 1:e52ae6584f1c 31 std::string error = mDot::getReturnCodeString(code) + " - " + _dot->getLastError();
Mike Fiore 1:e52ae6584f1c 32 setErrorMessage(error);
Mike Fiore 1:e52ae6584f1c 33 return 1;
Mike Fiore 1:e52ae6584f1c 34 }
Mike Fiore 1:e52ae6584f1c 35 }
Mike Fiore 1:e52ae6584f1c 36
Mike Fiore 1:e52ae6584f1c 37 return 0;
Mike Fiore 1:e52ae6584f1c 38 }
Mike Fiore 1:e52ae6584f1c 39
Mike Fiore 1:e52ae6584f1c 40 bool CmdDataSessionKey::verify(std::vector<std::string> args)
Mike Fiore 1:e52ae6584f1c 41 {
Mike Fiore 1:e52ae6584f1c 42 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 43 return true;
Mike Fiore 1:e52ae6584f1c 44
Mike Fiore 1:e52ae6584f1c 45 if (args.size() == 2) {
Mike Fiore 1:e52ae6584f1c 46 if (!isHexString(args[1], 16)) {
Mike Fiore 1:e52ae6584f1c 47 setErrorMessage("Invalid key, expects (hex:16)");
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
Mike Fiore 1:e52ae6584f1c 54 setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 55 return false;
Mike Fiore 1:e52ae6584f1c 56 }