Merge pull request #218 from mkinney/fix_remote_admin_message

mkinney · web-flow · commit 465bafeb3084 · 2022-01-10T16:51:04.000-08:00
refactor code to only call local node when necessary; fix tests
diff --git a/meshtastic/__main__.py b/meshtastic/__main__.py
@@ -18,6 +18,7 @@
 from meshtastic.ble_interface import BLEInterface
 from meshtastic import portnums_pb2, channel_pb2, radioconfig_pb2
 from meshtastic.globals import Globals
+from meshtastic.__init__ import BROADCAST_ADDR
 
 
 def onReceive(packet, interface):
@@ -140,14 +141,6 @@ def onConnected(interface):
         if not args.export_config:
             print("Connected to radio")
 
-        def getNode():
-            """This operation could be expensive, so we try to cache the results"""
-            targetNode = our_globals.get_target_node()
-            if not targetNode:
-                targetNode = interface.getNode(args.destOrLocal)
-                our_globals.set_target_node(targetNode)
-            return targetNode
-
         if args.setlat or args.setlon or args.setalt:
             closeNow = True
 
@@ -179,12 +172,12 @@ def getNode():
         if args.set_owner:
             closeNow = True
             print(f"Setting device owner to {args.set_owner}")
-            getNode().setOwner(args.set_owner)
+            interface.getNode(args.dest).setOwner(args.set_owner)
 
         if args.pos_fields:
             # If --pos-fields invoked with args, set position fields
             closeNow = True
-            prefs = getNode().radioConfig.preferences
+            prefs = interface.getNode(args.dest).radioConfig.preferences
             allFields = 0
 
             try:
@@ -201,12 +194,12 @@ def getNode():
                 print(f"Setting position fields to {allFields}")
                 setPref(prefs, 'position_flags', ('%d' % allFields))
                 print("Writing modified preferences to device")
-                getNode().writeConfig()
+                interface.getNode(args.dest).writeConfig()
 
         elif args.pos_fields is not None:
             # If --pos-fields invoked without args, read and display current value
             closeNow = True
-            prefs = getNode().radioConfig.preferences
+            prefs = interface.getNode(args.dest).radioConfig.preferences
 
             fieldNames = []
             for bit in radioconfig_pb2.PositionFlags.values():
@@ -225,86 +218,85 @@ def getNode():
                 print(sorted(meshtastic.mesh_pb2.Team.keys()))
             else:
                 print(f"Setting team to {meshtastic.mesh_pb2.Team.Name(v_team)}")
-                getNode().setOwner(team=v_team)
+                interface.getNode(args.dest).setOwner(team=v_team)
 
         if args.set_ham:
             closeNow = True
             print(f"Setting Ham ID to {args.set_ham} and turning off encryption")
-            getNode().setOwner(args.set_ham, is_licensed=True)
+            interface.getNode(args.dest).setOwner(args.set_ham, is_licensed=True)
             # Must turn off encryption on primary channel
-            getNode().turnOffEncryptionOnPrimaryChannel()
+            interface.getNode(args.dest).turnOffEncryptionOnPrimaryChannel()
 
         if args.reboot:
             closeNow = True
-            getNode().reboot()
+            interface.getNode(args.dest).reboot()
 
         if args.sendtext:
             closeNow = True
             channelIndex = 0
             if args.ch_index is not None:
                 channelIndex = int(args.ch_index)
-            logging.debug(f'channelIndex:{channelIndex}')
-            logging.debug(f'interface.localNode:{interface.localNode}')
-            logging.debug(f'interface.localNode.channels:{interface.localNode.channels}')
-            our_globals.set_target_node(interface.localNode)
-            ch = getNode().getChannelByChannelIndex(channelIndex)
+            ch = interface.localNode.getChannelByChannelIndex(channelIndex)
             logging.debug(f'ch:{ch}')
             if ch and ch.role != channel_pb2.Channel.Role.DISABLED:
