MultiTech / Mbed OS Dot-AT-Firmware

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

Revision:
34:3b696c2b1e4b
Parent:
28:c222ca8383f4
--- a/CommandTerminal/CmdWakePin.cpp	Fri Jan 29 13:04:32 2021 -0600
+++ b/CommandTerminal/CmdWakePin.cpp	Thu Nov 11 13:52:20 2021 -0600
@@ -2,7 +2,7 @@
 
 CmdWakePin::CmdWakePin() :
 #if MTS_CMD_TERM_VERBOSE
-    Command("Wake Pin", "AT+WP", "Wakeup DIO pin of sleep mode (1-8) (default: DI8, 1:DIN), deep-sleep uses DIO7", "(1-8)")
+    Command("Wake Pin", "AT+WP", "Wakeup DIO pin of sleep mode (1-8) (default: DI8, 1:DIN), deep-sleep uses DIO7", "(1-8),(0:NOPULL,1:PULLUP,2:PULLDOWN),(0:ANY,1:RISE,2:FALL)")
 #else
     Command("AT+WP")
 #endif
@@ -12,12 +12,72 @@
 
 uint32_t CmdWakePin::action(const std::vector<std::string>& args) {
     if (args.size() == 1) {
-        CommandTerminal::Serial()->writef("%s\r\n", mDot::pinName2Str(CommandTerminal::Dot()->getWakePin()).c_str());
-    } else if (args.size() == 2) {
+        static char modes[][10] = {
+            "NOPULL", "PULLUP", "PULLDOWN", "OTHER"
+        };
+        static char triggers[][5] = {
+            "ANY", "RISE", "FALL", "?"
+        };
+
+        int mode;
+        PinMode pm = CommandTerminal::Dot()->getWakePinMode();
+        switch (pm) {
+        case PullNone:
+            mode = 0;
+            break;
+        case PullUp:
+            mode = 1;
+            break;
+        case PullDown:
+            mode = 2;
+            break;
+        default:
+            mode = 3;
+            break;
+        }
+
+        int trigger = CommandTerminal::Dot()->getWakePinTrigger();
+        if (trigger > 2) {
+            trigger = 3;
+        }
+       
+        CommandTerminal::Serial()->writef("%s,%s,%s\r\n", 
+            mDot::pinName2Str(CommandTerminal::Dot()->getWakePin()).c_str(), 
+            modes[mode],
+            triggers[trigger]);
+        
+    } else if (args.size() >= 2) {
         int pin;
         sscanf(args[1].c_str(), "%d", &pin);
 
         CommandTerminal::Dot()->setWakePin(mDot::pinNum2Name(pin));
+
+        if (args.size() > 2) {
+            int mode;
+            sscanf(args[2].c_str(), "%d", &mode);
+            PinMode pm;
+            switch (mode) {
+            case 0:
+                pm = PullNone;
+                break;
+            case 1:
+                pm = PullUp;
+                break;
+            case 2:
+                pm = PullDown;
+                break;
+            default:
+                pm = PullDefault;
+                break;
+            }
+            CommandTerminal::Dot()->setWakePinMode(pm);
+        }
+
+        if (args.size() > 3) {
+            int trigger;
+            sscanf(args[3].c_str(), "%d", &trigger);
+            CommandTerminal::Dot()->setWakePinTrigger(trigger);
+        }
     }
 
     return 0;
@@ -27,7 +87,7 @@
     if (args.size() == 1)
         return true;
 
-    if (args.size() == 2) {
+    if (args.size() >= 2) {
         int pin;
         if (sscanf(args[1].c_str(), "%d", &pin) != 1) {
 #if MTS_CMD_TERM_VERBOSE
@@ -50,6 +110,40 @@
             return false;
         }
 
+        if (args.size() > 2) {
+            int mode;
+            if (sscanf(args[2].c_str(), "%d", &mode) != 1) {
+#if MTS_CMD_TERM_VERBOSE
+                CommandTerminal::setErrorMessage("Invalid argument");
+#endif
+                return false;
+            }
+
+            if (mode < 0 || mode > 2) {
+#if MTS_CMD_TERM_VERBOSE
+                CommandTerminal::setErrorMessage("Invalid pin mode, expects (0-2)");
+#endif
+                return false;
+            }
+        }
+
+        if (args.size() > 3) {
+            int trigger;
+            if (sscanf(args[3].c_str(), "%d", &trigger) != 1) {
+#if MTS_CMD_TERM_VERBOSE
+                CommandTerminal::setErrorMessage("Invalid argument");
+#endif
+                return false;
+            }
+
+            if (trigger < 0 || trigger > 2) {
+#if MTS_CMD_TERM_VERBOSE
+                CommandTerminal::setErrorMessage("Invalid trigger, expects (0-2)");
+#endif
+                return false;
+            }
+        }
+
         return true;
     }