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

Committer:
Jason Reiss
Date:
2020-11-19
Revision:
28:c222ca8383f4
Parent:
27:5fafd3b26ac3
Child:
34:3b696c2b1e4b

File content as of revision 28:c222ca8383f4:

#include "CommandFactory.h"

#if MTS_CMD_TERM_VERBOSE
#define CMD_DUMMY(n,t,d,u)  CmdDummy(n,t,d,u)
#else
#define CMD_DUMMY(n,t,d,u)  CmdDummy(t)
#endif

Command* CommandFactory::Create(CmdId_t cmd)
{
    switch (cmd) {
    case eAT:
        return new CMD_DUMMY("Attention", "AT", "Attention", "");
    case eATI:
        return new CmdIdentification();
    case eLW:
        return new CMD_DUMMY("LoRaWAN MAC Version", "AT+LW", "Show support LoRaWAN MAC Version", "");
    case eATZ:
        return new CmdResetCpu();
    case eATE:
        return new CMD_DUMMY("Enable/Disable Echo", "ATE", "ATE0: disable, ATE1: enable", "(0,1)");
    case eATVERBOSE:
        return new CMD_DUMMY("Enable/Disable Verbose", "ATV", "ATV0: disable, ATV1: enable", "(0,1)");
    case eATK:
        return new CMD_DUMMY("Hardware Flow Control", "AT&K", "AT&K0: disable, AT&K3: enable", "(0,3)");
    case eATF:
        return new CmdFactoryDefault();
    case eATW:
        return new CMD_DUMMY("Save Configuration", "AT&W", "Save configuration to flash memory", "NONE");
#if MTS_CMD_TERM_VERBOSE
    case eATV:
        return new CmdDisplayConfig();
    case eATS:
        return new CmdDisplayStats();
#endif
    case eATR:
        return new CmdResetStats();
    case eIPR:
        return new CmdSerialBaudRate();
    case eDIPR:
        return new CmdDebugBaudRate();
    case eSMODE:
        return new CmdStartUpMode();
    case eDFREQ:
        return new CmdDefaultFrequencyBand();
    case eFREQ:
        return new CmdFrequencyBand();
    case eFSB:
        return new CmdFrequencySubBand();
    case ePN:
        return new CmdPublicNetwork();
    case eDI:
        return new CmdDeviceId();
    case eDC:
        return new CmdDeviceClass();
    case eLBT:
        return new CmdLbt();
    case eAP:
        return new CmdAppPort();
    case eNA:
        return new CmdNetworkAddress();
    case eNSK:
        return new CmdNetworkSessionKey();
    case eDSK:
        return new CmdDataSessionKey();
    case eULC:
        return new CmdUplinkCounter();
    case eDLC:
        return new CmdDownlinkCounter();
    case eSS:
        return new CMD_DUMMY("Save Network Session", "AT+SS", "Save network session info to flash", "NONE");
    case eRS:
        return new CmdRestoreSession();
    case eNK:
        return new CmdNetworkKey();
    case eGK:
        return new CmdGenAppKey();
    case eNI:
        return new CmdNetworkId();
    case eJD:
        return new CmdJoinDelay();
    case eJOIN:
        return new CmdJoinRequest();
    case eJR:
        return new CmdJoinRetries();
    case eJN:
        return new CmdJoinNonce();
    case eJNV:
        return new CmdJoinNonceValidation();
    case eNJM:
        return new CmdNetworkJoinMode();
    case ePS:
        return new CmdPreserveSession();
    case eNJS:
        return new CmdNetworkJoinStatus();
    case eNLC:
        return new CmdNetworkLinkCheck();
    case eLCC:
        return new CmdLinkCheckCount();
    case eLCT:
        return new CmdLinkCheckThreshold();
    case eRSSI:
        return new CmdRssi();
    case eSNR:
        return new CmdSnr();
    case eDP:
        return new CMD_DUMMY("Data Pending", "AT+DP", "Indicator of data in queue on server", "(0,1)");
    case eSDR:
        return new CmdSessionDataRate();
    case eCHM:
        return new CmdChannelMask();
    case eTXDR:
        return new CmdTxDataRate();
    case eTXP:
        return new CmdTxPower();
    case eANT:
        return new CmdAntennaGain();
    case eTXF:
        return new CmdTxFrequency();
    case eFO:
        return new CmdTxFrequencyOffset();
    case eTXW:
        return new CmdTxWait();
    case eTXCH:
        return new CmdTxChannel();
    case eTXN:
        return new CmdTxNextMs();
    case eTXS:
        return new CmdTxNextSize();
    case eTOA:
        return new CmdTimeOnAir();
    case eMCRX:
        return new CmdMulticastRx();
    case eRXD:
        return new CmdRxDelay();
    case eRXO:
        return new CmdRxOutput();
    case eADR:
        return new CmdAdaptiveDataRate();
    case eACK:
        return new CmdACKAttempts();
    case eBTO:
        return new CmdClassBTimeout();
    case eCTO:
        return new CmdClassCTimeout();
    case eREP:
        return new CmdRepeat();
    case ePP:
        return new CmdPingPeriod();
    case eMAC:
        return new CmdMacCmd();
    case eSEND:
        return new CmdSendString();
    case eSENDB:
        return new CmdSendBinary();
    case eRECV:
        return new CmdReceiveOnce();
    case eURC:
        return new CMD_DUMMY("Unsolicited Response Code", "AT+URC", "Output packets to terminal when received", "(0,1)");
    case eSD:
        return new CMD_DUMMY("Serial Data Mode", "AT+SD", "Enter serial data mode, exit with '+++'", "NONE");
    case eSLEEP:
        return new CMD_DUMMY("Sleep Mode", "AT+SLEEP", "Enter sleep mode (0:deepsleep,1:sleep)", "(0,1)");
    case eSDCE:
        return new CmdSerialClearOnError();
    case eWM:
        return new CmdWakeMode();
    case eWI:
        return new CmdWakeInterval();
    case eWP:
        return new CmdWakePin();
    case eWD:
        return new CmdWakeDelay();
    case eWTO:
        return new CmdWakeTimeout();
    case ePING:
        return new CmdPing();
    case eLOG:
        return new CmdLogLevel();
    case eFOTA:
        return new CmdFota();
    case eGPSTIME:
        return new CmdGpsTime();
    case eBLS:
        return new CmdBeaconLockStatus();
    case eLBTRSSI:
        return new CmdLBTRSSI();
    case eBAT:
        return new CmdBatteryLevel();
    case eATWP:
        return new CMD_DUMMY("Write Protected Config", "AT&WP", "Write protected config to flash (DevEUI, AppEUI, AppKey, Frequency Band)", "NONE");
#if defined(TARGET_MTS_MDOT_F411RE)
    case eREPAIR:
        return new CmdRepairFlash();
#endif
#if MTS_CMD_TERM_TEST_COMMANDS
    case ePRINT_TEST:
        return new CMD_DUMMY("***** Test Commands *****", "", "", "");
    case eRXDR:
        return new CmdRxDataRate();
    case eSENDI:
        return new CmdSendStringOnInterval();
    case eSENDC:
        return new CmdSendContinuous();
    case eMEM:
        return new CMD_DUMMY("Free Memory", "AT+MEM", "Show amount of free RAM available", "");
#endif
#ifdef MTS_RADIO_DEBUG_COMMANDS
    case ePRINT_DEBUG:
        return new CMD_DUMMY("***** Debug Commands *****", "", "", "");
    case eDREGS:
        return new CmdDumpRegisters();
    case eERASE:
        return new CmdEraseFlash();
    case eDD:
        return new CmdDisableDutyCycle();
    case eRXF:
        return new CmdRxFrequency();
    case eRECVC:
        return new CmdReceiveContinuous();
    case eRTC:
        return new CmdRtc();
#endif
    default:
        return NULL;
    }
}