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@18:63f098f042b2, 2019-03-08 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Fri Mar 08 11:37:37 2019 -0600
Revision:
18:63f098f042b2
Parent:
17:95c9eb69329a
Child:
23:4f0a981c0349
mdot-firmware revision 3.1.0

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