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@27:5fafd3b26ac3, 2020-09-11 (annotated)

Committer:
Jason Reiss
Date:
Fri Sep 11 13:16:33 2020 -0500
Revision:
27:5fafd3b26ac3
Parent:
18:63f098f042b2
Child:
28:c222ca8383f4
Update to Dot 3.3.6

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