-                print(f"Sending text message {args.sendtext} to {args.destOrAll} on channelIndex:{channelIndex}")
-                interface.sendText(args.sendtext, args.destOrAll, wantAck=True, channelIndex=channelIndex)
+                print(f"Sending text message {args.sendtext} to {args.dest} on channelIndex:{channelIndex}")
+                interface.sendText(args.sendtext, args.dest, wantAck=True, channelIndex=channelIndex)
             else:
                 meshtastic.util.our_exit(f"Warning: {channelIndex} is not a valid channel. Channel must not be DISABLED.")
 
         if args.sendping:
             payload = str.encode("test string")
-            print(f"Sending ping message to {args.destOrAll}")
-            interface.sendData(payload, args.destOrAll, portNum=portnums_pb2.PortNum.REPLY_APP,
+            print(f"Sending ping message to {args.dest}")
+            interface.sendData(payload, args.dest, portNum=portnums_pb2.PortNum.REPLY_APP,
                                wantAck=True, wantResponse=True)
 
         if args.gpio_wrb or args.gpio_rd or args.gpio_watch:
-            rhc = remote_hardware.RemoteHardwareClient(interface)
-
-            if args.gpio_wrb:
-                bitmask = 0
-                bitval = 0
-                for wrpair in (args.gpio_wrb or []):
-                    bitmask |= 1 << int(wrpair[0])
-                    bitval |= int(wrpair[1]) << int(wrpair[0])
-                print(f"Writing GPIO mask 0x{bitmask:x} with value 0x{bitval:x} to {args.dest}")
-                rhc.writeGPIOs(args.dest, bitmask, bitval)
-                closeNow = True
-
-            if args.gpio_rd:
-                bitmask = int(args.gpio_rd, 16)
-                print(f"Reading GPIO mask 0x{bitmask:x} from {args.dest}")
-                interface.mask = bitmask
-                rhc.readGPIOs(args.dest, bitmask, None)
-                if not interface.noProto:
-                    # wait up to X seconds for a response
-                    for _ in range(10):
+            if args.dest == BROADCAST_ADDR:
+                meshtastic.util.our_exit("Warning: Must use a destination node ID.")
+            else:
+                rhc = remote_hardware.RemoteHardwareClient(interface)
+
+                if args.gpio_wrb:
+                    bitmask = 0
+                    bitval = 0
+                    for wrpair in (args.gpio_wrb or []):
+                        bitmask |= 1 << int(wrpair[0])
+                        bitval |= int(wrpair[1]) << int(wrpair[0])
+                    print(f"Writing GPIO mask 0x{bitmask:x} with value 0x{bitval:x} to {args.dest}")
+                    rhc.writeGPIOs(args.dest, bitmask, bitval)
+                    closeNow = True
+
+                if args.gpio_rd:
+                    bitmask = int(args.gpio_rd, 16)
+                    print(f"Reading GPIO mask 0x{bitmask:x} from {args.dest}")
+                    interface.mask = bitmask
+                    rhc.readGPIOs(args.dest, bitmask, None)
+                    if not interface.noProto:
+                        # wait up to X seconds for a response
+                        for _ in range(10):
+                            time.sleep(1)
+                            if interface.gotResponse:
+                                break
+                    logging.debug(f'end of gpio_rd')
+
+                if args.gpio_watch:
+                    bitmask = int(args.gpio_watch, 16)
+                    print(f"Watching GPIO mask 0x{bitmask:x} from {args.dest}. Press ctrl-c to exit")
+                    while True:
+                        rhc.watchGPIOs(args.dest, bitmask)
                         time.sleep(1)
-                        if interface.gotResponse:
-                            break
-                logging.debug(f'end of gpio_rd')
-
-            if args.gpio_watch:
-                bitmask = int(args.gpio_watch, 16)
-                print(f"Watching GPIO mask 0x{bitmask:x} from {args.dest}. Press ctrl-c to exit")
-                while True:
-                    rhc.watchGPIOs(args.dest, bitmask)
-                    time.sleep(1)
 
         # handle settings
         if args.set:
             closeNow = True
-            prefs = getNode().radioConfig.preferences
+            prefs = interface.getNode(args.dest).radioConfig.preferences
 
             # Handle the int/float/bool arguments
             for pref in args.set:
                 setPref(prefs, pref[0], pref[1])
 
             print("Writing modified preferences to device")
-            getNode().writeConfig()
+            interface.getNode(args.dest).writeConfig()
 
         if args.configure:
             with open(args.configure[0], encoding='utf8') as file:
@@ -313,11 +305,11 @@ def getNode():
 
                 if 'owner' in configuration:
                     print(f"Setting device owner to {configuration['owner']}")
-                    getNode().setOwner(configuration['owner'])
+                    interface.getNode(args.dest).setOwner(configuration['owner'])
 
                 if 'channel_url' in configuration:
                     print("Setting channel url to", configuration['channel_url'])
-                    getNode().setURL(configuration['channel_url'])
+                    interface.getNode(args.dest).setURL(configuration['channel_url'])
 
                 if 'location' in configuration:
                     alt = 0
@@ -342,11 +334,11 @@ def getNode():
                     interface.localNode.writeConfig()
 
                 if 'user_prefs' in configuration:
-                    prefs = getNode().radioConfig.preferences
+                    prefs = interface.getNode(args.dest).radioConfig.preferences
                     for pref in configuration['user_prefs']:
                         setPref(prefs, pref, str(configuration['user_prefs'][pref]))
                     print("Writing modified preferences to device")
-                    getNode().writeConfig()
+                    interface.getNode(args.dest).writeConfig()
 
         if args.export_config:
             # export the configuration (the opposite of '--configure')
@@ -355,15 +347,15 @@ def getNode():
 
         if args.seturl:
             closeNow = True
-            getNode().setURL(args.seturl)
+            interface.getNode(args.dest).setURL(args.seturl)
 
         # handle changing channels
 
         if args.ch_add:
             closeNow = True
             if len(args.ch_add) > 10:
                 meshtastic.util.our_exit("Warning: Channel name must be shorter. Channel not added.")
-            n = getNode()
+            n = interface.getNode(args.dest)
             ch = n.getChannelByName(args.ch_add)
             if ch:
                 meshtastic.util.our_exit(f"Warning: This node already has a '{args.ch_add}' channel. No changes were made.")
@@ -391,7 +383,7 @@ def getNode():
                     meshtastic.util.our_exit("Warning: Cannot delete primary channel.", 1)
                 else:
                     print(f"Deleting channel {channelIndex}")
-                    ch = getNode().deleteChannel(channelIndex)
+                    ch = interface.getNode(args.dest).deleteChannel(channelIndex)
 
         ch_changes = [args.ch_longslow, args.ch_longfast,
                       args.ch_mediumslow, args.ch_mediumfast,
@@ -407,7 +399,7 @@ def getNode():
                     channelIndex = 0
                 else:
                     meshtastic.util.our_exit("Warning: Need to specify '--ch-index'.", 1)
-            ch = getNode().channels[channelIndex]
+            ch = interface.getNode(args.dest).channels[channelIndex]
 
             if any_primary_channel_changes or args.ch_enable or args.ch_disable:
 
@@ -468,21 +460,22 @@ def setSimpleChannel(modem_config):
                 ch.role = channel_pb2.Channel.Role.DISABLED
 
             print(f"Writing modified channels to device")
-            getNode().writeChannel(channelIndex)
+            interface.getNode(args.dest).writeChannel(channelIndex)
 
         if args.info:
             print("")
-            if not args.dest:  # If we aren't trying to talk to our local node, don't show it
+            # If we aren't trying to talk to our local node, don't show it
+            if args.dest == BROADCAST_ADDR:
                 interface.showInfo()
 
             print("")
-            getNode().showInfo()
+            interface.getNode(args.dest).showInfo()
             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
+            prefs = interface.getNode(args.dest).radioConfig.preferences
 
             # Handle the int/float/bool arguments
             for pref in args.get:
@@ -596,13 +589,8 @@ def common():
             channelIndex = int(args.ch_index)
             our_globals.set_channel_index(channelIndex)
 
-        # Some commands require dest to be set, so we now use destOrAll/destOrLocal for more lenient commands
         if not args.dest:
-            args.destOrAll = "^all"
-            args.destOrLocal = "^local"
-        else:
-            args.destOrAll = args.dest
-            args.destOrLocal = args.dest  # FIXME, temp hack for debugging remove
+            args.dest = BROADCAST_ADDR
 
         if not args.seriallog:
             if args.noproto:
diff --git a/meshtastic/globals.py b/meshtastic/globals.py
@@ -27,7 +27,6 @@ def __init__(self):
             Globals.__instance = self
         self.args = None
         self.parser = None
-        self.target_node = None
         self.channel_index = None
         self.logfile = None
         self.tunnelInstance = None
@@ -36,7 +35,6 @@ def reset(self):
         """Reset all of our globals. If you add a member, add it to this method, too."""
         self.args = None
         self.parser = None
-        self.target_node = None
         self.channel_index = None
         self.logfile = None
         self.tunnelInstance = None
@@ -50,10 +48,6 @@ def set_parser(self, parser):
         """Set the parser"""
         self.parser = parser
 
-    def set_target_node(self, target_node):
-        """Set the target_node"""
-        self.target_node = target_node
-
     def set_channel_index(self, channel_index):
         """Set the channel_index"""
         self.channel_index = channel_index
@@ -75,10 +69,6 @@ def get_parser(self):
         """Get parser"""
         return self.parser
 
-    def get_target_node(self):
-        """Get target_node"""
-        return self.target_node
-
     def get_channel_index(self):
         """Get channel_index"""
         return self.channel_index
diff --git a/meshtastic/mesh_interface.py b/meshtastic/mesh_interface.py
@@ -159,7 +159,7 @@ def getTimeAgo(ts):
 
     def getNode(self, nodeId):
         """Return a node object which contains device settings and channel info"""
-        if nodeId == LOCAL_ADDR:
+        if nodeId in (LOCAL_ADDR, BROADCAST_ADDR):
             return self.localNode
         else:
             n = meshtastic.node.Node(self, nodeId)
diff --git a/meshtastic/node.py b/meshtastic/node.py
@@ -257,6 +257,7 @@ def _requestSettings(self):
         p = admin_pb2.AdminMessage()
         p.get_radio_request = True
 
+        # TODO: should we check that localNode has an 'admin' channel?
         # Show progress message for super slow operations
         if self != self.iface.localNode:
             print("Requesting preferences from remote node.")
diff --git a/meshtastic/serial_interface.py b/meshtastic/serial_interface.py
@@ -40,28 +40,25 @@ def __init__(self, devPath=None, debugOut=None, noProto=False, connectNow=True):
 
         # first we need to set the HUPCL so the device will not reboot based on RTS and/or DTR
         # see https://github.com/pyserial/pyserial/issues/124
-        if not self.noProto:
-            if platform.system() != 'Windows':
-                with open(devPath, encoding='utf8') as f:
-                    attrs = termios.tcgetattr(f)
-                    attrs[2] = attrs[2] & ~termios.HUPCL
-                    termios.tcsetattr(f, termios.TCSAFLUSH, attrs)
-                    f.close()
-                time.sleep(0.1)
+        if platform.system() != 'Windows':
+            with open(devPath, encoding='utf8') as f:
+                attrs = termios.tcgetattr(f)
+                attrs[2] = attrs[2] & ~termios.HUPCL
+                termios.tcsetattr(f, termios.TCSAFLUSH, attrs)
+                f.close()
+            time.sleep(0.1)
 
         self.stream = serial.Serial(devPath, 921600, exclusive=True, timeout=0.5, write_timeout=0)
-        if not self.noProto:
-            self.stream.flush()
-            time.sleep(0.1)
+        self.stream.flush()
+        time.sleep(0.1)
 
         StreamInterface.__init__(self, debugOut=debugOut, noProto=noProto, connectNow=connectNow)
 
     def close(self):
         """Close a connection to the device"""
-        if not self.noProto:
-            self.stream.flush()
-            time.sleep(0.1)
-            self.stream.flush()
-            time.sleep(0.1)
+        self.stream.flush()
+        time.sleep(0.1)
+        self.stream.flush()
+        time.sleep(0.1)
         logging.debug("Closing Serial stream")
         StreamInterface.close(self)
diff --git a/meshtastic/tests/test_main.py b/meshtastic/tests/test_main.py
diff --git a/meshtastic/tests/test_serial_interface.py b/meshtastic/tests/test_serial_interface.py
