AT command firmware for MultiTech Dot devices.
Fork of mDot_AT_firmware by
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.
Stable library for mDot.
xDot Library
Development library for xDot.
Stable library for xDot.
ATSerialFlowControl.h@26:35c201bc5205, 2019-05-03 (annotated)
- Committer:
- jreiss
- Date:
- Fri May 03 18:49:18 2019 +0000
- Revision:
- 26:35c201bc5205
- Parent:
- 9:ff62b20f7000
Update to Dot 3.2.1 release; Remove AutoSleep command; Update mbed-os to 5.11.1;
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Mike Fiore |
9:ff62b20f7000 | 1 | #ifndef ATSERIALFLOWCONTROL_H |
Mike Fiore |
9:ff62b20f7000 | 2 | #define ATSERIALFLOWCONTROL_H |
Mike Fiore |
9:ff62b20f7000 | 3 | |
Mike Fiore |
9:ff62b20f7000 | 4 | #include "ATSerial.h" |
Mike Fiore |
9:ff62b20f7000 | 5 | |
Mike Fiore |
9:ff62b20f7000 | 6 | namespace mts |
Mike Fiore |
9:ff62b20f7000 | 7 | { |
Mike Fiore |
9:ff62b20f7000 | 8 | |
Mike Fiore |
9:ff62b20f7000 | 9 | /** This class derives from MTSBufferedIO/ATSerial and provides a buffered wrapper to the |
Mike Fiore |
9:ff62b20f7000 | 10 | * standard mbed Serial class along with generic RTS/CTS HW flow control. Since it |
Mike Fiore |
9:ff62b20f7000 | 11 | * depends only on the mbed Serial, DigitalOut and DigitalIn classes for accessing |
Mike Fiore |
9:ff62b20f7000 | 12 | * the serial data, this class is inherently portable accross different mbed platforms |
Mike Fiore |
9:ff62b20f7000 | 13 | * and provides HW flow control even when not natively supported by the processors |
Mike Fiore |
9:ff62b20f7000 | 14 | * serial port. If HW flow control is not needed, use ATSerial instead. It should also |
Mike Fiore |
9:ff62b20f7000 | 15 | * be noted that the RTS/CTS functionality in this class is implemented as a DTE device. |
Mike Fiore |
9:ff62b20f7000 | 16 | */ |
Mike Fiore |
9:ff62b20f7000 | 17 | class ATSerialFlowControl : public ATSerial |
Mike Fiore |
9:ff62b20f7000 | 18 | { |
Mike Fiore |
9:ff62b20f7000 | 19 | public: |
Mike Fiore |
9:ff62b20f7000 | 20 | /** Creates a new ATSerialFlowControl object that can be used to talk to an mbed serial |
Mike Fiore |
9:ff62b20f7000 | 21 | * port through internal SW buffers. Note that this class also adds the ability to use |
Mike Fiore |
9:ff62b20f7000 | 22 | * RTS/CTS HW Flow Conrtol through and standard mbed DigitalIn and DigitalOut pins. |
Mike Fiore |
9:ff62b20f7000 | 23 | * The RTS and CTS functionality assumes this is a DTE device. |
Mike Fiore |
9:ff62b20f7000 | 24 | * |
Mike Fiore |
9:ff62b20f7000 | 25 | * @param TXD the transmit data pin on the desired mbed serial interface. |
Mike Fiore |
9:ff62b20f7000 | 26 | * @param RXD the receive data pin on the desired mbed serial interface. |
Mike Fiore |
9:ff62b20f7000 | 27 | * @param RTS the DigitalOut pin that RTS will be attached to. (DTE) |
Mike Fiore |
9:ff62b20f7000 | 28 | * @param CTS the DigitalIn pin that CTS will be attached to. (DTE) |
Mike Fiore |
9:ff62b20f7000 | 29 | * @param txBufferSize the size in bytes of the internal SW transmit buffer. The |
Mike Fiore |
9:ff62b20f7000 | 30 | * default is 256 bytes. |
Mike Fiore |
9:ff62b20f7000 | 31 | * @param rxBufferSize the size in bytes of the internal SW receive buffer. The |
Mike Fiore |
9:ff62b20f7000 | 32 | * default is 256 bytes. |
Mike Fiore |
9:ff62b20f7000 | 33 | */ |
Mike Fiore |
9:ff62b20f7000 | 34 | ATSerialFlowControl(PinName TXD, PinName RXD, PinName RTS, PinName CTS, int txBufSize = 256, int rxBufSize = 256); |
Mike Fiore |
9:ff62b20f7000 | 35 | |
Mike Fiore |
9:ff62b20f7000 | 36 | /** Destructs an ATSerialFlowControl object and frees all related resources. |
Mike Fiore |
9:ff62b20f7000 | 37 | */ |
Mike Fiore |
9:ff62b20f7000 | 38 | virtual ~ATSerialFlowControl(); |
Mike Fiore |
9:ff62b20f7000 | 39 | |
Mike Fiore |
9:ff62b20f7000 | 40 | //Overriden from MTSBufferedIO to support flow control correctly |
Mike Fiore |
9:ff62b20f7000 | 41 | virtual void rxClear(); |
Mike Fiore |
9:ff62b20f7000 | 42 | |
Mike Fiore |
9:ff62b20f7000 | 43 | private: |
Mike Fiore |
9:ff62b20f7000 | 44 | void notifyStartSending(); // Used to set cts start signal |
Mike Fiore |
9:ff62b20f7000 | 45 | void notifyStopSending(); // Used to set cts stop signal |
Mike Fiore |
9:ff62b20f7000 | 46 | |
Mike Fiore |
9:ff62b20f7000 | 47 | //This device acts as a DTE |
Mike Fiore |
9:ff62b20f7000 | 48 | bool rxReadyFlag; //Tracks state change for rts signaling |
Mike Fiore |
9:ff62b20f7000 | 49 | DigitalOut rts; // Used to tell DCE to send or not send data |
Mike Fiore |
9:ff62b20f7000 | 50 | DigitalIn cts; // Used to check if DCE is ready for data |
Mike Fiore |
9:ff62b20f7000 | 51 | int highThreshold; // High water mark for setting cts to stop |
Mike Fiore |
9:ff62b20f7000 | 52 | int lowThreshold; // Low water mark for setting cts to start |
Mike Fiore |
9:ff62b20f7000 | 53 | |
Mike Fiore |
9:ff62b20f7000 | 54 | virtual void handleRead(); // Method for handling data to be read |
Mike Fiore |
9:ff62b20f7000 | 55 | virtual void handleWrite(); // Method for handling data to be written |
Mike Fiore |
9:ff62b20f7000 | 56 | }; |
Mike Fiore |
9:ff62b20f7000 | 57 | |
Mike Fiore |
9:ff62b20f7000 | 58 | } |
Mike Fiore |
9:ff62b20f7000 | 59 | |
Mike Fiore |
9:ff62b20f7000 | 60 | #endif /* MTSSERIALFLOWCONTROL */ |