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