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@42:23e2df6714f4, 5 months ago (annotated)

Committer:
Jason Reiss
Date:
Wed Dec 06 13:33:52 2023 -0600
Revision:
42:23e2df6714f4
Parent:
36:b586cd6e91f3 
TestMode: reset appnonce to 0 on reset to accomodate LCTT 3.12.0 and earlier. If the test suite changes to test AppNonce loaded from NVM this will fail tests.

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