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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 14:f9a77400b622 1 #include "CmdChannelMask.h"
jenkins@jenkinsdm1 16:d5cf2af81a6d 2 #include "ChannelPlan.h"
Mike Fiore 14:f9a77400b622 3
Mike Fiore 14:f9a77400b622 4 CmdChannelMask::CmdChannelMask()
Mike Fiore 14:f9a77400b622 5 :
Jason Reiss 27:5fafd3b26ac3 6 Command("Channel Mask", "AT+CHM",
Jason Reiss 27:5fafd3b26ac3 7 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 8 "Get/set channel mask (OFFSET:0-4,MASK:0000-FFFF)",
Jason Reiss 27:5fafd3b26ac3 9 #else
Jason Reiss 27:5fafd3b26ac3 10 "",
Jason Reiss 27:5fafd3b26ac3 11 #endif
Jason Reiss 27:5fafd3b26ac3 12 "(OFFSET:0-4,MASK:0000-FFFF)")
Mike Fiore 14:f9a77400b622 13 {
Mike Fiore 14:f9a77400b622 14 _queryable = true;
Mike Fiore 14:f9a77400b622 15 }
Mike Fiore 14:f9a77400b622 16
jenkins@jenkinsdm1 18:63f098f042b2 17 uint32_t CmdChannelMask::action(const std::vector<std::string>& args) {
Mike Fiore 14:f9a77400b622 18
Mike Fiore 14:f9a77400b622 19 if (args.size() == 1) {
Mike Fiore 14:f9a77400b622 20 if (CommandTerminal::Dot()->getVerbose())
Mike Fiore 14:f9a77400b622 21 CommandTerminal::Serial()->writef("Channel Mask: ");
Mike Fiore 14:f9a77400b622 22
Mike Fiore 14:f9a77400b622 23 std::vector<uint16_t> mask = CommandTerminal::Dot()->getChannelMask();
Mike Fiore 14:f9a77400b622 24
Mike Fiore 14:f9a77400b622 25 for (int i = int(mask.size()) - 1; i >= 0; i--) {
Mike Fiore 14:f9a77400b622 26 CommandTerminal::Serial()->writef("%04X", mask[i]);
Mike Fiore 14:f9a77400b622 27 }
Mike Fiore 14:f9a77400b622 28
Mike Fiore 14:f9a77400b622 29 CommandTerminal::Serial()->writef("\r\n");
Mike Fiore 14:f9a77400b622 30
Mike Fiore 14:f9a77400b622 31 } else if (args.size() == 3) {
Mike Fiore 14:f9a77400b622 32 int temp = 0;
Mike Fiore 14:f9a77400b622 33 int offset = 0;
Mike Fiore 14:f9a77400b622 34 uint16_t mask = 0;
Mike Fiore 14:f9a77400b622 35
Mike Fiore 14:f9a77400b622 36 sscanf(args[1].c_str(), "%d", &offset);
Mike Fiore 14:f9a77400b622 37
Mike Fiore 14:f9a77400b622 38 // Convert the ASCII hex data to binary...
Mike Fiore 14:f9a77400b622 39 sscanf(&args[2][0], "%02x", &temp);
Mike Fiore 14:f9a77400b622 40 mask = uint8_t(temp) << 8;
Mike Fiore 14:f9a77400b622 41 sscanf(&args[2][2], "%02x", &temp);
Mike Fiore 14:f9a77400b622 42 mask |= uint8_t(temp);
Mike Fiore 14:f9a77400b622 43
Jason Reiss 23:4f0a981c0349 44 if (CommandTerminal::Dot()->setChannelMask(offset, mask) != mDot::MDOT_OK) {
Mike Fiore 14:f9a77400b622 45 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
Mike Fiore 14:f9a77400b622 46 return 1;
Mike Fiore 14:f9a77400b622 47 }
Mike Fiore 14:f9a77400b622 48 }
Mike Fiore 14:f9a77400b622 49
Mike Fiore 14:f9a77400b622 50 return 0;
Mike Fiore 14:f9a77400b622 51 }
Mike Fiore 14:f9a77400b622 52
jenkins@jenkinsdm1 18:63f098f042b2 53 bool CmdChannelMask::verify(const std::vector<std::string>& args) {
Mike Fiore 14:f9a77400b622 54 if (args.size() == 1)
Mike Fiore 14:f9a77400b622 55 return true;
Mike Fiore 14:f9a77400b622 56
Mike Fiore 14:f9a77400b622 57 if (args.size() == 3) {
Mike Fiore 14:f9a77400b622 58
Mike Fiore 14:f9a77400b622 59 int offset;
Mike Fiore 14:f9a77400b622 60 if (sscanf(args[1].c_str(), "%d", &offset) != 1) {
Mike Fiore 14:f9a77400b622 61 CommandTerminal::setErrorMessage("Invalid argument");
Mike Fiore 14:f9a77400b622 62 return false;
Mike Fiore 14:f9a77400b622 63 }
Mike Fiore 14:f9a77400b622 64
jenkins@jenkinsdm1 16:d5cf2af81a6d 65 if (lora::ChannelPlan::IsPlanDynamic(CommandTerminal::Dot()->getFrequencyBand())) {
Mike Fiore 14:f9a77400b622 66 if (offset > 0) {
Mike Fiore 14:f9a77400b622 67 CommandTerminal::setErrorMessage("Invalid offset, expects (0)");
Mike Fiore 14:f9a77400b622 68 return false;
Mike Fiore 14:f9a77400b622 69 }
Mike Fiore 14:f9a77400b622 70 } else {
Mike Fiore 14:f9a77400b622 71 if (offset < 0 || offset > 4) {
Mike Fiore 14:f9a77400b622 72 CommandTerminal::setErrorMessage("Invalid offset, expects (0-4)");
Mike Fiore 14:f9a77400b622 73 return false;
Mike Fiore 14:f9a77400b622 74 }
Mike Fiore 14:f9a77400b622 75 }
Mike Fiore 14:f9a77400b622 76
Mike Fiore 14:f9a77400b622 77 if (!isHexString(args[2], 2)) {
Mike Fiore 14:f9a77400b622 78 CommandTerminal::setErrorMessage("Invalid mask, expect (0000-FFFF)");
Mike Fiore 14:f9a77400b622 79 return false;
Mike Fiore 14:f9a77400b622 80 }
Mike Fiore 14:f9a77400b622 81
Mike Fiore 14:f9a77400b622 82 return true;
Mike Fiore 14:f9a77400b622 83 }
Mike Fiore 14:f9a77400b622 84
Mike Fiore 14:f9a77400b622 85 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 14:f9a77400b622 86 return false;
Mike Fiore 14:f9a77400b622 87 }