dbus2mqtt 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

dbus2mqtt/config/__init__.py

@@ -107,8 +107,14 @@ class FlowActionMqttPublishConfig:
     type: Literal["mqtt_publish"] = "mqtt_publish"
     payload_type: Literal["json", "yaml", "text", "binary"] = "json"
 
+@dataclass
+class FlowActionLogConfig:
+    msg: str
+    type: Literal["log"] = "log"
+    level: Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"] = "INFO"
+
 FlowActionConfig = Annotated[
-    FlowActionMqttPublishConfig | FlowActionContextSetConfig,
+    FlowActionMqttPublishConfig | FlowActionContextSetConfig | FlowActionLogConfig,
     Field(discriminator="type")
 ]
 
@@ -157,6 +163,7 @@ class MqttConfig:
     username: str
     password: SecretStr
     port: int = 1883
+    subscription_topics: list[str] = field(default_factory=lambda: ['dbus2mqtt/#'])
 
 @dataclass
 class Config:

dbus2mqtt/dbus/dbus_client.py

@@ -512,7 +512,7 @@ class DbusClient:
                 # clean lingering interface messgage handler from bus
                 self.bus.remove_message_handler(proxy_interface._message_handler)
 
-            # For now that InterfacesRemoved signal means the entire object is removed form D-Bus
+            # For now that InterfacesRemoved signal means the entire object is removed from D-Bus
             del self.subscriptions[bus_name].path_objects[path]
 
         # cleanup the entire BusNameSubscriptions if no more objects are subscribed
@@ -745,12 +745,13 @@ class DbusClient:
                 path = message.body[0]
                 await self._handle_interfaces_removed(bus_name, path)
 
-
     async def _on_mqtt_msg(self, msg: MqttMessage):
-        # self.queue.put({
-        #     "topic": topic,
-        #     "payload": payload
-        # })
+        """Executes dbus method calls or property updates on objects when messages have
+        1. a matching subscription configured
+        2. a matching method
+        3. a matching bus_name (if provided)
+        4. a matching path (if provided)
+        """
 
         found_matching_topic = False
         for subscription_configs in self.config.subscriptions:
@@ -766,6 +767,9 @@ class DbusClient:
         matched_method = False
         matched_property = False
 
+        payload_bus_name = msg.payload.get("bus_name") or "*"
+        payload_path = msg.payload.get("path") or "*"
+
         payload_method = msg.payload.get("method")
         payload_method_args = msg.payload.get("args") or []
 
@@ -773,47 +777,44 @@ class DbusClient:
         payload_value = msg.payload.get("value")
 
         if payload_method is None and (payload_property is None or payload_value is None):
-            logger.info(f"on_mqtt_msg: Unsupported payload, missing 'method' or 'property/value', got method={payload_method}, property={payload_property}, value={payload_value} from {msg.payload}")
+            if msg.payload:
+                logger.info(f"on_mqtt_msg: Unsupported payload, missing 'method' or 'property/value', got method={payload_method}, property={payload_property}, value={payload_value} from {msg.payload}")
             return
 
         for [bus_name, bus_name_subscription] in self.subscriptions.items():
