dbus2mqtt 0.4.0__tar.gz → 0.4.2__tar.gz

{dbus2mqtt-0.4.0 → dbus2mqtt-0.4.2}/.github/release-drafter.yml

@@ -1,7 +1,8 @@
-name-template: 'v$RESOLVED_VERSION 🌈'
+name-template: 'v$RESOLVED_VERSION'
 tag-template: 'v$RESOLVED_VERSION'
 exclude-labels:
   - dependencies
+  - skip-changelog
 categories:
   - title: 🚨 Breaking changes
     labels:
@@ -13,13 +14,13 @@ categories:
   - title: 🐛 Bug Fixes
     labels:
       - bugfix
-  - title: 🧰 Maintenance
+  - title: 🧰 Misc
     labels:
       - chore
       - documentation
   - title: ⬆️ Dependency updates
     labels:
-      - "dependencies"
+      - dependencies
 exclude-contributors:
   - jwnmulder
 autolabeler:
@@ -38,15 +39,13 @@ version-resolver:
   minor:
     labels:
       - minor
-      - feature
-      - enhancement
       - breaking-change  # minor until we are on 1.x
   patch:
     labels:
       - patch
+      - feature  # patch until we are on 1.x
+      - enhancement  # patch until we are on 1.x
   default: patch
 change-template: '* $TITLE (#$NUMBER)'
 template: |
-  ## Changes
-
   $CHANGES

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

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

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

@@ -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 → dbus2mqtt-0.4.2}/README.md

@@ -1,7 +1,7 @@
 # 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**.
 
@@ -122,6 +122,8 @@ or
 mqtt:
   host: localhost
   port: 1883
