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