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

main.cpp@27:5fafd3b26ac3, 2020-09-11 (annotated)

Committer:
Jason Reiss
Date:
Fri Sep 11 13:16:33 2020 -0500
Revision:
27:5fafd3b26ac3
Parent:
23:4f0a981c0349
Child:
28:c222ca8383f4
Update to Dot 3.3.6

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 27:5fafd3b26ac3 21 #if defined(DEBUG_MAC) && defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 22 lora::ChannelPlan* plan = new lora::ChannelPlan_US915();
Jason Reiss 27:5fafd3b26ac3 23 mDot* dot = mDot::getInstance(plan);
Jason Reiss 27:5fafd3b26ac3 24 #else
jenkins@jenkinsdm1 16:d5cf2af81a6d 25 #if CHANNEL_PLAN == CP_AS923
Jason Reiss 23:4f0a981c0349 26 lora::ChannelPlan_AS923 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 27 #elif CHANNEL_PLAN == CP_US915
Jason Reiss 23:4f0a981c0349 28 lora::ChannelPlan_US915 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 29 #elif CHANNEL_PLAN == CP_AU915
Jason Reiss 23:4f0a981c0349 30 lora::ChannelPlan_AU915 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 31 #elif CHANNEL_PLAN == CP_EU868
Jason Reiss 23:4f0a981c0349 32 lora::ChannelPlan_EU868 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 33 #elif CHANNEL_PLAN == CP_KR920
Jason Reiss 23:4f0a981c0349 34 lora::ChannelPlan_KR920 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 35 #elif CHANNEL_PLAN == CP_IN865
Jason Reiss 23:4f0a981c0349 36 lora::ChannelPlan_IN865 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 37 #elif CHANNEL_PLAN == CP_AS923_JAPAN
Jason Reiss 23:4f0a981c0349 38 lora::ChannelPlan_AS923_Japan plan;
Jason Reiss 23:4f0a981c0349 39 #elif CHANNEL_PLAN == CP_RU864
Jason Reiss 23:4f0a981c0349 40 lora::ChannelPlan_RU864 plan;
jenkins@jenkinsdm1 16:d5cf2af81a6d 41 #endif
Jason Reiss 23:4f0a981c0349 42 mDot* dot = mDot::getInstance(&plan);
Jason Reiss 27:5fafd3b26ac3 43 #endif //MTS_MDOT_F411RE
jenkins@jenkinsdm1 16:d5cf2af81a6d 44 assert(dot);
Mike Fiore 9:ff62b20f7000 45
Jason Reiss 27:5fafd3b26ac3 46 #if defined(DEBUG_MAC) && defined(TARGET_MTS_MDOT_F411RE)
Jason Reiss 27:5fafd3b26ac3 47 logDebug("Loading default channel plan %02x", dot->getDefaultFrequencyBand());
Jason Reiss 27:5fafd3b26ac3 48 switch (dot->getDefaultFrequencyBand()) {
Jason Reiss 27:5fafd3b26ac3 49 case lora::ChannelPlan::AS923:
Jason Reiss 27:5fafd3b26ac3 50 delete plan;
Jason Reiss 27:5fafd3b26ac3 51 plan = new lora::ChannelPlan_AS923();
Jason Reiss 27:5fafd3b26ac3 52 break;
Jason Reiss 27:5fafd3b26ac3 53
Jason Reiss 27:5fafd3b26ac3 54 case lora::ChannelPlan::US915_OLD:
Jason Reiss 27:5fafd3b26ac3 55 delete plan;
Jason Reiss 27:5fafd3b26ac3 56 plan = new lora::ChannelPlan_US915();
Jason Reiss 27:5fafd3b26ac3 57 break;
Jason Reiss 27:5fafd3b26ac3 58
Jason Reiss 27:5fafd3b26ac3 59 case lora::ChannelPlan::AU915_OLD:
Jason Reiss 27:5fafd3b26ac3 60 delete plan;
Jason Reiss 27:5fafd3b26ac3 61 plan = new lora::ChannelPlan_AU915();
Jason Reiss 27:5fafd3b26ac3 62 break;
Jason Reiss 27:5fafd3b26ac3 63
Jason Reiss 27:5fafd3b26ac3 64 case lora::ChannelPlan::EU868_OLD:
Jason Reiss 27:5fafd3b26ac3 65 delete plan;
Jason Reiss 27:5fafd3b26ac3 66 plan = new lora::ChannelPlan_EU868();
Jason Reiss 27:5fafd3b26ac3 67 break;
Jason Reiss 27:5fafd3b26ac3 68
Jason Reiss 27:5fafd3b26ac3 69 case lora::ChannelPlan::KR920:
Jason Reiss 27:5fafd3b26ac3 70 delete plan;
Jason Reiss 27:5fafd3b26ac3 71 plan = new lora::ChannelPlan_KR920();
Jason Reiss 27:5fafd3b26ac3 72 break;
Jason Reiss 27:5fafd3b26ac3 73
Jason Reiss 27:5fafd3b26ac3 74 case lora::ChannelPlan::AS923_JAPAN:
Jason Reiss 27:5fafd3b26ac3 75 delete plan;
Jason Reiss 27:5fafd3b26ac3 76 plan = new lora::ChannelPlan_AS923_Japan();
Jason Reiss 27:5fafd3b26ac3 77 break;
Jason Reiss 27:5fafd3b26ac3 78
Jason Reiss 27:5fafd3b26ac3 79 case lora::ChannelPlan::IN865:
Jason Reiss 27:5fafd3b26ac3 80 delete plan;
Jason Reiss 27:5fafd3b26ac3 81 plan = new lora::ChannelPlan_IN865();
Jason Reiss 27:5fafd3b26ac3 82 break;
Jason Reiss 27:5fafd3b26ac3 83
Jason Reiss 27:5fafd3b26ac3 84 case lora::ChannelPlan::RU864:
Jason Reiss 27:5fafd3b26ac3 85 delete plan;
Jason Reiss 27:5fafd3b26ac3 86 plan = new lora::ChannelPlan_RU864();
Jason Reiss 27:5fafd3b26ac3 87 break;
Jason Reiss 27:5fafd3b26ac3 88
Jason Reiss 27:5fafd3b26ac3 89 default:
Jason Reiss 27:5fafd3b26ac3 90 logInfo("Default channel plan not valid Defaulting US915");
Jason Reiss 27:5fafd3b26ac3 91 delete plan;
Jason Reiss 27:5fafd3b26ac3 92 plan = new lora::ChannelPlan_US915();
Jason Reiss 27:5fafd3b26ac3 93 break;
Jason Reiss 27:5fafd3b26ac3 94 }
Jason Reiss 27:5fafd3b26ac3 95 dot->setChannelPlan(plan);
Jason Reiss 27:5fafd3b26ac3 96 #endif
Mike Fiore 9:ff62b20f7000 97 // Seed the RNG
Mike Fiore 9:ff62b20f7000 98 srand(dot->getRadioRandom());
Mike Fiore 9:ff62b20f7000 99
Mike Fiore 9:ff62b20f7000 100 mts::ATSerial* serial;
Mike Fiore 9:ff62b20f7000 101
Mike Fiore 9:ff62b20f7000 102 if (dot->getFlowControl())
Mike Fiore 14:f9a77400b622 103 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 9:ff62b20f7000 104 serial = new mts::ATSerialFlowControl(XBEE_DOUT, XBEE_DIN, XBEE_RTS, XBEE_CTS, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 105 #else
Mike Fiore 14:f9a77400b622 106 serial = new mts::ATSerialFlowControl(UART1_TX, UART1_RX, UART1_RTS, UART1_CTS, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 107 #endif
Mike Fiore 9:ff62b20f7000 108 else
Mike Fiore 14:f9a77400b622 109 #if defined(TARGET_MTS_MDOT_F411RE)
Mike Fiore 9:ff62b20f7000 110 serial = new mts::ATSerial(XBEE_DOUT, XBEE_DIN, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 111 #else
Mike Fiore 14:f9a77400b622 112 serial = new mts::ATSerial(UART1_TX, UART1_RX, SERIAL_BUFFER_SIZE, SERIAL_BUFFER_SIZE);
Mike Fiore 14:f9a77400b622 113 #endif
Mike Fiore 9:ff62b20f7000 114
jenkins@jenkinsdm1 18:63f098f042b2 115 debug_port.baud(dot->getDebugBaud());
Mike Fiore 9:ff62b20f7000 116 serial->baud(dot->getBaud());
Mike Fiore 9:ff62b20f7000 117
Mike Fiore 14:f9a77400b622 118 CommandTerminal term(*serial);
Mike Fiore 14:f9a77400b622 119 CommandTerminal::_dot = dot;
jenkins@jenkinsdm1 22:a13ac7df92c0 120
Jason Reiss 23:4f0a981c0349 121 Fota::getInstance(dot);
jenkins@jenkinsdm1 18:63f098f042b2 122
Mike Fiore 14:f9a77400b622 123 term.init();
Mike Fiore 9:ff62b20f7000 124
Mike Fiore 9:ff62b20f7000 125 term.start();
Mike Fiore 9:ff62b20f7000 126 }
Mike Fiore 14:f9a77400b622 127
Mike Fiore 14:f9a77400b622 128 #endif // UNIT_TEST
Jason Reiss 23:4f0a981c0349 129 #endif