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