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/CmdRxDataRate.cpp@9:ff62b20f7000, 2016-04-04 (annotated)

Committer:
Mike Fiore
Date:
Mon Apr 04 09:00:31 2016 -0500
Revision:
9:ff62b20f7000
Parent:
1:e52ae6584f1c
Child:
14:f9a77400b622
update to version 1.0.8 of AT firmware

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdRxDataRate.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 9:ff62b20f7000 3 CmdRxDataRate::CmdRxDataRate(mDot* dot, mts::MTSSerial& serial)
Mike Fiore 9:ff62b20f7000 4 :
Mike Fiore 9:ff62b20f7000 5 Command(dot, "Rx Data Rate", "AT+RXDR", "Set the Rx datarate, testing purposes only"),
Mike Fiore 9:ff62b20f7000 6 _serial(serial)
Mike Fiore 1:e52ae6584f1c 7 {
Mike Fiore 1:e52ae6584f1c 8 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 9:ff62b20f7000 9 if (_dot->getFrequencyBand() == mDot::FB_915)
Mike Fiore 9:ff62b20f7000 10 _usage = "(7-10|DR0-DR4|DR8-DR13)";
Mike Fiore 1:e52ae6584f1c 11 else
Mike Fiore 9:ff62b20f7000 12 _usage = "(7-12|DR0-DR7)";
Mike Fiore 1:e52ae6584f1c 13
Mike Fiore 1:e52ae6584f1c 14 _queryable = true;
Mike Fiore 1:e52ae6584f1c 15 }
Mike Fiore 1:e52ae6584f1c 16
Mike Fiore 9:ff62b20f7000 17 uint32_t CmdRxDataRate::action(std::vector<std::string> args) {
Mike Fiore 9:ff62b20f7000 18 if (args.size() == 1) {
Mike Fiore 1:e52ae6584f1c 19 if (_dot->getVerbose())
Mike Fiore 1:e52ae6584f1c 20 _serial.writef("Rx Data Rate: ");
Mike Fiore 1:e52ae6584f1c 21
Mike Fiore 1:e52ae6584f1c 22 _serial.writef("%s\r\n", mDot::DataRateStr(_dot->getRxDataRate()).c_str());
Mike Fiore 1:e52ae6584f1c 23 }
Mike Fiore 9:ff62b20f7000 24 else if (args.size() == 2) {
Mike Fiore 9:ff62b20f7000 25 std::string dr = mts::Text::toUpper(args[1]);
Mike Fiore 1:e52ae6584f1c 26 int32_t code;
Mike Fiore 9:ff62b20f7000 27 int datarate = 0;
Mike Fiore 1:e52ae6584f1c 28 uint8_t i;
Mike Fiore 1:e52ae6584f1c 29
Mike Fiore 9:ff62b20f7000 30 int res = sscanf(dr.c_str(), "%d", &datarate);
Mike Fiore 9:ff62b20f7000 31
Mike Fiore 9:ff62b20f7000 32 if (res == 0) {
Mike Fiore 9:ff62b20f7000 33 for (i = 0; i < 24; i++) {
Mike Fiore 9:ff62b20f7000 34 if (mDot::DataRateStr(i).find(dr) != std::string::npos) {
Mike Fiore 9:ff62b20f7000 35 datarate = i;
Mike Fiore 9:ff62b20f7000 36 break;
Mike Fiore 9:ff62b20f7000 37 }
Mike Fiore 9:ff62b20f7000 38 }
Mike Fiore 9:ff62b20f7000 39 } else {
Mike Fiore 9:ff62b20f7000 40 if (datarate > 6) {
Mike Fiore 9:ff62b20f7000 41 // Convert SF to DR
Mike Fiore 9:ff62b20f7000 42 if (_dot->getFrequencyBand() == mDot::FB_915) {
Mike Fiore 9:ff62b20f7000 43 datarate = 10 - datarate;
Mike Fiore 9:ff62b20f7000 44 } else {
Mike Fiore 9:ff62b20f7000 45 datarate = 12 - datarate;
Mike Fiore 9:ff62b20f7000 46 }
Mike Fiore 1:e52ae6584f1c 47 }
Mike Fiore 1:e52ae6584f1c 48 }
Mike Fiore 1:e52ae6584f1c 49
Mike Fiore 9:ff62b20f7000 50 if ((code = _dot->setRxDataRate(datarate)) != mDot::MDOT_OK) {
Mike Fiore 9:ff62b20f7000 51 setErrorMessage(_dot->getLastError());;
Mike Fiore 1:e52ae6584f1c 52 return 1;
Mike Fiore 1:e52ae6584f1c 53 }
Mike Fiore 1:e52ae6584f1c 54 }
Mike Fiore 1:e52ae6584f1c 55
Mike Fiore 1:e52ae6584f1c 56 return 0;
Mike Fiore 1:e52ae6584f1c 57 }
Mike Fiore 1:e52ae6584f1c 58
Mike Fiore 9:ff62b20f7000 59 bool CmdRxDataRate::verify(std::vector<std::string> args) {
Mike Fiore 1:e52ae6584f1c 60 if (args.size() == 1)
Mike Fiore 1:e52ae6584f1c 61 return true;
Mike Fiore 1:e52ae6584f1c 62
Mike Fiore 9:ff62b20f7000 63 if (args.size() == 2) {
Mike Fiore 9:ff62b20f7000 64 std::string dr = mts::Text::toUpper(args[1]);
Mike Fiore 9:ff62b20f7000 65
Mike Fiore 1:e52ae6584f1c 66 uint8_t i;
Mike Fiore 1:e52ae6584f1c 67 int datarate = -1;
Mike Fiore 9:ff62b20f7000 68
Mike Fiore 9:ff62b20f7000 69 int res = sscanf(dr.c_str(), "%d", &datarate);
Mike Fiore 9:ff62b20f7000 70
Mike Fiore 9:ff62b20f7000 71 if (res == 0) {
Mike Fiore 9:ff62b20f7000 72 for (i = 0; i < 24; i++) {
Mike Fiore 9:ff62b20f7000 73 if (mDot::DataRateStr(i).find(dr) != std::string::npos) {
Mike Fiore 9:ff62b20f7000 74 datarate = i;
Mike Fiore 9:ff62b20f7000 75 break;
Mike Fiore 9:ff62b20f7000 76 }
Mike Fiore 9:ff62b20f7000 77 }
Mike Fiore 9:ff62b20f7000 78 } else {
Mike Fiore 9:ff62b20f7000 79 if (_dot->getFrequencyBand() == mDot::FB_915 && datarate > 10) {
Mike Fiore 9:ff62b20f7000 80 datarate = -1;
Mike Fiore 9:ff62b20f7000 81 } else if (_dot->getFrequencyBand() == mDot::FB_868 && datarate > 12) {
Mike Fiore 9:ff62b20f7000 82 datarate = -1;
Mike Fiore 9:ff62b20f7000 83 } else if (datarate > 6) {
Mike Fiore 9:ff62b20f7000 84 // Convert SF to DR
Mike Fiore 9:ff62b20f7000 85 if (_dot->getFrequencyBand() == mDot::FB_915) {
Mike Fiore 9:ff62b20f7000 86 datarate = 10 - datarate;
Mike Fiore 9:ff62b20f7000 87 } else {
Mike Fiore 9:ff62b20f7000 88 datarate = 12 - datarate;
Mike Fiore 9:ff62b20f7000 89 }
Mike Fiore 1:e52ae6584f1c 90 }
Mike Fiore 1:e52ae6584f1c 91 }
Mike Fiore 1:e52ae6584f1c 92
Mike Fiore 1:e52ae6584f1c 93 if (_dot->getFrequencyBand() == mDot::FB_915) {
Mike Fiore 9:ff62b20f7000 94 // DR8-13 used for P2P modes
Mike Fiore 9:ff62b20f7000 95 if (datarate < 0 || datarate > 13 || (datarate >= 5 && datarate <= 7)) {
Mike Fiore 9:ff62b20f7000 96 setErrorMessage("Invalid data rate, expects (7-10|DR0-DR4|DR8-DR13)");
Mike Fiore 9:ff62b20f7000 97 return false;
Mike Fiore 9:ff62b20f7000 98 }
Mike Fiore 9:ff62b20f7000 99 } else {
Mike Fiore 9:ff62b20f7000 100 if (datarate < 0 || datarate > 7) {
Mike Fiore 9:ff62b20f7000 101 setErrorMessage("Invalid data rate, expects (7-12|DR0-DR7)");
Mike Fiore 1:e52ae6584f1c 102 return false;
Mike Fiore 1:e52ae6584f1c 103 }
Mike Fiore 1:e52ae6584f1c 104 }
Mike Fiore 1:e52ae6584f1c 105
Mike Fiore 1:e52ae6584f1c 106 return true;
Mike Fiore 1:e52ae6584f1c 107 }
Mike Fiore 1:e52ae6584f1c 108
Mike Fiore 1:e52ae6584f1c 109 setErrorMessage("Invalid arguments");
Mike Fiore 1:e52ae6584f1c 110 return false;
Mike Fiore 1:e52ae6584f1c 111 }