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