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/CmdNetworkSessionKey.cpp@33:5c0252521669, 2021-01-29 (annotated)

Committer:
Jason Reiss
Date:
Fri Jan 29 13:04:32 2021 -0600
Revision:
33:5c0252521669
Parent:
28:c222ca8383f4 
Remove moved commands

Who changed what in which revision?

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