dbus2mqtt 0.1.1__tar.gz → 0.1.2__tar.gz

dbus2mqtt-0.1.2/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

dbus2mqtt-0.1.2/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/.github/release-drafter.yml

@@ -14,8 +14,6 @@ categories:
       - 'bug'
   - title: '🧰 Maintenance'
     label: 'chore'
-# change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
-# change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
 exclude-contributors:
   - jwnmulder
 version-resolver:
@@ -29,6 +27,7 @@ version-resolver:
     labels:
       - 'patch'
   default: patch
+change-template: '* $TITLE (#$NUMBER)'
 template: |
   ## Changes
 

dbus2mqtt-0.1.1/.github/workflows/main.yml → dbus2mqtt-0.1.2/.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: main
+name: CI
 
 "on":
   push:

dbus2mqtt-0.1.2/.github/workflows/docker-latest.yml

@@ -0,0 +1,74 @@
+name: Build and Push Docker latest
+
+"on":
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Determine version from hatch
+        id: version
+        run: echo "PRETEND_VERSION=$(uvx hatch version)" >> "$GITHUB_OUTPUT"
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            jwnmulder/dbus2mqtt
+            ghcr.io/jwnmulder/dbus2mqtt
+          tags: |
+            type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', 'main') }}
+          labels: |
+            org.opencontainers.image.source=https://github.com/jwnmulder/dbus2mqtt
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          username: jwnmulder
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to GHCR
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: jwnmulder
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./docker/Dockerfile.latest
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            PRETEND_VERSION=${{ steps.version.outputs.PRETEND_VERSION }}

dbus2mqtt-0.1.2/.github/workflows/docker-publish-pypi-release.yml

@@ -0,0 +1,69 @@
+name: Build and Push Docker Images for Released Versions
+
+"on":
+  # push:
+  #   branches:
+  #     - main
+  workflow_dispatch:
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    strategy:
+      matrix:
+        version:
+          - 0.1
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            jwnmulder/dbus2mqtt
+            ghcr.io/jwnmulder/dbus2mqtt
+          tags: |
+            type=pep440,pattern={{major}},value=${{ matrix.version }},enable=${{ !startsWith(matrix.version, '0.') }}
+            type=pep440,pattern={{major}}.{{minor}},value=${{ matrix.version }}
+          # type=ref,event=branch
+          # type=ref,event=pr
+          # type=semver,pattern={{version}},value=${{ matrix.version }}
+          labels: |
+            org.opencontainers.image.source=https://github.com/jwnmulder/dbus2mqtt
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          username: jwnmulder
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to GHCR
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: jwnmulder
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./docker/Dockerfile.pypi
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            DBUS2MQTT_VERSION=${{ matrix.version }}

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/.github/workflows/publish.yml

@@ -1,11 +1,3 @@
-# This workflow will upload a Python Package to PyPI when a release is created
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
 name: Upload Python Package
 
 "on":

dbus2mqtt-0.1.2/.gitignore

@@ -0,0 +1,25 @@
+# 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]
+*$py.class
+
+# Distribution / packaging
+dist/
+
+# Environments
+.env
+.venv
+
+# Ruff stuff:
+.ruff_cache/
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+*.code-workspace

dbus2mqtt-0.1.2/.python-version

@@ -0,0 +1 @@
+3.13

dbus2mqtt-0.1.2/.vscode/launch.json

@@ -0,0 +1,13 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "dbus2mqtt - home_assistant_media_player",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "dbus2mqtt",
+            "console": "integratedTerminal",
+            "args": "--config docs/examples/home_assistant_media_player.yaml"
+        }
+    ]
+}

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-Version: 0.1.1
+Version: 0.1.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
@@ -9,6 +9,7 @@ License-File: LICENSE
 Keywords: dbus,home-assistant,mpris,mqtt,python
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -31,8 +32,6 @@ Description-Content-Type: text/markdown
 
 # dbus2mqtt
 