-            for [path, proxy_object] in bus_name_subscription.path_objects.items():
-                for subscription_configs in self.config.get_subscription_configs(bus_name=bus_name, path=path):
-                    for interface_config in subscription_configs.interfaces:
-
-                        for method in interface_config.methods:
-
-                            # filter configured method, configured topic, ...
-                            if method.method == payload_method:
-                                interface = proxy_object.get_interface(name=interface_config.interface)
-                                matched_method = True
-
-                                try:
-                                    logger.info(f"on_mqtt_msg: method={method.method}, args={payload_method_args}, bus_name={bus_name}, path={path}, interface={interface_config.interface}")
-                                    await self.call_dbus_interface_method(interface, method.method, payload_method_args)
-                                except Exception as e:
-                                    logger.warning(f"on_mqtt_msg: method={method.method}, args={payload_method_args}, bus_name={bus_name} failed, exception={e}")
-
-                        for property in interface_config.properties:
-                            # filter configured property, configured topic, ...
-                            if property.property == payload_property:
-                                interface = proxy_object.get_interface(name=interface_config.interface)
-                                matched_property = True
-
-                                try:
-                                    logger.info(f"on_mqtt_msg: property={property.property}, value={payload_value}, bus_name={bus_name}, path={path}, interface={interface_config.interface}")
-                                    await self.set_dbus_interface_property(interface, property.property, payload_value)
-                                except Exception as e:
-                                    logger.warning(f"on_mqtt_msg: property={property.property}, value={payload_value}, bus_name={bus_name} failed, exception={e}")
+            if fnmatch.fnmatchcase(bus_name, payload_bus_name):
+                for [path, proxy_object] in bus_name_subscription.path_objects.items():
+                    if fnmatch.fnmatchcase(path, payload_path):
+                        for subscription_configs in self.config.get_subscription_configs(bus_name=bus_name, path=path):
+                            for interface_config in subscription_configs.interfaces:
+
+                                for method in interface_config.methods:
+
+                                    # filter configured method, configured topic, ...
+                                    if method.method == payload_method:
+                                        interface = proxy_object.get_interface(name=interface_config.interface)
+                                        matched_method = True
+
+                                        try:
+                                            logger.info(f"on_mqtt_msg: method={method.method}, args={payload_method_args}, bus_name={bus_name}, path={path}, interface={interface_config.interface}")
+                                            await self.call_dbus_interface_method(interface, method.method, payload_method_args)
+                                        except Exception as e:
+                                            logger.warning(f"on_mqtt_msg: method={method.method}, args={payload_method_args}, bus_name={bus_name} failed, exception={e}")
+
+                                for property in interface_config.properties:
+                                    # filter configured property, configured topic, ...
+                                    if property.property == payload_property:
+                                        interface = proxy_object.get_interface(name=interface_config.interface)
+                                        matched_property = True
+
+                                        try:
+                                            logger.info(f"on_mqtt_msg: property={property.property}, value={payload_value}, bus_name={bus_name}, path={path}, interface={interface_config.interface}")
+                                            await self.set_dbus_interface_property(interface, property.property, payload_value)
+                                        except Exception as e:
+                                            logger.warning(f"on_mqtt_msg: property={property.property}, value={payload_value}, bus_name={bus_name} failed, exception={e}")
 
         if not matched_method and not matched_property:
             if payload_method:
-                logger.info(f"No configured or active dbus subscriptions for topic={msg.topic}, method={payload_method}, active bus_names={list(self.subscriptions.keys())}")
+                logger.info(f"No configured or active dbus subscriptions for topic={msg.topic}, method={payload_method}, bus_name={payload_bus_name}, path={payload_path or '*'}, active bus_names={list(self.subscriptions.keys())}")
             if payload_property:
-                logger.info(f"No configured or active dbus subscriptions for topic={msg.topic}, property={payload_property}, active bus_names={list(self.subscriptions.keys())}")
-
-        # raw mode, payload contains: bus_name (specific or wildcard), path, interface_name
-        # topic: dbus2mqtt/raw (with allowlist check)
-
-        # predefined mode with topic matching from configuration
-        # topic: dbus2mqtt/MediaPlayer/command
+                logger.info(f"No configured or active dbus subscriptions for topic={msg.topic}, property={payload_property}, bus_name={payload_bus_name}, path={payload_path or '*'}, active bus_names={list(self.subscriptions.keys())}")

dbus2mqtt/flow/actions/log_action.py

@@ -0,0 +1,36 @@
+
+import logging
+
+from jinja2.exceptions import TemplateError
+
+from dbus2mqtt import AppContext
+from dbus2mqtt.config import FlowActionLogConfig
+from dbus2mqtt.flow import FlowAction, FlowExecutionContext
+
+logger = logging.getLogger(__name__)
+
+class LogAction(FlowAction):
+
+    def __init__(self, config: FlowActionLogConfig, app_context: AppContext):
+        self.config = config
+        self.templating = app_context.templating
+
+    async def execute(self, context: FlowExecutionContext):
+
+        render_context = context.get_aggregated_context()
+
+        log_msg = self.config.msg
+        log_level = logging._nameToLevel.get(self.config.level.upper(), logging.INFO)
+
+        try:
+            log_msg = await self.templating.async_render_template(
+                templatable=self.config.msg,
+                context=render_context,
+                res_type=str
+            )
+
+        except TemplateError as e:
+            logger.warning(f"Error rendering jinja template, flow: '{context.name or ''}', msg={e}, msg={self.config.msg}, render_context={render_context}", exc_info=True)
+            return
+
+        logger.log(level=log_level, msg=log_msg)

dbus2mqtt/flow/flow_processor.py