+  subscription_topics:
+    - dbus2mqtt/#
 ```
 
 ### Exposing dbus methods
@@ -141,21 +143,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
@@ -182,7 +194,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 → dbus2mqtt-0.4.2}/docker/Dockerfile.dev

@@ -25,7 +25,7 @@ RUN --mount=type=cache,target=/root/.cache/uv \
     uv sync --frozen --no-dev
 
 # Then, use a final image without uv
-FROM python:3.13-slim-bookworm
+FROM python:3.13-slim-bookworm@sha256:6544e0e002b40ae0f59bc3618b07c1e48064c4faed3a15ae2fbd2e8f663e8283
 # It is important to use the image that matches the builder, as the path to the
 # Python executable must be the same, e.g., using `python:3.12-slim-bookworm`
 # will fail.

{dbus2mqtt-0.4.0 → dbus2mqtt-0.4.2}/docker/Dockerfile.pypi

@@ -1,4 +1,4 @@
-FROM python:3.13-slim-bookworm
+FROM python:3.13-slim-bookworm@sha256:6544e0e002b40ae0f59bc3618b07c1e48064c4faed3a15ae2fbd2e8f663e8283
 
 WORKDIR /app
 

dbus2mqtt-0.4.2/docs/examples/bluez.md

@@ -0,0 +1,37 @@
+# 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
+```
+
+## Commands
+
+The following table lists commands, their descriptions, and an example JSON payload for invoking them via MQTT.
+
+Dbus methods can be invoked by sendig the JSON payload to MQTT topic `dbus2mqtt/bluez/hci0/command`. Method calls will be done for all matching dbus objects.
+
+| Interface            | Method<br />Property  | Description                          | Example MQTT JSON Payload                          |
+|----------------------|-----------------------|--------------------------------------|-------------------------------------------------|
+| `org.bluez.Adapter1` | `StartDiscovery`      | Starts bluetooth discovery           | `{ "method": "StartDiscovery" }`                |
+| `org.bluez.Adapter1` | `StopDiscovery`       | Stops bluetooth discovery            | `{ "method": "StopDiscovery" }`                         |
+| `org.bluez.Device1` | `Connect`              |                                      | `{ "method": "Connect", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                |
+| `org.bluez.Device1` | `Disconnect`           |                                      | `{ "method": "Disconnect", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                         |
+| `org.bluez.Device1` | `Pair`                 |                                      | `{ "method": "Pair", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                |
+| `org.bluez.Device1` | `CancelPairing`        |                                      | `{ "method": "CancelPairing", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                         |
+
+
+https://manpages.ubuntu.com/manpages/noble/man5/org.bluez.

{dbus2mqtt-0.4.0 → dbus2mqtt-0.4.2}/docs/examples/bluez.yaml

@@ -5,12 +5,18 @@ dbus:
     - bus_name: org.bluez
       path: /org/bluez/hci0
 
+      # https://manpages.ubuntu.com/manpages/oracular/man5/org.bluez.Adapter.5.html
+
       interfaces:
         - interface: org.freedesktop.DBus.Properties
           signals:
             - signal: PropertiesChanged
+
+        - interface: org.bluez.Adapter1
+          mqtt_command_topic: dbus2mqtt/bluez/hci0/command
           methods:
-            - method: GetAll
+            - method: StartDiscovery
+            - method: StopDiscovery
 
       flows:
         - name: "publish adapter state"
@@ -27,18 +33,28 @@ dbus:
             - type: mqtt_publish
               topic: dbus2mqtt/bluez/hci0
               payload_type: json
-              payload_template:
-                hci0: "{{ adapter_properties }}"
+              payload_template: |
+                {{
+                    { 'dbus_object_path': path }
+                    | combine(adapter_properties)
+                }}
 
     - bus_name: org.bluez
       path: /org/bluez/hci0/dev_*
 
+      # https://manpages.ubuntu.com/manpages/noble/man5/org.bluez.Device.5.html
       interfaces:
         - interface: org.freedesktop.DBus.Properties
           signals:
             - signal: PropertiesChanged
+
+        - interface: org.bluez.Device1
+          mqtt_command_topic: dbus2mqtt/bluez/hci0/command
           methods:
-            - method: GetAll
+            - method: Connect
+            - method: Disconnect
+            - method: Pair
+            - method: CancelPairing
 
       flows:
         - name: "publish device state"
@@ -55,7 +71,11 @@ dbus:
             - type: mqtt_publish
               topic: dbus2mqtt/bluez/{{ path | replace('/org/bluez/', '') }}
               payload_type: json
-              payload_template: "{{ device_properties }}"
+              payload_template: |
+                {{
+                    { 'dbus_object_path': path }
+                    | combine(device_properties)
+                }}
         - name: "device removed"
           triggers:
             - type: object_removed

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

@@ -1,6 +1,8 @@
 # mqtt:
 #   host:
 #   port:
+#   subscription_topics:
+#     - dbus2mqtt/#
 
 dbus:
   subscriptions:
@@ -37,4 +39,8 @@ flows:
         payload_type: json
         payload_template:
           now: "{{ now().isoformat() }}"
-          dbus_list: "{{ dbus_list('*') }}"
+          dbus_list_res: "{{ dbus_list('*') }}"
+      - type: log
+        level: INFO
+        msg: >
+          Just published: dbus_list={{ dbus_list('*') }} to topic 'dbus2mqtt/state'

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

@@ -12,7 +12,7 @@ Pre-requisites:
 Features:
 
 * dbus subscription using `org.mpris.MediaPlayer2.*` wildcard to support multiple concurrent MRPIS players
-* Every 5 seconds, the state if the `first` known MPRIS player is published to MQTT topic `dbus2mqtt/org.mpris.MediaPlayer2/state`
+* Every 5 seconds, the state of the `first` known MPRIS player is published to MQTT topic `dbus2mqtt/org.mpris.MediaPlayer2/state`
 * Every MPRIS property update immediately publishes the state to MQTT topic `dbus2mqtt/org.mpris.MediaPlayer2/state`
 * Support for player commands (see below)
 

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

@@ -1,7 +1,3 @@
-# mqtt:
-#   host:
-#   port:
-
 dbus:
   subscriptions:
 
@@ -68,10 +64,13 @@ dbus:
               topic: dbus2mqtt/org.mpris.MediaPlayer2/state
               payload_type: json
               payload_template: |
+                {% set metadata = player_properties.get('Metadata') or {} %}
+                {% set metadata_xesam_url = metadata.get('xesam:url', '') | urldecode %}
                 {{
                     { 'bus_name': mpris_bus_name }
                     | combine(player_properties)
-                    | combine ({ 'Position': seeked_position } if seeked_position else {})
+                    | combine({ 'Position': seeked_position } if seeked_position else {})
+                    | combine({ 'Metadata': { 'xesam:url': metadata_xesam_url } }, recursive=True)
                 }}
 
         - name: "publish local art image"

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

@@ -1,7 +1,3 @@
-# mqtt:
-#   host:
-#   port:
-
 dbus:
   subscriptions:
 

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

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

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

@@ -1,6 +1,6 @@
 # Flows
 
-**dbus2mqtt** allows you to add additional processing logic (flows) for when events occur. Configuration is best done in yaml and a complete example can be found here: [MPRIS to Home Assistant Media Player integration](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md)
+**dbus2mqtt** allows you to add additional processing logic (flows) for when events occur. Configuration is done in yaml and a complete example can be found in [home_assistant_media_player.yaml](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.yaml) which is part of the [MPRIS to Home Assistant Media Player integration](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md) example
 
 Flows can be defined on a global or dbus subscription level and can be triggered by any of the following events:
 
@@ -9,12 +9,26 @@ Flows can be defined on a global or dbus subscription level and can be triggered
 * `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
+Within each flow a set of actions can be configured. These are executed in the order as defined in yaml
 
+* `log` for logging message
 * `context_set` to set variables
 * `mqtt_publish` to publish a mqtt message
 
-Actions support string templating which is based on jinja2
+An example
+
+```yaml
+flows:
+  - name: "Example flow"
+    triggers:
+      - type: schedule
+        interval: {seconds: 5}
+    actions:
+      - type: log
+        msg: hello from example flow
+```
+
+Some action parameters allow the use of jinja2 templating. dbus2mqtt supports both builtin jinja2 filters and comes with additional filters from [jinja2-ansible-filters](https://pypi.org/project/jinja2-ansible-filters/). When supported, it is documented below.
 
 ## Flow triggers
 
@@ -22,7 +36,6 @@ Actions support string templating which is based on jinja2
 
 ```yaml
 type: schedule
-cron: {second: 5}
 interval: {seconds: 5}
 ```
 
@@ -41,6 +54,12 @@ When triggered, the following context parameters are available
 
 ### dbus_signal
 
+```yaml
+type: dbus_signal
+interface: org.freedesktop.DBus.Properties
+signal: PropertiesChanged
+```
+
 DBus signals triggers must be configured with an anterface and path. Note that only subscribed signals can be configured as a trigger.
 
 | key | description  |
@@ -86,6 +105,19 @@ When triggered, the following context parameters are available
 
 ## Flow actions
 
+### log
+
+```yaml
+type: log
+msg: your log message
+levvel: INFO
+```
+
+| key              | type             | description  |
+|------------------|------------------|--------------|
+| msg              | str              | a templated string |
+| level            | str              | One of ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"], defaults to 'INFO' |
+
 ### context_set
 
 ```yaml
@@ -101,8 +133,6 @@ global_context: {}
 | dbus_object_context | dict | Per dbus object context, shared between multiple flow executions. Value can be a dict of strings or dict of templated strings |
 | global_context      | dict | Global context, shared between multiple flow executions, over all subscriptions. Value can be a dict of strings or dict of templated strings |
 
-
-
 ### mqtt_publish
 
 ```yaml
@@ -113,11 +143,7 @@ payload_template: {PlaybackStatus: "Off"}
 ```
 
 | key              | type             | description  |
-|------------------|------------------|-------------|
+|------------------|------------------|--------------|
 | topic            | string | mqtt topic the messaage is published to |
 | payload_type     | string | any of [json, yaml, text], defaults to json, format the message is published in to mqtt |
 | payload_template | string, dict | value can be a string, a dict of strings, a templated string or a nested dict of templated strings |
-
-## Jinja2 based templating
-
-Some configuration values allow the use of jinja 2 templating. dbus2mqtt supports both the builtin filters and comes with additional filters from [jinja2-ansible-filters](https://pypi.org/project/jinja2-ansible-filters/)

{dbus2mqtt-0.4.0 → dbus2mqtt-0.4.2}/pyproject.toml

@@ -60,7 +60,7 @@ dev = [
     "pyright>=1.1.396",
     "pre-commit>=4.2.0",
     "pip>=25.0.1",
-    "pytest-asyncio>=0.26.0",
+    "pytest-asyncio>=1.0.0"
 ]
 
 [project.urls]
@@ -81,7 +81,9 @@ lint-pyright = "pyright"
 addopts = "-s"
 testpaths = ["tests"]
 pythonpath = "."
-asyncio_default_fixture_loop_scope = "session"
+asyncio_default_fixture_loop_scope = "function"
+asyncio_default_test_loop_scope = "function"
+log_cli = true
 
 [tool.pyright]
 venvPath = "."

dbus2mqtt-0.4.2/renovate.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": ["local>jwnmulder/renovate-config"],
+
+  "labels": ["dependencies"],
+
+  "packageRules": [
+    {
+      "matchJsonata": ["isBreaking"],
+      "dependencyDashboardApproval": true
+    },
+    {
+      "matchFileNames": [".pre-commit-config.yaml"],
+      "matchUpdateTypes": ["minor", "patch"],
+      "automerge": true,
+      "addLabels": ["automerge"]
+    },
+    {
+      "description": "Disable Renovate for .python-version",
+      "matchFileNames": [".python-version"],
+      "enabled": false
+    },
+    {
+      "matchDatasources": ["docker"],
+      "matchPackageNames": ["python"],
+      "pinDigests": true,
+      "separateMinorPatch": true
+    },
+    {
+      "matchDatasources": ["docker"],
+      "matchPackageNames": "python",
+      "matchUpdateTypes": ["patch", "pin", "digest"],
+      "extends": ["schedule:weekly"]
+    }
+  ]
+}

{dbus2mqtt-0.4.0 → dbus2mqtt-0.4.2}/src/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: