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-mbed5

Stable library for mDot.

Import librarylibmDot-mbed5

Stable version of the mDot library for mbed 5. This version of the library is suitable for deployment scenarios. See lastest commit message for version of mbed-os library that has been tested against.

xDot Library

Development library for xDot.

libxDot-dev-mbed5

Stable library for xDot.

Import librarylibxDot-mbed5

Stable version of the xDot library for mbed 5. This version of the library is suitable for deployment scenarios.

Committer:
Jason Reiss
Date:
Wed Apr 24 10:47:25 2019 -0500
Revision:
23:4f0a981c0349
Parent:
22:a13ac7df92c0
Child:
27:5fafd3b26ac3
Update for v3.2.0 release

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Mike Fiore 9:ff62b20f7000 1 #include "mbed.h"
Mike Fiore 9:ff62b20f7000 2 #include "mDot.h"
Mike Fiore 9:ff62b20f7000 3 #include "CommandTerminal.h"
Mike Fiore 9:ff62b20f7000 4 #include "ATSerial.h"
Mike Fiore 9:ff62b20f7000 5 #include "ATSerialFlowControl.h"
jenkins@jenkinsdm1 16:d5cf2af81a6d 6 #include "ChannelPlans.h"
Mike Fiore 9:ff62b20f7000 7
Mike Fiore 9:ff62b20f7000 8 #define SERIAL_BUFFER_SIZE 512
Mike Fiore 9:ff62b20f7000 9
jenkins@jenkinsdm1 18:63f098f042b2 10 Serial debug_port(USBTX, USBRX);
Mike Fiore 14:f9a77400b622 11
jenkins@jenkinsdm1 16:d5cf2af81a6d 12 #ifndef CHANNEL_PLAN
jenkins@jenkinsdm1 16:d5cf2af81a6d 13 #define CHANNEL_PLAN CP_US915
jenkins@jenkinsdm1 16:d5cf2af81a6d 14 #endif
jenkins@jenkinsdm1 16:d5cf2af81a6d 15
Mike Fiore 14:f9a77400b622 16 #ifndef UNIT_TEST
Jason Reiss 23:4f0a981c0349 17 #ifndef UNIT_TEST_MDOT_LIB
Mike Fiore 9:ff62b20f7000 18 int main()
Mike Fiore 9:ff62b20f7000 19 {
jenkins@jenkinsdm1 18:63f098f042b2 20 debug_port.baud(115200);
Jason Reiss 23:4f0a981c0349 21
jenkins@jenkinsdm1 16:d5cf2af81a6d 22 #if CHANNEL_PLAN == CP_AS923
Jason Reiss 23:4f0a981c0349 23 lora::ChannelPlan_AS923 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 24 #elif CHANNEL_PLAN == CP_US915
Jason Reiss 23:4f0a981c0349 25 lora::ChannelPlan_US915 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 26 #elif CHANNEL_PLAN == CP_AU915
Jason Reiss 23:4f0a981c0349 27 lora::ChannelPlan_AU915 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 28 #elif CHANNEL_PLAN == CP_EU868
Jason Reiss 23:4f0a981c0349 29 lora::ChannelPlan_EU868 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 30 #elif CHANNEL_PLAN == CP_KR920
Jason Reiss 23:4f0a981c0349 31 lora::ChannelPlan_KR920 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 32 #elif CHANNEL_PLAN == CP_IN865
Jason Reiss 23:4f0a981c0349 33 lora::ChannelPlan_IN865 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 34 #elif CHANNEL_PLAN == CP_AS923_JAPAN
Jason Reiss 23:4f0a981c0349 35 lora::ChannelPlan_AS923_Japan plan;
Jason Reiss 23:4f0a981c0349 36 #elif CHANNEL_PLAN == CP_RU864
Jason Reiss 23:4f0a981c0349 37 lora::ChannelPlan_RU864 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 38 #endif
Jason Reiss 23:4f0a981c0349 39 mDot* dot = mDot::getInstance(&plan);
jenkins@jenkinsdm1 16:d5cf2af81a6d 40
jenkins@jenkinsdm1 16:d5cf2af81a6d 41 assert(dot);
Mike Fiore 9:ff62b20f7000 42
Mike Fiore 9:ff62b20f7000 43 // Seed the RNG
Mike Fiore 9:ff62b20f7000 44 srand(dot->getRadioRandom());
Mike Fiore 9:ff62b20f7000 45
Mike Fiore 9:ff62b20f7000 46 mts::ATSerial* serial;
Mike Fiore 9:ff62b20f7000 47
Mike Fiore 9:ff62b20f7000 48 if (dot->getFlowControl())
Mike Fiore 14:f9a77400b622 49 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 9:ff62b20f7000 50 serial = new mts::ATSerialFlowControl(XBEE_DOUT, XBEE_DIN, XBEE_RTS, XBEE_CTS, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 51 #else
Mike Fiore 14:f9a77400b622 52 serial = new mts::ATSerialFlowControl(UART1_TX, UART1_RX, UART1_RTS, UART1_CTS, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 53 #endif
Mike Fiore 9:ff62b20f7000 54 else
Mike Fiore 14:f9a77400b622 55 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 9:ff62b20f7000 56 serial = new mts::ATSerial(XBEE_DOUT, XBEE_DIN, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 57 #else
Mike Fiore 14:f9a77400b622 58 serial = new mts::ATSerial(UART1_TX, UART1_RX, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 59 #endif
Mike Fiore 9:ff62b20f7000 60
jenkins@jenkinsdm1 18:63f098f042b2 61 debug_port.baud(dot->getDebugBaud());
Mike Fiore 9:ff62b20f7000 62 serial->baud(dot->getBaud());
Mike Fiore 9:ff62b20f7000 63
Mike Fiore 14:f9a77400b622 64 CommandTerminal term(*serial);
Mike Fiore 14:f9a77400b622 65 CommandTerminal::_dot = dot;
jenkins@jenkinsdm1 22:a13ac7df92c0 66
Jason Reiss 23:4f0a981c0349 67 Fota::getInstance(dot);
jenkins@jenkinsdm1 18:63f098f042b2 68
Mike Fiore 14:f9a77400b622 69 term.init();
Mike Fiore 9:ff62b20f7000 70
Mike Fiore 9:ff62b20f7000 71 term.start();
Mike Fiore 9:ff62b20f7000 72 }
Mike Fiore 14:f9a77400b622 73
Mike Fiore 14:f9a77400b622 74 #endif // UNIT_TEST
Jason Reiss 23:4f0a981c0349 75 #endif