Dot-AT-Firmware - AT command firmware for MultiTech Dot devices.

MultiTech » Code » 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

Diff: ATSerial.h

Revision:: 36:b586cd6e91f3
Parent:: 28:c222ca8383f4

--- a/ATSerial.h	Fri Aug 12 11:08:59 2022 -0500
+++ b/ATSerial.h	Fri Sep 08 08:34:24 2023 -0500
@@ -3,10 +3,15 @@
 
 #include "mbed.h"
 
+#define AT_SERIAL_RX_BUFFER_SIZE   512
+#define AT_SERIAL_TX_BUFFER_SIZE   256
+
+#define AT_SERIAL_DEFAULT_BAUD_RATE     115200
+
 namespace mts
 {
 
-/** This class wraps provides a buffered wrapper to the mbed::UnbufferedSerial
+/** This class provides a buffered wrapper to the mbed::UnbufferedSerial
  * class.  Looks for an escape sequence within received byte stream.
  */
 class ATSerial : private mbed::NonCopyable<ATSerial>
@@ -22,7 +27,7 @@
     * @param baud The initial baudrate
     */
     ATSerial(PinName txd, PinName rxd, PinName rts = NC, PinName cts = NC,
-        int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
+        int baud = AT_SERIAL_DEFAULT_BAUD_RATE);
 
     /** Destructs an ATSerial object and frees all related resources, including
     * internal buffers.
@@ -44,6 +49,10 @@
     */
     void format(int bits=8, mbed::SerialBase::Parity parity=mbed::SerialBase::None, int stop_bits=1);
 
+    void flowControl(bool enable);
+
+    bool flowControl();
+
     /** Check if bytes are available to read.
      * @return True if receive buffer is not empty.
      */
@@ -75,7 +84,7 @@
     void clearEscaped();
 
     /** Read a byte from receive buffer
-     * @param[out] c Storage for read character 
+     * @param[out] c Storage for read character
      * @return True if a character was read
      */
     bool read(char& c);
@@ -105,9 +114,10 @@
     mbed::UnbufferedSerial _serial; // Using unbuffered serial so reads can be done in event handler
 
     // Receive buffer
-    mbed::CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE> _rxbuf;
+    mbed::CircularBuffer<char, AT_SERIAL_RX_BUFFER_SIZE>* _rxbuf;
     // Transmit buffer
-    mbed::CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE> _txbuf;
+    mbed::CircularBuffer<char, AT_SERIAL_TX_BUFFER_SIZE>* _txbuf;
+
     bool _tx_irq_enabled;   // Flag indicating transmit IRQ is enabled
 
     Timer _timer;           // Inter-byte receive timer