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@18:63f098f042b2, 2019-03-08 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Fri Mar 08 11:37:37 2019 -0600
Revision:
18:63f098f042b2
Parent:
14:f9a77400b622
Child:
27:5fafd3b26ac3
mdot-firmware revision 3.1.0

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() :
jenkins@jenkinsdm1 18:63f098f042b2 4 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))")
Mike Fiore 1:e52ae6584f1c 5 {
Mike Fiore 1:e52ae6584f1c 6 _queryable = true;
Mike Fiore 1:e52ae6584f1c 7 }
Mike Fiore 1:e52ae6584f1c 8
jenkins@jenkinsdm1 18:63f098f042b2 9 uint32_t CmdNetworkKey::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 10 {
Mike Fiore 1:e52ae6584f1c 11 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 12 {
Mike Fiore 14:f9a77400b622 13 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getNetworkKey(), ".").c_str());
Mike Fiore 14:f9a77400b622 14 if (!CommandTerminal::Dot()->getNetworkPassphrase().empty())
Mike Fiore 14:f9a77400b622 15 CommandTerminal::Serial()->writef("Passphrase: '%s'\r\n", CommandTerminal::Dot()->getNetworkPassphrase().c_str());
Mike Fiore 1:e52ae6584f1c 16 }
Mike Fiore 1:e52ae6584f1c 17 else if (args.size() == 3)
Mike Fiore 1:e52ae6584f1c 18 {
Mike Fiore 1:e52ae6584f1c 19 if (args[1].find("1") == 0 && args[1].size() == 1)
Mike Fiore 1:e52ae6584f1c 20 {
Mike Fiore 1:e52ae6584f1c 21 std::string text;
Mike Fiore 1:e52ae6584f1c 22 if (args.size() > 3)
Mike Fiore 1:e52ae6584f1c 23 {
Mike Fiore 1:e52ae6584f1c 24 // passphrase was split on commas
Mike Fiore 1:e52ae6584f1c 25 for (size_t i = 2; i < args.size(); i++)
Mike Fiore 1:e52ae6584f1c 26 {
Mike Fiore 1:e52ae6584f1c 27 text.append(args[i]);
Mike Fiore 1:e52ae6584f1c 28 if (i < args.size() - 1)
Mike Fiore 1:e52ae6584f1c 29 text.append(",");
Mike Fiore 1:e52ae6584f1c 30 }
Mike Fiore 1:e52ae6584f1c 31 }
Mike Fiore 1:e52ae6584f1c 32 else
Mike Fiore 1:e52ae6584f1c 33 {
Mike Fiore 1:e52ae6584f1c 34 text = args[2];
Mike Fiore 1:e52ae6584f1c 35 }
Mike Fiore 1:e52ae6584f1c 36
Mike Fiore 14:f9a77400b622 37 if (CommandTerminal::Dot()->setNetworkPassphrase(text) == mDot::MDOT_OK)
Mike Fiore 1:e52ae6584f1c 38 {
Mike Fiore 14:f9a77400b622 39 CommandTerminal::Serial()->writef("Set Network Passphrase: ");
Mike Fiore 14:f9a77400b622 40 CommandTerminal::Serial()->writef("%s\r\n", text.c_str());
Mike Fiore 1:e52ae6584f1c 41 }
Mike Fiore 1:e52ae6584f1c 42 else
Mike Fiore 1:e52ae6584f1c 43 {
Mike Fiore 14:f9a77400b622 44 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Mike Fiore 1:e52ae6584f1c 45 return 1;
Mike Fiore 1:e52ae6584f1c 46 }
Mike Fiore 1:e52ae6584f1c 47 }
Mike Fiore 1:e52ae6584f1c 48 else
Mike Fiore 1:e52ae6584f1c 49 {
Mike Fiore 1:e52ae6584f1c 50 std::vector<uint8_t> NewKey;
Mike Fiore 1:e52ae6584f1c 51 readByteArray(args[2], NewKey, KEY_LENGTH);
jenkins@jenkinsdm1 18:63f098f042b2 52 if (args[1] != "2") {
jenkins@jenkinsdm1 18:63f098f042b2 53 if (CommandTerminal::Dot()->setNetworkKey(NewKey) == mDot::MDOT_OK)
jenkins@jenkinsdm1 18:63f098f042b2 54 {
jenkins@jenkinsdm1 18:63f098f042b2 55 CommandTerminal::Serial()->writef("Set Network Key: ");
jenkins@jenkinsdm1 18:63f098f042b2 56 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
jenkins@jenkinsdm1 18:63f098f042b2 57 }
jenkins@jenkinsdm1 18:63f098f042b2 58 else
jenkins@jenkinsdm1 18:63f098f042b2 59 {
jenkins@jenkinsdm1 18:63f098f042b2 60 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
jenkins@jenkinsdm1 18:63f098f042b2 61 return 1;
jenkins@jenkinsdm1 18:63f098f042b2 62 }
jenkins@jenkinsdm1 18:63f098f042b2 63 } else {
jenkins@jenkinsdm1 18:63f098f042b2 64 #ifdef MTS_RADIO_DEBUG_COMMANDS
jenkins@jenkinsdm1 18:63f098f042b2 65 if (CommandTerminal::Dot()->setProtectedAppKey(NewKey) == mDot::MDOT_OK)
jenkins@jenkinsdm1 18:63f098f042b2 66 {
jenkins@jenkinsdm1 18:63f098f042b2 67 CommandTerminal::Serial()->writef("Set Protected AppKey: ");
jenkins@jenkinsdm1 18:63f098f042b2 68 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(NewKey, ".").c_str());
jenkins@jenkinsdm1 18:63f098f042b2 69 }
jenkins@jenkinsdm1 18:63f098f042b2 70 else
jenkins@jenkinsdm1 18:63f098f042b2 71 {
jenkins@jenkinsdm1 18:63f098f042b2 72 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
jenkins@jenkinsdm1 18:63f098f042b2 73 return 1;
jenkins@jenkinsdm1 18:63f098f042b2 74 }
jenkins@jenkinsdm1 18:63f098f042b2 75 #else
jenkins@jenkinsdm1 18:63f098f042b2 76 CommandTerminal::Serial()->writef("Setting protected area only supported with mfg build!\r\n");
jenkins@jenkinsdm1 18:63f098f042b2 77 #endif
Mike Fiore 1:e52ae6584f1c 78 }
Mike Fiore 1:e52ae6584f1c 79 }
Mike Fiore 1:e52ae6584f1c 80 }
Mike Fiore 1:e52ae6584f1c 81
Mike Fiore 1:e52ae6584f1c 82 return 0;
Mike Fiore 1:e52ae6584f1c 83 }
Mike Fiore 1:e52ae6584f1c 84
jenkins@jenkinsdm1 18:63f098f042b2 85 bool CmdNetworkKey::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 86 {
Mike Fiore 1:e52ae6584f1c 87 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 88 return true;
Mike Fiore 1:e52ae6584f1c 89
Mike Fiore 1:e52ae6584f1c 90 if (args.size() == 3) {
jenkins@jenkinsdm1 18:63f098f042b2 91 if (args[1] != "0" && args[1] != "1" && args[1] != "2") {
jenkins@jenkinsdm1 18:63f098f042b2 92 CommandTerminal::setErrorMessage("Invalid type, expects (0,1,2)");
Mike Fiore 1:e52ae6584f1c 93 return false;
Mike Fiore 1:e52ae6584f1c 94 }
jenkins@jenkinsdm1 18:63f098f042b2 95 if ((args[1] == "0" || args[1] == "2") && !isHexString(args[2], 16)) {
Mike Fiore 14:f9a77400b622 96 CommandTerminal::setErrorMessage("Invalid key, expects (hex:16)");
Mike Fiore 1:e52ae6584f1c 97 return false;
Mike Fiore 1:e52ae6584f1c 98 }
Mike Fiore 1:e52ae6584f1c 99
Mike Fiore 1:e52ae6584f1c 100 if (args[1] == "1" && args[2].size() < 8) {
Mike Fiore 14:f9a77400b622 101 CommandTerminal::setErrorMessage("Invalid name, expects minimum 8 characters");
Mike Fiore 1:e52ae6584f1c 102 return false;
Mike Fiore 1:e52ae6584f1c 103 }
Mike Fiore 1:e52ae6584f1c 104
Mike Fiore 1:e52ae6584f1c 105 if (args[1] == "1" && (args[2].size() > 128 || args[2].size() < 8)) {
Mike Fiore 14:f9a77400b622 106 CommandTerminal::setErrorMessage("Invalid passphrase, expects (string:8-128)");
Mike Fiore 1:e52ae6584f1c 107 return false;
Mike Fiore 1:e52ae6584f1c 108 }
Mike Fiore 1:e52ae6584f1c 109
Mike Fiore 1:e52ae6584f1c 110 return true;
Mike Fiore 1:e52ae6584f1c 111 }
Mike Fiore 1:e52ae6584f1c 112
Mike Fiore 14:f9a77400b622 113 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 114 return false;
Mike Fiore 1:e52ae6584f1c 115 }
Mike Fiore 1:e52ae6584f1c 116