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/CmdDisplayConfig.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:
23:4f0a981c0349
mdot-firmware revision 3.1.0

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 14:f9a77400b622 3 CmdDisplayConfig::CmdDisplayConfig()
Mike Fiore 1:e52ae6584f1c 4 :
Mike Fiore 14:f9a77400b622 5 Command("Display Settings", "AT&V", "Displays current settings and status", "TABLE") {
Mike Fiore 14:f9a77400b622 6
Mike Fiore 1:e52ae6584f1c 7 }
Mike Fiore 1:e52ae6584f1c 8
jenkins@jenkinsdm1 18:63f098f042b2 9 uint32_t CmdDisplayConfig::action(const std::vector<std::string>& args) {
Mike Fiore 14:f9a77400b622 10 CommandTerminal::Serial()->writef("Device ID:\t\t");
Mike Fiore 14:f9a77400b622 11 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getDeviceId(), ":").c_str());
Mike Fiore 1:e52ae6584f1c 12
jenkins@jenkinsdm1 16:d5cf2af81a6d 13 CommandTerminal::Serial()->writef("Default Frequency Band:\t%s\r\n", CommandTerminal::Dot()->FrequencyBandStr(CommandTerminal::Dot()->getDefaultFrequencyBand()).c_str());
jenkins@jenkinsdm1 16:d5cf2af81a6d 14 // using getChannelPlanName here instead of mDot::FrequencyBandStr allows AT firmware to properly display custom channel plan names
jenkins@jenkinsdm1 16:d5cf2af81a6d 15 CommandTerminal::Serial()->writef("Current Frequency Band:\t%s\r\n", CommandTerminal::Dot()->getChannelPlanName().c_str());
Mike Fiore 14:f9a77400b622 16 CommandTerminal::Serial()->writef("Frequency Sub Band:\t%u\r\n", CommandTerminal::Dot()->getFrequencySubBand());
jenkins@jenkinsdm1 18:63f098f042b2 17
jenkins@jenkinsdm1 18:63f098f042b2 18 int32_t ret = CommandTerminal::Dot()->getPublicNetwork();
jenkins@jenkinsdm1 18:63f098f042b2 19 string network_mode = "Not defined";
jenkins@jenkinsdm1 18:63f098f042b2 20 switch(ret) {
jenkins@jenkinsdm1 18:63f098f042b2 21 case 0: network_mode = "Private MTS";
jenkins@jenkinsdm1 18:63f098f042b2 22 break;
jenkins@jenkinsdm1 18:63f098f042b2 23 case 1: network_mode = "Public LoRaWAN";
jenkins@jenkinsdm1 18:63f098f042b2 24 break;
jenkins@jenkinsdm1 18:63f098f042b2 25 case 2: network_mode = "Private LoRaWAN";
jenkins@jenkinsdm1 18:63f098f042b2 26 break;
jenkins@jenkinsdm1 18:63f098f042b2 27 }
jenkins@jenkinsdm1 18:63f098f042b2 28 CommandTerminal::Serial()->writef("Network Mode:\t\t%s\r\n", network_mode.c_str());
jenkins@jenkinsdm1 18:63f098f042b2 29
Mike Fiore 14:f9a77400b622 30 CommandTerminal::Serial()->writef("Start Up Mode:\t\t%s\r\n", mDot::ModeStr(CommandTerminal::Dot()->getStartUpMode()).c_str());
Mike Fiore 14:f9a77400b622 31
Mike Fiore 14:f9a77400b622 32 CommandTerminal::Serial()->writef("Network Address:\t%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getNetworkAddress()).c_str());
Mike Fiore 1:e52ae6584f1c 33
Mike Fiore 14:f9a77400b622 34 CommandTerminal::Serial()->writef("Network ID:\t\t");
Mike Fiore 14:f9a77400b622 35 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getNetworkId(), ":").c_str());
Mike Fiore 1:e52ae6584f1c 36
Mike Fiore 14:f9a77400b622 37 CommandTerminal::Serial()->writef("Network ID Passphrase:\t%s\r\n", CommandTerminal::Dot()->getNetworkName().c_str());
Mike Fiore 1:e52ae6584f1c 38
Mike Fiore 14:f9a77400b622 39 CommandTerminal::Serial()->writef("Network Key:\t\t");
jenkins@jenkinsdm1 18:63f098f042b2 40
Mike Fiore 14:f9a77400b622 41 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getNetworkKey(), ".").c_str());
Mike Fiore 14:f9a77400b622 42 CommandTerminal::Serial()->writef("Network Key Passphrase:\t%s\r\n", CommandTerminal::Dot()->getNetworkPassphrase().c_str());
Mike Fiore 1:e52ae6584f1c 43
Mike Fiore 14:f9a77400b622 44 CommandTerminal::Serial()->writef("Network Session Key:\t");
Mike Fiore 14:f9a77400b622 45 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getNetworkSessionKey(), ".").c_str());
Mike Fiore 1:e52ae6584f1c 46
Mike Fiore 14:f9a77400b622 47 CommandTerminal::Serial()->writef("Data Session Key:\t");
Mike Fiore 14:f9a77400b622 48 CommandTerminal::Serial()->writef("%s\r\n", mts::Text::bin2hexString(CommandTerminal::Dot()->getDataSessionKey(), ".").c_str());
Mike Fiore 1:e52ae6584f1c 49
Mike Fiore 14:f9a77400b622 50 CommandTerminal::Serial()->writef("Network Join Mode:\t%s\r\n", mDot::JoinModeStr(CommandTerminal::Dot()->getJoinMode()).c_str());
Mike Fiore 1:e52ae6584f1c 51
Mike Fiore 14:f9a77400b622 52 CommandTerminal::Serial()->writef("Network Join Retries:\t%u\r\n", CommandTerminal::Dot()->getJoinRetries());
Mike Fiore 14:f9a77400b622 53
Mike Fiore 14:f9a77400b622 54 CommandTerminal::Serial()->writef("Preserve Session:\t%s\r\n", CommandTerminal::Dot()->getPreserveSession() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 55
Mike Fiore 14:f9a77400b622 56 CommandTerminal::Serial()->writef("Join Byte Order:\t%s\r\n", CommandTerminal::Dot()->getJoinByteOrder() ? "MSB" : "LSB");
Mike Fiore 1:e52ae6584f1c 57
Mike Fiore 14:f9a77400b622 58 CommandTerminal::Serial()->writef("Join Delay:\t\t%d\r\n", CommandTerminal::Dot()->getJoinDelay());
Mike Fiore 9:ff62b20f7000 59
Mike Fiore 14:f9a77400b622 60 CommandTerminal::Serial()->writef("Join Rx1 DR Offset:\t%d\r\n", CommandTerminal::Dot()->getJoinRx1DataRateOffset());
Mike Fiore 4:666017851052 61
Mike Fiore 14:f9a77400b622 62 CommandTerminal::Serial()->writef("Join Rx2 Datarate:\tDR%d - %s\r\n", CommandTerminal::Dot()->getJoinRx2DataRate(), CommandTerminal::Dot()->getDateRateDetails(CommandTerminal::Dot()->getJoinRx2DataRate()).c_str());
Mike Fiore 9:ff62b20f7000 63
Mike Fiore 14:f9a77400b622 64 CommandTerminal::Serial()->writef("Join Rx2 Frequency:\t%lu\r\n", CommandTerminal::Dot()->getJoinRx2Frequency());
Mike Fiore 9:ff62b20f7000 65
Mike Fiore 14:f9a77400b622 66 CommandTerminal::Serial()->writef("App Port:\t\t%d\r\n", CommandTerminal::Dot()->getAppPort());
Mike Fiore 14:f9a77400b622 67
jenkins@jenkinsdm1 16:d5cf2af81a6d 68 CommandTerminal::Serial()->writef("Listen Before Talk:\t");
jenkins@jenkinsdm1 16:d5cf2af81a6d 69 if (CommandTerminal::Dot()->getLbtTimeUs() == 0 && CommandTerminal::Dot()->getLbtThreshold() == 0) {
jenkins@jenkinsdm1 16:d5cf2af81a6d 70 CommandTerminal::Serial()->writef("off\r\n");
jenkins@jenkinsdm1 16:d5cf2af81a6d 71 } else {
jenkins@jenkinsdm1 16:d5cf2af81a6d 72 CommandTerminal::Serial()->writef("%u us, %d dBm\r\n", CommandTerminal::Dot()->getLbtTimeUs(), CommandTerminal::Dot()->getLbtThreshold());
jenkins@jenkinsdm1 16:d5cf2af81a6d 73 }
jenkins@jenkinsdm1 16:d5cf2af81a6d 74
Mike Fiore 14:f9a77400b622 75 CommandTerminal::Serial()->writef("Link Check Threshold:\t");
Mike Fiore 14:f9a77400b622 76 if (CommandTerminal::Dot()->getLinkCheckThreshold() == 0) {
Mike Fiore 14:f9a77400b622 77 CommandTerminal::Serial()->writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 78 } else {
Mike Fiore 14:f9a77400b622 79 CommandTerminal::Serial()->writef("%lu\r\n", CommandTerminal::Dot()->getLinkCheckThreshold());
Mike Fiore 1:e52ae6584f1c 80 }
Mike Fiore 1:e52ae6584f1c 81
Mike Fiore 14:f9a77400b622 82 CommandTerminal::Serial()->writef("Link Check Count:\t");
Mike Fiore 14:f9a77400b622 83 if (CommandTerminal::Dot()->getLinkCheckCount() == 0) {
Mike Fiore 14:f9a77400b622 84 CommandTerminal::Serial()->writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 85 } else {
Mike Fiore 14:f9a77400b622 86 CommandTerminal::Serial()->writef("%lu packets\r\n", CommandTerminal::Dot()->getLinkCheckCount());
Mike Fiore 1:e52ae6584f1c 87 }
Mike Fiore 1:e52ae6584f1c 88
Mike Fiore 14:f9a77400b622 89 CommandTerminal::Serial()->writef("Error Correction:\t");
Mike Fiore 14:f9a77400b622 90 if (CommandTerminal::Dot()->getFec() == 0) {
Mike Fiore 14:f9a77400b622 91 CommandTerminal::Serial()->writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 92 } else {
Mike Fiore 14:f9a77400b622 93 CommandTerminal::Serial()->writef("%u bytes\r\n", CommandTerminal::Dot()->getFec());
Mike Fiore 1:e52ae6584f1c 94 }
Mike Fiore 1:e52ae6584f1c 95
Mike Fiore 14:f9a77400b622 96 CommandTerminal::Serial()->writef("ACK Retries:\t\t");
Mike Fiore 14:f9a77400b622 97 if (CommandTerminal::Dot()->getAck() == 0) {
Mike Fiore 14:f9a77400b622 98 CommandTerminal::Serial()->writef("off\r\n");
Mike Fiore 1:e52ae6584f1c 99 } else {
Mike Fiore 14:f9a77400b622 100 CommandTerminal::Serial()->writef("%u\r\n", CommandTerminal::Dot()->getAck());
Mike Fiore 1:e52ae6584f1c 101 }
Mike Fiore 1:e52ae6584f1c 102
Mike Fiore 14:f9a77400b622 103 CommandTerminal::Serial()->writef("Packet Repeat:\t\t%d\r\n", CommandTerminal::Dot()->getRepeat());
Mike Fiore 9:ff62b20f7000 104
Mike Fiore 14:f9a77400b622 105 CommandTerminal::Serial()->writef("Encryption:\t\t%s\r\n", CommandTerminal::Dot()->getAesEncryption() ? "on" : "off");
Mike Fiore 14:f9a77400b622 106 CommandTerminal::Serial()->writef("CRC:\t\t\t%s\r\n", CommandTerminal::Dot()->getCrc() ? "on" : "off");
Mike Fiore 14:f9a77400b622 107 CommandTerminal::Serial()->writef("Adaptive Data Rate:\t%s\r\n", CommandTerminal::Dot()->getAdr() ? "on" : "off");
Mike Fiore 14:f9a77400b622 108 CommandTerminal::Serial()->writef("Command Echo:\t\t%s\r\n", CommandTerminal::Dot()->getEcho() ? "on" : "off");
Mike Fiore 14:f9a77400b622 109 CommandTerminal::Serial()->writef("Verbose Response:\t%s\r\n", CommandTerminal::Dot()->getVerbose() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 110
Mike Fiore 14:f9a77400b622 111 CommandTerminal::Serial()->writef("Tx Frequency:\t\t%lu\r\n", CommandTerminal::Dot()->getTxFrequency());
Mike Fiore 9:ff62b20f7000 112
Mike Fiore 14:f9a77400b622 113 CommandTerminal::Serial()->writef("Tx Data Rate:\t\tDR%d - %s\r\n", CommandTerminal::Dot()->getTxDataRate(), CommandTerminal::Dot()->getDateRateDetails(CommandTerminal::Dot()->getTxDataRate()).c_str());
jenkins@jenkinsdm1 16:d5cf2af81a6d 114 CommandTerminal::Serial()->writef("Min/Max Tx Data Rate:\tMin: DR%d - %s\r\n\t\t\tMax: DR%d - %s\r\n", CommandTerminal::Dot()->getMinDatarate(), CommandTerminal::Dot()->getDateRateDetails(CommandTerminal::Dot()->getMinDatarate()).c_str(), CommandTerminal::Dot()->getMaxDatarate(), CommandTerminal::Dot()->getDateRateDetails(CommandTerminal::Dot()->getMaxDatarate()).c_str());
Mike Fiore 14:f9a77400b622 115 CommandTerminal::Serial()->writef("Tx Power:\t\t%u\r\n", CommandTerminal::Dot()->getTxPower());
jenkins@jenkinsdm1 16:d5cf2af81a6d 116 CommandTerminal::Serial()->writef("Min/Max Tx Power:\tMin: %u\r\n\t\t\tMax: %u\r\n", CommandTerminal::Dot()->getMinTxPower(), CommandTerminal::Dot()->getMaxTxPower());
Mike Fiore 14:f9a77400b622 117 CommandTerminal::Serial()->writef("Tx Antenna Gain:\t%d\r\n", CommandTerminal::Dot()->getAntennaGain());
Mike Fiore 14:f9a77400b622 118 CommandTerminal::Serial()->writef("Tx Wait:\t\t%s\r\n", CommandTerminal::Dot()->getTxWait() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 119
Mike Fiore 14:f9a77400b622 120 CommandTerminal::Serial()->writef("Tx Inverted Signal:\t%s\r\n", CommandTerminal::Dot()->getTxInverted() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 121
Mike Fiore 9:ff62b20f7000 122 bool hasChannels = false;
Mike Fiore 9:ff62b20f7000 123 for (size_t i = 0; i < 16; i++) {
Mike Fiore 14:f9a77400b622 124 if (CommandTerminal::Dot()->getConfigChannels()[i] != 0) {
Mike Fiore 9:ff62b20f7000 125 hasChannels = true;
Mike Fiore 9:ff62b20f7000 126 break;
Mike Fiore 9:ff62b20f7000 127 }
Mike Fiore 9:ff62b20f7000 128 }
Mike Fiore 9:ff62b20f7000 129
Mike Fiore 9:ff62b20f7000 130 if (hasChannels) {
Mike Fiore 14:f9a77400b622 131 CommandTerminal::Serial()->writef("Tx Channels --------------------------------------\r\n");
Mike Fiore 14:f9a77400b622 132 CommandTerminal::Serial()->writef("\tIndex\tFrequency\tDR Range\r\n");
Mike Fiore 9:ff62b20f7000 133 for (size_t i = 0; i < 16; i++) {
Mike Fiore 14:f9a77400b622 134 if (CommandTerminal::Dot()->getConfigChannels()[i] != 0)
Mike Fiore 14:f9a77400b622 135 CommandTerminal::Serial()->writef("\t%d:\t%09lu\t%02x\r\n", i, CommandTerminal::Dot()->getConfigChannels()[i], CommandTerminal::Dot()->getConfigChannelRanges()[i]);
Mike Fiore 9:ff62b20f7000 136 }
Mike Fiore 14:f9a77400b622 137 CommandTerminal::Serial()->writef("--------------------------------------------------\r\n");
Mike Fiore 9:ff62b20f7000 138 }
Mike Fiore 9:ff62b20f7000 139
Mike Fiore 14:f9a77400b622 140 CommandTerminal::Serial()->writef("Rx Delay:\t\t%d s\r\n", CommandTerminal::Dot()->getRxDelay());
Mike Fiore 14:f9a77400b622 141 // CommandTerminal::Serial()->writef("Rx Frequency:\t\t%lu\r\n", CommandTerminal::Dot()->getRxFrequency());
Mike Fiore 14:f9a77400b622 142 // CommandTerminal::Serial()->writef("Rx Data Rate:\t\t%s\r\n", mDot::DataRateStr(CommandTerminal::Dot()->getRxDataRate()).c_str());
Mike Fiore 14:f9a77400b622 143 CommandTerminal::Serial()->writef("Rx Inverted Signal:\t%s\r\n", CommandTerminal::Dot()->getRxInverted() ? "on" : "off");
Mike Fiore 1:e52ae6584f1c 144
Mike Fiore 14:f9a77400b622 145 CommandTerminal::Serial()->writef("Rx Output Style:\t%s\r\n", mDot::RxOutputStr(CommandTerminal::Dot()->getRxOutput()).c_str());
Mike Fiore 1:e52ae6584f1c 146
Mike Fiore 14:f9a77400b622 147 CommandTerminal::Serial()->writef("Debug Baud Rate:\t%lu\r\n", CommandTerminal::Dot()->getDebugBaud());
Mike Fiore 14:f9a77400b622 148 CommandTerminal::Serial()->writef("Serial Baud Rate:\t%lu\r\n", CommandTerminal::Dot()->getBaud());
Mike Fiore 14:f9a77400b622 149 CommandTerminal::Serial()->writef("Serial Flow Control:\t%s\r\n", CommandTerminal::Dot()->getFlowControl() == 0 ? "off" : "on");
Mike Fiore 14:f9a77400b622 150 CommandTerminal::Serial()->writef("Serial Clear On Error:\t%s\r\n", CommandTerminal::Dot()->getSerialClearOnError() == 0 ? "off" : "on");
Mike Fiore 1:e52ae6584f1c 151
Mike Fiore 14:f9a77400b622 152 uint8_t mode = CommandTerminal::Dot()->getWakeMode();
Mike Fiore 14:f9a77400b622 153 CommandTerminal::Serial()->writef("Wake Mode:\t\t%s\r\n", mode == 0 ? "INTERVAL" : ( mode == 1 ? "INTERRUPT" : "BOTH"));
Mike Fiore 14:f9a77400b622 154 CommandTerminal::Serial()->writef("Wake Interval:\t\t%lu s\r\n", CommandTerminal::Dot()->getWakeInterval());
Mike Fiore 14:f9a77400b622 155 CommandTerminal::Serial()->writef("Wake Delay:\t\t%lu ms\r\n", CommandTerminal::Dot()->getWakeDelay());
Mike Fiore 14:f9a77400b622 156 CommandTerminal::Serial()->writef("Wake Timeout:\t\t%u ms\r\n", CommandTerminal::Dot()->getWakeTimeout());
Mike Fiore 14:f9a77400b622 157 CommandTerminal::Serial()->writef("Wake Pin:\t\t%s\r\n", mDot::pinName2Str(CommandTerminal::Dot()->getWakePin()).c_str());
Mike Fiore 1:e52ae6584f1c 158
Mike Fiore 14:f9a77400b622 159 CommandTerminal::Serial()->writef("Log Level:\t\t%ld\r\n", CommandTerminal::Dot()->getLogLevel());
Mike Fiore 1:e52ae6584f1c 160
Mike Fiore 1:e52ae6584f1c 161 return 0;
Mike Fiore 1:e52ae6584f1c 162 }
Mike Fiore 1:e52ae6584f1c 163