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/CmdNetworkAddress.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 "CmdNetworkAddress.h"
Mike Fiore 1:e52ae6584f1c 2 #include <algorithm>
Mike Fiore 1:e52ae6584f1c 3
Mike Fiore 14:f9a77400b622 4 CmdNetworkAddress::CmdNetworkAddress() :
Jason Reiss 27:5fafd3b26ac3 5 Command("Network Address", "AT+NA",
Jason Reiss 27:5fafd3b26ac3 6 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 7 "Network address (devAddr in LoraMac) (4 bytes)",
Jason Reiss 27:5fafd3b26ac3 8 #else
Jason Reiss 27:5fafd3b26ac3 9 "",
Jason Reiss 27:5fafd3b26ac3 10 #endif
Jason Reiss 27:5fafd3b26ac3 11 "(hex:4) or (1-8),(hex:4)")
Mike Fiore 1:e52ae6584f1c 12 {
Mike Fiore 1:e52ae6584f1c 13 _queryable = true;
Mike Fiore 1:e52ae6584f1c 14 }
Mike Fiore 1:e52ae6584f1c 15
jenkins@jenkinsdm1 18:63f098f042b2 16 uint32_t CmdNetworkAddress::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 17 {
Mike Fiore 1:e52ae6584f1c 18 std::vector<uint8_t> addr;
Mike Fiore 1:e52ae6584f1c 19
Mike Fiore 1:e52ae6584f1c 20 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 21 {
Mike Fiore 14:f9a77400b622 22 addr = CommandTerminal::Dot()->getNetworkAddress();
Mike Fiore 14:f9a77400b622 23 CommandTerminal::Serial()->writef("%02x:%02x:%02x:%02x\r\n", addr[0], addr[1], addr[2], addr[3]);
Mike Fiore 1:e52ae6584f1c 24 }
Jason Reiss 27:5fafd3b26ac3 25 else if (args.size() == 2 || args.size() == 3)
Mike Fiore 1:e52ae6584f1c 26 {
Jason Reiss 27:5fafd3b26ac3 27 int index = 0;
Jason Reiss 27:5fafd3b26ac3 28 int arg_index = 1;
Jason Reiss 27:5fafd3b26ac3 29 if (args.size() == 3) {
Jason Reiss 27:5fafd3b26ac3 30 arg_index = 2;
Jason Reiss 27:5fafd3b26ac3 31 sscanf(args[1].c_str(), "%d", &index);
Mike Fiore 1:e52ae6584f1c 32 }
Mike Fiore 1:e52ae6584f1c 33
Jason Reiss 27:5fafd3b26ac3 34 if (args[2] == "?") {
Jason Reiss 27:5fafd3b26ac3 35 uint32_t addr = CommandTerminal::Dot()->getMulticastAddress(index-1);
Jason Reiss 27:5fafd3b26ac3 36 CommandTerminal::Serial()->writef("%02x:%02x:%02x:%02x\r\n", addr >> 24, (addr >> 16) & 0xff, (addr >> 8) & 0xff, (addr) & 0xff);
Mike Fiore 1:e52ae6584f1c 37 } else {
Jason Reiss 27:5fafd3b26ac3 38 int temp;
Jason Reiss 27:5fafd3b26ac3 39 uint32_t step = 2;
Jason Reiss 27:5fafd3b26ac3 40
Jason Reiss 27:5fafd3b26ac3 41 if (args[arg_index].find(":") != std::string::npos
Jason Reiss 27:5fafd3b26ac3 42 || args[arg_index].find(".") != std::string::npos
Jason Reiss 27:5fafd3b26ac3 43 || args[arg_index].find("-") != std::string::npos)
Jason Reiss 27:5fafd3b26ac3 44 step = 3;
Jason Reiss 27:5fafd3b26ac3 45
Jason Reiss 27:5fafd3b26ac3 46 // Convert the ASCII hex data to binary...
Jason Reiss 27:5fafd3b26ac3 47 for (size_t i = 0; i < args[arg_index].size(); i += step)
Jason Reiss 27:5fafd3b26ac3 48 {
Jason Reiss 27:5fafd3b26ac3 49 sscanf(&args[arg_index][i], "%02x", &temp);
Jason Reiss 27:5fafd3b26ac3 50 addr.push_back(temp);
Jason Reiss 27:5fafd3b26ac3 51 }
Jason Reiss 27:5fafd3b26ac3 52
Jason Reiss 27:5fafd3b26ac3 53 if (arg_index == 2 && CommandTerminal::Dot()->setMulticastAddress(index-1, addr[0] << 24 | addr[1] << 16 | addr[2] << 8 | addr[3]) == mDot::MDOT_OK) {
Jason Reiss 27:5fafd3b26ac3 54 CommandTerminal::Serial()->writef("Set Network Address: ");
Jason Reiss 27:5fafd3b26ac3 55 CommandTerminal::Serial()->writef("%02x:%02x:%02x:%02x\r\n", addr[0], addr[1], addr[2], addr[3]);
Jason Reiss 27:5fafd3b26ac3 56 } else if (arg_index == 1 && CommandTerminal::Dot()->setNetworkAddress(addr) == mDot::MDOT_OK) {
Jason Reiss 27:5fafd3b26ac3 57 CommandTerminal::Serial()->writef("Set Network Address: ");
Jason Reiss 27:5fafd3b26ac3 58 CommandTerminal::Serial()->writef("%02x:%02x:%02x:%02x\r\n", addr[0], addr[1], addr[2], addr[3]);
Jason Reiss 27:5fafd3b26ac3 59 } else {
Jason Reiss 27:5fafd3b26ac3 60 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());;
Jason Reiss 27:5fafd3b26ac3 61 return 1;
Jason Reiss 27:5fafd3b26ac3 62 }
Mike Fiore 1:e52ae6584f1c 63 }
Mike Fiore 1:e52ae6584f1c 64 }
Mike Fiore 1:e52ae6584f1c 65
Mike Fiore 1:e52ae6584f1c 66 return 0;
Mike Fiore 1:e52ae6584f1c 67 }
Mike Fiore 1:e52ae6584f1c 68
jenkins@jenkinsdm1 18:63f098f042b2 69 bool CmdNetworkAddress::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 70 {
Mike Fiore 1:e52ae6584f1c 71 if (args.size() == 1) {
Mike Fiore 1:e52ae6584f1c 72 return true;
Mike Fiore 1:e52ae6584f1c 73 }
Mike Fiore 1:e52ae6584f1c 74
Mike Fiore 1:e52ae6584f1c 75 if (args.size() == 2) {
Jason Reiss 27:5fafd3b26ac3 76
Mike Fiore 1:e52ae6584f1c 77 if (!isHexString(args[1], 4))
Mike Fiore 1:e52ae6584f1c 78 {
Mike Fiore 14:f9a77400b622 79 CommandTerminal::setErrorMessage("Invalid address, expects (hex:4)");
Mike Fiore 1:e52ae6584f1c 80 return false;
Mike Fiore 1:e52ae6584f1c 81 }
Mike Fiore 1:e52ae6584f1c 82
Mike Fiore 1:e52ae6584f1c 83 return true;
Mike Fiore 1:e52ae6584f1c 84 }
Mike Fiore 1:e52ae6584f1c 85
Jason Reiss 27:5fafd3b26ac3 86 if (args.size() == 3) {
Jason Reiss 27:5fafd3b26ac3 87 int index = 0;
Jason Reiss 27:5fafd3b26ac3 88 sscanf(args[1].c_str(), "%d", &index);
Jason Reiss 27:5fafd3b26ac3 89
Jason Reiss 27:5fafd3b26ac3 90 if (args[1].size() == 1 && (index < 1 || index > 8)) {
Jason Reiss 27:5fafd3b26ac3 91 CommandTerminal::setErrorMessage("Invalid index, expects 1-8");
Jason Reiss 27:5fafd3b26ac3 92 return false;
Jason Reiss 27:5fafd3b26ac3 93 } else if (args[2] != "?" && !isHexString(args[2], 4)) {
Jason Reiss 27:5fafd3b26ac3 94 CommandTerminal::setErrorMessage("Invalid address, expects (hex:4)");
Jason Reiss 27:5fafd3b26ac3 95 return false;
Jason Reiss 27:5fafd3b26ac3 96 }
Jason Reiss 27:5fafd3b26ac3 97
Jason Reiss 27:5fafd3b26ac3 98 return true;
Jason Reiss 27:5fafd3b26ac3 99 }
Jason Reiss 27:5fafd3b26ac3 100
Mike Fiore 14:f9a77400b622 101 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 102 return false;
Mike Fiore 1:e52ae6584f1c 103 }