Merge pull request #589 from ianmcorvidae/nodeless-startup

Allow a faster nodedb-less startup on 2.3.11+ with `--no-nodes`

Author: ianmcorvidae

meshtastic/__init__.py

@@ -117,6 +117,9 @@ def onConnection(interface, topic=pub.AUTO_TOPIC): # called when we (re)connect
    format is Mmmss (where M is 1+the numeric major number. i.e. 20120 means 1.1.20
 """
 
+NODELESS_WANT_CONFIG_ID = 69420
+"""A special thing to pass for want_config_id that instructs nodes to skip sending nodeinfos other than its own."""
+
 publishingThread = DeferredExecution("publishing")
 
 

meshtastic/__main__.py

@@ -1050,11 +1050,11 @@ def common():
                 meshtastic.util.our_exit("BLE scan finished", 0)
                 return
             elif args.ble:
-                client = BLEInterface(args.ble, debugOut=logfile, noProto=args.noproto)
+                client = BLEInterface(args.ble, debugOut=logfile, noProto=args.noproto, noNodes=args.no_nodes)
             elif args.host:
                 try:
                     client = meshtastic.tcp_interface.TCPInterface(
-                        args.host, debugOut=logfile, noProto=args.noproto
+                        args.host, debugOut=logfile, noProto=args.noproto, noNodes=args.no_nodes
                     )
                 except Exception as ex:
                     meshtastic.util.our_exit(
@@ -1063,7 +1063,7 @@ def common():
             else:
                 try:
                     client = meshtastic.serial_interface.SerialInterface(
-                        args.port, debugOut=logfile, noProto=args.noproto
+                        args.port, debugOut=logfile, noProto=args.noproto, noNodes=args.no_nodes
                     )
                 except PermissionError as ex:
                     username = os.getlogin()
@@ -1078,7 +1078,7 @@ def common():
                 if client.devPath is None:
                     try:
                         client = meshtastic.tcp_interface.TCPInterface(
-                            "localhost", debugOut=logfile, noProto=args.noproto
+                            "localhost", debugOut=logfile, noProto=args.noproto, noNodes=args.no_nodes
                         )
                     except Exception as ex:
                         meshtastic.util.our_exit(
@@ -1453,6 +1453,13 @@ def initParser():
         action="store_true",
     )
 
+    group.add_argument(
+        "--no-nodes",
+        help="Request that the node not send node info to the client. "
+        "Will break things that depend on the nodedb, but will speed up startup. Requires 2.3.11+ firmware.",
+        action="store_true",
+    )
+
     group.add_argument(
         "--setalt",
         help="Set device altitude in meters (allows use without GPS), and enable fixed position.",

meshtastic/ble_interface.py

@@ -32,7 +32,7 @@ class BLEState(): # pylint: disable=C0115
         MESH = False
 
 
-    def __init__(self, address: Optional[str], noProto: bool = False, debugOut = None):
+    def __init__(self, address: Optional[str], noProto: bool = False, debugOut = None, noNodes: bool = False):
         self.state = BLEInterface.BLEState()
 
         if not address:
@@ -60,7 +60,7 @@ def __init__(self, address: Optional[str], noProto: bool = False, debugOut = Non
             return
 
         logging.debug("Mesh init starting")
-        MeshInterface.__init__(self, debugOut = debugOut, noProto = noProto)
+        MeshInterface.__init__(self, debugOut = debugOut, noProto = noProto, noNodes = noNodes)
         self._startConfig()
         if not self.noProto:
             self._waitConnected(timeout = 60.0)

meshtastic/mesh_interface.py

@@ -26,6 +26,7 @@
     BROADCAST_ADDR,
     BROADCAST_NUM,
     LOCAL_ADDR,
+    NODELESS_WANT_CONFIG_ID,
     ResponseHandler,
     protocols,
     publishingThread,
@@ -41,7 +42,7 @@
 )
 
 
-class MeshInterface:
+class MeshInterface: # pylint: disable=R0902
     """Interface class for meshtastic devices
 
     Properties:
@@ -57,12 +58,14 @@ def __init__(self, message):
             self.message = message
             super().__init__(self.message)
 
-    def __init__(self, debugOut=None, noProto: bool=False) -> None:
+    def __init__(self, debugOut=None, noProto: bool=False, noNodes: bool=False) -> None:
         """Constructor
 
         Keyword Arguments:
             noProto -- If True, don't try to run our protocol on the
                        link - just be a dumb serial client.
+            noNodes -- If True, instruct the node to not send its nodedb
+                       on startup, just other configuration information.
         """
         self.debugOut = debugOut
         self.nodes: Optional[Dict[str,Dict]] = None  # FIXME
@@ -81,7 +84,8 @@ def __init__(self, debugOut=None, noProto: bool=False) -> None:
         random.seed()  # FIXME, we should not clobber the random seedval here, instead tell user they must call it
         self.currentPacketId: int = random.randint(0, 0xFFFFFFFF)
         self.nodesByNum: Optional[Dict[int, Dict]] = None
-        self.configId: Optional[int] = None
+        self.noNodes: bool = noNodes
+        self.configId: Optional[int] = NODELESS_WANT_CONFIG_ID if noNodes else None
         self.gotResponse: bool = False  # used in gpio read
         self.mask: Optional[int] = None  # used in gpio read and gpio watch
         self.queueStatus: Optional[mesh_pb2.QueueStatus] = None
@@ -713,7 +717,8 @@ def _startConfig(self):
         self._localChannels = [] # empty until we start getting channels pushed from the device (during config)
 
         startConfig = mesh_pb2.ToRadio()
-        self.configId = random.randint(0, 0xFFFFFFFF)
+        if self.configId is None or not self.noNodes:
+            self.configId = random.randint(0, 0xFFFFFFFF)
         startConfig.want_config_id = self.configId
         self._sendToRadio(startConfig)
 

meshtastic/serial_interface.py

@@ -18,7 +18,7 @@
 class SerialInterface(StreamInterface):
     """Interface class for meshtastic devices over a serial link"""
 
-    def __init__(self, devPath: Optional[str]=None, debugOut=None, noProto=False, connectNow=True):
+    def __init__(self, devPath: Optional[str]=None, debugOut=None, noProto=False, connectNow=True, noNodes: bool=False):
         """Constructor, opens a connection to a specified serial port, or if unspecified try to
         find one Meshtastic device by probing
 
@@ -62,7 +62,7 @@ def __init__(self, devPath: Optional[str]=None, debugOut=None, noProto=False, co
         time.sleep(0.1)
 
         StreamInterface.__init__(
-            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow
+            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow, noNodes=noNodes
         )
 
     def close(self):

meshtastic/stream_interface.py

@@ -19,7 +19,7 @@
 class StreamInterface(MeshInterface):
     """Interface class for meshtastic devices over a stream link (serial, TCP, etc)"""
 
-    def __init__(self, debugOut=None, noProto=False, connectNow=True):
+    def __init__(self, debugOut=None, noProto=False, connectNow=True, noNodes=False):
         """Constructor, opens a connection to self.stream
 
         Keyword Arguments:
@@ -43,7 +43,7 @@ def __init__(self, debugOut=None, noProto=False, connectNow=True):
         # FIXME, figure out why daemon=True causes reader thread to exit too early
         self._rxThread = threading.Thread(target=self.__reader, args=(), daemon=True)
 
-        MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto)
+        MeshInterface.__init__(self, debugOut=debugOut, noProto=noProto, noNodes=noNodes)
 
         # Start the reader thread after superclass constructor completes init
         if connectNow:

meshtastic/tcp_interface.py

@@ -17,6 +17,7 @@ def __init__(
         noProto=False,
         connectNow=True,
         portNumber=4403,
+        noNodes:bool=False,
     ):
         """Constructor, opens a connection to a specified IP address/hostname
 
@@ -38,7 +39,7 @@ def __init__(
             self.socket = None
 
         StreamInterface.__init__(
-            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow
+            self, debugOut=debugOut, noProto=noProto, connectNow=connectNow, noNodes=noNodes
         )
 
     def _socket_shutdown(self):