Merge branch 'master' into loggingHandler2

Author: ianmcorvidae

.github/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to Meshtastic Python
+
+## Development resources
+- [API Documentation](https://python.meshtastic.org/)
+- [Meshtastic Python Development](https://meshtastic.org/docs/development/python/)
+- [Building Meshtastic Python](https://meshtastic.org/docs/development/python/building/)
+- [Using the Meshtastic Python Library](https://meshtastic.org/docs/development/python/library/)
+
+## How to check your code (pytest/pylint) before a PR
+- [Pre-requisites](https://meshtastic.org/docs/development/python/building/#pre-requisites)
+- also execute `poetry install --all-extras --with dev,powermon` for all optional dependencies
+- check your code with github ci actions locally
+    - You need to have act installed. You can get it at https://nektosact.com/ 
+    - on linux: `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
+    - on windows:
+      - linux checks (linux docker): `act --matrix "python-version:3.12"`
+      - windows checks (windows host): `act -P ubuntu-latest=-self-hosted --matrix "python-version:3.12"`
+- or run all locally:
+    - run `poetry run pylint meshtastic examples/ --ignore-patterns ".*_pb2.pyi?$"`
+    - run `poetry run mypy meshtastic/`
+    - run `poetry run pytest`
+    - more commands see [CI workflow](https://github.com/meshtastic/python/blob/master/.github/workflows/ci.yml)

meshtastic/__main__.py

@@ -60,7 +60,7 @@
     have_powermon = False
     powermon_exception = e
     meter = None
-from meshtastic.protobuf import channel_pb2, config_pb2, portnums_pb2
+from meshtastic.protobuf import channel_pb2, config_pb2, portnums_pb2, mesh_pb2
 from meshtastic.version import get_active_version
 
 logger = logging.getLogger(__name__)
@@ -346,51 +346,56 @@ def onConnected(interface):
             closeNow = True
             waitForAckNak = True
 
-            # Validate owner names before connecting to device
-            if args.set_owner is not None:
-                stripped_long_name = args.set_owner.strip()
-                if not stripped_long_name:
-                    meshtastic.util.our_exit("ERROR: Long Name cannot be empty or contain only whitespace characters")
-
-            if hasattr(args, 'set_owner_short') and args.set_owner_short is not None:
-                stripped_short_name = args.set_owner_short.strip()
-                if not stripped_short_name:
-                    meshtastic.util.our_exit("ERROR: Short Name cannot be empty or contain only whitespace characters")
-
-            if args.set_owner and args.set_owner_short:
-                print(f"Setting device owner to {args.set_owner} and short name to {args.set_owner_short}")
-            elif args.set_owner:
-                print(f"Setting device owner to {args.set_owner}")
-            elif args.set_owner_short and not args.set_owner:
-                print(f"Setting device owner short to {args.set_owner_short}")
-
-            if args.set_is_unmessageable:
+            long_name = args.set_owner.strip() if args.set_owner else None
+            short_name = args.set_owner_short.strip() if args.set_owner_short else None
+
+            if long_name is not None and not long_name:
+                meshtastic.util.our_exit("ERROR: Long Name cannot be empty or contain only whitespace characters")
+
+            if short_name is not None and not short_name:
+                meshtastic.util.our_exit("ERROR: Short Name cannot be empty or contain only whitespace characters")
+
+            if long_name and short_name:
+                print(f"Setting device owner to {long_name} and short name to {short_name}")
+            elif long_name:
+                print(f"Setting device owner to {long_name}")
+            elif short_name:
+                print(f"Setting device owner short to {short_name}")
+
+            unmessagable = None
+            if args.set_is_unmessageable is not None:
                 unmessagable = (
                     meshtastic.util.fromStr(args.set_is_unmessageable)
                     if isinstance(args.set_is_unmessageable, str)
                     else args.set_is_unmessageable
                 )
+                print(f"Setting device owner is_unmessageable to {unmessagable}")
 
-                if unmessagable is not None:
-                    print(f"Setting device owner is_unmessageable to {unmessagable}")
-                    interface.getNode(
-                        args.dest, False, **getNode_kwargs).setOwner(long_name=args.set_owner,
-                        short_name=args.set_owner_short, is_unmessagable=unmessagable
-                    )
+            interface.getNode(args.dest, False, **getNode_kwargs).setOwner(
+                long_name=long_name,
+                short_name=short_name,
+                is_unmessagable=unmessagable
+            )
 
         if args.set_canned_message:
             closeNow = True
             waitForAckNak = True
-            print(f"Setting canned plugin message to {args.set_canned_message}")
-            interface.getNode(args.dest, False, **getNode_kwargs).set_canned_message(
-                args.set_canned_message
-            )
+            node = interface.getNode(args.dest, False, **getNode_kwargs)
+            if node.module_available(mesh_pb2.CANNEDMSG_CONFIG):
+                print(f"Setting canned plugin message to {args.set_canned_message}")
+                node.set_canned_message(args.set_canned_message)
+            else:
+                print("Canned Message module is excluded by firmware; skipping set.")
 
         if args.set_ringtone:
             closeNow = True
             waitForAckNak = True
-            print(f"Setting ringtone to {args.set_ringtone}")
-            interface.getNode(args.dest, False, **getNode_kwargs).set_ringtone(args.set_ringtone)
+            node = interface.getNode(args.dest, False, **getNode_kwargs)
+            if node.module_available(mesh_pb2.EXTNOTIF_CONFIG):
+                print(f"Setting ringtone to {args.set_ringtone}")
+                node.set_ringtone(args.set_ringtone)
+            else:
+                print("External Notification is excluded by firmware; skipping ringtone set.")
 
         if args.pos_fields:
             # If --pos-fields invoked with args, set position fields

meshtastic/node.py

@@ -52,6 +52,16 @@ def __repr__(self):
         r += ")"
         return r
 
+    def module_available(self, excluded_bit: int) -> bool:
+        """Check DeviceMetadata.excluded_modules to see if a module is available."""
+        meta = getattr(self.iface, "metadata", None)
+        if meta is None:
+            return True
+        try:
+            return (meta.excluded_modules & excluded_bit) == 0
+        except Exception:
+            return True
+
     def showChannels(self):
         """Show human readable description of our channels."""
         print("Channels:")
@@ -442,6 +452,10 @@ def onResponseRequestRingtone(self, p):
     def get_ringtone(self):
         """Get the ringtone. Concatenate all pieces together and return a single string."""
         logger.debug(f"in get_ringtone()")
+        if not self.module_available(mesh_pb2.EXTNOTIF_CONFIG):
+            logging.warning("External Notification module not present (excluded by firmware)")
+            return None
+
         if not self.ringtone:
             p1 = admin_pb2.AdminMessage()
             p1.get_ringtone_request = True
@@ -463,6 +477,9 @@ def get_ringtone(self):
 
     def set_ringtone(self, ringtone):
         """Set the ringtone. The ringtone length must be less than 230 character."""
+        if not self.module_available(mesh_pb2.EXTNOTIF_CONFIG):
+            logging.warning("External Notification module not present (excluded by firmware)")
+            return None
 
         if len(ringtone) > 230:
             our_exit("Warning: The ringtone must be less than 230 characters.")
@@ -513,6 +530,9 @@ def onResponseRequestCannedMessagePluginMessageMessages(self, p):
     def get_canned_message(self):
         """Get the canned message string. Concatenate all pieces together and return a single string."""
         logger.debug(f"in get_canned_message()")
+        if not self.module_available(mesh_pb2.CANNEDMSG_CONFIG):
+            logging.warning("Canned Message module not present (excluded by firmware)")
+            return None
         if not self.cannedPluginMessage:
             p1 = admin_pb2.AdminMessage()
             p1.get_canned_message_module_messages_request = True
@@ -538,6 +558,9 @@ def get_canned_message(self):
 
     def set_canned_message(self, message):
         """Set the canned message. The canned messages length must be less than 200 character."""
+        if not self.module_available(mesh_pb2.CANNEDMSG_CONFIG):
+            logging.warning("Canned Message module not present (excluded by firmware)")
+            return None
 
         if len(message) > 200:
             our_exit("Warning: The canned message must be less than 200 characters.")