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@33:5c0252521669, 2021-01-29 (annotated)

Committer:
Jason Reiss
Date:
Fri Jan 29 13:04:32 2021 -0600
Revision:
33:5c0252521669
Parent:
28:c222ca8383f4
Child:
36:b586cd6e91f3
Remove moved commands

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