-> **⚠️ Warning:** This project has no releases yet. Running from source works. Docker images and Python packages are planned but not yet available.
-
 **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**.
 
@@ -46,10 +45,15 @@ This makes it easy to integrate Linux desktop services or system signals into MQ
 * 📡 Expose **D-Bus methods** for remote control via MQTT messages.
 * 🏠 Includes example configurations for **MPRIS** and **Home Assistant Media Player** integration.
 
+## Project status
+
+**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)
+
+
 TODO list
 
-* Create a release on PyPI
-* Release a docker image
 * Improve error handling when deleting message with 'retain' set. WARNING:dbus2mqtt.mqtt_client:on_message: Unexpected payload, expecting json, topic=dbus2mqtt/org.mpris.MediaPlayer2/command, payload=, error=Expecting value: line 1 column 1 (char 0)
 * Property set only works the first time, need to restart after which the first set will work again
 
@@ -94,17 +98,17 @@ MQTT__USERNAME=
 MQTT__PASSWORD=
 ```
 
-### Running from source
-
-To run dbus2mqtt from source (requires uv to be installed)
+### Install and run dbus2mqtt
 
 ```bash
-uv run main.py --config config.yaml
+python -m pip install dbus2mqtt
+dbus2mqtt --config config.yaml
 ```
 
+
 ### Run using docker with auto start behavior
 
-To build and run dbus2mqtt using Docker with the [home_assistant_media_player.yaml](docs/examples/home_assistant_media_player.yaml) example from this repository
+To build and run dbus2mqtt using Docker with the [home_assistant_media_player.yaml](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.yaml) example from this repository.
 
 ```bash
 # setup configuration
@@ -112,9 +116,6 @@ mkdir -p $HOME/.config/dbus2mqtt
 cp docs/examples/home_assistant_media_player.yaml $HOME/.config/dbus2mqtt/config.yaml
 cp .env.example $HOME/.config/dbus2mqtt/.env
 
-# build image
-docker build -t jwnmulder/dbus2mqtt:latest .
-
 # run image and automatically start on reboot
 docker run --detach --name dbus2mqtt \
   --volume "$HOME"/.config/dbus2mqtt:"$HOME"/.config/dbus2mqtt \
@@ -133,7 +134,7 @@ sudo docker logs dbus2mqtt -f
 
 ## Examples
 
-This repository contains some examples under [docs/examples](docs/examples.md). The most complete one being [MPRIS to Home Assistant Media Player integration](docs/examples/home_assistant_media_player.md)
+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)
 
 ## Configuration reference
 
@@ -216,8 +217,8 @@ dbus:
 
 ## Flows
 
-TODO: Document flows, for now see the [MPRIS to Home Assistant Media Player integration](docs/examples/home_assistant_media_player.md) example
+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
 
 ## Jinja templating
 
-TODO: Document Jinja templating, for now see the [MPRIS to Home Assistant Media Player integration](docs/examples/home_assistant_media_player.md) example
+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

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/README.md

@@ -1,7 +1,5 @@
 # dbus2mqtt
 
-> **⚠️ Warning:** This project has no releases yet. Running from source works. Docker images and Python packages are planned but not yet available.
-
 **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**.
 
@@ -15,10 +13,15 @@ This makes it easy to integrate Linux desktop services or system signals into MQ
 * 📡 Expose **D-Bus methods** for remote control via MQTT messages.
 * 🏠 Includes example configurations for **MPRIS** and **Home Assistant Media Player** integration.
 
+## Project status
+
+**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)
+
+
 TODO list
 
-* Create a release on PyPI
-* Release a docker image
 * Improve error handling when deleting message with 'retain' set. WARNING:dbus2mqtt.mqtt_client:on_message: Unexpected payload, expecting json, topic=dbus2mqtt/org.mpris.MediaPlayer2/command, payload=, error=Expecting value: line 1 column 1 (char 0)
 * Property set only works the first time, need to restart after which the first set will work again
 
