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@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
jenkins@jenkinsdm1 17:95c9eb69329a 1 #include "CmdDefaultFrequencyBand.h"
jenkins@jenkinsdm1 17:95c9eb69329a 2 #include "ChannelPlans.h"
jenkins@jenkinsdm1 17:95c9eb69329a 3
jenkins@jenkinsdm1 17:95c9eb69329a 4 CmdDefaultFrequencyBand::CmdDefaultFrequencyBand() :
Jason Reiss 27:5fafd3b26ac3 5 Command("Default Frequency Band", "AT+DFREQ",
Jason Reiss 23:4f0a981c0349 6 #if defined(DEBUG_MAC)
Jason Reiss 27:5fafd3b26ac3 7 "Frequency Band Device Was Manufactured For 'US915', 'AU915', 'EU868', 'AS923', 'KR920', 'AS923-JAPAN', 'IN865', 'RU864', or 'NONE'",
jenkins@jenkinsdm1 18:63f098f042b2 8 #else
Jason Reiss 27:5fafd3b26ac3 9 "",
jenkins@jenkinsdm1 18:63f098f042b2 10 #endif
Jason Reiss 27:5fafd3b26ac3 11 "(NONE,US915,AU915,EU868,AS923,KR920,AS923-JAPAN,IN865,RU864)")
jenkins@jenkinsdm1 17:95c9eb69329a 12 {
jenkins@jenkinsdm1 17:95c9eb69329a 13 _queryable = true;
jenkins@jenkinsdm1 17:95c9eb69329a 14 }
jenkins@jenkinsdm1 17:95c9eb69329a 15
jenkins@jenkinsdm1 18:63f098f042b2 16 uint32_t CmdDefaultFrequencyBand::action(const std::vector<std::string>& args)
jenkins@jenkinsdm1 17:95c9eb69329a 17 {
jenkins@jenkinsdm1 17:95c9eb69329a 18 if (args.size() == 1)
jenkins@jenkinsdm1 17:95c9eb69329a 19 {
jenkins@jenkinsdm1 17:95c9eb69329a 20 CommandTerminal::Serial()->writef("%s\r\n", CommandTerminal::Dot()->FrequencyBandStr(CommandTerminal::Dot()->getDefaultFrequencyBand()).c_str());
jenkins@jenkinsdm1 17:95c9eb69329a 21 }
jenkins@jenkinsdm1 17:95c9eb69329a 22 else if (args.size() == 2)
jenkins@jenkinsdm1 17:95c9eb69329a 23 {
jenkins@jenkinsdm1 17:95c9eb69329a 24 uint8_t band = lora::ChannelPlan::US915;
jenkins@jenkinsdm1 17:95c9eb69329a 25 std::string band_str = mts::Text::toUpper(args[1]);
jenkins@jenkinsdm1 17:95c9eb69329a 26
jenkins@jenkinsdm1 17:95c9eb69329a 27 if (mDot::FrequencyBandStr(lora::ChannelPlan::NONE) == band_str) {
jenkins@jenkinsdm1 17:95c9eb69329a 28 band = lora::ChannelPlan::NONE;
jenkins@jenkinsdm1 17:95c9eb69329a 29 }
jenkins@jenkinsdm1 17:95c9eb69329a 30 if (mDot::FrequencyBandStr(lora::ChannelPlan::US915) == band_str) {
jenkins@jenkinsdm1 18:63f098f042b2 31 band = lora::ChannelPlan::US915_OLD;
jenkins@jenkinsdm1 17:95c9eb69329a 32 }
jenkins@jenkinsdm1 17:95c9eb69329a 33 if (mDot::FrequencyBandStr(lora::ChannelPlan::AU915) == band_str) {
jenkins@jenkinsdm1 18:63f098f042b2 34 band = lora::ChannelPlan::AU915_OLD;
jenkins@jenkinsdm1 17:95c9eb69329a 35 }
jenkins@jenkinsdm1 17:95c9eb69329a 36 if (mDot::FrequencyBandStr(lora::ChannelPlan::EU868) == band_str) {
jenkins@jenkinsdm1 18:63f098f042b2 37 band = lora::ChannelPlan::EU868_OLD;
jenkins@jenkinsdm1 17:95c9eb69329a 38 }
jenkins@jenkinsdm1 17:95c9eb69329a 39 if (mDot::FrequencyBandStr(lora::ChannelPlan::AS923) == band_str) {
jenkins@jenkinsdm1 17:95c9eb69329a 40 band = lora::ChannelPlan::AS923;
jenkins@jenkinsdm1 17:95c9eb69329a 41 }
jenkins@jenkinsdm1 17:95c9eb69329a 42 if (mDot::FrequencyBandStr(lora::ChannelPlan::KR920) == band_str) {
jenkins@jenkinsdm1 17:95c9eb69329a 43 band = lora::ChannelPlan::KR920;
jenkins@jenkinsdm1 17:95c9eb69329a 44 }
jenkins@jenkinsdm1 17:95c9eb69329a 45 if (mDot::FrequencyBandStr(lora::ChannelPlan::AS923_JAPAN) == band_str) {
jenkins@jenkinsdm1 17:95c9eb69329a 46 band = lora::ChannelPlan::AS923_JAPAN;
jenkins@jenkinsdm1 17:95c9eb69329a 47 }
Jason Reiss 23:4f0a981c0349 48 if (mDot::FrequencyBandStr(lora::ChannelPlan::IN865) == band_str) {
Jason Reiss 23:4f0a981c0349 49 band = lora::ChannelPlan::IN865;
Jason Reiss 23:4f0a981c0349 50 }
Jason Reiss 23:4f0a981c0349 51 if (mDot::FrequencyBandStr(lora::ChannelPlan::RU864) == band_str) {
Jason Reiss 23:4f0a981c0349 52 band = lora::ChannelPlan::RU864;
Jason Reiss 23:4f0a981c0349 53 }
jenkins@jenkinsdm1 17:95c9eb69329a 54
jenkins@jenkinsdm1 17:95c9eb69329a 55 if (CommandTerminal::Dot()->setDefaultFrequencyBand(band) != mDot::MDOT_OK) {
Jason Reiss 23:4f0a981c0349 56 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
jenkins@jenkinsdm1 17:95c9eb69329a 57 return 1;
jenkins@jenkinsdm1 17:95c9eb69329a 58 }
jenkins@jenkinsdm1 17:95c9eb69329a 59 }
Jason Reiss 27:5fafd3b26ac3 60
jenkins@jenkinsdm1 17:95c9eb69329a 61 return 0;
jenkins@jenkinsdm1 17:95c9eb69329a 62 }
jenkins@jenkinsdm1 17:95c9eb69329a 63
jenkins@jenkinsdm1 18:63f098f042b2 64 bool CmdDefaultFrequencyBand::verify(const std::vector<std::string>& args)
jenkins@jenkinsdm1 17:95c9eb69329a 65 {
jenkins@jenkinsdm1 17:95c9eb69329a 66 if (args.size() == 1)
jenkins@jenkinsdm1 17:95c9eb69329a 67 return true;
Jason Reiss 27:5fafd3b26ac3 68
jenkins@jenkinsdm1 17:95c9eb69329a 69 if (args.size() == 2)
jenkins@jenkinsdm1 17:95c9eb69329a 70 {
jenkins@jenkinsdm1 17:95c9eb69329a 71 std::string band = mts::Text::toUpper(args[1]);
jenkins@jenkinsdm1 17:95c9eb69329a 72
jenkins@jenkinsdm1 17:95c9eb69329a 73 if (mDot::FrequencyBandStr(lora::ChannelPlan::NONE) != band &&
jenkins@jenkinsdm1 17:95c9eb69329a 74 mDot::FrequencyBandStr(lora::ChannelPlan::US915) != band &&
jenkins@jenkinsdm1 17:95c9eb69329a 75 mDot::FrequencyBandStr(lora::ChannelPlan::AU915) != band &&
jenkins@jenkinsdm1 17:95c9eb69329a 76 mDot::FrequencyBandStr(lora::ChannelPlan::EU868) != band &&
jenkins@jenkinsdm1 17:95c9eb69329a 77 mDot::FrequencyBandStr(lora::ChannelPlan::AS923) != band &&
jenkins@jenkinsdm1 17:95c9eb69329a 78 mDot::FrequencyBandStr(lora::ChannelPlan::KR920) != band &&
Jason Reiss 23:4f0a981c0349 79 mDot::FrequencyBandStr(lora::ChannelPlan::AS923_JAPAN) != band &&
Jason Reiss 23:4f0a981c0349 80 mDot::FrequencyBandStr(lora::ChannelPlan::IN865) != band &&
Jason Reiss 23:4f0a981c0349 81 mDot::FrequencyBandStr(lora::ChannelPlan::RU864) != band)
jenkins@jenkinsdm1 17:95c9eb69329a 82 {
Jason Reiss 23:4f0a981c0349 83 CommandTerminal::setErrorMessage("Invalid parameter, expects (NONE,US915,AU915,EU868,AS923,KR920,AS923-JAPAN,IN865,RU864)");
jenkins@jenkinsdm1 17:95c9eb69329a 84 return false;
jenkins@jenkinsdm1 17:95c9eb69329a 85 }
jenkins@jenkinsdm1 17:95c9eb69329a 86
jenkins@jenkinsdm1 17:95c9eb69329a 87 return true;
jenkins@jenkinsdm1 17:95c9eb69329a 88 }
jenkins@jenkinsdm1 17:95c9eb69329a 89
jenkins@jenkinsdm1 17:95c9eb69329a 90 CommandTerminal::setErrorMessage("Invalid arguments");
jenkins@jenkinsdm1 17:95c9eb69329a 91 return false;
jenkins@jenkinsdm1 17:95c9eb69329a 92 }