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

README.md@42:23e2df6714f4, 4 months ago (annotated)

Committer:
Jason Reiss
Date:
Wed Dec 06 13:33:52 2023 -0600
Revision:
42:23e2df6714f4
Parent:
37:09a914d7d426 
TestMode: reset appnonce to 0 on reset to accomodate LCTT 3.12.0 and earlier. If the test suite changes to test AppNonce loaded from NVM this will fail tests.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jreiss 26:35c201bc5205 1 The AT Firmware provides an AT interface to the Multitech LoRaWAN stack
jreiss 26:35c201bc5205 2
Jason Reiss 36:b586cd6e91f3 3 Build Commands
Jason Reiss 36:b586cd6e91f3 4 ------------------
Jason Reiss 36:b586cd6e91f3 5
Jason Reiss 36:b586cd6e91f3 6 $ mbed compile -m XDOT_L151CC -t ARMC6 --source . -DCHANNEL_PLAN=CP_EU868 --profile=release
Jason Reiss 36:b586cd6e91f3 7 $ mbed compile -m XDOT_L151CC -t ARMC6 --source . -DCHANNEL_PLAN=CP_GLOBAL --profile=release
Jason Reiss 36:b586cd6e91f3 8 $ mbed compile -m XDOT_L151CC -t ARMC6 --source . -DCHANNEL_PLAN=CP_AS923 --profile=release
Jason Reiss 36:b586cd6e91f3 9 $ mbed compile -m XDOT_L151CC -t ARMC6 --source . -DCHANNEL_PLAN=CP_AS923_2 --profile=release
Jason Reiss 36:b586cd6e91f3 10
Jason Reiss 36:b586cd6e91f3 11 $ mbed compile -m MTS_MDOT_F411RE -t GCC_ARM --source . -DCHANNEL_PLAN=CP_EU868 --profile=release
Jason Reiss 36:b586cd6e91f3 12 $ mbed compile -m MTS_MDOT_F411RE -t GCC_ARM --source . -DCHANNEL_PLAN=CP_GLOBAL --profile=release
Jason Reiss 36:b586cd6e91f3 13
Jason Reiss 37:09a914d7d426 14
Jason Reiss 37:09a914d7d426 15
Jason Reiss 36:b586cd6e91f3 16 Global Channel Plan
Jason Reiss 36:b586cd6e91f3 17 ------------------
Jason Reiss 36:b586cd6e91f3 18 Global Plans support US915, EU868, AU915 and AS923 (1,2,3,4)
Jason Reiss 36:b586cd6e91f3 19 AT Commands are used to set the channel plan after loading the firmware.
Jason Reiss 36:b586cd6e91f3 20
Jason Reiss 36:b586cd6e91f3 21 AT+DFREQ=US915
Jason Reiss 36:b586cd6e91f3 22 AT&W
Jason Reiss 36:b586cd6e91f3 23 ATZ
Jason Reiss 36:b586cd6e91f3 24
Jason Reiss 36:b586cd6e91f3 25
jreiss 26:35c201bc5205 26 Dot libraries
jreiss 26:35c201bc5205 27 ------------------
jreiss 26:35c201bc5205 28
jreiss 26:35c201bc5205 29 Include one of the following libraries to complete this project.
jreiss 26:35c201bc5205 30 * [libmDot-mbed5](http://github.com/MultiTechSystems/libmDot-mbed5/) -> production-ready build for mDot
jreiss 26:35c201bc5205 31 * [libmDot-dev-mbed5](http://github.com/MultiTechSystems/libmDot-dev-mbed5/) -> development build for mDot
jreiss 26:35c201bc5205 32 * [libxDot-mbed5](http://github.com/MultiTechSystems/libxDot-mbed5/) -> production-ready build for xDot
jreiss 26:35c201bc5205 33 * [libxDot-dev-mbed5](http://github.com/MultiTechSystems/libxDot-dev-mbed5/) -> development build for xDot
jreiss 26:35c201bc5205 34
jreiss 26:35c201bc5205 35 A changelog for the Dot library can be found [here](https://developer.mbed.org/teams/MultiTech/wiki/Dot-library-change-log).
jreiss 26:35c201bc5205 36
Jason Reiss 37:09a914d7d426 37 LCTT Testing
Jason Reiss 37:09a914d7d426 38 ------------------------------
Jason Reiss 37:09a914d7d426 39 To compile with LCTT test handling include this macro definitition. This will allow entering test mode with AT+TM!=1. Test mode will be automatically entered after pressing reset, to exit test mode enter + character in command terminal and press reset.
Jason Reiss 37:09a914d7d426 40
Jason Reiss 37:09a914d7d426 41 {
Jason Reiss 37:09a914d7d426 42 "macros": [
Jason Reiss 37:09a914d7d426 43 "MTS_DOT_ENABLE_LORAWAN_TESTMODE=1"
Jason Reiss 37:09a914d7d426 44 ]
Jason Reiss 37:09a914d7d426 45 }
Jason Reiss 37:09a914d7d426 46
Jason Reiss 37:09a914d7d426 47
jreiss 26:35c201bc5205 48
jreiss 26:35c201bc5205 49
jreiss 26:35c201bc5205 50 Firmware update over the air
jreiss 26:35c201bc5205 51 ------------------------------
jreiss 26:35c201bc5205 52 FOTA support can be compiled into this application by adding "FOTA=1" to the macros array in the mbed_app.json file.
jreiss 26:35c201bc5205 53 FOTA is only supported on the mDot platform, xDot does not have an external flash for supporting FOTA.
jreiss 26:35c201bc5205 54
jreiss 26:35c201bc5205 55 {
jreiss 26:35c201bc5205 56 "macros": [
jreiss 26:35c201bc5205 57 "FOTA=1"
jreiss 26:35c201bc5205 58 ]
jreiss 26:35c201bc5205 59 }
Jason Reiss 36:b586cd6e91f3 60