@@ -17,6 +17,7 @@ from dbus2mqtt.config import (
 from dbus2mqtt.event_broker import FlowTriggerMessage
 from dbus2mqtt.flow import FlowAction, FlowExecutionContext
 from dbus2mqtt.flow.actions.context_set import ContextSetAction
+from dbus2mqtt.flow.actions.log_action import LogAction
 from dbus2mqtt.flow.actions.mqtt_publish import MqttPublishAction
 
 logger = logging.getLogger(__name__)
@@ -102,8 +103,11 @@ class FlowActionContext:
             action = None
             if action_config.type == "context_set":
                 action = ContextSetAction(action_config, self.app_context)
-            if action_config.type == "mqtt_publish":
+            elif action_config.type == "mqtt_publish":
                 action = MqttPublishAction(action_config, self.app_context)
+            elif action_config.type == "log":
+                action = LogAction(action_config, self.app_context)
+
             if action:
                 res.append(action)
 

dbus2mqtt/mqtt/mqtt_client.py

@@ -13,6 +13,8 @@ import paho.mqtt.client as mqtt
 import yaml
 
 from paho.mqtt.enums import CallbackAPIVersion
+from paho.mqtt.packettypes import PacketTypes
+from paho.mqtt.properties import Properties
 from paho.mqtt.subscribeoptions import SubscribeOptions
 
 from dbus2mqtt import AppContext
@@ -27,8 +29,11 @@ class MqttClient:
         self.event_broker = app_context.event_broker
 
         unique_client_id_postfix = ''.join(random.choices(string.ascii_lowercase + string.digits, k=6))
+        self.client_id_prefix = "dbus2mqtt-"
+        self.client_id = f"{self.client_id_prefix}{unique_client_id_postfix}"
+
         self.client = mqtt.Client(
-            client_id=f"dbus2mqtt-client-{unique_client_id_postfix}",
+            client_id=self.client_id,
             protocol=mqtt.MQTTv5,
             callback_api_version=CallbackAPIVersion.VERSION2
         )
@@ -84,7 +89,16 @@ class MqttClient:
                 if first_message:
                     await asyncio.wait_for(self.connected_event.wait(), timeout=5)
 
-                self.client.publish(topic=msg.topic, payload=payload or "").wait_for_publish(timeout=1000)
+                publish_properties = Properties(PacketTypes.PUBLISH)
+                publish_properties.UserProperty = ("client_id", self.client_id)
+
+                publish_info = self.client.publish(
+                    topic=msg.topic,
+                    payload=payload or "",
+                    properties=publish_properties
+                )
+                publish_info.wait_for_publish(timeout=1000)
+
                 if first_message:
                     logger.info(f"First message published: topic={msg.topic}, payload={payload_log_msg}")
                     first_message = False
@@ -100,24 +114,31 @@ class MqttClient:
             logger.warning(f"on_connect: Failed to connect: {reason_code}. Will retry connection")
         else:
             logger.info(f"on_connect: Connected to {self.config.host}:{self.config.port}")
-            # Subscribing in on_connect() means that if we lose the connection and
-            # reconnect then subscriptions will be renewed.
-            # TODO: Determine topics based on config
-            client.subscribe("dbus2mqtt/#", options=SubscribeOptions(noLocal=True))
+
+            subscriptions = [(t, SubscribeOptions(noLocal=True)) for t in self.config.subscription_topics]
+            client.subscribe(subscriptions)
 
             self.loop.call_soon_threadsafe(self.connected_event.set)
 
     def on_message(self, client: mqtt.Client, userdata: Any, msg: mqtt.MQTTMessage):
 
-        # TODO: Skip messages being sent by other dbus2mqtt clients
-
+        # Skip retained messages
         payload = msg.payload.decode()
         if msg.retain:
             logger.info(f"on_message: skipping msg with retain=True, topic={msg.topic}, payload={payload}")
             return
 
+        # Skip messages being sent by other dbus2mqtt clients
+        if msg.properties:
+            user_properties: list[tuple[str, object]] = getattr(msg.properties, "UserProperty", [])
+            client_id = next((str(v) for k, v in user_properties if k == "client_id"), None)
+            if client_id and client_id != self.client_id:
+                logger.info(f"on_message: skipping msg from another dbus2mqtt client, topic={msg.topic}, client_id={client_id}")
+            if client_id and client_id.startswith(self.client_id_prefix):
+                return
+
         try:
-            json_payload = json.loads(payload)
+            json_payload = json.loads(payload) if payload else {}
             logger.debug(f"on_message: msg.topic={msg.topic}, msg.payload={json.dumps(json_payload)}")
             self.event_broker.on_mqtt_receive(MqttMessage(msg.topic, json_payload))
         except json.JSONDecodeError as e:

dbus2mqtt/template/templating.py

@@ -1,3 +1,4 @@
+import urllib.parse
 
 from datetime import datetime
 from typing import Any, TypeVar
@@ -7,11 +8,18 @@ from jinja2.nativetypes import NativeEnvironment
 
 TemplateResultType = TypeVar('TemplateResultType')
 
+def urldecode(string):
+    return urllib.parse.unquote(string)
+
 class TemplateEngine:
     def __init__(self):
 
         engine_globals = {}
         engine_globals['now'] = datetime.now
+        engine_globals['urldecode'] = urldecode
+
+        engine_filters = {}
+        engine_filters['urldecode'] = urldecode
 
         self.jinja2_env = NativeEnvironment(
             loader=BaseLoader(),
@@ -32,6 +40,9 @@ class TemplateEngine:
         self.jinja2_env.globals.update(engine_globals)
         self.jinja2_async_env.globals.update(engine_globals)
 
+        self.jinja2_env.filters.update(engine_filters)
+        self.jinja2_async_env.filters.update(engine_filters)
+
     def add_functions(self, custom_functions: dict[str, Any]):
         self.jinja2_env.globals.update(custom_functions)
         self.jinja2_async_env.globals.update(custom_functions)

{dbus2mqtt-0.4.0.dist-info → dbus2mqtt-0.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-Version: 0.4.0
+Version: 0.4.2
 Summary: A Python tool to expose Linux D-Bus signals, methods and properties over MQTT - featuring templating, payload enrichment and Home Assistant-ready examples 
 Project-URL: Repository, https://github.com/jwnmulder/dbus2mqtt.git
 Project-URL: Issues, https://github.com/jwnmulder/dbus2mqtt/issues
@@ -32,8 +32,8 @@ Description-Content-Type: text/markdown
 
 # dbus2mqtt
 
-**dbus2mqtt** is a Python application that bridges **Linux D-Bus** with **MQTT**.
-It lets you forward D-Bus signals and properties to MQTT topics, call D-Bus methods via MQTT messages, and shape payloads using flexible **Jinja2 templating**.
+**dbus2mqtt** is a Python application that bridges **DBus** with **MQTT**.
+It lets you forward Linux D-Bus signals and properties to MQTT topics, call D-Bus methods via MQTT messages, and shape payloads using flexible **Jinja2 templating**.
 
 This makes it easy to integrate Linux desktop services or system signals into MQTT-based workflows - including **Home Assistant**.
 
@@ -154,6 +154,8 @@ or
 mqtt:
   host: localhost
   port: 1883
+  subscription_topics:
+    - dbus2mqtt/#
 ```
 
 ### Exposing dbus methods
@@ -173,21 +175,31 @@ dbus:
 
 This configuration will expose 2 methods. Triggering methods can be done by publishing json messages to the `dbus2mqtt/org.mpris.MediaPlayer2/command` MQTT topic. Arguments can be passed along in `args`.
 
-Note that methods are called on **all** bus_names matching the configured pattern
+Some examples that call methods  on **all** bus_names matching the configured pattern
 
 ```json
 {
-    "method" : "Play",
+    "method": "Play",
 }
 ```
 
 ```json
 {
-    "method" : "OpenUri",
+    "method": "OpenUri",
     "args": []
 }
 ```
 
+To specifically target objects the properties `bus_name` and/or `path` can be used. Both properties support wildcards
+
+```json
+{
+    "method": "Play",
+    "bus_name": "*.firefox",
+    "path": "/org/mpris/MediaPlayer2"
+}
+```
+
 ### Exposing dbus signals
 
 Publishing signals to MQTT topics works by subscribing to the relevant signal and using flows for publishing
@@ -214,7 +226,7 @@ dbus:
 
 ## Flows
 
-TODO: Document flows, for now see the [MPRIS to Home Assistant Media Player integration](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md) example
+A reference of all supported flow triggers and actions can be found on [Flows](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/flows.md)
 
 ## Jinja templating
 

{dbus2mqtt-0.4.0.dist-info → dbus2mqtt-0.4.2.dist-info}/RECORD

@@ -2,22 +2,23 @@ dbus2mqtt/__init__.py,sha256=VunubKEH4_lne9Ttd2YRpyXjZMIAzyD2eiJ2sfvvTFU,362
 dbus2mqtt/__main__.py,sha256=NAoa3nwgBSQI22eWzzRx61SIDThDwXmUofWWZU3_4-Q,71
 dbus2mqtt/event_broker.py,sha256=Hp5yurhP8FkAO-y0l2grygHxR2e37ZQ7QScjcQDA2UU,1334
 dbus2mqtt/main.py,sha256=Kr2LRVxWcPDtNwCj8Eqz9TxtGLAVrV4q0nizKh1pLXc,4539
-dbus2mqtt/config/__init__.py,sha256=LXQg2cZ_vMvhAl7_cC6G3gxCaLCq9uaTfZqw7OEXkPQ,5104
+dbus2mqtt/config/__init__.py,sha256=947_dLVt8qq7P3p15jGIy5Vf1jUUMGrh1xr_DVhZclQ,5372
 dbus2mqtt/config/jsonarparse.py,sha256=VJGFeyQJcOE6bRXlSRr3FClvN_HnmiIlEGmOgNM0oCc,1214
-dbus2mqtt/dbus/dbus_client.py,sha256=0XneV3wulj6d_l4Jq9KIwROC19DLF853u6weCdyxpwA,39222
+dbus2mqtt/dbus/dbus_client.py,sha256=WHsmOiaJ5SY6zk-C99m83MEpycnUyGpsYmGopJJbPE8,39690
 dbus2mqtt/dbus/dbus_types.py,sha256=NmPD9um499e49Pk8DWH4IrIPQh1BinHYQgoXllCNiDw,777
 dbus2mqtt/dbus/dbus_util.py,sha256=h-1Y8Mvz9bj9X7mPZ8LghkvXDrujdJHK0__AOW373hE,697
 dbus2mqtt/dbus/introspection_patches/mpris_playerctl.py,sha256=q93d_Yp93u3Y-9q0dRdKW5hrij9GK3CFqKhUWVE8uw4,5883
 dbus2mqtt/dbus/introspection_patches/mpris_vlc.py,sha256=Cf-o-05W6gUoKpcYR7n0dRi-CrbeASPTwkyEzZGnU3Y,4241
 dbus2mqtt/flow/__init__.py,sha256=tAL-CjXQHq_tGTKctIdOZ5teVKBtcJs6Astq_RdruV8,1540
-dbus2mqtt/flow/flow_processor.py,sha256=-fJ5JPFcFqz1RokKaqjdHoU-EPg5McAERKYFwIkMzgU,8749
+dbus2mqtt/flow/flow_processor.py,sha256=N-btGap1wqnM4zKyulH_5KQhGi0IRlsK2cHrrnomMQQ,8922
 dbus2mqtt/flow/actions/context_set.py,sha256=dIT39MJJVb0wuRI_ZM3ssnXYfa-iyB4o_UZD-1BZL2g,1087
+dbus2mqtt/flow/actions/log_action.py,sha256=2_-YEKkX5kvFzK6x4v-Hx3u2PEM8fip_4buMg_ij-oI,1156
 dbus2mqtt/flow/actions/mqtt_publish.py,sha256=psNkTvaR3JZwAwpM4AqiZTDnA5UQX9r4CUZ1LA7iRW4,2366
-dbus2mqtt/mqtt/mqtt_client.py,sha256=0d8XSe4-WxrUBxcUprukwxgzIhnCn1G0fCPnLqPp9ko,5148
+dbus2mqtt/mqtt/mqtt_client.py,sha256=P6rxVNA2M_wxhI3RcHpvayEEmcUQGGDG6hkLmjiqY1w,6056
 dbus2mqtt/template/dbus_template_functions.py,sha256=UEoXK2PqDKF6jR4vTFHQwq58f5APnOJr7B1_I1zW8yM,2449
-dbus2mqtt/template/templating.py,sha256=ZLp1A8PFAs_-Bndx4yGqyppaDfh8marHlK7P3bFInu4,4144
-dbus2mqtt-0.4.0.dist-info/METADATA,sha256=enb7xSlQVzVTVxCLshavr5HoV8tNamfd2AOJzgel_Sg,7887
-dbus2mqtt-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dbus2mqtt-0.4.0.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
-dbus2mqtt-0.4.0.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
-dbus2mqtt-0.4.0.dist-info/RECORD,,
+dbus2mqtt/template/templating.py,sha256=YzE6-pBoATrV7nXkgxSiLlbxgbC65-2wGiFPHgIDd9g,4470
+dbus2mqtt-0.4.2.dist-info/METADATA,sha256=K8XT049Ryv76ssq7GeUYSRjeZbsWLYSvVoOHrA1bfeY,8105
+dbus2mqtt-0.4.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dbus2mqtt-0.4.2.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
+dbus2mqtt-0.4.2.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
+dbus2mqtt-0.4.2.dist-info/RECORD,,