@@ -63,17 +66,17 @@ MQTT__USERNAME=
 MQTT__PASSWORD=
 ```
 
-### Running from source
-
-To run dbus2mqtt from source (requires uv to be installed)
+### Install and run dbus2mqtt
 
 ```bash
-uv run main.py --config config.yaml
+python -m pip install dbus2mqtt
+dbus2mqtt --config config.yaml
 ```
 
+
 ### Run using docker with auto start behavior
 
-To build and run dbus2mqtt using Docker with the [home_assistant_media_player.yaml](docs/examples/home_assistant_media_player.yaml) example from this repository
+To build and run dbus2mqtt using Docker with the [home_assistant_media_player.yaml](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.yaml) example from this repository.
 
 ```bash
 # setup configuration
@@ -81,9 +84,6 @@ mkdir -p $HOME/.config/dbus2mqtt
 cp docs/examples/home_assistant_media_player.yaml $HOME/.config/dbus2mqtt/config.yaml
 cp .env.example $HOME/.config/dbus2mqtt/.env
 
-# build image
-docker build -t jwnmulder/dbus2mqtt:latest .
-
 # run image and automatically start on reboot
 docker run --detach --name dbus2mqtt \
   --volume "$HOME"/.config/dbus2mqtt:"$HOME"/.config/dbus2mqtt \
@@ -102,7 +102,7 @@ sudo docker logs dbus2mqtt -f
 
 ## Examples
 
-This repository contains some examples under [docs/examples](docs/examples.md). The most complete one being [MPRIS to Home Assistant Media Player integration](docs/examples/home_assistant_media_player.md)
+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)
 
 ## Configuration reference
 
@@ -185,8 +185,8 @@ dbus:
 
 ## Flows
 
-TODO: Document flows, for now see the [MPRIS to Home Assistant Media Player integration](docs/examples/home_assistant_media_player.md) example
+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
 
 ## Jinja templating
 
-TODO: Document Jinja templating, for now see the [MPRIS to Home Assistant Media Player integration](docs/examples/home_assistant_media_player.md) example
+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

dbus2mqtt-0.1.1/Dockerfile → dbus2mqtt-0.1.2/docker/Dockerfile.latest

@@ -2,9 +2,12 @@
 
 # First, build the application in the `/app` directory.
 # See `Dockerfile` for details.
-FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS builder
+FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim AS builder
 ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy
 
+ARG PRETEND_VERSION
+ENV SETUPTOOLS_SCM_PRETEND_VERSION=${PRETEND_VERSION}
+
 # Disable Python downloads, because we want to use the system interpreter
 # across both images. If using a managed Python version, it needs to be
 # copied from the build image into the final image; see `standalone.Dockerfile`
@@ -21,9 +24,8 @@ ADD src/ pyproject.toml uv.lock .python-version README.md /app
 RUN --mount=type=cache,target=/root/.cache/uv \
     uv sync --frozen --no-dev
 
-
 # Then, use a final image without uv
-FROM python:3.12-slim-bookworm
+FROM python:3.13-slim-bookworm
 # 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.1.2/docker/Dockerfile.pypi

@@ -0,0 +1,10 @@
+FROM python:3.13-slim-bookworm
+
+WORKDIR /app
+
+ARG DBUS2MQTT_VERSION=latest
+
+RUN pip install --no-cache-dir dbus2mqtt=="$DBUS2MQTT_VERSION"
+
+ENTRYPOINT ["python", "-m", "dbus2mqtt"]
+CMD ["--help"]

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/docs/examples/home_assistant_media_player.md

@@ -1,49 +1,74 @@
 # Mediaplayer integration with Home Assistant
 
-Trying out this example
+With dbus2mqtt as a bridge between MPRIS players and Home Assistant, it becomes possible to control Linux based media players via Home Assistant.
 
-```bash
-uv run dbus2mqtt --config docs/home_assistant_media_player.yaml
-```
+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.
+
+Pre-requisites:
 
