dbus2mqtt 0.2.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

dbus2mqtt/{config.py → config/__init__.py}

@@ -50,8 +50,8 @@ class FlowTriggerMqttConfig:
 class FlowTriggerScheduleConfig:
     type: Literal["schedule"] = "schedule"
     id: str = field(default_factory=lambda: uuid.uuid4().hex)
-    cron: dict[str, Any] | None = None
-    interval: dict[str, Any] | None = None
+    cron: dict[str, object] | None = None
+    interval: dict[str, object] | None = None
 
 @dataclass
 class FlowTriggerDbusSignalConfig:
@@ -60,17 +60,17 @@ class FlowTriggerDbusSignalConfig:
     type: Literal["dbus_signal"] = "dbus_signal"
     bus_name: str | None = None
     path: str | None = None
-    filter: str | None = None
+    # filter: str | None = None
 
 @dataclass
 class FlowTriggerBusNameAddedConfig:
     type: Literal["bus_name_added"] = "bus_name_added"
-    filter: str | None = None
+    # filter: str | None = None
 
 @dataclass
 class FlowTriggerBusNameRemovedConfig:
     type: Literal["bus_name_removed"] = "bus_name_removed"
-    filter: str | None = None
+    # filter: str | None = None
 
 FlowTriggerConfig = Annotated[
     FlowTriggerMqttConfig | FlowTriggerScheduleConfig | FlowTriggerDbusSignalConfig | FlowTriggerBusNameAddedConfig | FlowTriggerBusNameRemovedConfig,
@@ -80,15 +80,17 @@ FlowTriggerConfig = Annotated[
 @dataclass
 class FlowActionContextSetConfig:
     type: Literal["context_set"] = "context_set"
-    context: dict[str, Any] | None = None
-    global_context: dict[str, Any] | None = None
+    context: dict[str, object] | None = None
+    """Per flow execution context"""
+    global_context: dict[str, object] | None = None
+    """Global context, shared between multiple flow executions, over all subscriptions"""
 
 @dataclass
 class FlowActionMqttPublishConfig:
     topic: str
     payload_template: str | dict[str, Any]
     type: Literal["mqtt_publish"] = "mqtt_publish"
-    payload_type: Literal["json", "yaml", "text"] = "json"
+    payload_type: Literal["json", "yaml", "text", "binary"] = "json"
 
 FlowActionConfig = Annotated[
     FlowActionMqttPublishConfig | FlowActionContextSetConfig,

dbus2mqtt/config/jsonarparse.py

@@ -0,0 +1,31 @@
+import jsonargparse
+
+
+def _custom_yaml_load(stream):
+    if isinstance(stream, str):
+        v = stream.strip()
+
+        # jsonargparse tries to parse yaml 1.1 boolean like values
+        # Without this, str:"{'PlaybackStatus': 'Off'}" would become dict:{'PlaybackStatus': False}
+        if v in ['on', 'On', 'off', 'Off', 'TRUE', 'FALSE', 'True', 'False']:
+            return stream
+
+        # Anoyingly, values starting with {{ and ending with }} are working with the default yaml_loader
+        # from jsonargparse. Somehow its not when we use the custom yaml loader.
+        # This fixes it
+        if v.startswith("{{") or v.startswith("{%"):
+            return stream
+
+    # Delegate to default yaml loader from jsonargparse
+    yaml_loader = jsonargparse.get_loader("yaml")
+    return yaml_loader(stream)
+
+def new_argument_parser() -> jsonargparse.ArgumentParser:
+
+    # register out custom yaml loader for jsonargparse
+    jsonargparse.set_loader("yaml_custom", _custom_yaml_load)
+
+    # unless specified otherwise, load config from config.yaml
+    parser = jsonargparse.ArgumentParser(default_config_files=["config.yaml"], default_env=True, env_prefix=False, parser_mode="yaml_custom")
+
+    return parser

dbus2mqtt/dbus/dbus_client.py

@@ -1,13 +1,11 @@
 import json
 import logging
-import re
 
 from datetime import datetime
 from typing import Any
 
-import dbus_next
-import dbus_next.aio as dbus_aio
-import dbus_next.introspection as dbus_introspection
+import dbus_fast.aio as dbus_aio
+import dbus_fast.introspection as dbus_introspection
 
 from dbus2mqtt import AppContext
 from dbus2mqtt.config import InterfaceConfig, SubscriptionConfig
@@ -17,17 +15,15 @@ from dbus2mqtt.dbus.dbus_util import (
     unwrap_dbus_object,
     unwrap_dbus_objects,
 )
+from dbus2mqtt.dbus.introspection_patches.mpris_playerctl import (
+    mpris_introspection_playerctl,
+)
+from dbus2mqtt.dbus.introspection_patches.mpris_vlc import mpris_introspection_vlc
 from dbus2mqtt.event_broker import DbusSignalWithState, MqttMessage
 from dbus2mqtt.flow.flow_processor import FlowScheduler, FlowTriggerMessage
 
 logger = logging.getLogger(__name__)
 
-# dbus_next path to support https://docs.flatpak.org/en/latest/portal-api-reference.html
-# Although not correct, flatpak exposes properties with names containing '-'
-# This is failing assertions in dbus_next
-# original: r'^[A-Za-z_][A-Za-z0-9_]*$'
-# patched:  r'^[A-Za-z_][A-Za-z0-9_-]*$'
-dbus_next.validators._element_re = re.compile(r'^[A-Za-z_][A-Za-z0-9_-]*$')
 
 class DbusClient:
 
@@ -90,23 +86,23 @@ class DbusClient:
 
         return proxy_object, bus_name_subscriptions
 
-    def _dbus_next_signal_publisher(self, dbus_signal_state: dict[str, Any], *args):
+    def _dbus_fast_signal_publisher(self, dbus_signal_state: dict[str, Any], *args):
         unwrapped_args = unwrap_dbus_objects(args)
         self.event_broker.on_dbus_signal(
             DbusSignalWithState(**dbus_signal_state, args=unwrapped_args)
         )
 
-    def _dbus_next_signal_handler(self, signal: dbus_introspection.Signal, state: dict[str, Any]) -> Any:
+    def _dbus_fast_signal_handler(self, signal: dbus_introspection.Signal, state: dict[str, Any]) -> Any:
         expected_args = len(signal.args)
 
         if expected_args == 1:
-            return lambda a: self._dbus_next_signal_publisher(state, a)
+            return lambda a: self._dbus_fast_signal_publisher(state, a)
         elif expected_args == 2:
-            return lambda a, b: self._dbus_next_signal_publisher(state, a, b)
+            return lambda a, b: self._dbus_fast_signal_publisher(state, a, b)
         elif expected_args == 3:
-            return lambda a, b, c: self._dbus_next_signal_publisher(state, a, b, c)
+            return lambda a, b, c: self._dbus_fast_signal_publisher(state, a, b, c)
         elif expected_args == 4:
-            return lambda a, b, c, d: self._dbus_next_signal_publisher(state, a, b, c, d)
+            return lambda a, b, c, d: self._dbus_fast_signal_publisher(state, a, b, c, d)
         raise ValueError("Unsupported nr of arguments")
 
     async def _subscribe_interface(self, bus_name: str, path: str, introspection: dbus_introspection.Node, interface: dbus_introspection.Interface, subscription_config: SubscriptionConfig, si: InterfaceConfig) -> SubscribedInterface:
@@ -131,7 +127,7 @@ class DbusClient:
                     "signal_config": signal_config,
                 }
 
-                handler = self._dbus_next_signal_handler(interface_signal, dbus_signal_state)
+                handler = self._dbus_fast_signal_handler(interface_signal, dbus_signal_state)
                 obj_interface.__getattribute__(on_signal_method_name)(handler)
                 logger.info(f"subscribed with signal_handler: signal={signal_config.signal}, bus_name={bus_name}, path={path}, interface={interface.name}")
 
@@ -162,12 +158,28 @@ class DbusClient:
 
         return new_subscriptions
 
+    async def _introspect(self, bus_name: str, path: str) -> dbus_introspection.Node:
+
+        if path == "/org/mpris/MediaPlayer2" and bus_name.startswith("org.mpris.MediaPlayer2.vlc"):
+            # vlc 3.x branch contains an incomplete dbus introspection
+            # https://github.com/videolan/vlc/commit/48e593f164d2bf09b0ca096d88c86d78ec1a2ca0
+            # Until vlc 4.x is out we use the official specification instead
+            introspection = mpris_introspection_vlc
+        else:
+            introspection = await self.bus.introspect(bus_name, path)
+
+        # MPRIS: If no introspection data is available, load a default
+        if path == "/org/mpris/MediaPlayer2" and bus_name.startswith("org.mpris.MediaPlayer2.") and len(introspection.interfaces) == 0:
+            introspection = mpris_introspection_playerctl
+
+        return introspection
+
     async def _visit_bus_name_path(self, bus_name: str, path: str) -> list[SubscribedInterface]:
 
         new_subscriptions: list[SubscribedInterface] = []
 
         try:
-            introspection = await self.bus.introspect(bus_name, path)
+            introspection = await self._introspect(bus_name, path)
         except TypeError as e:
             logger.warning(f"bus.introspect failed, bus_name={bus_name}, path={path}: {e}")
             return new_subscriptions
@@ -223,21 +235,27 @@ class DbusClient:
                 self.flow_scheduler.start_flow_set(subscription_config.flows)
 
                 # Trigger flows that have a bus_name_added trigger configured
-                await self._trigger_bus_name_added(subscription_config, subscribed_interface.bus_name)
+                await self._trigger_bus_name_added(subscription_config, subscribed_interface.bus_name, subscribed_interface.path)
 
                 processed_new_subscriptions.add(subscription_config.id)
 
         return new_subscriped_interfaces
 
-    async def _trigger_bus_name_added(self, subscription_config: SubscriptionConfig, bus_name: str):
+    async def _trigger_bus_name_added(self, subscription_config: SubscriptionConfig, bus_name: str, path: str):
 
         for flow in subscription_config.flows:
             for trigger in flow.triggers:
                 if trigger.type == "bus_name_added":
-                    context = {
+                    trigger_context = {
                         "bus_name": bus_name,
+                        "path": path
                     }
-                    trigger_message = FlowTriggerMessage(flow, trigger, datetime.now(), context)
+                    trigger_message = FlowTriggerMessage(
+                        flow,
+                        trigger,
+                        datetime.now(),
+                        trigger_context=trigger_context
+                    )
                     await self.event_broker.flow_trigger_queue.async_q.put(trigger_message)
 
     async def _handle_bus_name_removed(self, bus_name: str):
@@ -251,7 +269,7 @@ class DbusClient:
                 for subscription_config in subscription_configs:
 
                     # Trigger flows that have a bus_name_added trigger configured
-                    await self._trigger_bus_name_removed(subscription_config, bus_name)
+                    await self._trigger_bus_name_removed(subscription_config, bus_name, path)
 
                     # Stop schedule triggers
                     self.flow_scheduler.stop_flow_set(subscription_config.flows)
@@ -275,16 +293,22 @@ class DbusClient:
 
             del self.subscriptions[bus_name]
 
-    async def _trigger_bus_name_removed(self, subscription_config: SubscriptionConfig, bus_name: str):
+    async def _trigger_bus_name_removed(self, subscription_config: SubscriptionConfig, bus_name: str, path: str):
 
         # Trigger flows that have a bus_name_removed trigger configured
         for flow in subscription_config.flows:
             for trigger in flow.triggers:
                 if trigger.type == "bus_name_removed":
-                    context = {
+                    trigger_context = {
                         "bus_name": bus_name,
+                        "path": path
                     }
-                    trigger_message = FlowTriggerMessage(flow, trigger, datetime.now(), context)
+                    trigger_message = FlowTriggerMessage(
+                        flow,
+                        trigger,
+                        datetime.now(),
+                        trigger_context=trigger_context
+                    )
                     await self.event_broker.flow_trigger_queue.async_q.put(trigger_message)
 
     async def _dbus_name_owner_changed_callback(self, name, old_owner, new_owner):
@@ -310,7 +334,7 @@ class DbusClient:
 
         return res
 
-    async def get_dbus_interface_property(self, interface: dbus_aio.proxy_object.ProxyInterface, property: str):
+    async def get_dbus_interface_property(self, interface: dbus_aio.proxy_object.ProxyInterface, property: str) -> Any:
 
         call_method_name = "get_" + camel_to_snake(property)
         res = await interface.__getattribute__(call_method_name)()
@@ -322,17 +346,12 @@ class DbusClient:
 
         return res
 
-    async def set_dbus_interface_property(self, interface: dbus_aio.proxy_object.ProxyInterface, property: str, value):
+    async def set_dbus_interface_property(self, interface: dbus_aio.proxy_object.ProxyInterface, property: str, value: Any) -> None:
 
         call_method_name = "set_" + camel_to_snake(property)
-        res = await interface.__getattribute__(call_method_name)(value)
-
-        if res:
-            res = unwrap_dbus_object(res)
-
-        logger.info(f"set_dbus_interface_property: bus_name={interface.bus_name}, interface={interface.introspection.name}, property={property}, res={res}")
+        await interface.__getattribute__(call_method_name)(value)
 
-        return res
+        logger.info(f"set_dbus_interface_property: bus_name={interface.bus_name}, interface={interface.introspection.name}, property={property}, value={value}")
 
     async def mqtt_receive_queue_processor_task(self):
         """Continuously processes messages from the async queue."""
@@ -367,13 +386,18 @@ class DbusClient:
                             matches_filter = signal.signal_config.matches_filter(self.app_context.templating, *signal.args)
 
                         if matches_filter:
-                            context = {
+                            trigger_context = {
                                 "bus_name": signal.bus_name,
                                 "path": signal.path,
                                 "interface": signal.interface_name,
                                 "args": signal.args
                             }
-                            trigger_message = FlowTriggerMessage(flow, trigger, datetime.now(), context)
+                            trigger_message = FlowTriggerMessage(
+                                flow,
+                                trigger,
+                                datetime.now(),
+                                trigger_context=trigger_context
+                            )
 
                             await self.event_broker.flow_trigger_queue.async_q.put(trigger_message)
                     except Exception as e:

dbus2mqtt/dbus/dbus_types.py

@@ -2,14 +2,14 @@
 
 from dataclasses import dataclass
 
-import dbus_next.aio as dbus_aio
+import dbus_fast.aio as dbus_aio
 
 from dbus2mqtt.config import InterfaceConfig, SubscriptionConfig
 
 
 class BusNameSubscriptions:
 
-    def __init__(self,  bus_name: str):
+    def __init__(self, bus_name: str):
         self.bus_name = bus_name
         self.path_objects: dict[str, dbus_aio.proxy_object.ProxyObject] = {}
 

dbus2mqtt/dbus/dbus_util.py

@@ -1,7 +1,7 @@
 import json
 import re
 
-import dbus_next.signature as dbus_signature
+import dbus_fast.signature as dbus_signature
 
 
 def _variant_serializer(obj):
@@ -10,7 +10,7 @@ def _variant_serializer(obj):
     return obj
 
 def unwrap_dbus_object(o):
-    # an easy way to get rid of dbus_next.signature.Variant types
+    # an easy way to get rid of dbus_fast.signature.Variant types
     res = json.dumps(o, default=_variant_serializer)
     json_obj = json.loads(res)
     return json_obj

dbus2mqtt/dbus/introspection_patches/mpris_playerctl.py

@@ -0,0 +1,151 @@
+import dbus_fast.introspection as dbus_introspection
+
+# taken from https://github.com/altdesktop/playerctl/blob/b19a71cb9dba635df68d271bd2b3f6a99336a223/playerctl/playerctl-daemon.c#L578
+mpris_introspection_playerctl = dbus_introspection.Node.parse("""\
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+  "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node>
+  <interface name="org.freedesktop.DBus.Introspectable">
+    <method name="Introspect">
+      <arg name="data" direction="out" type="s"/>
+    </method>
+  </interface>
+
+  <interface name="org.freedesktop.DBus.Properties">
+    <method name="Get">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="v"/>
+    </method>
+    <method name="Set">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="v"/>
+    </method>
+    <method name="GetAll">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="a{sv}"/>
+    </method>
+    <signal name="PropertiesChanged">
+      <arg type="s"/>
+      <arg type="a{sv}"/>
+      <arg type="as"/>
+    </signal>
+  </interface>
+
+  <interface name="org.mpris.MediaPlayer2">
+    <property name="CanQuit" type="b" access="read"/>
+    <property name="Fullscreen" type="b" access="readwrite"/>
+    <property name="CanSetFullscreen" type="b" access="read"/>
+    <property name="CanRaise" type="b" access="read"/>
+    <property name="HasTrackList" type="b" access="read"/>
+    <property name="Identity" type="s" access="read"/>
+    <property name="DesktopEntry" type="s" access="read"/>
+    <property name="SupportedUriSchemes" type="as" access="read"/>
+    <property name="SupportedMimeTypes" type="as" access="read"/>
+    <method name="Raise"/>
+    <method name="Quit"/>
+  </interface>
+
+  <interface name="org.mpris.MediaPlayer2.Player">
+    <property name="PlaybackStatus" type="s" access="read"/>
+    <property name="LoopStatus" type="s" access="readwrite"/>
+    <property name="Rate" type="d" access="readwrite"/>
+    <property name="Shuffle" type="b" access="readwrite"/>
+    <property name="Metadata" type="a{sv}" access="read"/>
+    <property name="Volume" type="d" access="readwrite"/>
+    <property name="Position" type="x" access="read"/>
+    <property name="MinimumRate" type="d" access="read"/>
+    <property name="MaximumRate" type="d" access="read"/>
+    <property name="CanGoNext" type="b" access="read"/>
+    <property name="CanGoPrevious" type="b" access="read"/>
+    <property name="CanPlay" type="b" access="read"/>
+    <property name="CanPause" type="b" access="read"/>
+    <property name="CanSeek" type="b" access="read"/>
+    <property name="CanControl" type="b" access="read"/>
+    <method name="Next"/>
+    <method name="Previous"/>
+    <method name="Pause"/>
+    <method name="PlayPause"/>
+    <method name="Stop"/>
+    <method name="Play"/>
+    <method name="Seek">
+      <arg type="x" name="Offset" direction="in"/>
+    </method>
+    <method name="SetPosition">
+      <arg type="o" name="TrackId" direction="in"/>
+      <arg type="x" name="Offset" direction="in"/>
+    </method>
+    <method name="OpenUri">
+      <arg type="s" name="Uri" direction="in"/>
+    </method>
+    <signal name="Seeked">
+      <arg type="x" name="Position" direction="out"/>
+    </signal>
+  </interface>
+
+  <interface name="org.mpris.MediaPlayer2.TrackList">
+    <property name="Tracks" type="ao" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="invalidates"/>
+    </property>
+    <property name="CanEditTracks" type="b" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="true"/>
+    </property>
+    <method name="GetTracksMetadata">
+      <arg direction="in" name="TrackIds" type="ao"/>
+      <arg direction="out" name="Metadata" type="aa{sv}"/>
+    </method>
+    <method name="AddTrack">
+      <arg direction="in" name="Uri" type="s"/>
+      <arg direction="in" name="AfterTrack" type="o"/>
+      <arg direction="in" name="SetAsCurrent" type="b"/>
+    </method>
+    <method name="RemoveTrack">
+      <arg direction="in" name="TrackId" type="o"/>
+    </method>
+    <method name="GoTo">
+      <arg direction="in" name="TrackId" type="o"/>
+    </method>
+    <signal name="TrackListReplaced">
+      <arg name="Tracks" type="ao"/>
+      <arg name="CurrentTrack" type="o"/>
+    </signal>
+    <signal name="TrackAdded">
+      <arg name="Metadata" type="a{sv}"/>
+      <arg name="AfterTrack" type="o"/>
+    </signal>
+    <signal name="TrackRemoved">
+      <arg name="TrackId" type="o"/>
+    </signal>
+    <signal name="TrackMetadataChanged">
+      <arg name="TrackId" type="o"/>
+      <arg name="Metadata" type="a{sv}"/>
+    </signal>
+  </interface>
+
+  <interface name="org.mpris.MediaPlayer2.Playlists">
+    <method name="ActivatePlaylist">
+      <arg direction="in" name="PlaylistId" type="o"/>
+    </method>
+    <method name="GetPlaylists">
+      <arg direction="in" name="Index" type="u"/>
+      <arg direction="in" name="MaxCount" type="u"/>
+      <arg direction="in" name="Order" type="s"/>
+      <arg direction="in" name="ReverseOrder" type="b"/>
+      <arg direction="out" name="Playlists" type="a(oss)"/>
+    </method>
+    <property name="PlaylistCount" type="u" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="true"/>
+    </property>
+    <property name="Orderings" type="as" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="true"/>
+    </property>
+    <property name="ActivePlaylist" type="(b(oss))" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="true"/>
+    </property>
+    <signal name="PlaylistChanged">
+      <arg name="Playlist" type="(oss)"/>
+    </signal>
+  </interface>
+</node>
+""")

dbus2mqtt/dbus/introspection_patches/mpris_vlc.py

@@ -0,0 +1,122 @@
+import dbus_fast.introspection as dbus_introspection
+
+# taken from https://code.videolan.org/videolan/vlc/-/blob/master/modules/control/dbus/dbus_introspect.h
+mpris_introspection_vlc = dbus_introspection.Node.parse("""\
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+  "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node>
+  <interface name="org.freedesktop.DBus.Introspectable">
+    <method name="Introspect">
+      <arg name="data" direction="out" type="s"/>
+    </method>
+  </interface>
+
+  <interface name="org.freedesktop.DBus.Properties">
+    <method name="Get">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="v"/>
+    </method>
+    <method name="Set">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="v"/>
+    </method>
+    <method name="GetAll">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="a{sv}"/>
+    </method>
+    <signal name="PropertiesChanged">
+      <arg type="s"/>
+      <arg type="a{sv}"/>
+      <arg type="as"/>
+    </signal>
+  </interface>
+
+  <interface name="org.mpris.MediaPlayer2">
+    <property name="CanQuit" type="b" access="read"/>
+    <property name="Fullscreen" type="b" access="readwrite"/>
+    <property name="CanSetFullscreen" type="b" access="read"/>
+    <property name="CanRaise" type="b" access="read"/>
+    <property name="HasTrackList" type="b" access="read"/>
+    <property name="Identity" type="s" access="read"/>
+    <property name="DesktopEntry" type="s" access="read"/>
+    <property name="SupportedUriSchemes" type="as" access="read"/>
+    <property name="SupportedMimeTypes" type="as" access="read"/>
+    <method name="Raise"/>
+    <method name="Quit"/>
+  </interface>
+
+  <interface name="org.mpris.MediaPlayer2.Player">
+    <property name="PlaybackStatus" type="s" access="read"/>
+    <property name="LoopStatus" type="s" access="readwrite"/>
+    <property name="Rate" type="d" access="readwrite"/>
+    <property name="Shuffle" type="b" access="readwrite"/>
+    <property name="Metadata" type="a{sv}" access="read"/>
+    <property name="Volume" type="d" access="readwrite"/>
+    <property name="Position" type="x" access="read"/>
+    <property name="MinimumRate" type="d" access="read"/>
+    <property name="MaximumRate" type="d" access="read"/>
+    <property name="CanGoNext" type="b" access="read"/>
+    <property name="CanGoPrevious" type="b" access="read"/>
+    <property name="CanPlay" type="b" access="read"/>
+    <property name="CanPause" type="b" access="read"/>
+    <property name="CanSeek" type="b" access="read"/>
+    <property name="CanControl" type="b" access="read"/>
+    <method name="Next"/>
+    <method name="Previous"/>
+    <method name="Pause"/>
+    <method name="PlayPause"/>
+    <method name="Stop"/>
+    <method name="Play"/>
+    <method name="Seek">
+      <arg type="x" direction="in"/>
+    </method>
+    <method name="SetPosition">
+      <arg type="o" direction="in"/>
+      <arg type="x" direction="in"/>
+    </method>
+    <method name="OpenUri">
+      <arg type="s" direction="in"/>
+    </method>
+    <signal name="Seeked">
+      <arg type="x"/>
+    </signal>
+  </interface>
+
+  <interface name="org.mpris.MediaPlayer2.TrackList">
+    <property name="Tracks" type="ao" access="read"/>
+    <property name="CanEditTracks" type="b" access="read"/>
+    <method name="GetTracksMetadata">
+      <arg type="ao" direction="in"/>
+      <arg type="aa{sv}" direction="out"/>
+    </method>
+    <method name="AddTrack">
+      <arg type="s" direction="in"/>
+      <arg type="o" direction="in"/>
+      <arg type="b" direction="in"/>
+    </method>
+    <method name="RemoveTrack">
+      <arg type="o" direction="in"/>
+    </method>
+    <method name="GoTo">
+      <arg type="o" direction="in"/>
+    </method>
+    <signal name="TrackListReplaced">
+      <arg type="ao"/>
+      <arg type="o"/>
+    </signal>
+    <signal name="TrackAdded">
+      <arg type="a{sv}"/>
+      <arg type="o"/>
+    </signal>
+    <signal name="TrackRemoved">
+      <arg type="o"/>
+    </signal>
+    <signal name="TrackMetadataChanged">
+      <arg type="o"/>
+      <arg type="a{sv}"/>
+    </signal>
+  </interface>
+</node>
+""")

dbus2mqtt/event_broker.py

@@ -37,7 +37,7 @@ class FlowTriggerMessage:
     flow_config: FlowConfig
     flow_trigger_config: FlowTriggerConfig
     timestamp: datetime
-    context: dict[str, Any] | None = None
+    trigger_context: dict[str, Any] | None = None
 
 class EventBroker:
     def __init__(self):

dbus2mqtt/flow/actions/mqtt_publish.py

@@ -1,6 +1,8 @@
 
 import logging
 
+from urllib.parse import urlparse
+
 from jinja2.exceptions import TemplateError
 
 from dbus2mqtt import AppContext
@@ -26,11 +28,21 @@ class MqttPublishAction(FlowAction):
 
             if self.config.payload_type == "text":
                 res_type = str
+            elif self.config.payload_type == "binary":
+                res_type = str
             else:
                 res_type = dict
 
             payload = await self.templating.async_render_template(self.config.payload_template, res_type, render_context)
 
+            # for binary payloads, payload contains the file to read binary data from
+            if isinstance(payload, str) and self.config.payload_type == "binary":
+                uri = payload
+                payload = urlparse(uri)
+                if not payload.scheme == "file":
+                    raise ValueError(f"Expected readable file, got: '{uri}'")
+
+
         except TemplateError as e:
             logger.warning(f"Error rendering jinja template, flow: '{context.name or ''}', msg={e}, payload_template={self.config.payload_template}, render_context={render_context}", exc_info=True)
             return

dbus2mqtt/flow/flow_processor.py

@@ -7,7 +7,7 @@ from typing import Any
 from apscheduler.schedulers.asyncio import AsyncIOScheduler
 
 from dbus2mqtt import AppContext
-from dbus2mqtt.config import FlowConfig, FlowTriggerConfig
+from dbus2mqtt.config import FlowConfig, FlowTriggerConfig, FlowTriggerDbusSignalConfig
 from dbus2mqtt.event_broker import FlowTriggerMessage
 from dbus2mqtt.flow import FlowAction, FlowExecutionContext
 from dbus2mqtt.flow.actions.context_set import ContextSetAction
@@ -46,6 +46,7 @@ class FlowScheduler:
                     if not existing_job and trigger.type == "schedule":
                         logger.info(f"Starting scheduler[{trigger.id}] for flow {flow.id}")
                         if trigger.interval:
+                            trigger_args: dict[str, Any] = trigger.interval
                             # Each schedule gets its own job
                             self.scheduler.add_job(
                                 self._schedule_flow_strigger,
@@ -55,9 +56,10 @@ class FlowScheduler:
                                 misfire_grace_time=5,
                                 coalesce=True,
                                 args=[flow, trigger],
-                                **trigger.interval
+                                **trigger_args
                             )
                         elif trigger.cron:
+                            trigger_args: dict[str, Any] = trigger.cron
                             # Each schedule gets its own job
                             self.scheduler.add_job(
                                 self._schedule_flow_strigger,
@@ -67,7 +69,7 @@ class FlowScheduler:
                                 misfire_grace_time=5,
                                 coalesce=True,
                                 args=[flow, trigger],
-                                **trigger.cron
+                                **trigger_args
                             )
 
     def stop_flow_set(self, flows):
@@ -160,38 +162,38 @@ class FlowProcessor:
                 await self._process_flow_trigger(flow_trigger_message)
 
             except Exception as e:
-                logger.warning(f"flow_processor_task: Exception {e}", exc_info=True)
+                # exc_info is only set when running in verbose mode to avoid lots of stack traces being printed
+                # while flows are still running and the DBus object was just removed. Some examples:
+
+                log_level = logging.WARN
+
+                # 1: error during context_set
+                # WARNING:dbus2mqtt.flow.flow_processor:flow_processor_task: Exception The name org.mpris.MediaPlayer2.firefox.instance_1_672 was not provided by any .service files
+                if "was not provided by any .service files" in str(e):
+                    log_level = logging.DEBUG
+
+                logger.log(log_level, f"flow_processor_task: Exception {e}", exc_info=logger.isEnabledFor(logging.DEBUG))
             finally:
                 self.event_broker.flow_trigger_queue.async_q.task_done()
 
+    def _trigger_config_to_str(self, config: FlowTriggerConfig) -> str:
+        if isinstance(config, FlowTriggerDbusSignalConfig):
+            return f"{config.type}({config.signal})"
+        return config.type
+
     async def _process_flow_trigger(self, flow_trigger_message: FlowTriggerMessage):
-        log_message = f"on_trigger: {flow_trigger_message.flow_trigger_config.type}, time={flow_trigger_message.timestamp.isoformat()}"
+
+        trigger_str = self._trigger_config_to_str(flow_trigger_message.flow_trigger_config)
+        flow_str = flow_trigger_message.flow_config.name or flow_trigger_message.flow_config.id
+
+        log_message = f"on_trigger: {trigger_str}, flow={flow_str}, time={flow_trigger_message.timestamp.isoformat()}"
+
         if flow_trigger_message.flow_trigger_config.type != "schedule":
             logger.info(log_message)
         else:
             logger.debug(log_message)
 
         flow_id = flow_trigger_message.flow_config.id
-        # flow_name = flow_trigger_message.flow_config.name
 
         flow = self._flows[flow_id]
-        await flow.execute_actions(trigger_context=flow_trigger_message.context)
-
-# # Create a flow from the YAML configuration
-# for flow_config in config['flows']:
-#     flow_name = flow_config['name']
-#     triggers = flow_config.get('triggers', [])
-#     actions = flow_config.get('actions', [])
-
-#     with Flow(flow_name) as flow:
-#         data = "sensor_data"
-#         for action in actions:
-#             if action['type'] == 'python_script':
-#                 process_data(data)
-#             elif action['type'] == 'mqtt_publish':
-#                 mqtt_publish(action['topic'], action['message_template'], data)
-
-#         # Add scheduling trigger if defined
-#         for trigger in triggers:
-#             if trigger['type'] == 'schedule' and 'cron' in trigger:
-#                 flow.schedule = CronSchedule(cron=trigger['cron'])
+        await flow.execute_actions(trigger_context=flow_trigger_message.trigger_context)

dbus2mqtt/main.py

@@ -5,12 +5,12 @@ import sys
 from typing import cast
 
 import colorlog
-import dbus_next.aio as dbus_aio
+import dbus_fast.aio as dbus_aio
 import dotenv
-import jsonargparse
 
 from dbus2mqtt import AppContext
 from dbus2mqtt.config import Config
+from dbus2mqtt.config.jsonarparse import new_argument_parser
 from dbus2mqtt.dbus.dbus_client import DbusClient
 from dbus2mqtt.event_broker import EventBroker
 from dbus2mqtt.flow.flow_processor import FlowProcessor, FlowScheduler
@@ -41,14 +41,14 @@ async def dbus_processor_task(app_context: AppContext, flow_scheduler: FlowSched
 
 async def mqtt_processor_task(app_context: AppContext):
 
-    mqtt_client = MqttClient(app_context)
+    loop = asyncio.get_running_loop()
+    mqtt_client_run_future = loop.create_future()
+
+    mqtt_client = MqttClient(app_context, loop)
 
     mqtt_client.connect()
     mqtt_client.client.loop_start()
 
-    loop = asyncio.get_running_loop()
-    mqtt_client_run_future = loop.create_future()
-
     try:
         await asyncio.gather(
             mqtt_client_run_future,
@@ -84,6 +84,7 @@ async def run(config: Config):
     except asyncio.CancelledError:
         pass
 
+
 def main():
 
     # load environment from .env if it exists
@@ -92,8 +93,7 @@ def main():
         logger.info(f"Loaded environment variables from {dotenv_file}")
         dotenv.load_dotenv(dotenv_path=dotenv_file)
 
-    # unless specified otherwise, load config from config.yaml
-    parser = jsonargparse.ArgumentParser(default_config_files=["config.yaml"], default_env=True, env_prefix=False)
+    parser = new_argument_parser()
 
     parser.add_argument("--verbose", "-v", nargs="?", const=True, help="Enable verbose logging")
     parser.add_argument("--config", action="config")
@@ -123,4 +123,7 @@ def main():
 
     logger.debug(f"config: {config}")
 
-    asyncio.run(run(config))
+    try:
+        asyncio.run(run(config))
+    except KeyboardInterrupt:
+        return 0

dbus2mqtt/mqtt/mqtt_client.py

@@ -4,6 +4,8 @@ import json
 import logging
 
 from typing import Any
+from urllib.parse import ParseResult
+from urllib.request import urlopen
 
 import paho.mqtt.client as mqtt
 import yaml
@@ -18,7 +20,7 @@ logger = logging.getLogger(__name__)
 
 class MqttClient:
 
-    def __init__(self, app_context: AppContext):
+    def __init__(self, app_context: AppContext, loop):
         self.config = app_context.config.mqtt
         self.event_broker = app_context.event_broker
 
@@ -35,6 +37,9 @@ class MqttClient:
         self.client.on_connect = self.on_connect
         self.client.on_message = self.on_message
 
+        self.loop = loop
+        self.connected_event = asyncio.Event()
+
     def connect(self):
 
         # mqtt_client.on_message = lambda client, userdata, message: asyncio.create_task(mqtt_on_message(client, userdata, message))
@@ -52,34 +57,39 @@ class MqttClient:
             msg = await self.event_broker.mqtt_publish_queue.async_q.get()  # Wait for a message
 
             try:
-                payload = msg.payload
+                payload: str | bytes | None = msg.payload
                 type = msg.payload_serialization_type
-                if isinstance(msg.payload, dict):
-                    if type == "json":
-                        payload = json.dumps(msg.payload)
-                    elif type == "yaml":
-                        payload = yaml.dump(msg.payload)
-                elif type == "text":
-                    payload = str(payload)
+                if type == "text":
+                    payload = str(msg.payload)
+                if isinstance(msg.payload, dict) and type == "json":
+                    payload = json.dumps(msg.payload)
+                elif isinstance(msg.payload, dict) and type == "yaml":
+                    payload = yaml.dump(msg.payload)
+                elif isinstance(msg.payload, ParseResult) and type == "binary":
+                    try:
+                        with urlopen(msg.payload.geturl()) as response:
+                            payload = response.read()
+                    except Exception as e:
+                        # In case failing uri reads, we still publish an empty msg to avoid stale data
+                        payload = None
+                        logger.warning(f"mqtt_publish_queue_processor_task: Exception {e}", exc_info=logger.isEnabledFor(logging.DEBUG))
+
+                payload_log_msg = payload if isinstance(payload, str) else msg.payload
+                logger.debug(f"mqtt_publish_queue_processor_task: topic={msg.topic}, type={payload.__class__}, payload={payload_log_msg}")
 
-                logger.debug(f"mqtt_publish_queue_processor_task: payload={payload}")
-                self.client.publish(topic=msg.topic, payload=payload)
+                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)
                 if first_message:
-                    logger.info(f"First message published: topic={msg.topic}, payload={payload}")
+                    logger.info(f"First message published: topic={msg.topic}, payload={payload_log_msg}")
                     first_message = False
 
             except Exception as e:
-                logger.warning(f"mqtt_publish_queue_processor_task: Exception {e}", exc_info=True)
+                logger.warning(f"mqtt_publish_queue_processor_task: Exception {e}", exc_info=logger.isEnabledFor(logging.DEBUG))
             finally:
                 self.event_broker.mqtt_publish_queue.async_q.task_done()
 
-
-    async def run(self):
-        """Runs the MQTT loop in a non-blocking way with asyncio."""
-        self.client.loop_start()  # Runs Paho's loop in a background thread
-        await asyncio.Event().wait()  # Keeps the coroutine alive
-
     # The callback for when the client receives a CONNACK response from the server.
     def on_connect(self, client: mqtt.Client, userdata, flags, reason_code, properties):
         if reason_code.is_failure:
@@ -90,6 +100,8 @@ class MqttClient:
             # reconnect then subscriptions will be renewed.
             client.subscribe("dbus2mqtt/#", options=SubscribeOptions(noLocal=True))
 
+            self.loop.call_soon_threadsafe(self.connected_event.set)
+
     def on_message(self, client: mqtt.Client, userdata: Any, msg: mqtt.MQTTMessage):
 
         payload = msg.payload.decode()

dbus2mqtt/template/dbus_template_functions.py

@@ -3,8 +3,8 @@ import logging
 
 from typing import Any
 
-from dbus_next.constants import ErrorType
-from dbus_next.errors import DBusError
+from dbus_fast.constants import ErrorType
+from dbus_fast.errors import DBusError
 
 from dbus2mqtt.dbus.dbus_client import DbusClient
 

dbus2mqtt/template/templating.py

@@ -41,6 +41,9 @@ class TemplateEngine:
 
     def _convert_value(self, res: Any, res_type: type[TemplateResultType]) -> TemplateResultType:
 
+        if res is None:
+            return res
+
         if isinstance(res, res_type):
             return res
 

{dbus2mqtt-0.2.0.dist-info → dbus2mqtt-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-Version: 0.2.0
+Version: 0.3.1
 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
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Requires-Dist: apscheduler>=3.11.0
 Requires-Dist: colorlog>=6.9.0
-Requires-Dist: dbus-next>=0.2.3
+Requires-Dist: dbus-fast>=2.44.1
 Requires-Dist: janus>=2.0.0
 Requires-Dist: jinja2-ansible-filters>=1.3.2
 Requires-Dist: jinja2>=3.1.6
@@ -111,7 +111,7 @@ cp docs/examples/home_assistant_media_player.yaml $HOME/.config/dbus2mqtt/config
 cp .env.example $HOME/.config/dbus2mqtt/.env
 
 # run image and automatically start on reboot
-sudo docker pull jwnmulder/dbus2mqtt
+docker pull jwnmulder/dbus2mqtt
 docker run --detach --name dbus2mqtt \
   --volume "$HOME"/.config/dbus2mqtt:"$HOME"/.config/dbus2mqtt \
   --volume /run/user:/run/user \
@@ -138,7 +138,7 @@ dbus2mqtt leverages [jsonargparse](https://jsonargparse.readthedocs.io/en/stable
 ### MQTT and D-Bus connection details
 
 ```bash
-# dbus_next configuration
+# dbus_fast configuration
 export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus
 
 # dbus2mqtt configuration
@@ -171,7 +171,9 @@ dbus:
             - method: Play
 ```
 
-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`
+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
 
 ```json
 {

dbus2mqtt-0.3.1.dist-info/RECORD

@@ -0,0 +1,23 @@
+dbus2mqtt/__init__.py,sha256=VunubKEH4_lne9Ttd2YRpyXjZMIAzyD2eiJ2sfvvTFU,362
+dbus2mqtt/__main__.py,sha256=NAoa3nwgBSQI22eWzzRx61SIDThDwXmUofWWZU3_4-Q,71
+dbus2mqtt/event_broker.py,sha256=WNup2Xywt2MYs1yDyKAytApJn_YOPnxQag3kOkOajX0,1844
+dbus2mqtt/main.py,sha256=pHsRbjjvQSAOWhmfazixKteAdfrB-YnC4LQAZovdkEQ,3863
+dbus2mqtt/config/__init__.py,sha256=lx94zQsejGMRf90h594jId_CKXY0CyL7n6hk3lwAVvE,4307
+dbus2mqtt/config/jsonarparse.py,sha256=VJGFeyQJcOE6bRXlSRr3FClvN_HnmiIlEGmOgNM0oCc,1214
+dbus2mqtt/dbus/dbus_client.py,sha256=LAP6QkjPvDHIXOKncHiNYrTnVEV2NRYc1Mymzp-miMY,23217
+dbus2mqtt/dbus/dbus_types.py,sha256=EejiLlh3ALAnB4OFvNRL4ILBbxSKgFNNwifBrfap1Gc,494
+dbus2mqtt/dbus/dbus_util.py,sha256=Q50Tr1qjqZHpVirzvT9gXYwiCLwPe6BpgVmAcrqdHKE,569
+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=TR30RpN0DoKWgx3Il-wyIzGwRqTjXyEUlqar3S3E3SI,8215
+dbus2mqtt/flow/actions/context_set.py,sha256=dIT39MJJVb0wuRI_ZM3ssnXYfa-iyB4o_UZD-1BZL2g,1087
+dbus2mqtt/flow/actions/mqtt_publish.py,sha256=psNkTvaR3JZwAwpM4AqiZTDnA5UQX9r4CUZ1LA7iRW4,2366
+dbus2mqtt/mqtt/mqtt_client.py,sha256=9Y0AEuquq4gEQ8j9JD1wauU22wSHZFSyQBNr905lwxA,4899
+dbus2mqtt/template/dbus_template_functions.py,sha256=0WXH-X3Si5D8iKP1WrSK9XmbKcaTGQo92SJsfHG0JEE,2427
+dbus2mqtt/template/templating.py,sha256=ZLp1A8PFAs_-Bndx4yGqyppaDfh8marHlK7P3bFInu4,4144
+dbus2mqtt-0.3.1.dist-info/METADATA,sha256=5xbhQusP8EUrvvMuN6rK2MUWBNKMgWOu1XkfADaGSd8,7830
+dbus2mqtt-0.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dbus2mqtt-0.3.1.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
+dbus2mqtt-0.3.1.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
+dbus2mqtt-0.3.1.dist-info/RECORD,,

dbus2mqtt-0.2.0.dist-info/RECORD

@@ -1,20 +0,0 @@
-dbus2mqtt/__init__.py,sha256=VunubKEH4_lne9Ttd2YRpyXjZMIAzyD2eiJ2sfvvTFU,362
-dbus2mqtt/__main__.py,sha256=NAoa3nwgBSQI22eWzzRx61SIDThDwXmUofWWZU3_4-Q,71
-dbus2mqtt/config.py,sha256=aTAWR4G1y12-96w1db2rjdCafEy6gF9gAiNFcW3Sz4M,4152
-dbus2mqtt/event_broker.py,sha256=GG7vZZHu08vJgCH5cA-yw3yWU3I2wWHhiEFNMHA4oJk,1836
-dbus2mqtt/main.py,sha256=1zodEH7s-u75eY4fYLSpV-mtcCV_VL38Do2VXLinrh4,3898
-dbus2mqtt/dbus/dbus_client.py,sha256=Y5upYGX84TCZRzJb7cQhxv9irXBfxo6bFmUil-jdlo4,22005
-dbus2mqtt/dbus/dbus_types.py,sha256=bUik8LWPnLLJhhJExPuvyn1_MmkUjTn4jxXh3EkYgzI,495
-dbus2mqtt/dbus/dbus_util.py,sha256=kAqA9SPR1N45fzXeXmBXlhulFEIFKrOIvr_LeygO928,569
-dbus2mqtt/flow/__init__.py,sha256=tAL-CjXQHq_tGTKctIdOZ5teVKBtcJs6Astq_RdruV8,1540
-dbus2mqtt/flow/flow_processor.py,sha256=v5LvcNe-IpEXkWgBW0mK76khrqb5aFkZF0Nw2IvxIEs,7834
-dbus2mqtt/flow/actions/context_set.py,sha256=dIT39MJJVb0wuRI_ZM3ssnXYfa-iyB4o_UZD-1BZL2g,1087
-dbus2mqtt/flow/actions/mqtt_publish.py,sha256=-qQtyc1KspPzAus3AK0iO629RP3RIAMwUecMqqBIrRY,1878
-dbus2mqtt/mqtt/mqtt_client.py,sha256=xUJzkkv2uE3xWy0-SINeRjwfMNnDNLytdxEe3ahIIvk,4006
-dbus2mqtt/template/dbus_template_functions.py,sha256=mSZr4s7XzmMCYnJYV1MlBWOBz71MGEBj6mLJzIapNf8,2427
-dbus2mqtt/template/templating.py,sha256=phmh18uslexw1CmjYHotMHc4zfzIEUflwLnrnBGfAVs,4096
-dbus2mqtt-0.2.0.dist-info/METADATA,sha256=qwjAjBYoDxEsbFkwZXnhEW7hzwXICEd4qFj8sdo8xTw,7750
-dbus2mqtt-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dbus2mqtt-0.2.0.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
-dbus2mqtt-0.2.0.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
-dbus2mqtt-0.2.0.dist-info/RECORD,,