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@35:e17e00b8e022, 21 months ago (annotated)

Committer:
Jason Reiss
Date:
Fri Aug 12 11:08:59 2022 -0500
Revision:
35:e17e00b8e022
Parent:
28:c222ca8383f4
Child:
36:b586cd6e91f3
Update AT Version to 4.1.5

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