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. Check the commit messages of the Dot library version used to find the correct mbed-os version to use with it. The mbed-os version must match the version used in that version of Dot library or it will likely cause it to fail to compile or have unexpected problems while running.

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

Committer:
jenkins@jenkinsdm1
Date:
Fri Mar 08 11:37:37 2019 -0600
Revision:
18:63f098f042b2
Parent:
16:d5cf2af81a6d
Child:
27:5fafd3b26ac3
mdot-firmware revision 3.1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 14:f9a77400b622 1 #include "CmdJoinRx2Frequency.h"
Mike Fiore 14:f9a77400b622 2 #include "CommandTerminal.h"
Mike Fiore 14:f9a77400b622 3
Mike Fiore 14:f9a77400b622 4 CmdJoinRx2Frequency::CmdJoinRx2Frequency()
Mike Fiore 14:f9a77400b622 5 :
Mike Fiore 14:f9a77400b622 6 Command("Join Rx2 Frequency", "AT+JR2F", "Join Rx2 frequency", "(US:902000000-928000000,AU:915000000-928000000,EU:863000000-870000000)") {
Mike Fiore 14:f9a77400b622 7
Mike Fiore 14:f9a77400b622 8 }
Mike Fiore 14:f9a77400b622 9
jenkins@jenkinsdm1 18:63f098f042b2 10 uint32_t CmdJoinRx2Frequency::action(const std::vector<std::string>& args) {
Mike Fiore 14:f9a77400b622 11
Mike Fiore 14:f9a77400b622 12 if (args.size() == 1)
jenkins@jenkinsdm1 16:d5cf2af81a6d 13 {
Mike Fiore 14:f9a77400b622 14 CommandTerminal::Serial()->writef("%lu\r\n", CommandTerminal::Dot()->getJoinRx2Frequency());
Mike Fiore 14:f9a77400b622 15 }
Mike Fiore 14:f9a77400b622 16 else if (args.size() == 2)
jenkins@jenkinsdm1 16:d5cf2af81a6d 17 {
Mike Fiore 14:f9a77400b622 18 int frequency = 0;
Mike Fiore 14:f9a77400b622 19
Mike Fiore 14:f9a77400b622 20 sscanf(args[1].c_str(), "%d", &frequency);
Mike Fiore 14:f9a77400b622 21 if (CommandTerminal::Dot()->setJoinRx2Frequency(frequency) != mDot::MDOT_OK)
jenkins@jenkinsdm1 16:d5cf2af81a6d 22 {
jenkins@jenkinsdm1 16:d5cf2af81a6d 23 CommandTerminal::setErrorMessage(CommandTerminal::Dot()->getLastError());
jenkins@jenkinsdm1 16:d5cf2af81a6d 24 ;
Mike Fiore 14:f9a77400b622 25 return 1;
Mike Fiore 14:f9a77400b622 26 }
Mike Fiore 14:f9a77400b622 27 }
Mike Fiore 14:f9a77400b622 28
Mike Fiore 14:f9a77400b622 29 return 0;
Mike Fiore 14:f9a77400b622 30 }
Mike Fiore 14:f9a77400b622 31
jenkins@jenkinsdm1 18:63f098f042b2 32 bool CmdJoinRx2Frequency::verify(const std::vector<std::string>& args) {
Mike Fiore 14:f9a77400b622 33 if (args.size() == 1)
Mike Fiore 14:f9a77400b622 34 return true;
Mike Fiore 14:f9a77400b622 35
jenkins@jenkinsdm1 16:d5cf2af81a6d 36 if (args.size() == 2) {
Mike Fiore 14:f9a77400b622 37 int frequency = ULONG_MAX;
Mike Fiore 14:f9a77400b622 38 if (sscanf(args[1].c_str(), "%d", &frequency) != 1) {
Mike Fiore 14:f9a77400b622 39 CommandTerminal::setErrorMessage("Invalid argument");
Mike Fiore 14:f9a77400b622 40 return false;
Mike Fiore 14:f9a77400b622 41 }
Mike Fiore 14:f9a77400b622 42
Mike Fiore 14:f9a77400b622 43 if (frequency != 0 && (frequency < int(CommandTerminal::Dot()->getMinFrequency()) || frequency > int(CommandTerminal::Dot()->getMaxFrequency()))) {
jenkins@jenkinsdm1 16:d5cf2af81a6d 44 char tmp[256];
jenkins@jenkinsdm1 16:d5cf2af81a6d 45 sprintf(tmp, "Invalid frequency, expects (0,%lu-%lu)", CommandTerminal::Dot()->getMinFrequency(), CommandTerminal::Dot()->getMaxFrequency());
jenkins@jenkinsdm1 16:d5cf2af81a6d 46 CommandTerminal::setErrorMessage(tmp);
Mike Fiore 14:f9a77400b622 47 return false;
Mike Fiore 14:f9a77400b622 48 }
Mike Fiore 14:f9a77400b622 49 return true;
Mike Fiore 14:f9a77400b622 50 }
Mike Fiore 14:f9a77400b622 51
Mike Fiore 14:f9a77400b622 52 CommandTerminal::setErrorMessage("Invalid arguments");
Mike Fiore 14:f9a77400b622 53 return false;
Mike Fiore 14:f9a77400b622 54 }