dbus2mqtt 0.3.1__tar.gz → 0.4.0__tar.gz

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/.github/workflows/docker-stable.yml

@@ -63,6 +63,8 @@ jobs:
           # type=ref,event=branch
           # type=ref,event=pr
           # type=semver,pattern={{version}},value=${{ matrix.version }}
+          flavor:
+            latest=false
           labels: |
             org.opencontainers.image.source=https://github.com/jwnmulder/dbus2mqtt
 

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/.pre-commit-config.yaml

@@ -33,7 +33,7 @@ repos:
           - --strict
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.9
+    rev: v0.11.13
     hooks:
       - id: ruff
         args:
@@ -42,11 +42,11 @@ repos:
           - I
 
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.7.3
+    rev: 0.7.13
     hooks:
       - id: uv-lock
 
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.400
+    rev: v1.1.402
     hooks:
       - id: pyright

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/.vscode/launch.json

@@ -8,6 +8,14 @@
             "module": "dbus2mqtt",
             "console": "integratedTerminal",
             "args": "--config docs/examples/home_assistant_media_player.yaml"
+        },
+        {
+            "name": "dbus2mqtt - bluez",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "dbus2mqtt",
+            "console": "integratedTerminal",
+            "args": "--config docs/examples/bluez.yaml"
         }
     ]
 }

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-Version: 0.3.1
+Version: 0.4.0
 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" \

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/README.md

@@ -21,7 +21,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:
@@ -36,7 +36,7 @@ dbus:
       flows:
         - name: "Publish MPRIS state"
           triggers:
-            - type: bus_name_added
+            - type: object_added
             - type: schedule
               interval: {seconds: 5}
           actions:
@@ -79,8 +79,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" \

dbus2mqtt-0.4.0/docs/examples/bluez.md

@@ -0,0 +1,19 @@
+# Bluez
+
+This configuration file demonstrates how to use dbus2mqtt to bridge D-Bus events from BlueZ (the official Linux Bluetooth protocol stack) to MQTT topics. It subscribes to relevant D-Bus signals and properties for both the Bluetooth adapter (`hci0`) and all Bluetooth devices managed by BlueZ. The configuration defines flows that:
+
+* Monitor property changes and object lifecycle events (added/removed) for the Bluetooth adapter and devices.
+* Retrieve the current state of the adapter or device using the `GetAll` method from the `org.freedesktop.DBus.Properties` interface.
+* Publish the retrieved state as JSON payloads to structured MQTT topics, enabling real-time monitoring and integration with home automation or IoT systems.
+
+This setup allows MQTT clients to receive updates about Bluetooth adapter and device states, as well as notifications when devices are removed, making it easier to integrate Bluetooth events into broader automation workflows.
+
+Configuration activities
+
+* dbus2mqtt setup using the supplied [bluez.yaml](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/bluez.yaml)
+
+Execute the following command to run dbus2mqtt with the example configuration in this repository.
+
+```bash
+uv run dbus2mqtt --config docs/examples/bluez.yaml
+```

dbus2mqtt-0.4.0/docs/examples/bluez.yaml

@@ -0,0 +1,66 @@
+dbus:
+  bus_type: SYSTEM
+  subscriptions:
+
+    - bus_name: org.bluez
+      path: /org/bluez/hci0
+
+      interfaces:
+        - interface: org.freedesktop.DBus.Properties
+          signals:
+            - signal: PropertiesChanged
+          methods:
+            - method: GetAll
+
+      flows:
+        - name: "publish adapter state"
+          triggers:
+            - type: object_added
+            - type: dbus_signal
+              interface: org.freedesktop.DBus.Properties
+              signal: PropertiesChanged
+          actions:
+            - type: context_set
+              context:
+                adapter_properties: |
+                  {{ dbus_call('org.bluez', '/org/bluez/hci0', 'org.freedesktop.DBus.Properties', 'GetAll', ['org.bluez.Adapter1']) }}
+            - type: mqtt_publish
+              topic: dbus2mqtt/bluez/hci0
+              payload_type: json
+              payload_template:
+                hci0: "{{ adapter_properties }}"
+
+    - bus_name: org.bluez
+      path: /org/bluez/hci0/dev_*
+
+      interfaces:
+        - interface: org.freedesktop.DBus.Properties
+          signals:
+            - signal: PropertiesChanged
+          methods:
+            - method: GetAll
+
+      flows:
+        - name: "publish device state"
+          triggers:
+            - type: object_added
+            - type: dbus_signal
+              interface: org.freedesktop.DBus.Properties
+              signal: PropertiesChanged
+          actions:
+            - type: context_set
+              context:
+                device_properties: |
+                  {{ dbus_call('org.bluez', path, 'org.freedesktop.DBus.Properties', 'GetAll', ['org.bluez.Device1']) }}
+            - type: mqtt_publish
+              topic: dbus2mqtt/bluez/{{ path | replace('/org/bluez/', '') }}
+              payload_type: json
+              payload_template: "{{ device_properties }}"
+        - name: "device removed"
+          triggers:
+            - type: object_removed
+          actions:
+            - type: mqtt_publish
+              topic: dbus2mqtt/bluez/{{ path | replace('/org/bluez/', '') }}
+              payload_type: json
+              payload_template: "{{ None }}"

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/docs/examples/dbus2mqtt_internal_state.yaml

