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@27:5fafd3b26ac3, 2020-09-11 (annotated)

Committer:
Jason Reiss
Date:
Fri Sep 11 13:16:33 2020 -0500
Revision:
27:5fafd3b26ac3
Parent:
18:63f098f042b2
Child:
28:c222ca8383f4
Update to Dot 3.3.6

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 14:f9a77400b622 3 CmdDataSessionKey::CmdDataSessionKey() :
Jason Reiss 27:5fafd3b26ac3 4 Command("Data Session Key", "AT+DSK",
Jason Reiss 27:5fafd3b26ac3 5 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 6 "Data session encryption key (16 bytes)",
Jason Reiss 27:5fafd3b26ac3 7 #else
Jason Reiss 27:5fafd3b26ac3 8 "",
Jason Reiss 27:5fafd3b26ac3 9 #endif
Jason Reiss 27:5fafd3b26ac3 10 "(hex:16) or (1-8),(hex:16)")
Mike Fiore 1:e52ae6584f1c 11 {
Mike Fiore 1:e52ae6584f1c 12 _queryable = true;
Mike Fiore 1:e52ae6584f1c 13 }
Mike Fiore 1:e52ae6584f1c 14
jenkins@jenkinsdm1 18:63f098f042b2 15 uint32_t CmdDataSessionKey::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 16 {
Mike Fiore 1:e52ae6584f1c 17 if (args.size() == 1)
jenkins@jenkinsdm1 18:63f098f042b2 18 {
Mike Fiore 14:f9a77400b622 19 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getDataSessionKey(), ".").c_str());
Mike Fiore 1:e52ae6584f1c 20 }
Jason Reiss 27:5fafd3b26ac3 21 else if (args.size() == 2 || args.size() == 3)
Mike Fiore 1:e52ae6584f1c 22 {
Jason Reiss 27:5fafd3b26ac3 23 int index = 0;
Jason Reiss 27:5fafd3b26ac3 24 int arg_index = 1;
Jason Reiss 27:5fafd3b26ac3 25 if (args.size() == 3) {
Jason Reiss 27:5fafd3b26ac3 26 arg_index = 2;
Jason Reiss 27:5fafd3b26ac3 27 sscanf(args[1].c_str(), "%d", &index);
Jason Reiss 27:5fafd3b26ac3 28 }
Mike Fiore 1:e52ae6584f1c 29
Jason Reiss 27:5fafd3b26ac3 30 if (args.size() == 3 && args[2] == "?") {
Jason Reiss 27:5fafd3b26ac3 31 uint8_t dsk[16];
Jason Reiss 27:5fafd3b26ac3 32 CommandTerminal::Dot()->getMulticastApplicationSessionKey(index-1, dsk);
Jason Reiss 27:5fafd3b26ac3 33 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(dsk, 16, ".").c_str());
Jason Reiss 27:5fafd3b26ac3 34 } else {
Jason Reiss 27:5fafd3b26ac3 35 std::vector<uint8_t> NewKey;
Jason Reiss 27:5fafd3b26ac3 36
Jason Reiss 27:5fafd3b26ac3 37 // Read in the key components...
Jason Reiss 27:5fafd3b26ac3 38 readByteArray(args[arg_index], NewKey, KEY_LENGTH);
Mike Fiore 1:e52ae6584f1c 39
Jason Reiss 27:5fafd3b26ac3 40 if (arg_index == 2 && CommandTerminal::Dot()->setMulticastApplicationSessionKey(index-1, &NewKey[0]) == mDot::MDOT_OK) {
Jason Reiss 27:5fafd3b26ac3 41 CommandTerminal::Serial()->writef("Set Multicast Application Session Key %d: ", index);
Jason Reiss 27:5fafd3b26ac3 42 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
Jason Reiss 27:5fafd3b26ac3 43 } else if (CommandTerminal::Dot()->setDataSessionKey(NewKey) == mDot::MDOT_OK) {
Jason Reiss 27:5fafd3b26ac3 44 CommandTerminal::Serial()->writef("Set Data Session Key: ");
Jason Reiss 27:5fafd3b26ac3 45 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
Jason Reiss 27:5fafd3b26ac3 46 } else {
Jason Reiss 27:5fafd3b26ac3 47 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Jason Reiss 27:5fafd3b26ac3 48 return 1;
Jason Reiss 27:5fafd3b26ac3 49 }
Mike Fiore 1:e52ae6584f1c 50 }
Mike Fiore 1:e52ae6584f1c 51 }
Mike Fiore 1:e52ae6584f1c 52
Mike Fiore 1:e52ae6584f1c 53 return 0;
Mike Fiore 1:e52ae6584f1c 54 }
Mike Fiore 1:e52ae6584f1c 55
jenkins@jenkinsdm1 18:63f098f042b2 56 bool CmdDataSessionKey::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 57 {
Mike Fiore 1:e52ae6584f1c 58 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 59 return true;
Mike Fiore 1:e52ae6584f1c 60
Mike Fiore 1:e52ae6584f1c 61 if (args.size() == 2) {
Mike Fiore 1:e52ae6584f1c 62 if (!isHexString(args[1], 16)) {
Mike Fiore 14:f9a77400b622 63 CommandTerminal::setErrorMessage("Invalid key, expects (hex:16)");
Mike Fiore 1:e52ae6584f1c 64 return false;
Mike Fiore 1:e52ae6584f1c 65 }
Mike Fiore 1:e52ae6584f1c 66
Mike Fiore 1:e52ae6584f1c 67 return true;
Mike Fiore 1:e52ae6584f1c 68 }
Mike Fiore 1:e52ae6584f1c 69
Jason Reiss 27:5fafd3b26ac3 70 if (args.size() == 3) {
Jason Reiss 27:5fafd3b26ac3 71 int index = 0;
Jason Reiss 27:5fafd3b26ac3 72 sscanf(args[1].c_str(), "%d", &index);
Jason Reiss 27:5fafd3b26ac3 73
Jason Reiss 27:5fafd3b26ac3 74 if (args[1].size() == 1 && (index < 1 || index > 8)) {
Jason Reiss 27:5fafd3b26ac3 75 CommandTerminal::setErrorMessage("Invalid index, expects 1-8");
Jason Reiss 27:5fafd3b26ac3 76 return false;
Jason Reiss 27:5fafd3b26ac3 77 } else if (args[2] != "?" && !isHexString(args[2], 16)) {
Jason Reiss 27:5fafd3b26ac3 78 CommandTerminal::setErrorMessage("Invalid key, expects (hex:16)");
Jason Reiss 27:5fafd3b26ac3 79 return false;
Jason Reiss 27:5fafd3b26ac3 80 }
Jason Reiss 27:5fafd3b26ac3 81
Jason Reiss 27:5fafd3b26ac3 82 return true;
Jason Reiss 27:5fafd3b26ac3 83 }
Jason Reiss 27:5fafd3b26ac3 84
Mike Fiore 14:f9a77400b622 85 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 86 return false;
Mike Fiore 1:e52ae6584f1c 87 }