bump version to 2.5.5

Allow request-telemetry to elicit LocalStats response

meshtastic/__main__.py

@@ -479,6 +479,8 @@ def onConnected(interface):
                         "air_quality": "air_quality_metrics",
                         "airquality": "air_quality_metrics",
                         "power": "power_metrics",
+                        "localstats": "local_stats",
+                        "local_stats": "local_stats",
                     }
                     telemType = telemMap.get(args.request_telemetry, "device_metrics")
                     print(

meshtastic/mesh_interface.py

@@ -617,6 +617,8 @@ class MeshInterface:  # pylint: disable=R0902
             r.air_quality_metrics.CopyFrom(telemetry_pb2.AirQualityMetrics())
         elif telemetryType == "power_metrics":
             r.power_metrics.CopyFrom(telemetry_pb2.PowerMetrics())
+        elif telemetryType == "local_stats":
+            r.local_stats.CopyFrom(telemetry_pb2.LocalStats())
         else: # fall through to device metrics
             if self.nodesByNum is not None:
                 node = self.nodesByNum.get(self.localNode.nodeNum)

meshtastic/protobuf/atak_pb2.pyi

@@ -256,7 +256,7 @@ class TAKPacket(google.protobuf.message.Message):
     detail: builtins.bytes
     """
     Generic CoT detail XML
-    May be compressed / truncated by the sender
+    May be compressed / truncated by the sender (EUD)
     """
     @property
     def contact(self) -> global___Contact:

meshtastic/protobuf/module_config_pb2.pyi

@@ -835,6 +835,8 @@ class ModuleConfig(google.protobuf.message.Message):
         POWER_MEASUREMENT_ENABLED_FIELD_NUMBER: builtins.int
         POWER_UPDATE_INTERVAL_FIELD_NUMBER: builtins.int
         POWER_SCREEN_ENABLED_FIELD_NUMBER: builtins.int
+        HEALTH_MEASUREMENT_ENABLED_FIELD_NUMBER: builtins.int
+        HEALTH_UPDATE_INTERVAL_FIELD_NUMBER: builtins.int
         device_update_interval: builtins.int
         """
         Interval in seconds of how often we should try to send our
@@ -883,6 +885,16 @@ class ModuleConfig(google.protobuf.message.Message):
         Interval in seconds of how often we should try to send our
         air quality metrics to the mesh
         """
+        health_measurement_enabled: builtins.bool
+        """
+        Preferences for the (Health) Telemetry Module
+        Enable/Disable the telemetry measurement module measurement collection
+        """
+        health_update_interval: builtins.int
+        """
+        Interval in seconds of how often we should try to send our
+        health metrics to the mesh
+        """
         def __init__(
             self,
             *,
@@ -896,8 +908,10 @@ class ModuleConfig(google.protobuf.message.Message):
             power_measurement_enabled: builtins.bool = ...,
             power_update_interval: builtins.int = ...,
             power_screen_enabled: builtins.bool = ...,
+            health_measurement_enabled: builtins.bool = ...,
+            health_update_interval: builtins.int = ...,
         ) -> None: ...
-        def ClearField(self, field_name: typing.Literal["air_quality_enabled", b"air_quality_enabled", "air_quality_interval", b"air_quality_interval", "device_update_interval", b"device_update_interval", "environment_display_fahrenheit", b"environment_display_fahrenheit", "environment_measurement_enabled", b"environment_measurement_enabled", "environment_screen_enabled", b"environment_screen_enabled", "environment_update_interval", b"environment_update_interval", "power_measurement_enabled", b"power_measurement_enabled", "power_screen_enabled", b"power_screen_enabled", "power_update_interval", b"power_update_interval"]) -> None: ...
+        def ClearField(self, field_name: typing.Literal["air_quality_enabled", b"air_quality_enabled", "air_quality_interval", b"air_quality_interval", "device_update_interval", b"device_update_interval", "environment_display_fahrenheit", b"environment_display_fahrenheit", "environment_measurement_enabled", b"environment_measurement_enabled", "environment_screen_enabled", b"environment_screen_enabled", "environment_update_interval", b"environment_update_interval", "health_measurement_enabled", b"health_measurement_enabled", "health_update_interval", b"health_update_interval", "power_measurement_enabled", b"power_measurement_enabled", "power_screen_enabled", b"power_screen_enabled", "power_update_interval", b"power_update_interval"]) -> None: ...
 
     @typing.final
     class CannedMessageConfig(google.protobuf.message.Message):

meshtastic/protobuf/telemetry_pb2.pyi

@@ -143,6 +143,14 @@ class _TelemetrySensorTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wra
     """
     Custom I2C sensor implementation based on https://github.com/meshtastic/i2c-sensor
     """
+    MAX30102: _TelemetrySensorType.ValueType  # 30
+    """
+    MAX30102 Pulse Oximeter and Heart-Rate Sensor
+    """
+    MLX90614: _TelemetrySensorType.ValueType  # 31
+    """
+    MLX90614 non-contact IR temperature sensor.
+    """
 
 class TelemetrySensorType(_TelemetrySensorType, metaclass=_TelemetrySensorTypeEnumTypeWrapper):
     """
@@ -269,6 +277,14 @@ CUSTOM_SENSOR: TelemetrySensorType.ValueType  # 29
 """
 Custom I2C sensor implementation based on https://github.com/meshtastic/i2c-sensor
 """
+MAX30102: TelemetrySensorType.ValueType  # 30
+"""
+MAX30102 Pulse Oximeter and Heart-Rate Sensor
+"""
+MLX90614: TelemetrySensorType.ValueType  # 31
+"""
+MLX90614 non-contact IR temperature sensor.
+"""
 global___TelemetrySensorType = TelemetrySensorType
 
 @typing.final
@@ -677,6 +693,9 @@ class LocalStats(google.protobuf.message.Message):
     NUM_PACKETS_RX_BAD_FIELD_NUMBER: builtins.int
     NUM_ONLINE_NODES_FIELD_NUMBER: builtins.int
     NUM_TOTAL_NODES_FIELD_NUMBER: builtins.int
+    NUM_RX_DUPE_FIELD_NUMBER: builtins.int
+    NUM_TX_RELAY_FIELD_NUMBER: builtins.int
+    NUM_TX_RELAY_CANCELED_FIELD_NUMBER: builtins.int
     uptime_seconds: builtins.int
     """
     How long the device has been running since the last reboot (in seconds)
@@ -695,7 +714,7 @@ class LocalStats(google.protobuf.message.Message):
     """
     num_packets_rx: builtins.int
     """
-    Number of packets received good
+    Number of packets received (both good and bad)
     """
     num_packets_rx_bad: builtins.int
     """
@@ -709,6 +728,20 @@ class LocalStats(google.protobuf.message.Message):
     """
     Number of nodes total
     """
+    num_rx_dupe: builtins.int
+    """
+    Number of received packets that were duplicates (due to multiple nodes relaying).
+    If this number is high, there are nodes in the mesh relaying packets when it's unnecessary, for example due to the ROUTER/REPEATER role.
+    """
+    num_tx_relay: builtins.int
+    """
+    Number of packets we transmitted that were a relay for others (not originating from ourselves).
+    """
+    num_tx_relay_canceled: builtins.int
+    """
+    Number of times we canceled a packet to be relayed, because someone else did it before us.
+    This will always be zero for ROUTERs/REPEATERs. If this number is high, some other node(s) is/are relaying faster than you.
+    """
     def __init__(
         self,
         *,
@@ -720,11 +753,55 @@ class LocalStats(google.protobuf.message.Message):
         num_packets_rx_bad: builtins.int = ...,
         num_online_nodes: builtins.int = ...,
         num_total_nodes: builtins.int = ...,
+        num_rx_dupe: builtins.int = ...,
+        num_tx_relay: builtins.int = ...,
+        num_tx_relay_canceled: builtins.int = ...,
     ) -> None: ...
-    def ClearField(self, field_name: typing.Literal["air_util_tx", b"air_util_tx", "channel_utilization", b"channel_utilization", "num_online_nodes", b"num_online_nodes", "num_packets_rx", b"num_packets_rx", "num_packets_rx_bad", b"num_packets_rx_bad", "num_packets_tx", b"num_packets_tx", "num_total_nodes", b"num_total_nodes", "uptime_seconds", b"uptime_seconds"]) -> None: ...
+    def ClearField(self, field_name: typing.Literal["air_util_tx", b"air_util_tx", "channel_utilization", b"channel_utilization", "num_online_nodes", b"num_online_nodes", "num_packets_rx", b"num_packets_rx", "num_packets_rx_bad", b"num_packets_rx_bad", "num_packets_tx", b"num_packets_tx", "num_rx_dupe", b"num_rx_dupe", "num_total_nodes", b"num_total_nodes", "num_tx_relay", b"num_tx_relay", "num_tx_relay_canceled", b"num_tx_relay_canceled", "uptime_seconds", b"uptime_seconds"]) -> None: ...
 
 global___LocalStats = LocalStats
 
+@typing.final
+class HealthMetrics(google.protobuf.message.Message):
+    """
+    Health telemetry metrics
+    """
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    HEART_BPM_FIELD_NUMBER: builtins.int
+    SPO2_FIELD_NUMBER: builtins.int
+    TEMPERATURE_FIELD_NUMBER: builtins.int
+    heart_bpm: builtins.int
+    """
+    Heart rate (beats per minute)
+    """
+    spO2: builtins.int
+    """
+    SpO2 (blood oxygen saturation) level
+    """
+    temperature: builtins.float
+    """
+    Body temperature in degrees Celsius
+    """
+    def __init__(
+        self,
+        *,
+        heart_bpm: builtins.int | None = ...,
+        spO2: builtins.int | None = ...,
+        temperature: builtins.float | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_heart_bpm", b"_heart_bpm", "_spO2", b"_spO2", "_temperature", b"_temperature", "heart_bpm", b"heart_bpm", "spO2", b"spO2", "temperature", b"temperature"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_heart_bpm", b"_heart_bpm", "_spO2", b"_spO2", "_temperature", b"_temperature", "heart_bpm", b"heart_bpm", "spO2", b"spO2", "temperature", b"temperature"]) -> None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_heart_bpm", b"_heart_bpm"]) -> typing.Literal["heart_bpm"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_spO2", b"_spO2"]) -> typing.Literal["spO2"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_temperature", b"_temperature"]) -> typing.Literal["temperature"] | None: ...
+
+global___HealthMetrics = HealthMetrics
+
 @typing.final
 class Telemetry(google.protobuf.message.Message):
     """
@@ -739,6 +816,7 @@ class Telemetry(google.protobuf.message.Message):
     AIR_QUALITY_METRICS_FIELD_NUMBER: builtins.int
     POWER_METRICS_FIELD_NUMBER: builtins.int
     LOCAL_STATS_FIELD_NUMBER: builtins.int
+    HEALTH_METRICS_FIELD_NUMBER: builtins.int
     time: builtins.int
     """
     Seconds since 1970 - or 0 for unknown/unset
@@ -773,6 +851,12 @@ class Telemetry(google.protobuf.message.Message):
         Local device mesh statistics
         """
 
+    @property
+    def health_metrics(self) -> global___HealthMetrics:
+        """
+        Health telemetry metrics
+        """
+
     def __init__(
         self,
         *,
@@ -782,10 +866,11 @@ class Telemetry(google.protobuf.message.Message):
         air_quality_metrics: global___AirQualityMetrics | None = ...,
         power_metrics: global___PowerMetrics | None = ...,
         local_stats: global___LocalStats | None = ...,
+        health_metrics: global___HealthMetrics | None = ...,
     ) -> None: ...
-    def HasField(self, field_name: typing.Literal["air_quality_metrics", b"air_quality_metrics", "device_metrics", b"device_metrics", "environment_metrics", b"environment_metrics", "local_stats", b"local_stats", "power_metrics", b"power_metrics", "variant", b"variant"]) -> builtins.bool: ...
-    def ClearField(self, field_name: typing.Literal["air_quality_metrics", b"air_quality_metrics", "device_metrics", b"device_metrics", "environment_metrics", b"environment_metrics", "local_stats", b"local_stats", "power_metrics", b"power_metrics", "time", b"time", "variant", b"variant"]) -> None: ...
-    def WhichOneof(self, oneof_group: typing.Literal["variant", b"variant"]) -> typing.Literal["device_metrics", "environment_metrics", "air_quality_metrics", "power_metrics", "local_stats"] | None: ...
+    def HasField(self, field_name: typing.Literal["air_quality_metrics", b"air_quality_metrics", "device_metrics", b"device_metrics", "environment_metrics", b"environment_metrics", "health_metrics", b"health_metrics", "local_stats", b"local_stats", "power_metrics", b"power_metrics", "variant", b"variant"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["air_quality_metrics", b"air_quality_metrics", "device_metrics", b"device_metrics", "environment_metrics", b"environment_metrics", "health_metrics", b"health_metrics", "local_stats", b"local_stats", "power_metrics", b"power_metrics", "time", b"time", "variant", b"variant"]) -> None: ...
+    def WhichOneof(self, oneof_group: typing.Literal["variant", b"variant"]) -> typing.Literal["device_metrics", "environment_metrics", "air_quality_metrics", "power_metrics", "local_stats", "health_metrics"] | None: ...
 
 global___Telemetry = Telemetry
 

meshtastic/util.py

@@ -675,5 +675,8 @@ def check_if_newer_version() -> Optional[str]:
 
 def message_to_json(message: Message, multiline: bool=False) -> str:
     """Return protobuf message as JSON. Always print all fields, even when not present in data."""
-    json = MessageToJson(message, always_print_fields_with_no_presence=True)
+    try:
+        json = MessageToJson(message, always_print_fields_with_no_presence=True)
+    except TypeError:
+        json = MessageToJson(message, including_default_value_fields=True) # type: ignore[call-arg] # pylint: disable=E1123
     return stripnl(json) if not multiline else json

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "meshtastic"
-version = "2.5.4"
+version = "2.5.5"
 description = "Python API & client shell for talking to Meshtastic devices"
 authors = ["Meshtastic Developers <contact@meshtastic.org>"]
 license = "GPL-3.0-only"
@@ -9,7 +9,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.9,<3.14"                                               # 3.9 is needed for pandas, bleak requires <3.14
 pyserial = "^3.5"
-protobuf = ">=5.26.0"
+protobuf = ">=4.21.12"
 dotmap = "^1.3.30"
 pexpect = "^4.9.0"
 pyqrcode = "^1.2.1"
@@ -37,7 +37,7 @@ autopep8 = "^2.1.0"
 pylint = "^3.2.3"
 pyinstaller = "^6.8.0"
 mypy = "^1.10.0"
-mypy-protobuf = "^3.6.0"
+mypy-protobuf = { version = "^3.3.0", optional = true }
 types-protobuf = "^5.26.0.20240422"
 types-tabulate = "^0.9.0.20240106"
 types-requests = "^2.31.0.20240406"