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

dbus2mqtt/dbus/dbus_types.py

@@ -1,23 +1,37 @@
 
 
 from dataclasses import dataclass
+from typing import Any
 
 import dbus_fast.aio as dbus_aio
 
-from dbus2mqtt.config import InterfaceConfig, SubscriptionConfig
+from dbus2mqtt.config import (
+    SignalConfig,
+    SubscriptionConfig,
+)
 
 
 class BusNameSubscriptions:
 
-    def __init__(self, bus_name: str):
+    def __init__(self, bus_name: str, unique_name: str):
         self.bus_name = bus_name
+        self.unique_name = unique_name
         self.path_objects: dict[str, dbus_aio.proxy_object.ProxyObject] = {}
 
 @dataclass
 class SubscribedInterface:
 
-    interface_config: InterfaceConfig
+    # interface_config: InterfaceConfig
     subscription_config: SubscriptionConfig
     bus_name: str
     path: str
     interface_name: str
+
+@dataclass
+class DbusSignalWithState:
+    bus_name: str
+    path: str
+    interface_name: str
+    subscription_config: SubscriptionConfig
+    signal_config: SignalConfig
+    args: list[Any]

dbus2mqtt/dbus/dbus_util.py

@@ -1,19 +1,20 @@
-import json
+import base64
 import re
 
 import dbus_fast.signature as dbus_signature
 
 
-def _variant_serializer(obj):
-    if isinstance(obj, dbus_signature.Variant):
-        return obj.value
-    return obj
-
-def unwrap_dbus_object(o):
-    # 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
+def unwrap_dbus_object(obj):
+    if isinstance(obj, dict):
+        return {k: unwrap_dbus_object(v) for k, v in obj.items()}
+    elif isinstance(obj, list | tuple | set):
+        return type(obj)(unwrap_dbus_object(i) for i in obj)
+    elif isinstance(obj, dbus_signature.Variant):
+        return unwrap_dbus_object(obj.value)
+    elif isinstance(obj, bytes):
+        return base64.b64encode(obj).decode('utf-8')
+    else:
+        return obj
 
 def unwrap_dbus_objects(args):
     res = [unwrap_dbus_object(o) for o in args]

dbus2mqtt/event_broker.py

@@ -7,12 +7,7 @@ from typing import Any
 
 import janus
 
-from dbus2mqtt.config import (
-    FlowConfig,
-    FlowTriggerConfig,
-    SignalConfig,
-    SubscriptionConfig,
-)
+from dbus2mqtt.config import FlowConfig, FlowTriggerConfig
 
 logger = logging.getLogger(__name__)
 
@@ -23,15 +18,6 @@ class MqttMessage:
     payload: Any
     payload_serialization_type: str = "json"
 
-@dataclass
-class DbusSignalWithState:
-    bus_name: str
-    path: str
-    interface_name: str
-    subscription_config: SubscriptionConfig
-    signal_config: SignalConfig
-    args: list[Any]
-
 @dataclass
 class FlowTriggerMessage:
     flow_config: FlowConfig
@@ -43,7 +29,6 @@ class EventBroker:
     def __init__(self):
         self.mqtt_receive_queue = janus.Queue[MqttMessage]()
         self.mqtt_publish_queue = janus.Queue[MqttMessage]()
-        self.dbus_signal_queue = janus.Queue[DbusSignalWithState]()
         self.flow_trigger_queue = janus.Queue[FlowTriggerMessage]()
         # self.dbus_send_queue: janus.Queue
 
@@ -51,7 +36,6 @@ class EventBroker:
         await asyncio.gather(
             self.mqtt_receive_queue.aclose(),
             self.mqtt_publish_queue.aclose(),
-            self.dbus_signal_queue.aclose(),
             self.flow_trigger_queue.aclose(),
             return_exceptions=True
         )
