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. Check the commit messages of the Dot library version used to find the correct mbed-os version to use with it. The mbed-os version must match the version used in that version of Dot library or it will likely cause it to fail to compile or have unexpected problems while running.

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/CmdDutyCycle.cpp@34:3b696c2b1e4b, 2021-11-11 (annotated)

Committer:
Jason Reiss
Date:
Thu Nov 11 13:52:20 2021 -0600
Revision:
34:3b696c2b1e4b
update command terminal

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jason Reiss 34:3b696c2b1e4b 1 #include "CmdDutyCycle.h"
Jason Reiss 34:3b696c2b1e4b 2
Jason Reiss 34:3b696c2b1e4b 3
Jason Reiss 34:3b696c2b1e4b 4 static inline void printDutyBand(uint8_t i) {
Jason Reiss 34:3b696c2b1e4b 5 const lora::DutyBand* band = CommandTerminal::Dot()->getDutyBand(i);
Jason Reiss 34:3b696c2b1e4b 6 if (band) {
Jason Reiss 34:3b696c2b1e4b 7 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 34:3b696c2b1e4b 8 CommandTerminal::Serial()->writef("%-5" PRIu16 "\t%9" PRIu32 "\t%9" PRIu32 "\t%" PRIu16 "\r\n",
Jason Reiss 34:3b696c2b1e4b 9 (uint16_t)i, band->FrequencyMin, band->FrequencyMax, band->DutyCycle);
Jason Reiss 34:3b696c2b1e4b 10 #else
Jason Reiss 34:3b696c2b1e4b 11 CommandTerminal::Serial()->writef("%" PRIu16 ",%" PRIu32 ",%" PRIu32 ",%" PRIu16 "\r\n",
Jason Reiss 34:3b696c2b1e4b 12 (uint16_t)i, band->FrequencyMin, band->FrequencyMax, band->DutyCycle);
Jason Reiss 34:3b696c2b1e4b 13 #endif
Jason Reiss 34:3b696c2b1e4b 14 }
Jason Reiss 34:3b696c2b1e4b 15 }
Jason Reiss 34:3b696c2b1e4b 16
Jason Reiss 34:3b696c2b1e4b 17 CmdDutyCycle::CmdDutyCycle() :
Jason Reiss 34:3b696c2b1e4b 18 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 34:3b696c2b1e4b 19 Command("Duty Cycle", "AT+DUTY", "Set duty cycle maximum or per band.", "<0-15> or <BAND_INDEX>,<OFF_RATIO>")
Jason Reiss 34:3b696c2b1e4b 20 #else
Jason Reiss 34:3b696c2b1e4b 21 Command("AT+DUTY")
Jason Reiss 34:3b696c2b1e4b 22 #endif
Jason Reiss 34:3b696c2b1e4b 23 {
Jason Reiss 34:3b696c2b1e4b 24 _queryable = true;
Jason Reiss 34:3b696c2b1e4b 25 }
Jason Reiss 34:3b696c2b1e4b 26
Jason Reiss 34:3b696c2b1e4b 27 uint32_t CmdDutyCycle::action(const std::vector<std::string>& args) {
Jason Reiss 34:3b696c2b1e4b 28 if (args.size() == 1) {
Jason Reiss 34:3b696c2b1e4b 29 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 34:3b696c2b1e4b 30 CommandTerminal::Serial()->writef( "Max %" PRIu16 "\r\n", (uint16_t)CommandTerminal::Dot()->getDutyCycle());
Jason Reiss 34:3b696c2b1e4b 31 CommandTerminal::Serial()->writef( "Index\tFreq Low \tFreq High\tOff Ratio\r\n");
Jason Reiss 34:3b696c2b1e4b 32 #else
Jason Reiss 34:3b696c2b1e4b 33 CommandTerminal::Serial()->writef( "%" PRIu16 "\r\n", (uint16_t)CommandTerminal::Dot()->getDutyCycle());
Jason Reiss 34:3b696c2b1e4b 34 #endif
Jason Reiss 34:3b696c2b1e4b 35
Jason Reiss 34:3b696c2b1e4b 36 for (uint8_t i = 0; i < CommandTerminal::Dot()->getDutyBands(); ++i) {
Jason Reiss 34:3b696c2b1e4b 37 printDutyBand(i);
Jason Reiss 34:3b696c2b1e4b 38 }
Jason Reiss 34:3b696c2b1e4b 39
Jason Reiss 34:3b696c2b1e4b 40 } else if (args.size() == 2) {
Jason Reiss 34:3b696c2b1e4b 41 int dc;
Jason Reiss 34:3b696c2b1e4b 42 sscanf(args[1].c_str(), "%d", &dc);
Jason Reiss 34:3b696c2b1e4b 43 if (CommandTerminal::Dot()->setDutyCycle(dc) != mDot::MDOT_OK) {
Jason Reiss 34:3b696c2b1e4b 44 return 1;
Jason Reiss 34:3b696c2b1e4b 45 }
Jason Reiss 34:3b696c2b1e4b 46 } else if (args.size() == 3) {
Jason Reiss 34:3b696c2b1e4b 47 int band_index;
Jason Reiss 34:3b696c2b1e4b 48 int dc;
Jason Reiss 34:3b696c2b1e4b 49
Jason Reiss 34:3b696c2b1e4b 50 sscanf(args[1].c_str(), "%d", &band_index);
Jason Reiss 34:3b696c2b1e4b 51 sscanf(args[2].c_str(), "%d", &dc);
Jason Reiss 34:3b696c2b1e4b 52 int32_t ret = CommandTerminal::Dot()->setDutyBandDutyCycle((uint8_t)band_index, dc);
Jason Reiss 34:3b696c2b1e4b 53 if (ret == mDot::MDOT_OK) {
Jason Reiss 34:3b696c2b1e4b 54 printDutyBand(band_index);
Jason Reiss 34:3b696c2b1e4b 55 } else {
Jason Reiss 34:3b696c2b1e4b 56 return 1;
Jason Reiss 34:3b696c2b1e4b 57 }
Jason Reiss 34:3b696c2b1e4b 58 }
Jason Reiss 34:3b696c2b1e4b 59 return 0;
Jason Reiss 34:3b696c2b1e4b 60 }
Jason Reiss 34:3b696c2b1e4b 61
Jason Reiss 34:3b696c2b1e4b 62 bool CmdDutyCycle::verify(const std::vector<std::string>& args) {
Jason Reiss 34:3b696c2b1e4b 63
Jason Reiss 34:3b696c2b1e4b 64 if (args.size() == 1) {
Jason Reiss 34:3b696c2b1e4b 65 return true;
Jason Reiss 34:3b696c2b1e4b 66 } else if (args.size() == 2) {
Jason Reiss 34:3b696c2b1e4b 67 int dc;
Jason Reiss 34:3b696c2b1e4b 68
Jason Reiss 34:3b696c2b1e4b 69 sscanf(args[1].c_str(), "%d", &dc);
Jason Reiss 34:3b696c2b1e4b 70
Jason Reiss 34:3b696c2b1e4b 71 if ((dc < 0) || (dc > 15)) {
Jason Reiss 34:3b696c2b1e4b 72 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 34:3b696c2b1e4b 73 CommandTerminal::setErrorMessage("Invalid parameter, expects (0-15)");
Jason Reiss 34:3b696c2b1e4b 74 #endif
Jason Reiss 34:3b696c2b1e4b 75 return false;
Jason Reiss 34:3b696c2b1e4b 76 }
Jason Reiss 34:3b696c2b1e4b 77 return true;
Jason Reiss 34:3b696c2b1e4b 78 } else if (args.size() == 3) {
Jason Reiss 34:3b696c2b1e4b 79 int band;
Jason Reiss 34:3b696c2b1e4b 80 int dc;
Jason Reiss 34:3b696c2b1e4b 81
Jason Reiss 34:3b696c2b1e4b 82 sscanf(args[1].c_str(), "%d", &band);
Jason Reiss 34:3b696c2b1e4b 83
Jason Reiss 34:3b696c2b1e4b 84 if ((band < 0) || (band >= CommandTerminal::Dot()->getDutyBands())) {
Jason Reiss 34:3b696c2b1e4b 85 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 34:3b696c2b1e4b 86 CommandTerminal::setErrorMessage("Invalid parameter, expects valid duty band index");
Jason Reiss 34:3b696c2b1e4b 87 #endif
Jason Reiss 34:3b696c2b1e4b 88 return false;
Jason Reiss 34:3b696c2b1e4b 89 }
Jason Reiss 34:3b696c2b1e4b 90
Jason Reiss 34:3b696c2b1e4b 91 sscanf(args[2].c_str(), "%d", &dc);
Jason Reiss 34:3b696c2b1e4b 92
Jason Reiss 34:3b696c2b1e4b 93 if ((dc < 0) || (dc > 65535)) {
Jason Reiss 34:3b696c2b1e4b 94 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 34:3b696c2b1e4b 95 CommandTerminal::setErrorMessage("Invalid parameter, expects (0-65535)");
Jason Reiss 34:3b696c2b1e4b 96 #endif
Jason Reiss 34:3b696c2b1e4b 97 return false;
Jason Reiss 34:3b696c2b1e4b 98 }
Jason Reiss 34:3b696c2b1e4b 99 return true;
Jason Reiss 34:3b696c2b1e4b 100 }
Jason Reiss 34:3b696c2b1e4b 101
Jason Reiss 34:3b696c2b1e4b 102 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 34:3b696c2b1e4b 103 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 34:3b696c2b1e4b 104 #endif
Jason Reiss 34:3b696c2b1e4b 105 return false;
Jason Reiss 34:3b696c2b1e4b 106 }