dbus2mqtt 0.4.2__tar.gz → 0.4.3__tar.gz

dbus2mqtt-0.4.3/.github/workflows/deploy-docs.yml

@@ -0,0 +1,29 @@
+name: deploy-docs
+
+"on":
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          activate-environment: true
+          enable-cache: true
+      - name: gh-deploy
+        run: |
+          uv run mkdocs gh-deploy --force

{dbus2mqtt-0.4.2 → dbus2mqtt-0.4.3}/.github/workflows/docker-dev.yml

@@ -6,7 +6,10 @@ name: docker-dev
       - main
     paths-ignore:
       - 'docs/**'
+      - 'tests/**'
       - '.pre-commit-config.yaml'
+      - 'README.md'
+      - 'renovate.json'
   workflow_dispatch:
 
 jobs:

{dbus2mqtt-0.4.2 → dbus2mqtt-0.4.3}/.github/workflows/docker-stable.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Determine supported release versions
         id: supported_release_versions
         run: |
-          SUPPORTED_CYCLES=("0.1" "0.2" "0.3" "0.4" "0.5" "0.6" "0.7" "0.8" "0.9" "1.0" "2.0")
+          SUPPORTED_CYCLES=("0.4" "0.5" "0.6" "0.7" "0.8" "0.9" "1.0" "2.0")
 
           VERSIONS_JSON=$(python3 .github/scripts/release-versions.py "${SUPPORTED_CYCLES[@]}")
 

dbus2mqtt-0.4.3/.github/workflows/trivy.yml

@@ -0,0 +1,35 @@
+name: trivy
+
+"on":
+  schedule:
+    - cron: '15 10 * * 1'
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  scan:
+    permissions:
+      contents: read  # for actions/checkout to fetch code
+      security-events: write  # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read  # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    name: Scan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Run Trivy vulnerability scanner
+        uses: aquasecurity/trivy-action@0.32.0
+        with:
+          image-ref: ghcr.io/jwnmulder/dbus2mqtt:latest
+          format: 'sarif'
+          output: 'trivy-results.sarif'
+          severity: 'CRITICAL,HIGH'
+          ignore-unfixed: true
+
+      - name: Upload Trivy scan results to GitHub Security tab
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: 'trivy-results.sarif'

{dbus2mqtt-0.4.2 → dbus2mqtt-0.4.3}/.gitignore

@@ -1,6 +1,3 @@
-# https://github.com/github/gitignore/blob/main/Python.gitignore
-# https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -8,6 +5,7 @@ __pycache__/
 
 # Distribution / packaging
 dist/
+site/
 
 # Environments
 .env

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

@@ -33,7 +33,7 @@ repos:
           - --strict
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.2
+    rev: v0.12.3
     hooks:
       - id: ruff
         args:
@@ -42,7 +42,7 @@ repos:
           - I
 
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.7.19
+    rev: 0.7.21
     hooks:
       - id: uv-lock
 

dbus2mqtt-0.4.3/.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "yaml.schemas": {
+        "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+    },
+    "yaml.customTags": [
+        "!ENV scalar",
+        "!ENV sequence",
+        "!relative scalar",
+        "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+        "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+        "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format",
+        "tag:yaml.org,2002:python/object/apply:pymdownx.slugs.slugify mapping"
+    ]
+}

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

@@ -1,13 +1,14 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-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
+Version: 0.4.3
+Summary: General purpose DBus to MQTT bridge - expose signals, methods and properties over MQTT - featuring jinja based templating, payload enrichment and MPRIS / BlueZ / Home Assistant ready examples 
+Project-URL: Documentation, https://jwnmulder.github.io/dbus2mqtt
+Project-URL: Source, https://github.com/jwnmulder/dbus2mqtt
 Project-URL: Issues, https://github.com/jwnmulder/dbus2mqtt/issues
 License-Expression: MIT
 License-File: LICENSE