-This example shows how this dbus2mqtt can act as a bridge between the MPRIS player and Home Assistant.
+* Home-Assistant with a working MQTT setup, the [media_player.template](https://github.com/Sennevds/media_player.template/tree/master) plugin installed and a working MQTT setup
+plugins installed
 
 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 MPRIS property update immediately publishes the state to MQTT topic `dbus2mqtt/org.mpris.MediaPlayer2/state`
-* Support for player commands (see table below)
+* Support for player commands (see below)
+
+Configuration activities
+
+* MQTT Sensor and player configuration in Home Assistant (see below)
+* dbus2mqtt setup using the supplied `home_assistant_media_player.yaml`
+
+Execute the following command to run dbus2mqtt with the example configuration in this repository.
+
+```bash
+dbus2mqtt --config docs/examples/home_assistant_media_player.yaml
+```
+
+
+## Tested configurations
+
+The following setup is known to work with Home Assistant.
 
-## Player Commands
+| Application  | Play<br />Pause<br /> | Stop | Next<br />Previous | Seek<br />SetPosition | Volume | Quit | Media Info | Media Image |
+|--------------|-----------------------|------|--------------------|------|--------|------|------------|-------------|
+| `Firefox`    | ✅ | ✅ | ✅ | ✅ | | ❌ | ✅ | Youtube only |
+| `VLC` | | | | | | | | | |
 
-The following table lists the supported player commands, their descriptions, and an example JSON payload for invoking them via MQTT.
+## Player commands
 
-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 following table lists player commands, their descriptions, and an example JSON payload for invoking them via MQTT.
 
-| Interface                       | Method     | Description                              | Example JSON Payload                                                               |
-|---------------------------------|------------|------------------------------------------|------------------------------------------------------------------------------------|
-| `org.mpris.MediaPlayer2.Player` | `Pause`    | Pauses playback                          | `{ "method": "Pause" }`                                                            |
-| `org.mpris.MediaPlayer2.Player` | `Play`     | Starts playback                          | `{ "method": "Play" }`                                                             |
-| `org.mpris.MediaPlayer2.Player` | `PlayPause`| Toggles between play and pause           | `{ "method": "PlayPause" }`                                                        |
-| `org.mpris.MediaPlayer2.Player` | `OpenUri`  | Opens a media file or stream by URI      | `{ "method": "OpenUri", "args": ["<URI>"] }`                                       |
-| `org.mpris.MediaPlayer2.Player` | `Stop`     | Stops playback                           | `{ "method": "Stop" }`                                                             |
-| `org.mpris.MediaPlayer2`        | `Quit`     | Quits the media player                   | `{ "method": "Quit" }`                                                             |
+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
 
-Replace `<URI>` in the `OpenUri` payload with the desired media URI.
+| 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                               | `{ "property": "Volume", "value": 50 }`        |
+| `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" }`                         |
 
-For an overview of MPRIS commands have a look at <https://specifications.freedesktop.org/mpris-spec/latest/Player_Interface.html>
+For an overview of MPRIS commands have a look at <https://mpris2.readthedocs.io/en/latest/interfaces.html#mpris2.MediaPlayer2>
 
 ## Home Assistant configuration
 
-Example Home Assistant configuration is based upon <https://github.com/Sennevds/media_player.template/tree/master>
+The configuration shown below creates a few components in Home Assistant
 
-Create the MQTT sensor for topic `dbus2mqtt/org.mpris.MediaPlayer2/state` and the Media Player as shown below
+* Media Player
+* MQTT sensor listening on topic `dbus2mqtt/org.mpris.MediaPlayer2/state`
 
 ```yaml
 mqtt:
   sensor:
-    - name: "MPRIS Media Player"
+    - name: MPRIS Media Player
       state_topic: dbus2mqtt/org.mpris.MediaPlayer2/state
       json_attributes_topic: dbus2mqtt/org.mpris.MediaPlayer2/state
       value_template: >-
@@ -62,7 +87,7 @@ media_player:
   - platform: media_player_template
     media_players:
       mpris_media_player:
-        # device_class: receiver
+        device_class: generic
         friendly_name: MPRIS Media Player
         value_template: "{{ states('sensor.mpris_media_player') }}"
 
@@ -80,7 +105,7 @@ media_player:
         media_image_url_template: >-
           {{ state_attr('sensor.mpris_media_player', 'Metadata')['xesam:url']
             | regex_replace(
-                find='https:\/\/www\\.youtube\\.com\/watch\\?v=(.*)',
+                find='https:\/\/www\\.youtube\\.com\/watch\\?v=([^&]+).*',
                 replace='https://img.youtube.com/vi/\\1/maxresdefault.jpg'
               )
           }}
@@ -119,7 +144,8 @@ media_player:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"method": "Seek", "args": [{{ position | int }}] }'
+            payload: >-
+              { "method": "SetPosition", "args": ["{{ state_attr('sensor.mpris_media_player', 'Metadata')['mpris:trackid'] }}", {{ position | int }}] }
         set_volume:
           service: mqtt.publish
           data:

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/docs/examples/home_assistant_media_player.yaml

@@ -7,12 +7,13 @@ dbus:
 
     - bus_name: org.mpris.MediaPlayer2.*
       path: /org/mpris/MediaPlayer2
-      # https://specifications.freedesktop.org/mpris-spec/latest/Player_Interface.html
+      # https://mpris2.readthedocs.io/en/latest/interfaces.html#mpris2.MediaPlayer2
 
       interfaces:
         - interface: org.freedesktop.DBus.Properties
           signals:
             - signal: PropertiesChanged
+              # TODO: Determine if we should filter here or in flows? The only consumers right now are the flows
               filter: "{{ args[0] == 'org.mpris.MediaPlayer2.Player' }}"
           methods:
             - method: GetAll
@@ -31,6 +32,7 @@ dbus:
             - method: Next
             - method: Previous
             - method: Seek
+            - method: SetPosition
             - method: PlayPause
             - method: OpenUri
 
@@ -40,16 +42,17 @@ dbus:
             - type: bus_name_added
             - type: schedule
               interval: {seconds: 5}
-              # - type: dbus_signal
-              #   interface: org.freedesktop.DBus.Properties
-              #   signal: PropertiesChanged
+            - type: dbus_signal
+              interface: org.freedesktop.DBus.Properties
+              signal: PropertiesChanged
               #   filter: "{{ args[0] == 'org.mpris.MediaPlayer2.Player' }}"
           actions:
             - type: context_set
               context:
                 mpris_bus_name: '{{ dbus_list("org.mpris.MediaPlayer2.*") | first }}'
-                # player_properties: |
-                #   {{ dbus_call(mpris_bus_name, path, 'org.freedesktop.DBus.Properties', 'GetAll', ['org.mpris.MediaPlayer2.Player']) | to_yaml }}
+                # TODO: This would be a nice addition to avoid repetition
+                #   player_properties: |
+                #     {{ dbus_call(mpris_bus_name, path, 'org.freedesktop.DBus.Properties', 'GetAll', ['org.mpris.MediaPlayer2.Player']) | to_yaml }}
                 path: /org/mpris/MediaPlayer2
             - type: mqtt_publish
               topic: dbus2mqtt/org.mpris.MediaPlayer2/state
@@ -61,7 +64,7 @@ dbus:
         - name: "MPRIS player removed"
           triggers:
             - type: bus_name_removed
-            # filter: # CHECK FOR LAST ONE #
+            # filter: # TODO: Check if this is the last or inactive one #
           actions:
             - type: mqtt_publish
               topic: dbus2mqtt/org.mpris.MediaPlayer2/state

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/pyproject.toml

@@ -25,6 +25,7 @@ classifiers = [
 
     "Intended Audience :: Developers",
     "Operating System :: POSIX :: Linux",
+    "License :: OSI Approved :: MIT License",
 
     # Supported Python versions
     "Programming Language :: Python :: 3",

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/src/dbus2mqtt/config.py

@@ -125,7 +125,7 @@ class DbusConfig:
     def get_subscription_configs(self, bus_name: str, path: str) -> list[SubscriptionConfig]:
         res: list[SubscriptionConfig] = []
         for subscription in self.subscriptions:
-            if fnmatch.fnmatchcase(bus_name, subscription.bus_name) and fnmatch.fnmatchcase(path, subscription.path):
+            if fnmatch.fnmatchcase(bus_name, subscription.bus_name) and path == subscription.path:
                 res.append(subscription)
         return res
 

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/src/dbus2mqtt/dbus/dbus_client.py

@@ -124,7 +124,7 @@ class DbusClient:
 
                 on_signal_method_name = "on_" + camel_to_snake(signal_config.signal)
                 dbus_signal_state = {
-                    "bus_name_subscriptions": bus_name_subscriptions,
+                    "bus_name": bus_name,
                     "path": path,
                     "interface_name": interface.name,
                     "subscription_config": subscription_config,
@@ -354,6 +354,8 @@ class DbusClient:
 
     async def _handle_on_dbus_signal(self, signal: DbusSignalWithState):
 
+        logger.debug(f"dbus_signal: signal={signal.signal_config.signal}, args={signal.args}, bus_name={signal.bus_name}, path={signal.path}, interface={signal.interface_name}")
+
         for flow in signal.subscription_config.flows:
             for trigger in flow.triggers:
                 if trigger.type == "dbus_signal" and signal.signal_config.signal == trigger.signal:
@@ -366,7 +368,7 @@ class DbusClient:
 
                         if matches_filter:
                             context = {
-                                "bus_name": signal.bus_name_subscriptions.bus_name,
+                                "bus_name": signal.bus_name,
                                 "path": signal.path,
                                 "interface": signal.interface_name,
                                 "args": signal.args
@@ -394,8 +396,8 @@ class DbusClient:
             return
 
         logger.debug(f"on_mqtt_msg: topic={msg.topic}, payload={json.dumps(msg.payload)}")
-        calls_done: list[str] = []
-        properties_set: list[str] = []
+        matched_method = False
+        matched_property = False
 
         payload_method = msg.payload.get("method")
         payload_method_args = msg.payload.get("args") or []
@@ -417,27 +419,27 @@ class DbusClient:
                             # filter configured method, configured topic, ...
                             if method.method == payload_method:
                                 interface = proxy_object.get_interface(name=interface_config.interface)
+                                matched_method = True
 
                                 try:
                                     logger.info(f"on_mqtt_msg: method={method.method}, args={payload_method_args}, bus_name={bus_name}, path={path}, interface={interface_config.interface}")
                                     await self.call_dbus_interface_method(interface, method.method, payload_method_args)
-                                    calls_done.append(method.method)
                                 except Exception as e:
-                                    logger.warning(f"on_mqtt_msg: method={method.method}, bus_name={bus_name} failed, exception={e}")
+                                    logger.warning(f"on_mqtt_msg: method={method.method}, args={payload_method_args}, bus_name={bus_name} failed, exception={e}")
 
                         for property in interface_config.properties:
                             # filter configured property, configured topic, ...
                             if property.property == payload_property:
                                 interface = proxy_object.get_interface(name=interface_config.interface)
+                                matched_property = True
 
                                 try:
                                     logger.info(f"on_mqtt_msg: property={property.property}, value={payload_value}, bus_name={bus_name}, path={path}, interface={interface_config.interface}")
                                     await self.set_dbus_interface_property(interface, property.property, payload_value)
-                                    properties_set.append(property.property)
                                 except Exception as e:
-                                    logger.warning(f"on_mqtt_msg: property={property.property}, bus_name={bus_name} failed, exception={e}")
+                                    logger.warning(f"on_mqtt_msg: property={property.property}, value={payload_value}, bus_name={bus_name} failed, exception={e}")
 
-        if len(calls_done) == 0 and len(properties_set) == 0:
+        if not matched_method and not matched_property:
             if payload_method:
                 logger.info(f"No configured or active dbus subscriptions for topic={msg.topic}, method={payload_method}, active bus_names={list(self.subscriptions.keys())}")
             if payload_property:

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/src/dbus2mqtt/dbus/dbus_util.py

@@ -15,7 +15,7 @@ def unwrap_dbus_object(o):
     json_obj = json.loads(res)
     return json_obj
 
-def unwrap_dbus_objects(*args):
+def unwrap_dbus_objects(args):
     res = [unwrap_dbus_object(o) for o in args]
     return res
 

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/src/dbus2mqtt/event_broker.py

@@ -13,7 +13,6 @@ from dbus2mqtt.config import (
     SignalConfig,
     SubscriptionConfig,
 )
-from dbus2mqtt.dbus.dbus_types import BusNameSubscriptions
 
 logger = logging.getLogger(__name__)
 
@@ -26,7 +25,7 @@ class MqttMessage:
 
 @dataclass
 class DbusSignalWithState:
-    bus_name_subscriptions: BusNameSubscriptions
+    bus_name: str
     path: str
     interface_name: str
     subscription_config: SubscriptionConfig

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/tests/__init__.py

@@ -1,4 +1,6 @@
 
+import dbus_next.aio as dbus_aio
+
 from pydantic import SecretStr
 
 from dbus2mqtt import AppContext, config
@@ -8,8 +10,9 @@ from dbus2mqtt.config import (
     FlowTriggerConfig,
     InterfaceConfig,
 )
+from dbus2mqtt.dbus.dbus_client import DbusClient
 from dbus2mqtt.event_broker import EventBroker
-from dbus2mqtt.flow.flow_processor import FlowProcessor
+from dbus2mqtt.flow.flow_processor import FlowProcessor, FlowScheduler
 from dbus2mqtt.template.templating import TemplateEngine
 
 
@@ -51,3 +54,17 @@ def mocked_flow_processor(app_context: AppContext, trigger_config: FlowTriggerCo
 
     processor = FlowProcessor(app_context)
     return processor, flow_config
+
+class MockedMessageBus(dbus_aio.message_bus.MessageBus):
+    def _setup_socket(self):
+        self._stream = ""
+        self._sock = ""
+        self._fd = ""
+
+def mocked_dbus_client(app_context: AppContext):
+
+    bus = MockedMessageBus(bus_address="unix:path=/run/user/1000/bus")
+    flow_scheduler = FlowScheduler(app_context)
+
+    dbus_client = DbusClient(app_context, bus, flow_scheduler)
+    return dbus_client

dbus2mqtt-0.1.2/tests/dbus/test_dbus_client.py

@@ -0,0 +1,49 @@
+
+import dbus_next.introspection as dbus_intr
+import dbus_next.signature as dbus_signature
+
+from dbus_next.constants import ArgDirection
+
+from tests import mocked_app_context, mocked_dbus_client
+
+
+def test_signal_handler_unwrap_args():
+
+    app_context = mocked_app_context()
+    dbus_client = mocked_dbus_client(app_context)
+
+    dbus_signal = dbus_intr.Signal("PropertiesChanged", [
+        dbus_intr.Arg(name="interface_name", signature="s", direction=[ArgDirection.IN]),
+        dbus_intr.Arg(name="changed_properties", signature="a{sv}", direction=[ArgDirection.IN]),
+        dbus_intr.Arg(name="invalidated_properties", signature="as", direction=[ArgDirection.IN])
+    ])
+
+    dbus_signal_state = {}
+    dbus_signal_state = {
+        "bus_name": "org.mpris.MediaPlayer2.vlc",
+        "path": "/org/mpris/MediaPlayer2",
+        "interface_name": "org.freedesktop.DBus.Properties",
+        "subscription_config": None, # subscription_config,
+        "signal_config": None, # signal_config,
+    }
+
+    handler = dbus_client._dbus_next_signal_handler(dbus_signal, dbus_signal_state)
+    assert handler is not None
+
+    args = [
+        "org.mpris.MediaPlayer2.Player",
+        {
+            "CanPause": dbus_signature.Variant("b", True)
+        },
+        []
+    ]
+
+    # Invoke with wrapped arguments
+    handler(*args)
+
+    # Check if message is published on the event_broker
+    mqtt_message = app_context.event_broker.dbus_signal_queue.sync_q.get_nowait()
+
+    # message args should be unwrapped
+    assert mqtt_message is not None
+    assert mqtt_message.args == ["org.mpris.MediaPlayer2.Player", {"CanPause" : True}, []]

{dbus2mqtt-0.1.1 → dbus2mqtt-0.1.2}/tests/flow/triggers/test_dbus_client_triggers.py

@@ -1,8 +1,5 @@
-
-import dbus_next.aio as dbus_aio
 import pytest
 
-from dbus2mqtt import AppContext
 from dbus2mqtt.config import (
     FlowActionContextSetConfig,
     FlowTriggerBusNameAddedConfig,
@@ -10,10 +7,8 @@ from dbus2mqtt.config import (
     FlowTriggerDbusSignalConfig,
     SignalConfig,
 )
-from dbus2mqtt.dbus.dbus_client import DbusClient
-from dbus2mqtt.event_broker import BusNameSubscriptions, DbusSignalWithState
-from dbus2mqtt.flow.flow_processor import FlowScheduler
-from tests import mocked_app_context, mocked_flow_processor
+from dbus2mqtt.event_broker import DbusSignalWithState
+from tests import mocked_app_context, mocked_dbus_client, mocked_flow_processor
 
 
 @pytest.mark.asyncio
@@ -32,7 +27,7 @@ async def test_bus_name_added_trigger():
         )
     ])
 
-    dbus_client = _mocked_dbus_client(app_context)
+    dbus_client = mocked_dbus_client(app_context)
 
     subscription_config = app_context.config.dbus.subscriptions[0]
 
@@ -64,7 +59,7 @@ async def test_bus_name_removed_trigger():
         )
     ])
 
-    dbus_client = _mocked_dbus_client(app_context)
+    dbus_client = mocked_dbus_client(app_context)
 
     subscription_config = app_context.config.dbus.subscriptions[0]
 
@@ -104,10 +99,10 @@ async def test_dbus_signal_trigger():
 
     subscription_config = app_context.config.dbus.subscriptions[0]
 
-    dbus_client = _mocked_dbus_client(app_context)
+    dbus_client = mocked_dbus_client(app_context)
 
     signal = DbusSignalWithState(
-        bus_name_subscriptions=BusNameSubscriptions("test-bus-name"),
+        bus_name="test-bus-name",
         path="/",
         interface_name=subscription_config.interfaces[0].interface,
         subscription_config=subscription_config,
@@ -132,17 +127,3 @@ async def test_dbus_signal_trigger():
         "interface": "test-interface-name",
         "args": ["first-arg", "second-arg"]
     }
-
-class MockedMessageBus(dbus_aio.message_bus.MessageBus):
-    def _setup_socket(self):
-        self._stream = ""
-        self._sock = ""
-        self._fd = ""
-
-def _mocked_dbus_client(app_context: AppContext):
-
-    bus = MockedMessageBus(bus_address="unix:path=/run/user/1000/bus")
-    flow_scheduler = FlowScheduler(app_context)
-
-    dbus_client = DbusClient(app_context, bus, flow_scheduler)
-    return dbus_client

dbus2mqtt-0.1.1/.gitignore

@@ -1,6 +0,0 @@
-.env
-
-.ruff_cache
-.venv
-dist
-__pycache__

dbus2mqtt-0.1.1/.python-version

@@ -1 +0,0 @@
-3.12