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/CmdDefaultFrequencyBand.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:
34:3b696c2b1e4b
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jenkins@jenkinsdm1 17:95c9eb69329a 1 #include "CmdDefaultFrequencyBand.h"
Jason Reiss 28:c222ca8383f4 2
Jason Reiss 28:c222ca8383f4 3
Jason Reiss 28:c222ca8383f4 4 static const uint8_t PLAN_COUNT = 11;
Jason Reiss 28:c222ca8383f4 5 static const lora::ChannelPlan::Plan PLANS[PLAN_COUNT] = {
Jason Reiss 28:c222ca8383f4 6 lora::ChannelPlan::NONE, lora::ChannelPlan::US915, lora::ChannelPlan::AU915,
Jason Reiss 28:c222ca8383f4 7 lora::ChannelPlan::EU868, lora::ChannelPlan::AS923, lora::ChannelPlan::KR920,
Jason Reiss 28:c222ca8383f4 8 lora::ChannelPlan::AS923_JAPAN, lora::ChannelPlan::IN865, lora::ChannelPlan::RU864,
Jason Reiss 28:c222ca8383f4 9 lora::ChannelPlan::AS923_2, lora::ChannelPlan::AS923_3
Jason Reiss 28:c222ca8383f4 10 // , lora::ChannelPlan::AS923_JAPAN1, lora::ChannelPlan::AS923_JAPAN2
Jason Reiss 28:c222ca8383f4 11 };
jenkins@jenkinsdm1 17:95c9eb69329a 12
jenkins@jenkinsdm1 17:95c9eb69329a 13 CmdDefaultFrequencyBand::CmdDefaultFrequencyBand() :
Jason Reiss 28:c222ca8383f4 14 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 15 Command("Default Frequency Band", "AT+DFREQ", "Frequency Band Device Was Manufactured For 'US915', 'AU915', 'EU868', 'AS923', 'AS923-2', 'AS923-3', 'KR920', 'AS923-JAPAN', 'IN865', 'RU864', or 'NONE'", "(NONE,US915,AU915,EU868,AS923,AS923-2,AS923-3,KR920,AS923-JAPAN,IN865,RU864)")
jenkins@jenkinsdm1 18:63f098f042b2 16 #else
Jason Reiss 28:c222ca8383f4 17 Command("AT+DFREQ")
jenkins@jenkinsdm1 18:63f098f042b2 18 #endif
jenkins@jenkinsdm1 17:95c9eb69329a 19 {
jenkins@jenkinsdm1 17:95c9eb69329a 20 _queryable = true;
jenkins@jenkinsdm1 17:95c9eb69329a 21 }
jenkins@jenkinsdm1 17:95c9eb69329a 22
Jason Reiss 28:c222ca8383f4 23 uint32_t CmdDefaultFrequencyBand::action(const std::vector<std::string>& args) {
jenkins@jenkinsdm1 17:95c9eb69329a 24 if (args.size() == 1)
jenkins@jenkinsdm1 17:95c9eb69329a 25 {
jenkins@jenkinsdm1 17:95c9eb69329a 26 CommandTerminal::Serial()->writef("%s\r\n", CommandTerminal::Dot()->FrequencyBandStr(CommandTerminal::Dot()->getDefaultFrequencyBand()).c_str());
jenkins@jenkinsdm1 17:95c9eb69329a 27 }
jenkins@jenkinsdm1 17:95c9eb69329a 28 else if (args.size() == 2)
jenkins@jenkinsdm1 17:95c9eb69329a 29 {
jenkins@jenkinsdm1 17:95c9eb69329a 30 uint8_t band = lora::ChannelPlan::US915;
jenkins@jenkinsdm1 17:95c9eb69329a 31 std::string band_str = mts::Text::toUpper(args[1]);
Jason Reiss 28:c222ca8383f4 32 std::string exp_band_str;
jenkins@jenkinsdm1 17:95c9eb69329a 33
Jason Reiss 28:c222ca8383f4 34 for (int i = 0; i < PLAN_COUNT; ++i) {
Jason Reiss 28:c222ca8383f4 35 if (mDot::FrequencyBandStr(PLANS[i]) == band_str) {
Jason Reiss 28:c222ca8383f4 36 band = PLANS[i];
Jason Reiss 28:c222ca8383f4 37 }
Jason Reiss 23:4f0a981c0349 38 }
jenkins@jenkinsdm1 17:95c9eb69329a 39
jenkins@jenkinsdm1 17:95c9eb69329a 40 if (CommandTerminal::Dot()->setDefaultFrequencyBand(band) != mDot::MDOT_OK) {
jenkins@jenkinsdm1 17:95c9eb69329a 41 return 1;
jenkins@jenkinsdm1 17:95c9eb69329a 42 }
jenkins@jenkinsdm1 17:95c9eb69329a 43 }
Jason Reiss 27:5fafd3b26ac3 44
jenkins@jenkinsdm1 17:95c9eb69329a 45 return 0;
jenkins@jenkinsdm1 17:95c9eb69329a 46 }
jenkins@jenkinsdm1 17:95c9eb69329a 47
Jason Reiss 28:c222ca8383f4 48 bool CmdDefaultFrequencyBand::verify(const std::vector<std::string>& args) {
jenkins@jenkinsdm1 17:95c9eb69329a 49 if (args.size() == 1)
jenkins@jenkinsdm1 17:95c9eb69329a 50 return true;
Jason Reiss 27:5fafd3b26ac3 51
jenkins@jenkinsdm1 17:95c9eb69329a 52 if (args.size() == 2)
jenkins@jenkinsdm1 17:95c9eb69329a 53 {
jenkins@jenkinsdm1 17:95c9eb69329a 54 std::string band = mts::Text::toUpper(args[1]);
jenkins@jenkinsdm1 17:95c9eb69329a 55
Jason Reiss 28:c222ca8383f4 56 for (int i = 0; i < PLAN_COUNT; ++i) {
Jason Reiss 28:c222ca8383f4 57 if (mDot::FrequencyBandStr(PLANS[i]) == band) {
Jason Reiss 28:c222ca8383f4 58 return true;
Jason Reiss 28:c222ca8383f4 59 }
jenkins@jenkinsdm1 17:95c9eb69329a 60 }
jenkins@jenkinsdm1 17:95c9eb69329a 61
Jason Reiss 28:c222ca8383f4 62 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 63 // CommandTerminal::setErrorMessage("Invalid parameter, expects (NONE,US915,AU915,EU868,AS923,AS923-2,AS923-3,KR920,AS923-JAPAN,AS923-JAPAN1,AS923-JAPAN2,IN865,RU864)");
Jason Reiss 28:c222ca8383f4 64 CommandTerminal::setErrorMessage("Invalid parameter, expects (NONE,US915,AU915,EU868,AS923,AS923-2,AS923-3,KR920,AS923-JAPAN,IN865,RU864)");
Jason Reiss 28:c222ca8383f4 65 #endif
Jason Reiss 28:c222ca8383f4 66 return false;
Jason Reiss 28:c222ca8383f4 67
jenkins@jenkinsdm1 17:95c9eb69329a 68 }
jenkins@jenkinsdm1 17:95c9eb69329a 69
Jason Reiss 28:c222ca8383f4 70 #if MTS_CMD_TERM_VERBOSE
jenkins@jenkinsdm1 17:95c9eb69329a 71 CommandTerminal::setErrorMessage("Invalid arguments");
Jason Reiss 28:c222ca8383f4 72 #endif
jenkins@jenkinsdm1 17:95c9eb69329a 73 return false;
jenkins@jenkinsdm1 17:95c9eb69329a 74 }