-Keywords: dbus,home-assistant,mpris,mqtt,python
-Classifier: Development Status :: 4 - Beta
+Keywords: bluez,bridge,dbus,home-assistant,jinja2,mpris,mqtt,python
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: POSIX :: Linux
@@ -16,6 +17,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
 Requires-Python: >=3.10
 Requires-Dist: apscheduler>=3.11.0
 Requires-Dist: colorlog>=6.9.0
@@ -37,7 +39,7 @@ It lets you forward Linux D-Bus signals and properties to MQTT topics, call D-Bu
 
 This makes it easy to integrate Linux desktop services or system signals into MQTT-based workflows - including **Home Assistant**.
 
-## ✨ Features
+## Features
 
 * 🔗 Forward **D-Bus signals** to MQTT topics.
 * 🧠 Enrich or transform **MQTT payloads** using Jinja2 templates and additional D-Bus calls.
@@ -49,11 +51,11 @@ This makes it easy to integrate Linux desktop services or system signals into MQ
 
 **dbus2mqtt** is considered stable for the use-cases it has been tested against, and is actively being developed. Documentation is continuously being improved.
 
-Initial testing has focused on MPRIS integration. A table of tested MPRIS players and their supported methods can be found here: [home_assistant_media_player.md](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md)
+Initial testing has focused on MPRIS integration. A table of tested MPRIS players and their supported methods can be found here: [Mediaplayer integration with Home Assistant](https://jwnmulder.github.io/dbus2mqtt/examples/home_assistant_media_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](https://github.com/jwnmulder/dbus2mqtt/blob/main/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.
 
 ```yaml
 dbus:
@@ -92,6 +94,7 @@ MQTT__USERNAME=
 MQTT__PASSWORD=
 ```
 
+
 ### Install and run dbus2mqtt
 
 ```bash
@@ -129,7 +132,8 @@ sudo docker logs dbus2mqtt -f
 
 ## Examples
 
-This repository contains examples under [docs/examples](https://github.com/jwnmulder/dbus2mqtt/blob/main//docs/examples.md). The most complete one being [MPRIS to Home Assistant Media Player integration](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md)
+More dbus2mqtt examples can be found here: [examples](https://jwnmulder.github.io/dbus2mqtt/examples/).
+The most complete one being [MPRIS to Home Assistant Media Player integration](https://jwnmulder.github.io/dbus2mqtt/examples/home_assistant_media_player/)
 
 ## Configuration reference
 
@@ -226,8 +230,8 @@ dbus:
 
 ## Flows
 
-A reference of all supported flow triggers and actions can be found on [Flows](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/flows.md)
+A reference of all supported flow triggers and actions can be found on [Flows](https://jwnmulder.github.io/dbus2mqtt/flows/)
 
 ## Jinja templating
 
-TODO: Document Jinja templating, 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
+TODO: Document Jinja templating, for now see the [MPRIS to Home Assistant Media Player integration](https://jwnmulder.github.io/dbus2mqtt/examples/home_assistant_media_player/) example

{dbus2mqtt-0.4.2 → dbus2mqtt-0.4.3}/README.md

@@ -5,7 +5,7 @@ It lets you forward Linux D-Bus signals and properties to MQTT topics, call D-Bu
 
 This makes it easy to integrate Linux desktop services or system signals into MQTT-based workflows - including **Home Assistant**.
 
-## ✨ Features
+## Features
 
 * 🔗 Forward **D-Bus signals** to MQTT topics.
 * 🧠 Enrich or transform **MQTT payloads** using Jinja2 templates and additional D-Bus calls.
@@ -17,11 +17,11 @@ This makes it easy to integrate Linux desktop services or system signals into MQ
 
 **dbus2mqtt** is considered stable for the use-cases it has been tested against, and is actively being developed. Documentation is continuously being improved.
 
-Initial testing has focused on MPRIS integration. A table of tested MPRIS players and their supported methods can be found here: [home_assistant_media_player.md](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md)
+Initial testing has focused on MPRIS integration. A table of tested MPRIS players and their supported methods can be found here: [Mediaplayer integration with Home Assistant](https://jwnmulder.github.io/dbus2mqtt/examples/home_assistant_media_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](https://github.com/jwnmulder/dbus2mqtt/blob/main/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.
 
 ```yaml
 dbus:
@@ -60,6 +60,7 @@ MQTT__USERNAME=
 MQTT__PASSWORD=
 ```
 
+
 ### Install and run dbus2mqtt
 
 ```bash
@@ -97,7 +98,8 @@ sudo docker logs dbus2mqtt -f
 
 ## Examples
 
-This repository contains examples under [docs/examples](https://github.com/jwnmulder/dbus2mqtt/blob/main//docs/examples.md). The most complete one being [MPRIS to Home Assistant Media Player integration](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md)
+More dbus2mqtt examples can be found here: [examples](https://jwnmulder.github.io/dbus2mqtt/examples/).
+The most complete one being [MPRIS to Home Assistant Media Player integration](https://jwnmulder.github.io/dbus2mqtt/examples/home_assistant_media_player/)
 
 ## Configuration reference
 
@@ -194,8 +196,8 @@ dbus:
 
 ## Flows
 
-A reference of all supported flow triggers and actions can be found on [Flows](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/flows.md)
+A reference of all supported flow triggers and actions can be found on [Flows](https://jwnmulder.github.io/dbus2mqtt/flows/)
 
 ## Jinja templating
 
-TODO: Document Jinja templating, 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
+TODO: Document Jinja templating, for now see the [MPRIS to Home Assistant Media Player integration](https://jwnmulder.github.io/dbus2mqtt/examples/home_assistant_media_player/) example

dbus2mqtt-0.4.2/docs/debugging.md → dbus2mqtt-0.4.3/docs/developer/debugging_dbus.md

@@ -1,23 +1,20 @@
-# Debugging
+# Debugging dbus
 
-## Running from source
+Useful snippets for checking what's going on on dbus
 
 ```bash
-uv run main.py --config config.yaml
-```
-
-## dbus debugging
-
-```bash
-uv run dbus2mqtt
-
-# https://dbus.freedesktop.org/doc/dbus-tutorial.html
-# https://dbus.freedesktop.org/doc/dbus-specification.html
+# monitor all dbus traffic
 dbus-monitor
 
+# show introspection data for dbus objects
 busctl --user introspect org.freedesktop.DBus /org/freedesktop/DBus
+```
+
+Useful snippts for MPRIS debugging
 
+```bash
 playerctl -l
+
 busctl --user introspect org.mpris.MediaPlayer2.vlc /org/mpris/MediaPlayer2
 
 dbus-send --print-reply --session --dest=org.freedesktop.DBus /org/freedesktop/DBus org.freedesktop.DBus.ListNames | grep mpris

dbus2mqtt-0.4.3/docs/developer/index.md

@@ -0,0 +1,15 @@
+# Developer guide
+
+## Specifications
+
+Generic DBus specifications:
+
+* [D-Bus Tutorial](https://dbus.freedesktop.org/doc/dbus-tutorial.html)
+* [D-Bus Specification](https://dbus.freedesktop.org/doc/dbus-specification.html)
+
+
+## Running from source
+
+```bash
+uv run main.py --config config.yaml
+```

{dbus2mqtt-0.4.2 → dbus2mqtt-0.4.3}/docs/examples/bluez.md

@@ -1,5 +1,12 @@
+---
+hide:
+  - toc
+---
+
 # Bluez
 
+## Introduction
+
 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.
@@ -8,7 +15,7 @@ This configuration file demonstrates how to use dbus2mqtt to bridge D-Bus events
 
 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
+## Setup activities
 
 * dbus2mqtt setup using the supplied [bluez.yaml](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/bluez.yaml)
 
@@ -24,14 +31,15 @@ The following table lists commands, their descriptions, and an example JSON payl
 
 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" }`                         |
+| Method<br />Property  | Description                          | Example MQTT JSON Payload                          |
+|-----------------------|--------------------------------------|-------------------------------------------------|
+| `StartDiscovery`      | Starts bluetooth discovery           | `#!json { "method": "StartDiscovery" }`                |
+| `StopDiscovery`       | Stops bluetooth discovery            | `#!json { "method": "StopDiscovery" }`                         |
+| `Connect`             |                                      | `#!json { "method": "Connect", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                |
+| `Disconnect`          |                                      | `#!json { "method": "Disconnect", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                         |
+| `Pair`                |                                      | `#!json { "method": "Pair", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                |
+| `CancelPairing`       |                                      | `#!json { "method": "CancelPairing", "path": "/org/bluez/hci0/dev_A1_A2_A3_A4_A5_A6" }`                         |
 
+## References
 
-https://manpages.ubuntu.com/manpages/noble/man5/org.bluez.
+* <https://manpages.ubuntu.com/manpages/noble/man5/org.bluez>

{dbus2mqtt-0.4.2 → dbus2mqtt-0.4.3}/docs/examples/dbus2mqtt_internal_state.md

@@ -1,4 +1,15 @@
-# dbus2mqtt internal state example
+---
+hide:
+  - toc
+---
+
+# dbus2mqtt internal state (WIP)
+
+## Introduction
+
+This will publish the dbus2mqtt's internal state to the `dbus2mqtt/state` MQTT topic every 5 seconds
+
+## Setup activities
 
 Execute the following command to run dbus2mqtt with the example configuration in this repository.
 
@@ -6,7 +17,6 @@ Execute the following command to run dbus2mqtt with the example configuration in
 dbus2mqtt --config docs/examples/dbus2mqtt_internal_state.yaml
 ```
 
-This will publish the dbus2mqtt's internal state to the `dbus2mqtt/state` MQTT topic every 5 seconds
 
 ```json
 {"now": "2025-04-23T16:01:34.985452", "dbus_list": ["org.freedesktop.systemd1", "org.gnome.SessionManager"]}

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

@@ -1,5 +1,12 @@
+---
+hide:
+  - toc
+---
+
 # Mediaplayer integration with Home Assistant
 
+## Introduction
+
 With dbus2mqtt as a bridge between MPRIS players and Home Assistant, it becomes possible to control Linux based media players via Home Assistant.
 
 The Media Player Remote Interfacing Specification (MPRIS) is a standard for controlling Linux media players. It provides a mechanism for compliant media players discovery, basic playback and media player state control as well as a tracklist interface which is used to add context to the current item.
@@ -7,21 +14,21 @@ The Media Player Remote Interfacing Specification (MPRIS) is a standard for cont
 Pre-requisites:
 
 * Home-Assistant with a working MQTT setup
-* The [media_player.template](https://github.com/Sennevds/media_player.template/tree/master) plugin
+* The community Home-Assistant plugin [github.com/Sennevds/media_player.template](https://github.com/Sennevds/media_player.template)
 
-Features:
+## Features
 
 * dbus subscription using `org.mpris.MediaPlayer2.*` wildcard to support multiple concurrent MRPIS players
 * 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)
 
-Configuration activities
+## Setup activities
 
-* MQTT Sensor and player configuration in Home Assistant (see below)
-* dbus2mqtt setup using the supplied [home_assistant_media_player.yaml](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.yaml)
+* Configure the MQTT Sensor and player configuration in Home Assistant with the configuration listed below
+* Config dbus2mqtt 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.
+To run, execute the following commands
 
 ```bash
 dbus2mqtt --config docs/examples/home_assistant_media_player.yaml
@@ -29,17 +36,18 @@ dbus2mqtt --config docs/examples/home_assistant_media_player.yaml
 
 ## Tested configurations
 
-The following setup is known to work with Home Assistant.
+The following MPRIS players are known to work with Home Assistant.
 
 | Application  | Play<br />Pause<br /> | Stop | Next<br />Previous | Seek<br />SetPosition | Volume | Quit | Media Info | Media Image | Notes
 |--------------|-----------------------|------|--------------------|------|--------|------|------------|-------------|-------------------|
 | `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 |
+| `Kodi`       | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ | Requires Kodi plugin [MediaPlayerRemoteInterface](https://github.com/wastis/MediaPlayerRemoteInterface) |
 
+!!! note
 
-More players that support MPRIS can be found here: <https://wiki.archlinux.org/title/MPRIS>
+    More players that support MPRIS (but have not been tested) can be found here: <https://wiki.archlinux.org/title/MPRIS>
 
 ## Player commands
 
@@ -47,18 +55,18 @@ The following table lists player commands, their descriptions, and an example JS
 
 Dbus methods can be invoked by sendig the JSON payload to MQTT topic `dbus2mqtt/org.mpris.MediaPlayer2/command`. Method calls will be done for all matching players. The same applies to property updates.
 
-| Interface                       | Method<br />Property | Description                       | Example MQTT JSON Payload                           |
-|---------------------------------|---------------|------------------------------------------|------------------------------------------------|
-| `org.mpris.MediaPlayer2.Player` | `Play`        | Starts playback                          | `{ "method": "Play" }`                         |
-| `org.mpris.MediaPlayer2.Player` | `Pause`       | Pauses playback                          | `{ "method": "Pause" }`                        |
-| `org.mpris.MediaPlayer2.Player` | `PlayPause`   | Toggles between play and pause           | `{ "method": "PlayPause" }`                    |
-| `org.mpris.MediaPlayer2.Player` | `Next`        | Next                                     | `{ "method": "Next" }`                         |
-| `org.mpris.MediaPlayer2.Player` | `Previous`    | Previous                                 | `{ "method": "Previous" }`                     |
-| `org.mpris.MediaPlayer2.Player` | `Stop`        | Stops playback                           | `{ "method": "Stop" }`                         |
-| `org.mpris.MediaPlayer2.Player` | `Seek`        | Seek forward or backward in micro seconds  | `{ "method": "Seek", "args": [60000000] }`   |
-| `org.mpris.MediaPlayer2.Player` | `Volume`      | Set volume (double between 0 and 1)      | `{ "property": "Volume", "value": 1.0 }`        |
-| `org.mpris.MediaPlayer2.Player` | `SetPosition` | Set / seek to position in micro seconds. First arguments needs to be trackid which can be determined via Metadata.mpris:trackid | `{ "method": "SetPosition", "args": ["/org/mpris/MediaPlayer2/firefox", 170692139] }`                         |
-| `org.mpris.MediaPlayer2`        | `Quit`        | Quits the media player                   | `{ "method": "Quit" }`                         |
+| Method<br />Property | Description                       | Example MQTT JSON Payload                           |
+|---------------|------------------------------------------|------------------------------------------------|
+| `Play`        | Starts playback                          | `#!json { "method": "Play" }`                         |
+| `Pause`       | Pauses playback                          | `#!json { "method": "Pause" }`                        |
+| `PlayPause`   | Toggles between play and pause           | `#!json { "method": "PlayPause" }`                    |
+| `Stop`        | Stops playback                           | `#!json { "method": "Stop" }`                         |
+| `Next`        | Next                                     | `#!json { "method": "Next" }`                         |
+| `Previous`    | Previous                                 | `#!json { "method": "Previous" }`                     |
+| `Seek`        | Seek forward or backward in micro seconds  | `#!json { "method": "Seek", "args": [60000000] }`   |
+| `Volume`      | Set volume (double between 0 and 1)      | `#!json { "property": "Volume", "value": 1.0 }`        |
+| `SetPosition` | Set / seek to position in micro seconds. First arguments needs to be trackid which can be determined via Metadata.mpris:trackid | `#!json { "method": "SetPosition", "args": ["/org/mpris/MediaPlayer2/firefox", 170692139] }`                         |
+| `Quit`        | Quits the media player                   | `#!json { "method": "Quit" }`                         |
 
 For an overview of MPRIS commands have a look at <https://mpris2.readthedocs.io/en/latest/interfaces.html#mpris2.MediaPlayer2>
 
@@ -69,7 +77,7 @@ The configuration shown below creates a few components in Home Assistant
 * Media Player
 * MQTT sensor listening on topic `dbus2mqtt/org.mpris.MediaPlayer2/state`
 
-```yaml
+```yaml+jinja
 mqtt:
   sensor:
     - name: MPRIS Media Player
@@ -94,7 +102,15 @@ media_player:
         current_volume_template: "{{ state_attr('sensor.mpris_media_player', 'Volume') }}"
         current_is_muted_template: "{{ state_attr('sensor.mpris_media_player', 'Volume') == 0 }}"
         current_position_template: "{{ state_attr('sensor.mpris_media_player', 'Position') }}"
-        title_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('xesam:title', '') }}"
+
+        # title: 'xesam:title' or filename without extension from 'xesam:url'
+        title_template: >-
+          {% set metadata = state_attr('sensor.mpris_media_player', 'Metadata') or {} %}
+          {% set title = metadata.get('xesam:title', '') %}
+          {% if not title or title == '' %}
+          {% set title = metadata.get('xesam:url', '') | regex_findall(find='([^\\/]+?)(?:\.[^.\\/]+)?$') | first | default('') %}
+          {% endif %}
+          {{ title }}
 
         media_content_type_template: music  # needed to show 'artist'
         media_duration_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('mpris:length', 0) }}"
@@ -129,32 +145,38 @@ media_player:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"method": "Quit"}'
+            payload: >
+              {"method": "Quit"}
         play:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"method": "Play"}'
+            payload: >
+              {"method": "Play"}
         pause:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"method": "Pause"}'
+            payload: >
+              {"method": "Pause"}
         stop:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"method": "Stop"}'
