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

main.cpp@16:d5cf2af81a6d, 2017-06-19 (annotated)

Committer:
jenkins@jenkinsdm1
Date:
Mon Jun 19 14:33:21 2017 -0500
Revision:
16:d5cf2af81a6d
Parent:
14:f9a77400b622
Child:
18:63f098f042b2
mdot-firmware revision 3.0.0-rc7

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
Mike Fiore 14:f9a77400b622 10 Serial debug(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
Mike Fiore 9:ff62b20f7000 17
Mike Fiore 9:ff62b20f7000 18 int main()
Mike Fiore 9:ff62b20f7000 19 {
Mike Fiore 9:ff62b20f7000 20 debug.baud(115200);
Mike Fiore 9:ff62b20f7000 21
jenkins@jenkinsdm1 16:d5cf2af81a6d 22 #if CHANNEL_PLAN == CP_AS923
jenkins@jenkinsdm1 16:d5cf2af81a6d 23 lora::ChannelPlan* plan = new lora::ChannelPlan_AS923();
jenkins@jenkinsdm1 16:d5cf2af81a6d 24 #elif CHANNEL_PLAN == CP_US915
jenkins@jenkinsdm1 16:d5cf2af81a6d 25 lora::ChannelPlan* plan = new lora::ChannelPlan_US915();
jenkins@jenkinsdm1 16:d5cf2af81a6d 26 #elif CHANNEL_PLAN == CP_AU915
jenkins@jenkinsdm1 16:d5cf2af81a6d 27 lora::ChannelPlan* plan = new lora::ChannelPlan_AU915();
jenkins@jenkinsdm1 16:d5cf2af81a6d 28 #elif CHANNEL_PLAN == CP_EU868
jenkins@jenkinsdm1 16:d5cf2af81a6d 29 lora::ChannelPlan* plan = new lora::ChannelPlan_EU868();
jenkins@jenkinsdm1 16:d5cf2af81a6d 30 #elif CHANNEL_PLAN == CP_KR920
jenkins@jenkinsdm1 16:d5cf2af81a6d 31 lora::ChannelPlan* plan = new lora::ChannelPlan_KR920();
jenkins@jenkinsdm1 16:d5cf2af81a6d 32 #elif CHANNEL_PLAN == CP_IN865
jenkins@jenkinsdm1 16:d5cf2af81a6d 33 lora::ChannelPlan* plan = new lora::ChannelPlan_IN865();
jenkins@jenkinsdm1 16:d5cf2af81a6d 34 #elif CHANNEL_PLAN == CP_AS923_JAPAN
jenkins@jenkinsdm1 16:d5cf2af81a6d 35 lora::ChannelPlan* plan = new lora::ChannelPlan_AS923_Japan();
jenkins@jenkinsdm1 16:d5cf2af81a6d 36 #endif
jenkins@jenkinsdm1 16:d5cf2af81a6d 37 assert(plan);
jenkins@jenkinsdm1 16:d5cf2af81a6d 38
jenkins@jenkinsdm1 16:d5cf2af81a6d 39 mDot* dot = mDot::getInstance(plan);
jenkins@jenkinsdm1 16:d5cf2af81a6d 40 assert(dot);
Mike Fiore 9:ff62b20f7000 41
Mike Fiore 9:ff62b20f7000 42 // Seed the RNG
Mike Fiore 9:ff62b20f7000 43 srand(dot->getRadioRandom());
Mike Fiore 9:ff62b20f7000 44
Mike Fiore 9:ff62b20f7000 45 mts::ATSerial* serial;
Mike Fiore 9:ff62b20f7000 46
Mike Fiore 9:ff62b20f7000 47 if (dot->getFlowControl())
Mike Fiore 14:f9a77400b622 48 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 9:ff62b20f7000 49 serial = new mts::ATSerialFlowControl(XBEE_DOUT, XBEE_DIN, XBEE_RTS, XBEE_CTS, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 50 #else
Mike Fiore 14:f9a77400b622 51 serial = new mts::ATSerialFlowControl(UART1_TX, UART1_RX, UART1_RTS, UART1_CTS, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 52 #endif
Mike Fiore 9:ff62b20f7000 53 else
Mike Fiore 14:f9a77400b622 54 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 9:ff62b20f7000 55 serial = new mts::ATSerial(XBEE_DOUT, XBEE_DIN, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 56 #else
Mike Fiore 14:f9a77400b622 57 serial = new mts::ATSerial(UART1_TX, UART1_RX, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 58 #endif
Mike Fiore 9:ff62b20f7000 59
Mike Fiore 9:ff62b20f7000 60 debug.baud(dot->getDebugBaud());
Mike Fiore 9:ff62b20f7000 61 serial->baud(dot->getBaud());
Mike Fiore 9:ff62b20f7000 62
Mike Fiore 14:f9a77400b622 63 CommandTerminal term(*serial);
Mike Fiore 14:f9a77400b622 64 CommandTerminal::_dot = dot;
Mike Fiore 14:f9a77400b622 65
Mike Fiore 14:f9a77400b622 66 term.init();
Mike Fiore 9:ff62b20f7000 67
Mike Fiore 9:ff62b20f7000 68 term.start();
Mike Fiore 9:ff62b20f7000 69 }
Mike Fiore 14:f9a77400b622 70
Mike Fiore 14:f9a77400b622 71 #endif // UNIT_TEST
Mike Fiore 14:f9a77400b622 72