1.2.36

Fix the text for --subnet in the help text

.vscode/launch.json

@@ -93,5 +93,13 @@
       "justMyCode": true,
       "args": ["--debug", "--sendtext", "pytest"]
     }
+    {
+      "name": "meshtastic showNodes",
+      "type": "python",
+      "request": "launch",
+      "module": "meshtastic",
+      "justMyCode": true,
+      "args": ["--debug", "--nodes"]
+    }
   ]
 }

docs/meshtastic/index.html

@@ -155,6 +155,8 @@ import base64
 import platform
 import socket
 import timeago
+import os
+import stat
 from . import mesh_pb2, portnums_pb2, apponly_pb2, admin_pb2, environmental_measurement_pb2, remote_hardware_pb2, channel_pb2, radioconfig_pb2, util
 from .util import fixme, catchAndIgnore, stripnl, DeferredExecution, Timeout
 from .node import Node
@@ -1010,18 +1012,40 @@ class SerialInterface(StreamInterface):
 
         # rts=False Needed to prevent TBEAMs resetting on OSX, because rts is connected to reset
         self.stream.port = devPath
-        # OS-X/Windows seems to have a bug in its serial driver.  It ignores that we asked for no RTSCTS
-        # control and will always drive RTS either high or low (rather than letting the CP102 leave
-        # it as an open-collector floating pin).  Since it is going to drive it anyways we want to make
-        # sure it is driven low, so that the TBEAM won't reset
-        # Linux does this properly, so don't apply this hack (because it makes the reset button not work)
-        if platform.system() != 'Linux':
+        
+        # HACK: If the platform driving the serial port is unable to leave the RTS pin in high-impedance
+        # mode, set RTS to false so that the device platform won't be reset spuriously.
+        # Linux does this properly, so don't apply this hack on Linux (because it makes the reset button not work).
+        if self._hostPlatformAlwaysDrivesUartRts():
             self.stream.rts = False
         self.stream.open()
 
         StreamInterface.__init__(
             self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
-
+    
+    """true if platform driving the serial port is Windows Subsystem for Linux 1."""
+    def _isWsl1(self):
+        # WSL1 identifies itself as Linux, but has a special char device at /dev/lxss for use with session control, 
+        # e.g. /init.  We should treat WSL1 as Windows for the RTS-driving hack because the underlying platfrom 
+        # serial driver for the CP21xx still exhibits the buggy behavior.
+        # WSL2 is not covered here, as it does not (as of 2021-May-25) support the appropriate functionality to 
+        # share or pass-through serial ports.
+        try:
+            # Claims to be Linux, but has /dev/lxss; must be WSL 1
+            return platform.system() == 'Linux' and stat.S_ISCHR(os.stat('/dev/lxss').st_mode);
+        except:
+            # Couldn't stat /dev/lxss special device; not WSL1
+            return False;
+    
+    def _hostPlatformAlwaysDrivesUartRts(self):
+        # OS-X/Windows seems to have a bug in its CP21xx serial drivers.  It ignores that we asked for no RTSCTS
+        # control and will always drive RTS either high or low (rather than letting the CP102 leave
+        # it as an open-collector floating pin).
+        # TODO: When WSL2 supports USB passthrough, this will get messier.  If/when WSL2 gets virtual serial 
+        # ports that "share" the Windows serial port (and thus the Windows drivers), this code will need to be 
+        # updated to reflect that as well -- or if T-Beams get made with an alternate USB to UART bridge that has
+        # a less buggy driver.
+        return platform.system() != 'Linux' or self._isWsl1();
 
 class TCPInterface(StreamInterface):
     """Interface class for meshtastic devices over a TCP link"""
@@ -1082,6 +1106,7 @@ def _onTextReceive(iface, asDict):
         asDict["decoded"]["text"] = asBytes.decode("utf-8")
     except Exception as ex:
         logging.error(f"Malformatted utf8 in text message: {ex}")
+    _receiveInfoUpdate(iface, asDict)
 
 
 def _onPositionReceive(iface, asDict):
@@ -1101,6 +1126,14 @@ def _onNodeInfoReceive(iface, asDict):
     n["user"] = p
     # We now have a node ID, make sure it is uptodate in that table
     iface.nodes[p["id"]] = n
+    _receiveInfoUpdate(iface, asDict)
+
+
+def _receiveInfoUpdate(iface, asDict):
+    iface._getOrCreateByNum(asDict["from"])["lastReceived"] = asDict
+    iface._getOrCreateByNum(asDict["from"])["lastHeard"] = asDict.get("rxTime")
+    iface._getOrCreateByNum(asDict["from"])["snr"] = asDict.get("rxSnr")
+    iface._getOrCreateByNum(asDict["from"])["hopLimit"] = asDict.get("hopLimit")
 
 
 """Well known message payloads can register decoders for automatic protobuf parsing"""
@@ -2337,17 +2370,40 @@ debugOut {stream} – If a stream is provided, any debug serial output from
 
         # rts=False Needed to prevent TBEAMs resetting on OSX, because rts is connected to reset
         self.stream.port = devPath
-        # OS-X/Windows seems to have a bug in its serial driver.  It ignores that we asked for no RTSCTS
-        # control and will always drive RTS either high or low (rather than letting the CP102 leave
-        # it as an open-collector floating pin).  Since it is going to drive it anyways we want to make
-        # sure it is driven low, so that the TBEAM won't reset
-        # Linux does this properly, so don't apply this hack (because it makes the reset button not work)
-        if platform.system() != 'Linux':
+        
+        # HACK: If the platform driving the serial port is unable to leave the RTS pin in high-impedance
+        # mode, set RTS to false so that the device platform won't be reset spuriously.
+        # Linux does this properly, so don't apply this hack on Linux (because it makes the reset button not work).
+        if self._hostPlatformAlwaysDrivesUartRts():
             self.stream.rts = False
         self.stream.open()
 
         StreamInterface.__init__(
-            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)</code></pre>
+            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
+    
+    &#34;&#34;&#34;true if platform driving the serial port is Windows Subsystem for Linux 1.&#34;&#34;&#34;
+    def _isWsl1(self):
+        # WSL1 identifies itself as Linux, but has a special char device at /dev/lxss for use with session control, 
+        # e.g. /init.  We should treat WSL1 as Windows for the RTS-driving hack because the underlying platfrom 
+        # serial driver for the CP21xx still exhibits the buggy behavior.
+        # WSL2 is not covered here, as it does not (as of 2021-May-25) support the appropriate functionality to 
+        # share or pass-through serial ports.
+        try:
+            # Claims to be Linux, but has /dev/lxss; must be WSL 1
+            return platform.system() == &#39;Linux&#39; and stat.S_ISCHR(os.stat(&#39;/dev/lxss&#39;).st_mode);
+        except:
+            # Couldn&#39;t stat /dev/lxss special device; not WSL1
+            return False;
+    
+    def _hostPlatformAlwaysDrivesUartRts(self):
+        # OS-X/Windows seems to have a bug in its CP21xx serial drivers.  It ignores that we asked for no RTSCTS
+        # control and will always drive RTS either high or low (rather than letting the CP102 leave
+        # it as an open-collector floating pin).
+        # TODO: When WSL2 supports USB passthrough, this will get messier.  If/when WSL2 gets virtual serial 
+        # ports that &#34;share&#34; the Windows serial port (and thus the Windows drivers), this code will need to be 
+        # updated to reflect that as well -- or if T-Beams get made with an alternate USB to UART bridge that has
+        # a less buggy driver.
+        return platform.system() != &#39;Linux&#39; or self._isWsl1();</code></pre>
 </details>
 <h3>Ancestors</h3>
 <ul class="hlist">

meshtastic/__init__.py

@@ -68,6 +68,8 @@ import base64
 import platform
 import socket
 import timeago
+import os
+import stat
 from . import mesh_pb2, portnums_pb2, apponly_pb2, admin_pb2, environmental_measurement_pb2, remote_hardware_pb2, channel_pb2, radioconfig_pb2, util
 from .util import fixme, catchAndIgnore, stripnl, DeferredExecution, Timeout
 from .node import Node
@@ -923,18 +925,40 @@ class SerialInterface(StreamInterface):
 
         # rts=False Needed to prevent TBEAMs resetting on OSX, because rts is connected to reset
         self.stream.port = devPath
-        # OS-X/Windows seems to have a bug in its serial driver.  It ignores that we asked for no RTSCTS
-        # control and will always drive RTS either high or low (rather than letting the CP102 leave
-        # it as an open-collector floating pin).  Since it is going to drive it anyways we want to make
-        # sure it is driven low, so that the TBEAM won't reset
-        # Linux does this properly, so don't apply this hack (because it makes the reset button not work)
-        if platform.system() != 'Linux':
+        
+        # HACK: If the platform driving the serial port is unable to leave the RTS pin in high-impedance
+        # mode, set RTS to false so that the device platform won't be reset spuriously.
+        # Linux does this properly, so don't apply this hack on Linux (because it makes the reset button not work).
+        if self._hostPlatformAlwaysDrivesUartRts():
             self.stream.rts = False
         self.stream.open()
 
         StreamInterface.__init__(
             self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
-
+    
+    """true if platform driving the serial port is Windows Subsystem for Linux 1."""
+    def _isWsl1(self):
+        # WSL1 identifies itself as Linux, but has a special char device at /dev/lxss for use with session control, 
+        # e.g. /init.  We should treat WSL1 as Windows for the RTS-driving hack because the underlying platfrom 
+        # serial driver for the CP21xx still exhibits the buggy behavior.
+        # WSL2 is not covered here, as it does not (as of 2021-May-25) support the appropriate functionality to 
+        # share or pass-through serial ports.
+        try:
+            # Claims to be Linux, but has /dev/lxss; must be WSL 1
+            return platform.system() == 'Linux' and stat.S_ISCHR(os.stat('/dev/lxss').st_mode);
+        except:
+            # Couldn't stat /dev/lxss special device; not WSL1
+            return False;
+    
+    def _hostPlatformAlwaysDrivesUartRts(self):
+        # OS-X/Windows seems to have a bug in its CP21xx serial drivers.  It ignores that we asked for no RTSCTS
+        # control and will always drive RTS either high or low (rather than letting the CP102 leave
+        # it as an open-collector floating pin).
+        # TODO: When WSL2 supports USB passthrough, this will get messier.  If/when WSL2 gets virtual serial 
+        # ports that "share" the Windows serial port (and thus the Windows drivers), this code will need to be 
+        # updated to reflect that as well -- or if T-Beams get made with an alternate USB to UART bridge that has
+        # a less buggy driver.
+        return platform.system() != 'Linux' or self._isWsl1();
 
 class TCPInterface(StreamInterface):
     """Interface class for meshtastic devices over a TCP link"""
@@ -995,6 +1019,7 @@ def _onTextReceive(iface, asDict):
         asDict["decoded"]["text"] = asBytes.decode("utf-8")
     except Exception as ex:
         logging.error(f"Malformatted utf8 in text message: {ex}")
+    _receiveInfoUpdate(iface, asDict)
 
 
 def _onPositionReceive(iface, asDict):
@@ -1014,6 +1039,14 @@ def _onNodeInfoReceive(iface, asDict):
     n["user"] = p
     # We now have a node ID, make sure it is uptodate in that table
     iface.nodes[p["id"]] = n
+    _receiveInfoUpdate(iface, asDict)
+
+
+def _receiveInfoUpdate(iface, asDict):
+    iface._getOrCreateByNum(asDict["from"])["lastReceived"] = asDict
+    iface._getOrCreateByNum(asDict["from"])["lastHeard"] = asDict.get("rxTime")
+    iface._getOrCreateByNum(asDict["from"])["snr"] = asDict.get("rxSnr")
+    iface._getOrCreateByNum(asDict["from"])["hopLimit"] = asDict.get("hopLimit")
 
 
 """Well known message payloads can register decoders for automatic protobuf parsing"""

meshtastic/__main__.py

@@ -64,7 +64,7 @@ trueTerms = {"t", "true", "yes"}
 falseTerms = {"f", "false", "no"}
 
 
-def genPSKS256():
+def genPSK256():
     return os.urandom(32)
 
 
@@ -118,6 +118,32 @@ never = 0xffffffff
 oneday = 24 * 60 * 60
 
 
+def getPref(attributes, name):
+    """Get a channel or preferences value"""
+
+    objDesc = attributes.DESCRIPTOR
+    field = objDesc.fields_by_name.get(name)
+    if not field:
+        print(f"{attributes.__class__.__name__} doesn't have an attribute called {name}, so you can not get it.")
+        print(f"Choices are:")
+        for f in objDesc.fields:
+            print(f"  {f.name}")
+        return
+
+    # okay - try to read the value
+    try:
+        try:
+            val = getattr(attributes, name)
+        except TypeError as ex:
+            # The getter didn't like our arg type guess try again as a string
+            val = getattr(attributes, name)
+
+        # succeeded!
+        print(f"{name}: {str(val)}")
+    except Exception as ex:
+        print(f"Can't get {name} due to {ex}")
+
+
 def setPref(attributes, name, valStr):
     """Set a channel or preferences value"""
 
@@ -281,6 +307,7 @@ def onConnected(interface):
             print("Writing modified preferences to device")
             getNode().writeConfig()
 
+
         if args.seturl:
             closeNow = True
             getNode().setURL(args.seturl)
@@ -372,6 +399,17 @@ def onConnected(interface):
             closeNow = True  # FIXME, for now we leave the link up while talking to remote nodes
             print("")
 
+        if args.get:
+            closeNow = True
+            prefs = getNode().radioConfig.preferences
+
+            # Handle the int/float/bool arguments
+            for pref in args.get:
+                getPref(
+                    prefs, pref[0])
+
+            print("Completed getting preferences")
+
         if args.nodes:
             closeNow = True
             interface.showNodes()
@@ -507,6 +545,9 @@ def initParser():
     parser.add_argument("--qr", help="Display the QR code that corresponds to the current channel",
                         action="store_true")
 
+    parser.add_argument(
+        "--get", help="Get a preferences field", nargs=1, action='append')
+
     parser.add_argument(
         "--set", help="Set a preferences field", nargs=2, action='append')
 
@@ -606,7 +647,7 @@ def initParser():
         parser.add_argument('--tunnel',
                             action='store_true', help="Create a TUN tunnel device for forwarding IP packets over the mesh")
         parser.add_argument(
-            "--subnet", dest='tunnel_net', help="Read from a GPIO mask", default=None)
+            "--subnet", dest='tunnel_net', help="Sets the local-end subnet address for the TUN IP bridge", default=None)
 
     parser.set_defaults(deprecated=None)
 

setup.py

@@ -12,7 +12,7 @@ with open("README.md", "r") as fh:
 # This call to setup() does all the work
 setup(
     name="meshtastic",
-    version="1.2.34",
+    version="1.2.36",
     description="Python API & client shell for talking to Meshtastic devices",
     long_description=long_description,
     long_description_content_type="text/markdown",