@@ -63,7 +47,3 @@ class EventBroker:
     async def publish_to_mqtt(self, msg: MqttMessage):
         # logger.debug("publish_to_mqtt")
         await self.mqtt_publish_queue.async_q.put(msg)
-
-    def on_dbus_signal(self, signal: DbusSignalWithState):
-        # logger.debug("on_dbus_signal")
-        self.dbus_signal_queue.sync_q.put(signal)

dbus2mqtt/flow/flow_processor.py

@@ -7,7 +7,13 @@ from typing import Any
 from apscheduler.schedulers.asyncio import AsyncIOScheduler
 
 from dbus2mqtt import AppContext
-from dbus2mqtt.config import FlowConfig, FlowTriggerConfig, FlowTriggerDbusSignalConfig
+from dbus2mqtt.config import (
+    FlowConfig,
+    FlowTriggerConfig,
+    FlowTriggerDbusSignalConfig,
+    FlowTriggerObjectAddedConfig,
+    FlowTriggerObjectRemovedConfig,
+)
 from dbus2mqtt.event_broker import FlowTriggerMessage
 from dbus2mqtt.flow import FlowAction, FlowExecutionContext
 from dbus2mqtt.flow.actions.context_set import ContextSetAction
@@ -103,7 +109,7 @@ class FlowActionContext:
 
         return res
 
-    async def execute_actions(self, trigger_context: dict[str, Any] | None):
+    async def execute_actions(self, trigger_type: str, trigger_context: dict[str, Any] | None):
 
         # per flow execution context
         context = FlowExecutionContext(
@@ -111,6 +117,8 @@ class FlowActionContext:
             global_flows_context=self.global_flows_context,
             flow_context=self.flow_context)
 
+        context.context["trigger_type"] = trigger_type
+
         if trigger_context:
             context.context.update(trigger_context)
 
@@ -176,14 +184,20 @@ class FlowProcessor:
             finally:
                 self.event_broker.flow_trigger_queue.async_q.task_done()
 
-    def _trigger_config_to_str(self, config: FlowTriggerConfig) -> str:
+    def _trigger_config_to_str(self, msg: FlowTriggerMessage) -> str:
+        config = msg.flow_trigger_config
         if isinstance(config, FlowTriggerDbusSignalConfig):
             return f"{config.type}({config.signal})"
+        elif isinstance(config, FlowTriggerObjectAddedConfig) or isinstance(config, FlowTriggerObjectRemovedConfig):
+            path = msg.trigger_context.get('path') if msg.trigger_context else None
+            if path:
+                return f"{config.type}({path})"
         return config.type
 
     async def _process_flow_trigger(self, flow_trigger_message: FlowTriggerMessage):
 
-        trigger_str = self._trigger_config_to_str(flow_trigger_message.flow_trigger_config)
+        trigger_type = flow_trigger_message.flow_trigger_config.type
+        trigger_str = self._trigger_config_to_str(flow_trigger_message)
         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()}"
@@ -196,4 +210,4 @@ class FlowProcessor:
         flow_id = flow_trigger_message.flow_config.id
 
         flow = self._flows[flow_id]
-        await flow.execute_actions(trigger_context=flow_trigger_message.trigger_context)
+        await flow.execute_actions(trigger_type, trigger_context=flow_trigger_message.trigger_context)

dbus2mqtt/main.py

@@ -8,6 +8,8 @@ import colorlog
 import dbus_fast.aio as dbus_aio
 import dotenv
 
+from dbus_fast import BusType
+
 from dbus2mqtt import AppContext
 from dbus2mqtt.config import Config
 from dbus2mqtt.config.jsonarparse import new_argument_parser
@@ -23,7 +25,8 @@ logger = logging.getLogger(__name__)
 
 async def dbus_processor_task(app_context: AppContext, flow_scheduler: FlowScheduler):
 
