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/CmdDeviceId.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 
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdDeviceId.h"
Mike Fiore 1:e52ae6584f1c 2 #include <algorithm>
Mike Fiore 1:e52ae6584f1c 3
Mike Fiore 14:f9a77400b622 4 CmdDeviceId::CmdDeviceId() :
Jason Reiss 28:c222ca8383f4 5 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 6 Command("Device ID", "AT+DI", "Device EUI-64 (MSB) (unique, set at factory) (8 bytes)", "(hex:8)")
Jason Reiss 27:5fafd3b26ac3 7 #else
Jason Reiss 28:c222ca8383f4 8 Command("AT+DI")
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 CmdDeviceId::action(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 15 {
Mike Fiore 1:e52ae6584f1c 16 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 17 {
Mike Fiore 14:f9a77400b622 18 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getDeviceId(), "-").c_str());
Mike Fiore 1:e52ae6584f1c 19 }
Mike Fiore 14:f9a77400b622 20 else if (args.size() == 2)
Mike Fiore 14:f9a77400b622 21 {
Mike Fiore 14:f9a77400b622 22 std::vector<uint8_t> NewEUI;
Mike Fiore 1:e52ae6584f1c 23
Mike Fiore 14:f9a77400b622 24 // Read in the key components...
Mike Fiore 14:f9a77400b622 25 readByteArray(args[1], NewEUI, EUI_LENGTH);
Mike Fiore 14:f9a77400b622 26
Mike Fiore 14:f9a77400b622 27 if (CommandTerminal::Dot()->setDeviceId(NewEUI) == mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 28 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(NewEUI, "-").c_str());
Mike Fiore 14:f9a77400b622 29 } else {
Mike Fiore 14:f9a77400b622 30 return 1;
Mike Fiore 14:f9a77400b622 31 }
Mike Fiore 14:f9a77400b622 32 }
Jason Reiss 27:5fafd3b26ac3 33
Mike Fiore 1:e52ae6584f1c 34 return 0;
Mike Fiore 1:e52ae6584f1c 35 }
Mike Fiore 1:e52ae6584f1c 36
jenkins@jenkinsdm1 18:63f098f042b2 37 bool CmdDeviceId::verify(const std::vector<std::string>& args)
Mike Fiore 1:e52ae6584f1c 38 {
Mike Fiore 1:e52ae6584f1c 39 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 40 return true;
Mike Fiore 1:e52ae6584f1c 41
Mike Fiore 14:f9a77400b622 42 if (args.size() == 2 && isHexString(args[1], 8))
Mike Fiore 14:f9a77400b622 43 return true;
Mike Fiore 14:f9a77400b622 44
Jason Reiss 28:c222ca8383f4 45 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 14:f9a77400b622 46 CommandTerminal::setErrorMessage("Invalid id, expects (hex:8)");
Jason Reiss 28:c222ca8383f4 47 #endif
Mike Fiore 14:f9a77400b622 48
Mike Fiore 1:e52ae6584f1c 49 return false;
Mike Fiore 1:e52ae6584f1c 50 }