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/CommandFactory.cpp@33:5c0252521669, 2021-01-29 (annotated)

Committer:
Jason Reiss
Date:
Fri Jan 29 13:04:32 2021 -0600
Revision:
33:5c0252521669
Parent:
28:c222ca8383f4
Child:
34:3b696c2b1e4b
Remove moved commands

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jason Reiss 27:5fafd3b26ac3 1 #include "CommandFactory.h"
Jason Reiss 27:5fafd3b26ac3 2
Jason Reiss 28:c222ca8383f4 3 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 28:c222ca8383f4 4 #define CMD_DUMMY(n,t,d,u) CmdDummy(n,t,d,u)
Jason Reiss 28:c222ca8383f4 5 #else
Jason Reiss 28:c222ca8383f4 6 #define CMD_DUMMY(n,t,d,u) CmdDummy(t)
Jason Reiss 28:c222ca8383f4 7 #endif
Jason Reiss 28:c222ca8383f4 8
Jason Reiss 27:5fafd3b26ac3 9 Command* CommandFactory::Create(CmdId_t cmd)
Jason Reiss 27:5fafd3b26ac3 10 {
Jason Reiss 27:5fafd3b26ac3 11 switch (cmd) {
Jason Reiss 27:5fafd3b26ac3 12 case eAT:
Jason Reiss 28:c222ca8383f4 13 return new CMD_DUMMY("Attention", "AT", "Attention", "");
Jason Reiss 27:5fafd3b26ac3 14 case eATI:
Jason Reiss 27:5fafd3b26ac3 15 return new CmdIdentification();
Jason Reiss 27:5fafd3b26ac3 16 case eLW:
Jason Reiss 28:c222ca8383f4 17 return new CMD_DUMMY("LoRaWAN MAC Version", "AT+LW", "Show support LoRaWAN MAC Version", "");
Jason Reiss 27:5fafd3b26ac3 18 case eATZ:
Jason Reiss 27:5fafd3b26ac3 19 return new CmdResetCpu();
Jason Reiss 27:5fafd3b26ac3 20 case eATE:
Jason Reiss 28:c222ca8383f4 21 return new CMD_DUMMY("Enable/Disable Echo", "ATE", "ATE0: disable, ATE1: enable", "(0,1)");
Jason Reiss 27:5fafd3b26ac3 22 case eATVERBOSE:
Jason Reiss 28:c222ca8383f4 23 return new CMD_DUMMY("Enable/Disable Verbose", "ATV", "ATV0: disable, ATV1: enable", "(0,1)");
Jason Reiss 27:5fafd3b26ac3 24 case eATK:
Jason Reiss 28:c222ca8383f4 25 return new CMD_DUMMY("Hardware Flow Control", "AT&K", "AT&K0: disable, AT&K3: enable", "(0,3)");
Jason Reiss 27:5fafd3b26ac3 26 case eATF:
Jason Reiss 27:5fafd3b26ac3 27 return new CmdFactoryDefault();
Jason Reiss 27:5fafd3b26ac3 28 case eATW:
Jason Reiss 28:c222ca8383f4 29 return new CMD_DUMMY("Save Configuration", "AT&W", "Save configuration to flash memory", "NONE");
Jason Reiss 28:c222ca8383f4 30 #if MTS_CMD_TERM_VERBOSE
Jason Reiss 27:5fafd3b26ac3 31 case eATV:
Jason Reiss 27:5fafd3b26ac3 32 return new CmdDisplayConfig();
Jason Reiss 27:5fafd3b26ac3 33 case eATS:
Jason Reiss 27:5fafd3b26ac3 34 return new CmdDisplayStats();
Jason Reiss 28:c222ca8383f4 35 #endif
Jason Reiss 27:5fafd3b26ac3 36 case eATR:
Jason Reiss 27:5fafd3b26ac3 37 return new CmdResetStats();
Jason Reiss 27:5fafd3b26ac3 38 case eIPR:
Jason Reiss 27:5fafd3b26ac3 39 return new CmdSerialBaudRate();
Jason Reiss 27:5fafd3b26ac3 40 case eDIPR:
Jason Reiss 27:5fafd3b26ac3 41 return new CmdDebugBaudRate();
Jason Reiss 27:5fafd3b26ac3 42 case eSMODE:
Jason Reiss 27:5fafd3b26ac3 43 return new CmdStartUpMode();
Jason Reiss 27:5fafd3b26ac3 44 case eDFREQ:
Jason Reiss 27:5fafd3b26ac3 45 return new CmdDefaultFrequencyBand();
Jason Reiss 27:5fafd3b26ac3 46 case eFREQ:
Jason Reiss 27:5fafd3b26ac3 47 return new CmdFrequencyBand();
Jason Reiss 27:5fafd3b26ac3 48 case eFSB:
Jason Reiss 27:5fafd3b26ac3 49 return new CmdFrequencySubBand();
Jason Reiss 27:5fafd3b26ac3 50 case ePN:
Jason Reiss 27:5fafd3b26ac3 51 return new CmdPublicNetwork();
Jason Reiss 27:5fafd3b26ac3 52 case eDI:
Jason Reiss 27:5fafd3b26ac3 53 return new CmdDeviceId();
Jason Reiss 27:5fafd3b26ac3 54 case eDC:
Jason Reiss 27:5fafd3b26ac3 55 return new CmdDeviceClass();
Jason Reiss 27:5fafd3b26ac3 56 case eLBT:
Jason Reiss 27:5fafd3b26ac3 57 return new CmdLbt();
Jason Reiss 27:5fafd3b26ac3 58 case eAP:
Jason Reiss 27:5fafd3b26ac3 59 return new CmdAppPort();
Jason Reiss 27:5fafd3b26ac3 60 case eNA:
Jason Reiss 27:5fafd3b26ac3 61 return new CmdNetworkAddress();
Jason Reiss 27:5fafd3b26ac3 62 case eNSK:
Jason Reiss 27:5fafd3b26ac3 63 return new CmdNetworkSessionKey();
Jason Reiss 27:5fafd3b26ac3 64 case eDSK:
Jason Reiss 27:5fafd3b26ac3 65 return new CmdDataSessionKey();
Jason Reiss 27:5fafd3b26ac3 66 case eULC:
Jason Reiss 27:5fafd3b26ac3 67 return new CmdUplinkCounter();
Jason Reiss 27:5fafd3b26ac3 68 case eDLC:
Jason Reiss 27:5fafd3b26ac3 69 return new CmdDownlinkCounter();
Jason Reiss 27:5fafd3b26ac3 70 case eSS:
Jason Reiss 28:c222ca8383f4 71 return new CMD_DUMMY("Save Network Session", "AT+SS", "Save network session info to flash", "NONE");
Jason Reiss 27:5fafd3b26ac3 72 case eRS:
Jason Reiss 27:5fafd3b26ac3 73 return new CmdRestoreSession();
Jason Reiss 27:5fafd3b26ac3 74 case eNK:
Jason Reiss 27:5fafd3b26ac3 75 return new CmdNetworkKey();
Jason Reiss 27:5fafd3b26ac3 76 case eGK:
Jason Reiss 27:5fafd3b26ac3 77 return new CmdGenAppKey();
Jason Reiss 27:5fafd3b26ac3 78 case eNI:
Jason Reiss 27:5fafd3b26ac3 79 return new CmdNetworkId();
Jason Reiss 27:5fafd3b26ac3 80 case eJD:
Jason Reiss 27:5fafd3b26ac3 81 return new CmdJoinDelay();
Jason Reiss 27:5fafd3b26ac3 82 case eJOIN:
Jason Reiss 27:5fafd3b26ac3 83 return new CmdJoinRequest();
Jason Reiss 27:5fafd3b26ac3 84 case eJR:
Jason Reiss 27:5fafd3b26ac3 85 return new CmdJoinRetries();
Jason Reiss 27:5fafd3b26ac3 86 case eJN:
Jason Reiss 27:5fafd3b26ac3 87 return new CmdJoinNonce();
Jason Reiss 27:5fafd3b26ac3 88 case eJNV:
Jason Reiss 27:5fafd3b26ac3 89 return new CmdJoinNonceValidation();
Jason Reiss 27:5fafd3b26ac3 90 case eNJM:
Jason Reiss 27:5fafd3b26ac3 91 return new CmdNetworkJoinMode();
Jason Reiss 27:5fafd3b26ac3 92 case ePS:
Jason Reiss 27:5fafd3b26ac3 93 return new CmdPreserveSession();
Jason Reiss 27:5fafd3b26ac3 94 case eNJS:
Jason Reiss 27:5fafd3b26ac3 95 return new CmdNetworkJoinStatus();
Jason Reiss 27:5fafd3b26ac3 96 case eNLC:
Jason Reiss 27:5fafd3b26ac3 97 return new CmdNetworkLinkCheck();
Jason Reiss 27:5fafd3b26ac3 98 case eLCC:
Jason Reiss 27:5fafd3b26ac3 99 return new CmdLinkCheckCount();
Jason Reiss 27:5fafd3b26ac3 100 case eLCT:
Jason Reiss 27:5fafd3b26ac3 101 return new CmdLinkCheckThreshold();
Jason Reiss 27:5fafd3b26ac3 102 case eRSSI:
Jason Reiss 27:5fafd3b26ac3 103 return new CmdRssi();
Jason Reiss 27:5fafd3b26ac3 104 case eSNR:
Jason Reiss 27:5fafd3b26ac3 105 return new CmdSnr();
Jason Reiss 27:5fafd3b26ac3 106 case eDP:
Jason Reiss 28:c222ca8383f4 107 return new CMD_DUMMY("Data Pending", "AT+DP", "Indicator of data in queue on server", "(0,1)");
Jason Reiss 27:5fafd3b26ac3 108 case eSDR:
Jason Reiss 27:5fafd3b26ac3 109 return new CmdSessionDataRate();
Jason Reiss 27:5fafd3b26ac3 110 case eCHM:
Jason Reiss 27:5fafd3b26ac3 111 return new CmdChannelMask();
Jason Reiss 27:5fafd3b26ac3 112 case eTXDR:
Jason Reiss 27:5fafd3b26ac3 113 return new CmdTxDataRate();
Jason Reiss 27:5fafd3b26ac3 114 case eTXP:
Jason Reiss 27:5fafd3b26ac3 115 return new CmdTxPower();
Jason Reiss 27:5fafd3b26ac3 116 case eANT:
Jason Reiss 27:5fafd3b26ac3 117 return new CmdAntennaGain();
Jason Reiss 27:5fafd3b26ac3 118 case eTXF:
Jason Reiss 27:5fafd3b26ac3 119 return new CmdTxFrequency();
Jason Reiss 27:5fafd3b26ac3 120 case eFO:
Jason Reiss 27:5fafd3b26ac3 121 return new CmdTxFrequencyOffset();
Jason Reiss 27:5fafd3b26ac3 122 case eTXW:
Jason Reiss 27:5fafd3b26ac3 123 return new CmdTxWait();
Jason Reiss 27:5fafd3b26ac3 124 case eTXCH:
Jason Reiss 27:5fafd3b26ac3 125 return new CmdTxChannel();
Jason Reiss 27:5fafd3b26ac3 126 case eTXN:
Jason Reiss 27:5fafd3b26ac3 127 return new CmdTxNextMs();
Jason Reiss 27:5fafd3b26ac3 128 case eTXS:
Jason Reiss 27:5fafd3b26ac3 129 return new CmdTxNextSize();
Jason Reiss 27:5fafd3b26ac3 130 case eTOA:
Jason Reiss 27:5fafd3b26ac3 131 return new CmdTimeOnAir();
Jason Reiss 27:5fafd3b26ac3 132 case eMCRX:
Jason Reiss 27:5fafd3b26ac3 133 return new CmdMulticastRx();
Jason Reiss 27:5fafd3b26ac3 134 case eRXD:
Jason Reiss 27:5fafd3b26ac3 135 return new CmdRxDelay();
Jason Reiss 27:5fafd3b26ac3 136 case eRXO:
Jason Reiss 27:5fafd3b26ac3 137 return new CmdRxOutput();
Jason Reiss 27:5fafd3b26ac3 138 case eADR:
Jason Reiss 27:5fafd3b26ac3 139 return new CmdAdaptiveDataRate();
Jason Reiss 27:5fafd3b26ac3 140 case eACK:
Jason Reiss 27:5fafd3b26ac3 141 return new CmdACKAttempts();
Jason Reiss 28:c222ca8383f4 142 case eBTO:
Jason Reiss 28:c222ca8383f4 143 return new CmdClassBTimeout();
Jason Reiss 28:c222ca8383f4 144 case eCTO:
Jason Reiss 28:c222ca8383f4 145 return new CmdClassCTimeout();
Jason Reiss 27:5fafd3b26ac3 146 case eREP:
Jason Reiss 27:5fafd3b26ac3 147 return new CmdRepeat();
Jason Reiss 27:5fafd3b26ac3 148 case ePP:
Jason Reiss 27:5fafd3b26ac3 149 return new CmdPingPeriod();
Jason Reiss 27:5fafd3b26ac3 150 case eMAC:
Jason Reiss 27:5fafd3b26ac3 151 return new CmdMacCmd();
Jason Reiss 27:5fafd3b26ac3 152 case eSEND:
Jason Reiss 27:5fafd3b26ac3 153 return new CmdSendString();
Jason Reiss 27:5fafd3b26ac3 154 case eSENDB:
Jason Reiss 27:5fafd3b26ac3 155 return new CmdSendBinary();
Jason Reiss 27:5fafd3b26ac3 156 case eRECV:
Jason Reiss 27:5fafd3b26ac3 157 return new CmdReceiveOnce();
Jason Reiss 27:5fafd3b26ac3 158 case eURC:
Jason Reiss 28:c222ca8383f4 159 return new CMD_DUMMY("Unsolicited Response Code", "AT+URC", "Output packets to terminal when received", "(0,1)");
Jason Reiss 27:5fafd3b26ac3 160 case eSD:
Jason Reiss 28:c222ca8383f4 161 return new CMD_DUMMY("Serial Data Mode", "AT+SD", "Enter serial data mode, exit with '+++'", "NONE");
Jason Reiss 27:5fafd3b26ac3 162 case eSLEEP:
Jason Reiss 28:c222ca8383f4 163 return new CMD_DUMMY("Sleep Mode", "AT+SLEEP", "Enter sleep mode (0:deepsleep,1:sleep)", "(0,1)");
Jason Reiss 27:5fafd3b26ac3 164 case eSDCE:
Jason Reiss 27:5fafd3b26ac3 165 return new CmdSerialClearOnError();
Jason Reiss 27:5fafd3b26ac3 166 case eWM:
Jason Reiss 27:5fafd3b26ac3 167 return new CmdWakeMode();
Jason Reiss 27:5fafd3b26ac3 168 case eWI:
Jason Reiss 27:5fafd3b26ac3 169 return new CmdWakeInterval();
Jason Reiss 27:5fafd3b26ac3 170 case eWP:
Jason Reiss 27:5fafd3b26ac3 171 return new CmdWakePin();
Jason Reiss 27:5fafd3b26ac3 172 case eWD:
Jason Reiss 27:5fafd3b26ac3 173 return new CmdWakeDelay();
Jason Reiss 27:5fafd3b26ac3 174 case eWTO:
Jason Reiss 27:5fafd3b26ac3 175 return new CmdWakeTimeout();
Jason Reiss 27:5fafd3b26ac3 176 case ePING:
Jason Reiss 27:5fafd3b26ac3 177 return new CmdPing();
Jason Reiss 27:5fafd3b26ac3 178 case eLOG:
Jason Reiss 27:5fafd3b26ac3 179 return new CmdLogLevel();
Jason Reiss 27:5fafd3b26ac3 180 case eFOTA:
Jason Reiss 27:5fafd3b26ac3 181 return new CmdFota();
Jason Reiss 27:5fafd3b26ac3 182 case eGPSTIME:
Jason Reiss 27:5fafd3b26ac3 183 return new CmdGpsTime();
Jason Reiss 27:5fafd3b26ac3 184 case eBLS:
Jason Reiss 27:5fafd3b26ac3 185 return new CmdBeaconLockStatus();
Jason Reiss 27:5fafd3b26ac3 186 case eLBTRSSI:
Jason Reiss 27:5fafd3b26ac3 187 return new CmdLBTRSSI();
Jason Reiss 27:5fafd3b26ac3 188 case eBAT:
Jason Reiss 27:5fafd3b26ac3 189 return new CmdBatteryLevel();
Jason Reiss 28:c222ca8383f4 190 case eATWP:
Jason Reiss 28:c222ca8383f4 191 return new CMD_DUMMY("Write Protected Config", "AT&WP", "Write protected config to flash (DevEUI, AppEUI, AppKey, Frequency Band)", "NONE");
Jason Reiss 28:c222ca8383f4 192 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 28:c222ca8383f4 193 case eREPAIR:
Jason Reiss 28:c222ca8383f4 194 return new CmdRepairFlash();
Jason Reiss 28:c222ca8383f4 195 #endif
Jason Reiss 28:c222ca8383f4 196 #if MTS_CMD_TERM_TEST_COMMANDS
Jason Reiss 27:5fafd3b26ac3 197 case ePRINT_TEST:
Jason Reiss 28:c222ca8383f4 198 return new CMD_DUMMY("***** Test Commands *****", "", "", "");
Jason Reiss 27:5fafd3b26ac3 199 case eRXDR:
Jason Reiss 27:5fafd3b26ac3 200 return new CmdRxDataRate();
Jason Reiss 27:5fafd3b26ac3 201 case eSENDI:
Jason Reiss 27:5fafd3b26ac3 202 return new CmdSendStringOnInterval();
Jason Reiss 27:5fafd3b26ac3 203 case eSENDC:
Jason Reiss 27:5fafd3b26ac3 204 return new CmdSendContinuous();
Jason Reiss 27:5fafd3b26ac3 205 case eMEM:
Jason Reiss 28:c222ca8383f4 206 return new CMD_DUMMY("Free Memory", "AT+MEM", "Show amount of free RAM available", "");
Jason Reiss 27:5fafd3b26ac3 207 #endif
Jason Reiss 28:c222ca8383f4 208 #ifdef MTS_RADIO_DEBUG_COMMANDS
Jason Reiss 28:c222ca8383f4 209 case ePRINT_DEBUG:
Jason Reiss 28:c222ca8383f4 210 return new CMD_DUMMY("***** Debug Commands *****", "", "", "");
Jason Reiss 27:5fafd3b26ac3 211 case eDREGS:
Jason Reiss 27:5fafd3b26ac3 212 return new CmdDumpRegisters();
Jason Reiss 27:5fafd3b26ac3 213 case eERASE:
Jason Reiss 27:5fafd3b26ac3 214 return new CmdEraseFlash();
Jason Reiss 27:5fafd3b26ac3 215 case eDD:
Jason Reiss 27:5fafd3b26ac3 216 return new CmdDisableDutyCycle();
Jason Reiss 27:5fafd3b26ac3 217 case eRXF:
Jason Reiss 27:5fafd3b26ac3 218 return new CmdRxFrequency();
Jason Reiss 27:5fafd3b26ac3 219 case eRECVC:
Jason Reiss 27:5fafd3b26ac3 220 return new CmdReceiveContinuous();
Jason Reiss 28:c222ca8383f4 221 case eRTC:
Jason Reiss 28:c222ca8383f4 222 return new CmdRtc();
Jason Reiss 27:5fafd3b26ac3 223 #endif
Jason Reiss 27:5fafd3b26ac3 224 default:
Jason Reiss 27:5fafd3b26ac3 225 return NULL;
Jason Reiss 27:5fafd3b26ac3 226 }
Jason Reiss 27:5fafd3b26ac3 227 }