+            payload: >
+              {"method": "Stop"}
         next:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"method": "Next"}'
+            payload: >
+              {"method": "Next"}
         previous:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"method": "Previous"}'
+            payload: >
+              {"method": "Previous"}
         seek:
           service: mqtt.publish
           data:
@@ -165,7 +187,8 @@ media_player:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"property": "Volume", "value": {{volume}} }'
+            payload: >
+              {"property": "Volume", "value": {{volume}} }
         volume_up:
           service: mqtt.publish
           data:

dbus2mqtt-0.4.3/docs/examples/index.md

@@ -0,0 +1,9 @@
+# Examples
+
+Examples work better than large amounts of documentation and puzzling everything together. Feel free to use these examples as-is or adapt them to your own likening.
+
+Each example comes with a dbus2mqtt configuration file and corresponding documentation.
+
+* [MPRIS to Home Assistant Media Player integration](home_assistant_media_player.md)
+* [BlueZ](bluez.md)
+* [Publish dbus2mqtt internal state](dbus2mqtt_internal_state.md)

{dbus2mqtt-0.4.2 → dbus2mqtt-0.4.3}/docs/examples/linux_desktop.md

@@ -1,16 +1,23 @@
-# Linux Desktop
+---
+hide:
+  - toc
+---
+
+# Linux Desktop (WIP)
+
+## Introduction
 
 > **Warning:** This is not working, dbus-next is validating property names and bails on `power-saver-enable`
 
+## Setup activities
+
 Trying out this example
 
 ```bash
 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.
-
-Features:
+## Features
 
 * ...