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/CmdNetworkKey.cpp@42:23e2df6714f4, 6 months ago (annotated)

Committer:
Jason Reiss
Date:
Wed Dec 06 13:33:52 2023 -0600
Revision:
42:23e2df6714f4
Parent:
36:b586cd6e91f3 
TestMode: reset appnonce to 0 on reset to accomodate LCTT 3.12.0 and earlier. If the test suite changes to test AppNonce loaded from NVM this will fail tests.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdNetworkKey.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 14:f9a77400b622 3 CmdNetworkKey::CmdNetworkKey() :
Jason Reiss 28:c222ca8383f4 4 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 5 Command("Network Key", "AT+NK", "Configured network key/passphrase (App Key in LoRaWAN) ## AT+NK=0/2,hex AT+NK=1,passphrase (Net key = cmac(passphrase)) (16 bytes)", "(0/2,(hex:16)),(1,(string:128))")
Jason Reiss 27:5fafd3b26ac3 6 #else
Jason Reiss 28:c222ca8383f4 7 Command("AT+NK")
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 CmdNetworkKey::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 14 {
Jason Reiss 28:c222ca8383f4 15 char arg1 = '\0';
Jason Reiss 28:c222ca8383f4 16 if ((args.size() >= 2) && (args[1].size() == 1)) {
Jason Reiss 28:c222ca8383f4 17 arg1 = args[1][0];
Mike Fiore 1:e52ae6584f1c 18 }
Jason Reiss 28:c222ca8383f4 19
Jason Reiss 28:c222ca8383f4 20 if ((args.size() == 1) || ((args.size() == 3) && (args[2].size() == 1) && (args[2][0] == '?'))) {
Jason Reiss 36:b586cd6e91f3 21 #if defined(TARGET_MTS_MDOT_F411RE) || defined(TARGET_XDOT_L151CC) || defined(TARGET_XDOT_MAX32670)
Jason Reiss 28:c222ca8383f4 22 if (arg1 == '2') {
Jason Reiss 28:c222ca8383f4 23 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getProtectedAppKey(), ".").c_str());
Jason Reiss 36:b586cd6e91f3 24 } else
Jason Reiss 36:b586cd6e91f3 25 #endif
Jason Reiss 36:b586cd6e91f3 26 {
Jason Reiss 28:c222ca8383f4 27 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getNetworkKey(), ".").c_str());
Jason Reiss 28:c222ca8383f4 28 if (!CommandTerminal::Dot()->getNetworkPassphrase().empty())
Jason Reiss 28:c222ca8383f4 29 CommandTerminal::Serial()->writef("Passphrase: '%s'\r\n", CommandTerminal::Dot()->getNetworkPassphrase().c_str());
Jason Reiss 28:c222ca8383f4 30 }
Jason Reiss 28:c222ca8383f4 31 } else if (args.size() >= 3) {
Jason Reiss 28:c222ca8383f4 32 if (arg1 == '1')
Mike Fiore 1:e52ae6584f1c 33 {
Jason Reiss 28:c222ca8383f4 34 std::string text = args[2];
Jason Reiss 28:c222ca8383f4 35 // passphrase was split on commas
Jason Reiss 28:c222ca8383f4 36 for (size_t i = 3; i < args.size(); i++)
Mike Fiore 1:e52ae6584f1c 37 {
Jason Reiss 28:c222ca8383f4 38 text.append(",");
Jason Reiss 28:c222ca8383f4 39 text.append(args[i]);
Mike Fiore 1:e52ae6584f1c 40 }
Mike Fiore 1:e52ae6584f1c 41
Mike Fiore 14:f9a77400b622 42 if (CommandTerminal::Dot()->setNetworkPassphrase(text) == mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 43 {
Jason Reiss 28:c222ca8383f4 44 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 45 CommandTerminal::Serial()->writef("Set Network Passphrase: ");
Mike Fiore 14:f9a77400b622 46 CommandTerminal::Serial()->writef("%s\r\n", text.c_str());
Jason Reiss 28:c222ca8383f4 47 #endif
Mike Fiore 1:e52ae6584f1c 48 }
Mike Fiore 1:e52ae6584f1c 49 else
Mike Fiore 1:e52ae6584f1c 50 {
Mike Fiore 1:e52ae6584f1c 51 return 1;
Mike Fiore 1:e52ae6584f1c 52 }
Mike Fiore 1:e52ae6584f1c 53 }
Mike Fiore 1:e52ae6584f1c 54 else
Mike Fiore 1:e52ae6584f1c 55 {
Mike Fiore 1:e52ae6584f1c 56 std::vector<uint8_t> NewKey;
Mike Fiore 1:e52ae6584f1c 57 readByteArray(args[2], NewKey, KEY_LENGTH);
Jason Reiss 28:c222ca8383f4 58 if (arg1 != '2') {
jenkins@jenkinsdm1 18:63f098f042b2 59 if (CommandTerminal::Dot()->setNetworkKey(NewKey) == mDot::MDOT_OK)
jenkins@jenkinsdm1 18:63f098f042b2 60 {
Jason Reiss 28:c222ca8383f4 61 #if MTS_CMD_TERM_VERBOSE
jenkins@jenkinsdm1 18:63f098f042b2 62 CommandTerminal::Serial()->writef("Set Network Key: ");
jenkins@jenkinsdm1 18:63f098f042b2 63 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
Jason Reiss 28:c222ca8383f4 64 #endif
jenkins@jenkinsdm1 18:63f098f042b2 65 }
jenkins@jenkinsdm1 18:63f098f042b2 66 else
jenkins@jenkinsdm1 18:63f098f042b2 67 {
jenkins@jenkinsdm1 18:63f098f042b2 68 return 1;
jenkins@jenkinsdm1 18:63f098f042b2 69 }
jenkins@jenkinsdm1 18:63f098f042b2 70 } else {
Jason Reiss 36:b586cd6e91f3 71 #if defined(TARGET_MTS_MDOT_F411RE) || defined(TARGET_XDOT_L151CC) || defined(TARGET_XDOT_MAX32670)
Jason Reiss 36:b586cd6e91f3 72
jenkins@jenkinsdm1 18:63f098f042b2 73 if (CommandTerminal::Dot()->setProtectedAppKey(NewKey) == mDot::MDOT_OK)
jenkins@jenkinsdm1 18:63f098f042b2 74 {
Jason Reiss 28:c222ca8383f4 75 #if MTS_CMD_TERM_VERBOSE
jenkins@jenkinsdm1 18:63f098f042b2 76 CommandTerminal::Serial()->writef("Set Protected AppKey: ");
jenkins@jenkinsdm1 18:63f098f042b2 77 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
Jason Reiss 28:c222ca8383f4 78 #endif
jenkins@jenkinsdm1 18:63f098f042b2 79 }
jenkins@jenkinsdm1 18:63f098f042b2 80 else
jenkins@jenkinsdm1 18:63f098f042b2 81 {
jenkins@jenkinsdm1 18:63f098f042b2 82 return 1;
jenkins@jenkinsdm1 18:63f098f042b2 83 }
Jason Reiss 36:b586cd6e91f3 84 #endif
Mike Fiore 1:e52ae6584f1c 85 }
Mike Fiore 1:e52ae6584f1c 86 }
Mike Fiore 1:e52ae6584f1c 87 }
Mike Fiore 1:e52ae6584f1c 88
Mike Fiore 1:e52ae6584f1c 89 return 0;
Mike Fiore 1:e52ae6584f1c 90 }
Mike Fiore 1:e52ae6584f1c 91
jenkins@jenkinsdm1 18:63f098f042b2 92 bool CmdNetworkKey::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 93 {
Mike Fiore 1:e52ae6584f1c 94 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 95 return true;
Jason Reiss 28:c222ca8383f4 96 if (args.size() > 1 && args[1].size() == 1) {
Mike Fiore 1:e52ae6584f1c 97
Jason Reiss 28:c222ca8383f4 98 char arg1 = args[1][0];
Jason Reiss 28:c222ca8383f4 99
Jason Reiss 28:c222ca8383f4 100 if (args.size() == 2 && arg1 == '2')
Jason Reiss 28:c222ca8383f4 101 return true;
Jason Reiss 28:c222ca8383f4 102
Jason Reiss 28:c222ca8383f4 103 if (args.size() >= 3) {
Jason Reiss 28:c222ca8383f4 104 if (arg1 != '0' && arg1 != '1' && arg1 != '2') {
Jason Reiss 28:c222ca8383f4 105 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 106 CommandTerminal::setErrorMessage("Invalid type, expects (0,1,2)");
Jason Reiss 28:c222ca8383f4 107 #endif
Jason Reiss 28:c222ca8383f4 108 return false;
Jason Reiss 28:c222ca8383f4 109 }
Jason Reiss 27:5fafd3b26ac3 110
Jason Reiss 28:c222ca8383f4 111 if ((arg1 == '0' || arg1 == '2') && args[2] != "?" && !isHexString(args[2], KEY_LENGTH)) {
Jason Reiss 28:c222ca8383f4 112 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 113 CommandTerminal::setErrorMessage("Invalid key, expects (hex:16)");
Jason Reiss 28:c222ca8383f4 114 #endif
Jason Reiss 28:c222ca8383f4 115 return false;
Jason Reiss 28:c222ca8383f4 116 } else {
Jason Reiss 28:c222ca8383f4 117 if (args[2].size() < 8) {
Jason Reiss 28:c222ca8383f4 118 if (!((args[2].size() == 1) && (args[2][0] == '?'))) {
Jason Reiss 28:c222ca8383f4 119 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 120 CommandTerminal::setErrorMessage("Invalid name, expects minimum 8 characters");
Jason Reiss 28:c222ca8383f4 121 #endif
Jason Reiss 28:c222ca8383f4 122 return false;
Jason Reiss 28:c222ca8383f4 123 }
Jason Reiss 28:c222ca8383f4 124 } else if (args[2].size() > 128) {
Jason Reiss 28:c222ca8383f4 125 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 126 CommandTerminal::setErrorMessage("Invalid passphrase, expects (string:8-128)");
Jason Reiss 28:c222ca8383f4 127 #endif
Jason Reiss 28:c222ca8383f4 128 return false;
Jason Reiss 28:c222ca8383f4 129 }
Jason Reiss 28:c222ca8383f4 130 }
Jason Reiss 28:c222ca8383f4 131
Jason Reiss 28:c222ca8383f4 132 return true;
Mike Fiore 1:e52ae6584f1c 133 }
Mike Fiore 1:e52ae6584f1c 134 }
Mike Fiore 1:e52ae6584f1c 135
Jason Reiss 28:c222ca8383f4 136 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 137 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 138 #endif
Mike Fiore 1:e52ae6584f1c 139 return false;
Mike Fiore 1:e52ae6584f1c 140 }
Mike Fiore 1:e52ae6584f1c 141