@@ -28,7 +28,7 @@ dbus:
 flows:
   - name: "publish internal state"
     triggers:
-      - type: bus_name_added
+      - type: object_added
       - type: schedule
         interval: {seconds: 5}
     actions:

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/docs/examples/home_assistant_media_player.md

@@ -19,7 +19,7 @@ Features:
 Configuration activities
 
 * MQTT Sensor and player configuration in Home Assistant (see below)
-* dbus2mqtt setup using the supplied `home_assistant_media_player.yaml`
+* dbus2mqtt setup using the supplied [home_assistant_media_player.yaml](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.yaml)
 
 Execute the following command to run dbus2mqtt with the example configuration in this repository.
 
@@ -36,6 +36,8 @@ The following setup is known to work with Home Assistant.
 | `Firefox`    | ✅ | ✅ | ✅ | ✅ |    | ❌ | ✅ | ✅ |  |
 | `VLC`        | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |    |  |
 | `Chromium`   | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ✅ | ✔️ | Images not working when Chromium is running as snap |
+| `Kodi`       | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | Requires Kodi plugin [MediaPlayerRemoteInterface](https://github.com/wastis/MediaPlayerRemoteInterface)<br /> Requires path to be set to '/'<br />Signals not working due to non-defaut path |
+
 
 More players that support MPRIS can be found here: <https://wiki.archlinux.org/title/MPRIS>
 
@@ -97,7 +99,12 @@ media_player:
         media_content_type_template: music  # needed to show 'artist'
         media_duration_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('mpris:length', 0) }}"
         album_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('xesam:album', '') }}"
