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/CmdDisplayConfig.cpp@1:e52ae6584f1c, 2015-06-25 (annotated)

Committer:
Mike Fiore
Date:
Thu Jun 25 10:23:41 2015 -0500
Revision:
1:e52ae6584f1c
Child:
4:666017851052
update debug, add command source files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 1:e52ae6584f1c 1 #include "CmdDisplayConfig.h"
Mike Fiore 1:e52ae6584f1c 2
Mike Fiore 1:e52ae6584f1c 3 CmdDisplayConfig::CmdDisplayConfig(mDot* dot, mts::MTSSerial& serial)
Mike Fiore 1:e52ae6584f1c 4 :
Mike Fiore 1:e52ae6584f1c 5 Command(dot, "Display Settings", "AT&V", "Displays current settings and status"),
Mike Fiore 1:e52ae6584f1c 6 _serial(serial) {
Mike Fiore 1:e52ae6584f1c 7 _help = std::string(text()) + ": " + std::string(desc());
Mike Fiore 1:e52ae6584f1c 8 _usage = "TABLE";
Mike Fiore 1:e52ae6584f1c 9 }
Mike Fiore 1:e52ae6584f1c 10
Mike Fiore 1:e52ae6584f1c 11 uint32_t CmdDisplayConfig::action(std::vector<std::string> args) {
Mike Fiore 1:e52ae6584f1c 12 _serial.writef("Device ID:\t\t");
Mike Fiore 1:e52ae6584f1c 13 _serial.writef("%s\r\n", mts::Text::bin2hexString(_dot->getDeviceId(), ":").c_str());
Mike Fiore 1:e52ae6584f1c 14
Mike Fiore 1:e52ae6584f1c 15 _serial.writef("Frequency Band:\t\t%s\r\n", mDot::FrequencyBandStr(_dot->getFrequencyBand()).c_str());
Mike Fiore 1:e52ae6584f1c 16 _serial.writef("Frequency Sub Band:\t%u\r\n", _dot->getFrequencySubBand());
Mike Fiore 1:e52ae6584f1c 17
Mike Fiore 1:e52ae6584f1c 18 _serial.writef("Public Network:\t\t%s\r\n", _dot->getPublicNetwork() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 19 _serial.writef("Start Up Mode:\t\t%s\r\n", mDot::ModeStr(_dot->getStartUpMode()).c_str());
Mike Fiore 1:e52ae6584f1c 20
Mike Fiore 1:e52ae6584f1c 21 _serial.writef("Network Address:\t%s\r\n", mts::Text::bin2hexString(_dot->getNetworkAddress()).c_str());
Mike Fiore 1:e52ae6584f1c 22
Mike Fiore 1:e52ae6584f1c 23 _serial.writef("Network ID:\t\t");
Mike Fiore 1:e52ae6584f1c 24 _serial.writef("%s\r\n", mts::Text::bin2hexString(_dot->getNetworkId(), ":").c_str());
Mike Fiore 1:e52ae6584f1c 25
Mike Fiore 1:e52ae6584f1c 26 _serial.writef("Network ID Passphrase:\t%s\r\n", _dot->getNetworkName().c_str());
Mike Fiore 1:e52ae6584f1c 27
Mike Fiore 1:e52ae6584f1c 28 _serial.writef("Network Key:\t\t");
Mike Fiore 1:e52ae6584f1c 29 _serial.writef("%s\r\n", mts::Text::bin2hexString(_dot->getNetworkKey(), ".").c_str());
Mike Fiore 1:e52ae6584f1c 30
Mike Fiore 1:e52ae6584f1c 31 _serial.writef("Network Key Passphrase:\t%s\r\n", _dot->getNetworkPassphrase().c_str());
Mike Fiore 1:e52ae6584f1c 32
Mike Fiore 1:e52ae6584f1c 33 _serial.writef("Network Session Key:\t");
Mike Fiore 1:e52ae6584f1c 34 _serial.writef("%s\r\n", mts::Text::bin2hexString(_dot->getNetworkSessionKey(), ".").c_str());
Mike Fiore 1:e52ae6584f1c 35
Mike Fiore 1:e52ae6584f1c 36 _serial.writef("Data Session Key:\t");
Mike Fiore 1:e52ae6584f1c 37 _serial.writef("%s\r\n", mts::Text::bin2hexString(_dot->getDataSessionKey(), ".").c_str());
Mike Fiore 1:e52ae6584f1c 38
Mike Fiore 1:e52ae6584f1c 39 _serial.writef("Network Join Mode:\t%s\r\n", mDot::JoinModeStr(_dot->getJoinMode()).c_str());
Mike Fiore 1:e52ae6584f1c 40
Mike Fiore 1:e52ae6584f1c 41 _serial.writef("Network Join Retries:\t%u\r\n", _dot->getJoinRetries());
Mike Fiore 1:e52ae6584f1c 42
Mike Fiore 1:e52ae6584f1c 43 _serial.writef("Link Check Threshold:\t");
Mike Fiore 1:e52ae6584f1c 44 if (_dot->getLinkCheckThreshold() == 0) {
Mike Fiore 1:e52ae6584f1c 45 _serial.writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 46 } else {
Mike Fiore 1:e52ae6584f1c 47 _serial.writef("%lu\r\n", _dot->getLinkCheckThreshold());
Mike Fiore 1:e52ae6584f1c 48 }
Mike Fiore 1:e52ae6584f1c 49
Mike Fiore 1:e52ae6584f1c 50 _serial.writef("Link Check Count:\t");
Mike Fiore 1:e52ae6584f1c 51 if (_dot->getLinkCheckCount() == 0) {
Mike Fiore 1:e52ae6584f1c 52 _serial.writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 53 } else {
Mike Fiore 1:e52ae6584f1c 54 _serial.writef("%lu packets\r\n", _dot->getLinkCheckCount());
Mike Fiore 1:e52ae6584f1c 55 }
Mike Fiore 1:e52ae6584f1c 56
Mike Fiore 1:e52ae6584f1c 57 _serial.writef("Error Correction:\t");
Mike Fiore 1:e52ae6584f1c 58 if (_dot->getFec() == 0) {
Mike Fiore 1:e52ae6584f1c 59 _serial.writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 60 } else {
Mike Fiore 1:e52ae6584f1c 61 _serial.writef("%u bytes\r\n", _dot->getFec());
Mike Fiore 1:e52ae6584f1c 62 }
Mike Fiore 1:e52ae6584f1c 63
Mike Fiore 1:e52ae6584f1c 64 _serial.writef("ACK Retries:\t\t");
Mike Fiore 1:e52ae6584f1c 65 if (_dot->getAck() == 0) {
Mike Fiore 1:e52ae6584f1c 66 _serial.writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 67 } else {
Mike Fiore 1:e52ae6584f1c 68 _serial.writef("%u\r\n", _dot->getAck());
Mike Fiore 1:e52ae6584f1c 69 }
Mike Fiore 1:e52ae6584f1c 70
Mike Fiore 1:e52ae6584f1c 71 _serial.writef("Encryption:\t\t%s\r\n", _dot->getAesEncryption() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 72 _serial.writef("CRC:\t\t\t%s\r\n", _dot->getCrc() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 73 _serial.writef("Adaptive Data Rate:\t%s\r\n", _dot->getAdr() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 74 _serial.writef("Command Echo:\t\t%s\r\n", _dot->getEcho() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 75 _serial.writef("Verbose Response:\t%s\r\n", _dot->getVerbose() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 76
Mike Fiore 1:e52ae6584f1c 77 _serial.writef("Tx Frequency:\t\t%lu\r\n", _dot->getTxFrequency());
Mike Fiore 1:e52ae6584f1c 78 _serial.writef("Tx Data Rate:\t\t%s\r\n", mDot::DataRateStr(_dot->getTxDataRate()).c_str());
Mike Fiore 1:e52ae6584f1c 79 _serial.writef("Tx Power:\t\t%u\r\n", _dot->getTxPower());
Mike Fiore 1:e52ae6584f1c 80 _serial.writef("Tx Wait:\t\t%s\r\n", _dot->getTxWait() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 81
Mike Fiore 1:e52ae6584f1c 82 _serial.writef("Tx Inverted Signal:\t%s\r\n", _dot->getTxInverted() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 83
Mike Fiore 1:e52ae6584f1c 84 _serial.writef("Rx Frequency:\t\t%lu\r\n", _dot->getRxFrequency());
Mike Fiore 1:e52ae6584f1c 85 _serial.writef("Rx Data Rate:\t\t%s\r\n", mDot::DataRateStr(_dot->getRxDataRate()).c_str());
Mike Fiore 1:e52ae6584f1c 86 _serial.writef("Rx Inverted Signal:\t%s\r\n", _dot->getRxInverted() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 87
Mike Fiore 1:e52ae6584f1c 88 _serial.writef("Rx Output Style:\t%s\r\n", mDot::RxOutputStr(_dot->getRxOutput()).c_str());
Mike Fiore 1:e52ae6584f1c 89
Mike Fiore 1:e52ae6584f1c 90 _serial.writef("Debug Baud Rate:\t%lu\r\n", _dot->getDebugBaud());
Mike Fiore 1:e52ae6584f1c 91 _serial.writef("Serial Baud Rate:\t%lu\r\n", _dot->getBaud());
Mike Fiore 1:e52ae6584f1c 92
Mike Fiore 1:e52ae6584f1c 93 _serial.writef("Serial Wake Interval:\t%lu s\r\n", _dot->getSerialWakeInterval());
Mike Fiore 1:e52ae6584f1c 94 _serial.writef("Serial Wake Delay:\t%lu ms\r\n", _dot->getSerialWakeDelay());
Mike Fiore 1:e52ae6584f1c 95 _serial.writef("Serial Receive Timeout:\t%u ms\r\n", _dot->getSerialReceiveTimeout());
Mike Fiore 1:e52ae6584f1c 96
Mike Fiore 1:e52ae6584f1c 97 _serial.writef("Log Level:\t\t%ld\r\n", _dot->getLogLevel());
Mike Fiore 1:e52ae6584f1c 98
Mike Fiore 1:e52ae6584f1c 99 return 0;
Mike Fiore 1:e52ae6584f1c 100 }
Mike Fiore 1:e52ae6584f1c 101