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/Commands.h@36:b586cd6e91f3, 2023-09-08 (annotated)

Committer:
Jason Reiss
Date:
Fri Sep 08 08:34:24 2023 -0500
Revision:
36:b586cd6e91f3
Parent:
34:3b696c2b1e4b
Child:
43:2cf3a16ad3f8
Update AT Version to 4.2.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 14:f9a77400b622 1 #ifndef __COMMANDS_H__
Mike Fiore 14:f9a77400b622 2 #define __COMMANDS_H__
Mike Fiore 14:f9a77400b622 3
Mike Fiore 1:e52ae6584f1c 4 #include "Command.h"
Mike Fiore 1:e52ae6584f1c 5 #include "CmdDummy.h"
Mike Fiore 1:e52ae6584f1c 6
Mike Fiore 1:e52ae6584f1c 7 #include "CmdIdentification.h"
Mike Fiore 1:e52ae6584f1c 8 #include "CmdResetCpu.h"
Mike Fiore 1:e52ae6584f1c 9 // Echo built into command terminal
Mike Fiore 1:e52ae6584f1c 10 // Verbose built into command terminal
Mike Fiore 1:e52ae6584f1c 11 //
Mike Fiore 1:e52ae6584f1c 12 #include "CmdFactoryDefault.h"
Jason Reiss 28:c222ca8383f4 13 #if MTS_CMD_TERM_VERBOSE
Mike Fiore 1:e52ae6584f1c 14 #include "CmdDisplayConfig.h"
Mike Fiore 1:e52ae6584f1c 15 #include "CmdDisplayStats.h"
Jason Reiss 28:c222ca8383f4 16 #endif
Mike Fiore 4:666017851052 17 #include "CmdResetStats.h"
Mike Fiore 1:e52ae6584f1c 18
Mike Fiore 1:e52ae6584f1c 19 #include "CmdSerialBaudRate.h"
Mike Fiore 9:ff62b20f7000 20 #include "CmdSerialClearOnError.h"
Mike Fiore 1:e52ae6584f1c 21 #include "CmdDebugBaudRate.h"
Mike Fiore 1:e52ae6584f1c 22 #include "CmdStartUpMode.h"
Mike Fiore 1:e52ae6584f1c 23
jenkins@jenkinsdm1 16:d5cf2af81a6d 24 #include "CmdDefaultFrequencyBand.h"
Mike Fiore 1:e52ae6584f1c 25 #include "CmdFrequencyBand.h"
Mike Fiore 1:e52ae6584f1c 26 #include "CmdDeviceId.h"
Mike Fiore 9:ff62b20f7000 27 #include "CmdDeviceClass.h"
Mike Fiore 1:e52ae6584f1c 28 #include "CmdPublicNetwork.h"
Mike Fiore 1:e52ae6584f1c 29 #include "CmdNetworkAddress.h"
Mike Fiore 1:e52ae6584f1c 30 #include "CmdNetworkSessionKey.h"
Mike Fiore 1:e52ae6584f1c 31 #include "CmdDataSessionKey.h"
Mike Fiore 9:ff62b20f7000 32 #include "CmdUplinkCounter.h"
Mike Fiore 9:ff62b20f7000 33 #include "CmdDownlinkCounter.h"
Mike Fiore 9:ff62b20f7000 34 #include "CmdRestoreSession.h"
Jason Reiss 36:b586cd6e91f3 35 #include "CmdCustomDeviceID.h"
Jason Reiss 36:b586cd6e91f3 36 #include "CmdCustomSerialNumber.h"
Mike Fiore 1:e52ae6584f1c 37 #include "CmdNetworkKey.h"
Jason Reiss 27:5fafd3b26ac3 38 #include "CmdGenAppKey.h"
Mike Fiore 1:e52ae6584f1c 39 #include "CmdNetworkId.h"
Mike Fiore 9:ff62b20f7000 40 #include "CmdAppPort.h"
Mike Fiore 1:e52ae6584f1c 41 #include "CmdJoinRequest.h"
Mike Fiore 1:e52ae6584f1c 42 #include "CmdJoinRetries.h"
Jason Reiss 27:5fafd3b26ac3 43 #include "CmdJoinNonce.h"
Jason Reiss 27:5fafd3b26ac3 44 #include "CmdJoinNonceValidation.h"
Mike Fiore 9:ff62b20f7000 45 #include "CmdJoinDelay.h"
Mike Fiore 14:f9a77400b622 46 // Remove join settings commands until valid case for changing default settings
Mike Fiore 14:f9a77400b622 47 //#include "CmdJoinRx1Offset.h"
Mike Fiore 14:f9a77400b622 48 //#include "CmdJoinRx2Datarate.h"
Mike Fiore 14:f9a77400b622 49 //#include "CmdJoinRx2Frequency.h"
Mike Fiore 1:e52ae6584f1c 50 #include "CmdNetworkJoinMode.h"
Mike Fiore 9:ff62b20f7000 51 #include "CmdPreserveSession.h"
Mike Fiore 1:e52ae6584f1c 52 #include "CmdNetworkJoinStatus.h"
Mike Fiore 1:e52ae6584f1c 53 #include "CmdNetworkLinkCheck.h"
Mike Fiore 1:e52ae6584f1c 54 #include "CmdLinkCheckCount.h"
Mike Fiore 1:e52ae6584f1c 55 #include "CmdLinkCheckThreshold.h"
Mike Fiore 1:e52ae6584f1c 56 #include "CmdRssi.h"
Mike Fiore 1:e52ae6584f1c 57 #include "CmdSnr.h"
Mike Fiore 1:e52ae6584f1c 58
Mike Fiore 9:ff62b20f7000 59 #include "CmdSessionDataRate.h"
Mike Fiore 14:f9a77400b622 60 #include "CmdChannelMask.h"
Mike Fiore 9:ff62b20f7000 61
Mike Fiore 1:e52ae6584f1c 62 #include "CmdTxDataRate.h"
Mike Fiore 9:ff62b20f7000 63 #include "CmdAntennaGain.h"
Mike Fiore 1:e52ae6584f1c 64 #include "CmdTxPower.h"
Mike Fiore 1:e52ae6584f1c 65 #include "CmdTxWait.h"
Jason Reiss 23:4f0a981c0349 66 #include "CmdTxFrequencyOffset.h"
Mike Fiore 1:e52ae6584f1c 67 #include "CmdTxChannel.h"
Mike Fiore 1:e52ae6584f1c 68 #include "CmdTxNextMs.h"
Jason Reiss 23:4f0a981c0349 69 #include "CmdTxNextSize.h"
Mike Fiore 1:e52ae6584f1c 70 #include "CmdTimeOnAir.h"
Mike Fiore 1:e52ae6584f1c 71 #include "CmdFrequencySubBand.h"
jenkins@jenkinsdm1 16:d5cf2af81a6d 72 #include "CmdLbt.h"
Mike Fiore 1:e52ae6584f1c 73
Mike Fiore 9:ff62b20f7000 74 #include "CmdRxDelay.h"
Mike Fiore 1:e52ae6584f1c 75 #include "CmdRxOutput.h"
Jason Reiss 27:5fafd3b26ac3 76 #include "CmdMulticastRx.h"
Mike Fiore 1:e52ae6584f1c 77
Mike Fiore 1:e52ae6584f1c 78 #include "CmdAdaptiveDataRate.h"
Mike Fiore 1:e52ae6584f1c 79
Mike Fiore 1:e52ae6584f1c 80 #include "CmdACKAttempts.h"
Mike Fiore 9:ff62b20f7000 81 #include "CmdRepeat.h"
Jason Reiss 23:4f0a981c0349 82 #include "CmdPingPeriod.h"
Mike Fiore 14:f9a77400b622 83 #include "CmdMacCmd.h"
Mike Fiore 1:e52ae6584f1c 84 #include "CmdSendString.h"
Mike Fiore 1:e52ae6584f1c 85 #include "CmdSendBinary.h"
Mike Fiore 1:e52ae6584f1c 86 #include "CmdReceiveOnce.h"
Mike Fiore 4:666017851052 87 #include "CmdPing.h"
Jason Reiss 28:c222ca8383f4 88 #include "CmdClassBTimeout.h"
Jason Reiss 28:c222ca8383f4 89 #include "CmdClassCTimeout.h"
Mike Fiore 1:e52ae6584f1c 90
Mike Fiore 1:e52ae6584f1c 91 // Serial Data Mode built into command terminal
Mike Fiore 4:666017851052 92 // Sleep built into command terminal
Mike Fiore 4:666017851052 93 #include "CmdWakeInterval.h"
Mike Fiore 4:666017851052 94 #include "CmdWakePin.h"
Mike Fiore 4:666017851052 95 #include "CmdWakeMode.h"
Mike Fiore 4:666017851052 96 #include "CmdWakeDelay.h"
Mike Fiore 4:666017851052 97 #include "CmdWakeTimeout.h"
Mike Fiore 1:e52ae6584f1c 98
Mike Fiore 1:e52ae6584f1c 99 #include "CmdLogLevel.h"
Mike Fiore 1:e52ae6584f1c 100
Jason Reiss 36:b586cd6e91f3 101 #include "CmdRtc.h"
jenkins@jenkinsdm1 18:63f098f042b2 102 #include "CmdFota.h"
Jason Reiss 28:c222ca8383f4 103 #include "CmdGpsTime.h"
Jason Reiss 28:c222ca8383f4 104 #include "CmdBeaconLockStatus.h"
Jason Reiss 28:c222ca8383f4 105 #include "CmdLBTRSSI.h"
jenkins@jenkinsdm1 18:63f098f042b2 106 #include "CmdBatteryLevel.h"
Jason Reiss 23:4f0a981c0349 107 #include "CmdTxFrequency.h"
Jason Reiss 34:3b696c2b1e4b 108 #include "CmdDutyCycle.h"
Jason Reiss 36:b586cd6e91f3 109 #include "CmdDisableDutyCycle.h"
Jason Reiss 28:c222ca8383f4 110
Jason Reiss 28:c222ca8383f4 111 #if MTS_CMD_TERM_TEST_COMMANDS
Jason Reiss 28:c222ca8383f4 112 #include "CmdRxDataRate.h"
Jason Reiss 28:c222ca8383f4 113 #include "CmdSendStringOnInterval.h"
Jason Reiss 23:4f0a981c0349 114 #include "CmdSendContinuous.h"
Jason Reiss 36:b586cd6e91f3 115 #include "CmdSweep.h"
Jason Reiss 28:c222ca8383f4 116 #endif
jenkins@jenkinsdm1 18:63f098f042b2 117
Jason Reiss 27:5fafd3b26ac3 118 #if defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 119 #include "CmdRepairFlash.h"
Jason Reiss 34:3b696c2b1e4b 120 #include "CmdWriteOtp.h"
Jason Reiss 27:5fafd3b26ac3 121 #endif
Jason Reiss 27:5fafd3b26ac3 122
Jason Reiss 28:c222ca8383f4 123 #ifdef MTS_RADIO_DEBUG_COMMANDS
Mike Fiore 1:e52ae6584f1c 124 // Radio debug commands
Mike Fiore 14:f9a77400b622 125 #include "CmdDumpRegisters.h"
Mike Fiore 14:f9a77400b622 126 #include "CmdEraseFlash.h"
Jason Reiss 28:c222ca8383f4 127 #include "CmdReceiveContinuous.h"
Jason Reiss 28:c222ca8383f4 128 #endif
Mike Fiore 14:f9a77400b622 129
Jason Reiss 36:b586cd6e91f3 130 #if defined(TARGET_XDOT_MAX32670)
Jason Reiss 36:b586cd6e91f3 131 #include "CmdTXPwrMode.h"
Jason Reiss 36:b586cd6e91f3 132 #ifdef MTS_RADIO_CTRL_COMMANDS
Jason Reiss 36:b586cd6e91f3 133 #include "CmdPaDutyConf.h"
Jason Reiss 36:b586cd6e91f3 134 #include "CmdHpMaxConf.h"
Jason Reiss 36:b586cd6e91f3 135 #include "CmdLnaConf.h"
Jason Reiss 36:b586cd6e91f3 136 #include "CmdXTATrim.h"
Jason Reiss 36:b586cd6e91f3 137 #include "CmdXTBTrim.h"
Jason Reiss 36:b586cd6e91f3 138 #include "CmdSetSW.h"
Jason Reiss 36:b586cd6e91f3 139 #include "CmdRamp.h"
Jason Reiss 36:b586cd6e91f3 140 #include "CmdInfPreamble.h"
Jason Reiss 36:b586cd6e91f3 141 #include "CmdRadioSleep.h"
Jason Reiss 36:b586cd6e91f3 142 #include "CmdSendDI.h"
Jason Reiss 36:b586cd6e91f3 143 #include "CmdRxFrequency.h"
Jason Reiss 36:b586cd6e91f3 144
Jason Reiss 36:b586cd6e91f3 145 #endif // MTS_RADOI_CTRL_COMMANDS
Jason Reiss 36:b586cd6e91f3 146 #endif // TARGET_XDOT_MAX32670
Jason Reiss 36:b586cd6e91f3 147
Mike Fiore 14:f9a77400b622 148 #endif // __COMMANDS_H__