-    bus = dbus_aio.message_bus.MessageBus()
+    bus_type = BusType.SYSTEM if app_context.config.dbus.bus_type == "SYSTEM" else BusType.SESSION
+    bus = dbus_aio.message_bus.MessageBus(bus_type=bus_type)
 
     dbus_client = DbusClient(app_context, bus, flow_scheduler)
     app_context.templating.add_functions(jinja_custom_dbus_functions(dbus_client))
@@ -36,7 +39,8 @@ async def dbus_processor_task(app_context: AppContext, flow_scheduler: FlowSched
     await asyncio.gather(
         dbus_client_run_future,
         asyncio.create_task(dbus_client.dbus_signal_queue_processor_task()),
-        asyncio.create_task(dbus_client.mqtt_receive_queue_processor_task())
+        asyncio.create_task(dbus_client.mqtt_receive_queue_processor_task()),
+        asyncio.create_task(dbus_client.dbus_object_lifecycle_signal_processor_task())
     )
 
 async def mqtt_processor_task(app_context: AppContext):
@@ -103,9 +107,19 @@ def main():
 
     config: Config = cast(Config, parser.instantiate_classes(cfg))
 
+    class NamePartsFilter(logging.Filter):
+        def filter(self, record):
+            record.name_last = record.name.rsplit('.', 1)[-1]
+            # record.name_first = record.name.split('.', 1)[0]
+            # record.name_short = record.name
+            # if record.name.startswith("dbus2mqtt"):
+            #     record.name_short = record.name.split('.', 1)[-1]
+            return True
+
     handler = colorlog.StreamHandler(stream=sys.stdout)
+    handler.addFilter(NamePartsFilter())
     handler.setFormatter(colorlog.ColoredFormatter(
-        '%(log_color)s%(levelname)s:%(name)s:%(message)s',
+        '%(log_color)s%(levelname)s:%(name_last)s:%(message)s',
         log_colors={
             "DEBUG": "light_black",
             "WARNING": "yellow",

dbus2mqtt/mqtt/mqtt_client.py

@@ -2,6 +2,8 @@
 import asyncio
 import json
 import logging
+import random
+import string
 
 from typing import Any
 from urllib.parse import ParseResult
@@ -24,7 +26,9 @@ class MqttClient:
         self.config = app_context.config.mqtt
         self.event_broker = app_context.event_broker
 
+        unique_client_id_postfix = ''.join(random.choices(string.ascii_lowercase + string.digits, k=6))
         self.client = mqtt.Client(
+            client_id=f"dbus2mqtt-client-{unique_client_id_postfix}",
             protocol=mqtt.MQTTv5,
             callback_api_version=CallbackAPIVersion.VERSION2
         )
@@ -42,10 +46,10 @@ class MqttClient:
 
     def connect(self):
 
-        # mqtt_client.on_message = lambda client, userdata, message: asyncio.create_task(mqtt_on_message(client, userdata, message))
         self.client.connect_async(
             host=self.config.host,
-            port=self.config.port
+            port=self.config.port,
+            clean_start=mqtt.MQTT_CLEAN_START_FIRST_ONLY
         )
 
     async def mqtt_publish_queue_processor_task(self):
@@ -98,19 +102,22 @@ class MqttClient:
             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))
 
             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
+
         payload = msg.payload.decode()
         if msg.retain:
             logger.info(f"on_message: skipping msg with retain=True, topic={msg.topic}, payload={payload}")
             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/dbus_template_functions.py

@@ -32,7 +32,7 @@ class DbusContext:
             # Pylance will mentiod this line is unreachable. It is not as jinja2 can pass in any type
             raise ValueError("method_args must be a list")
 
-        proxy_object = self.dbus_client.get_proxy_object(bus_name, path)
+        proxy_object = self.dbus_client.get_subscribed_proxy_object(bus_name, path)
         if not proxy_object:
             raise ValueError(f"No matching subscription found for bus_name: {bus_name}, path: {path}")
 
@@ -42,7 +42,7 @@ class DbusContext:
 
     async def async_dbus_property_get_fn(self, bus_name: str, path: str, interface: str, property:str, default_unsupported: Any = None):
 
-        proxy_object = self.dbus_client.get_proxy_object(bus_name, path)
+        proxy_object = self.dbus_client.get_subscribed_proxy_object(bus_name, path)
         if not proxy_object:
             raise ValueError(f"No matching subscription found for bus_name: {bus_name}, path: {path}")
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-Version: 0.3.1
+Version: 0.4.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
@@ -53,7 +53,7 @@ Initial testing has focused on MPRIS integration. A table of tested MPRIS player
 
 ## Getting started with dbus2mqtt
 
-Create a `config.yaml` file with the contents shown below. This configuration will expose all bus properties from the `org.mpris.MediaPlayer2.Player` interface to MQTT on the `dbus2mqtt/org.mpris.MediaPlayer2/state` topic. Have a look at [docs/examples](docs/examples.md) for more examples
+Create a `config.yaml` file with the contents shown below. This configuration will expose all bus properties from the `org.mpris.MediaPlayer2.Player` interface to MQTT on the `dbus2mqtt/org.mpris.MediaPlayer2/state` topic. Have a look at [docs/examples](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples.md) for more examples
 
 ```yaml
 dbus:
@@ -68,7 +68,7 @@ dbus:
       flows:
         - name: "Publish MPRIS state"
           triggers:
-            - type: bus_name_added
+            - type: object_added
             - type: schedule
               interval: {seconds: 5}
           actions:
@@ -111,8 +111,8 @@ 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
-docker pull jwnmulder/dbus2mqtt
-docker run --detach --name dbus2mqtt \
+sudo docker pull jwnmulder/dbus2mqtt
+sudo docker run --detach --name dbus2mqtt \
   --volume "$HOME"/.config/dbus2mqtt:"$HOME"/.config/dbus2mqtt \
   --volume /run/user:/run/user \
   --env DBUS_SESSION_BUS_ADDRESS="$DBUS_SESSION_BUS_ADDRESS" \
@@ -173,21 +173,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

dbus2mqtt-0.4.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=Hp5yurhP8FkAO-y0l2grygHxR2e37ZQ7QScjcQDA2UU,1334
+dbus2mqtt/main.py,sha256=Kr2LRVxWcPDtNwCj8Eqz9TxtGLAVrV4q0nizKh1pLXc,4539
+dbus2mqtt/config/__init__.py,sha256=LXQg2cZ_vMvhAl7_cC6G3gxCaLCq9uaTfZqw7OEXkPQ,5104
+dbus2mqtt/config/jsonarparse.py,sha256=VJGFeyQJcOE6bRXlSRr3FClvN_HnmiIlEGmOgNM0oCc,1214
+dbus2mqtt/dbus/dbus_client.py,sha256=zWz9V0lbGzbb3AifqWrwkOaC9OdZtQbfHhkSSJfXMi8,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/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=R0ZNUmOr8Lg8s2TuUcjH3BvEPPlNK731tzO0tNVvqqs,5167
+dbus2mqtt/template/dbus_template_functions.py,sha256=UEoXK2PqDKF6jR4vTFHQwq58f5APnOJr7B1_I1zW8yM,2449
+dbus2mqtt/template/templating.py,sha256=ZLp1A8PFAs_-Bndx4yGqyppaDfh8marHlK7P3bFInu4,4144
+dbus2mqtt-0.4.1.dist-info/METADATA,sha256=LR9PxxTxJ6TcxHpa8YKg9E6uWRDWYRBbpQ5-o5QGTxQ,8114
+dbus2mqtt-0.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dbus2mqtt-0.4.1.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
+dbus2mqtt-0.4.1.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
+dbus2mqtt-0.4.1.dist-info/RECORD,,

dbus2mqtt-0.3.1.dist-info/RECORD

@@ -1,23 +0,0 @@
-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,,