-        artist_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('xesam:artist', ['']) | first }}"
+        artist_template: >-
+          {% set artist = (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('xesam:artist', '') %}
+          {% if artist is string %}
+          {% set artist = [artist] %}
+          {% endif %}
+          {{ artist | first }}
 
         # mpris:artUrl might contain a file:// schema. In these cases we rely on images published via MQTT
         media_image_url_template: >-

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/docs/examples/home_assistant_media_player.yaml

@@ -42,7 +42,7 @@ dbus:
       flows:
         - name: "publish player state"
           triggers:
-            - type: bus_name_added
+            - type: object_added
             - type: schedule
               interval: {seconds: 5}
             - type: dbus_signal
@@ -57,6 +57,9 @@ dbus:
               context:
                 mpris_bus_name: '{{ dbus_list("org.mpris.MediaPlayer2.*") | first }}'
                 mpris_path: /org/mpris/MediaPlayer2
+                # Some players return stale position if GetAll is executed immediately after a seeked signal.
+                # By storing the seeked position it can be used to override Position below
+                seeked_position: '{{ args[0] if trigger_type == "dbus_signal" and signal == "Seeked" else None }}'
             - type: context_set
               context:
                 player_properties: |
@@ -68,13 +71,14 @@ dbus:
                 {{
                     { 'bus_name': mpris_bus_name }
                     | combine(player_properties)
+                    | combine ({ 'Position': seeked_position } if seeked_position else {})
                 }}
 
         - name: "publish local art image"
           # mpris:artUrl can have a file:// or http:// schema
           # Home Assistant is unable to access file:// so we use MQTT for that
           triggers:
-            - type: bus_name_added
+            - type: object_added
             - type: dbus_signal
               interface: org.freedesktop.DBus.Properties
               signal: PropertiesChanged
@@ -90,7 +94,7 @@ dbus:
 
         - name: "player removed"
           triggers:
-            - type: bus_name_removed
+            - type: object_removed
             # filter: # TODO: Check if this is the last or inactive one #
           actions:
             - type: mqtt_publish

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/docs/examples/linux_desktop.md

@@ -5,7 +5,7 @@
 Trying out this example
 
 ```bash
-uv run dbus2mqtt --config docs/linux_desktop.yaml
+uv run dbus2mqtt --config docs/examples/linux_desktop.yaml
 ```
 
 This example shows how this dbus2mqtt can act as a bridge between the MPRIS player and Home Assistant.

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/docs/examples/linux_desktop.yaml

@@ -25,7 +25,7 @@ dbus:
       flows:
         - name: "publish state at startup and schedule"
           triggers:
-            - type: bus_name_added
+            - type: object_added
             - type: schedule
               interval: {seconds: 5}
           actions:

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/docs/examples.md

@@ -1,4 +1,5 @@
 Examples in this repository
 
 * [MPRIS to Home Assistant Media Player integration](examples/home_assistant_media_player.md)
+* [bluez](examples/bluez.md)
 * [Publish dbus2mqtt internal state](examples/dbus2mqtt_internal_state.md)

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/docs/flows.md

@@ -6,8 +6,8 @@ Flows can be defined on a global or dbus subscription level and can be triggered
 
 * `schedule` for cron based schedules
 * `dbus_signal` for when dbus signal occur
-* `bus_name_added` when a new bus_name is registered on dbus
-* `bus_name_removed` when a bus_name is removed from dbus
+* `object_added` when a new bus_name is registered on dbus
+* `object_removed` when a bus_name is removed from dbus
 
 Within each flow a set of actions can be configured. These are executed in order
 
@@ -53,14 +53,15 @@ When triggered, the following context parameters are available
 | name | type | description |
 |------|------|-------------|
 | bus_name  | string | bus_name of the object that was registered on dbus |
-| path      | string | bus_name path of the object that was registered on dbus |
+| path      | string | path of the object that was registered on dbus |
 | interface | string | name of interface for which the signal was triggered |
+| signal    | string | name of the signal, e.g. 'Seeked'
 | args      | list   | signal arguments, list of objects |
 
-### bus_name_added
+### object_added
 
 ```yaml
-type: bus_name_added
+type: object_added
 ```
 
 When triggered, the following context parameters are available
@@ -68,12 +69,12 @@ When triggered, the following context parameters are available
 | name | description |
 |------|-------------|
 | bus_name | bus_name of the object that was registered on dbus |
-| path     | bus_name path of the object that was registered on dbus |
+| path     | path of the object that was registered on dbus |
 
-### bus_name_removed
+### object_removed
 
 ```yaml
-type: bus_name_removed
+type: object_removed
 ```
 
 When triggered, the following context parameters are available
@@ -81,7 +82,7 @@ When triggered, the following context parameters are available
 | name | description |
 |------|-------------|
 | bus_name | bus_name of the object that was registered on dbus |
-| path     | bus_name path of the object that was registered on dbus |
+| path     | path of the object that was registered on dbus |
 
 ## Flow actions
 

{dbus2mqtt-0.3.1 → dbus2mqtt-0.4.0}/src/dbus2mqtt/config/__init__.py

@@ -1,5 +1,6 @@
 import fnmatch
 import uuid
+import warnings
 
 from dataclasses import dataclass, field
 from typing import Annotated, Any, Literal
@@ -65,15 +66,29 @@ class FlowTriggerDbusSignalConfig:
 @dataclass
 class FlowTriggerBusNameAddedConfig:
     type: Literal["bus_name_added"] = "bus_name_added"
-    # filter: str | None = None
+
+    def __post_init__(self):
+        warnings.warn(f"{self.type} flow trigger may be removed in a future version.", DeprecationWarning, stacklevel=2)
 
 @dataclass
 class FlowTriggerBusNameRemovedConfig:
     type: Literal["bus_name_removed"] = "bus_name_removed"
+
+    def __post_init__(self):
+        warnings.warn(f"{self.type} flow trigger may be removed in a future version.", DeprecationWarning, stacklevel=2)
+
+@dataclass
+class FlowTriggerObjectAddedConfig:
+    type: Literal["object_added"] = "object_added"
+    # filter: str | None = None
+
+@dataclass
+class FlowTriggerObjectRemovedConfig:
+    type: Literal["object_removed"] = "object_removed"
     # filter: str | None = None
 
 FlowTriggerConfig = Annotated[
-    FlowTriggerMqttConfig | FlowTriggerScheduleConfig | FlowTriggerDbusSignalConfig | FlowTriggerBusNameAddedConfig | FlowTriggerBusNameRemovedConfig,
+    FlowTriggerMqttConfig | FlowTriggerScheduleConfig | FlowTriggerDbusSignalConfig | FlowTriggerBusNameAddedConfig | FlowTriggerBusNameRemovedConfig | FlowTriggerObjectAddedConfig | FlowTriggerObjectRemovedConfig,
     Field(discriminator="type")
 ]
 
@@ -117,6 +132,7 @@ class SubscriptionConfig:
 @dataclass
 class DbusConfig:
     subscriptions: list[SubscriptionConfig]
+    bus_type: Literal["SESSION", "SYSTEM"] = "SESSION"
 
     def is_bus_name_configured(self, bus_name: str) -> bool:
 
@@ -125,11 +141,14 @@ class DbusConfig:
                 return True
         return False
 
-    def get_subscription_configs(self, bus_name: str, path: str) -> list[SubscriptionConfig]:
+    def get_subscription_configs(self, bus_name: str, path: str|None = None) -> list[SubscriptionConfig]:
         res: list[SubscriptionConfig] = []
         for subscription in self.subscriptions:
-            if fnmatch.fnmatchcase(bus_name, subscription.bus_name) and path == subscription.path:
-                res.append(subscription)
+            if fnmatch.fnmatchcase(bus_name, subscription.bus_name):
+                if not path or path == subscription.path:
+                    res.append(subscription)
+                elif fnmatch.fnmatchcase(path, subscription.path):
+                    res.append(subscription)
         return res
 
 @dataclass