dbus2mqtt 0.1.0__tar.gz

dbus2mqtt-0.1.0/.dockerignore

@@ -0,0 +1,14 @@
+# Ignore everything
+*
+
+# Allow files and directories
+!/src
+!/tests
+!/docs/**.yaml
+
+!/pyproject.toml
+!/uv.lock
+!/.python-version
+
+!/LICENSE
+!/README.md

dbus2mqtt-0.1.0/.env.example

@@ -0,0 +1,4 @@
+MQTT__HOST=localhost
+MQTT__PORT=1883
+MQTT__USERNAME=
+MQTT__PASSWORD=

dbus2mqtt-0.1.0/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: main
+
+"on":
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Uv sync
+        run: uv sync
+
+      - name: Run tests
+        run: uv run pytest

dbus2mqtt-0.1.0/.github/workflows/pre-commit.yml

@@ -0,0 +1,29 @@
+name: pre-commit
+
+"on":
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  repository_dispatch:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Uv sync
+        run: uv sync
+
+      - uses: pre-commit/action@v3.0.1

dbus2mqtt-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,127 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+"on":
+  push:
+    branches:
+      - main
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Build
+        run: uv build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dbus2mqtt  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs:
+      - publish-to-pypi
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          "$GITHUB_REF_NAME"
+          --repo "$GITHUB_REPOSITORY"
+          --notes ""
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          "$GITHUB_REF_NAME" dist/**
+          --repo "$GITHUB_REPOSITORY"
+
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/dbus2mqtt
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+          verbose: true

dbus2mqtt-0.1.0/.gitignore

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

dbus2mqtt-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-json
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  # - repo: https://github.com/shellcheck-py/shellcheck-py
+  #   rev: v0.9.0.6
+  #   hooks:
+  #     - id: shellcheck
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.37.0
+    hooks:
+      - id: yamllint
+        args:
+          - --strict
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.5
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+          - --fixable
+          - I
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.6.14
+    hooks:
+      - id: uv-lock
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.399
+    hooks:
+      - id: pyright

dbus2mqtt-0.1.0/.python-version

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

dbus2mqtt-0.1.0/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

dbus2mqtt-0.1.0/.yamllint.yml

@@ -0,0 +1,4 @@
+extends: default
+rules:
+  document-start: disable
+  line-length: disable

dbus2mqtt-0.1.0/Dockerfile

@@ -0,0 +1,39 @@
+# An example using multi-stage image builds to create a final image without uv.
+
+# First, build the application in the `/app` directory.
+# See `Dockerfile` for details.
+FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim AS builder
+ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy
+
+# 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`
+# for an example.
+ENV UV_PYTHON_DOWNLOADS=0
+
+WORKDIR /app
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --frozen --no-install-project --no-dev
+
+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
+# 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.
+
+# Copy the application from the builder
+COPY --from=builder --chown=app:app /app /app
+
+# Place executables in the environment at the front of the path
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Run the FastAPI application by default
+ENTRYPOINT ["python", "-m", "dbus2mqtt"]
+CMD ["--help"]

dbus2mqtt-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jan-Willem Mulder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dbus2mqtt-0.1.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: dbus2mqtt
+Version: 0.1.0
+Summary: A Python tool to expose Linux D-Bus signals, methods and properties over MQTT - featuring templating, payload enrichment and Home Assistant-ready examples 
+Project-URL: Repository, https://github.com/jwnmulder/dbus2mqtt.git
+Project-URL: Issues, https://github.com/jwnmulder/dbus2mqtt/issues
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dbus,home-assistant,mpris,mqtt,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.12
+Requires-Dist: apscheduler>=3.11.0
+Requires-Dist: colorlog>=6.9.0
+Requires-Dist: dbus-next>=0.2.3
+Requires-Dist: janus>=2.0.0
+Requires-Dist: jinja2-ansible-filters>=1.3.2
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: jsonargparse>=4.38.0
+Requires-Dist: paho-mqtt>=2.1.0
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: schedule>=1.2.2
+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**.
+
+This makes it easy to integrate Linux desktop services or system signals into MQTT-based workflows - including **Home Assistant**.
+
+## ✨ Features
+
+* 🔗 Forward **D-Bus signals** to MQTT topics.
+* 🧠 Enrich or transform **MQTT payloads** using Jinja2 templates and additional D-Bus calls.
+* ⚡ Trigger message publishing via **signals, timers, property changes, or startup events**.
+* 📡 Expose **D-Bus methods** for remote control via MQTT messages.
+* 🏠 Includes example configurations for **MPRIS** and **Home Assistant Media Player** integration.
+
+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
+
+## Getting started with dbus2mqtt
+
+Create a `config.yaml` file with the contents shown below. This configuration will expose all bus properties from the `org.mpris.MediaPlayer2.Player` interface to MQTT on the `dbus2mqtt/org.mpris.MediaPlayer2/state` topic. Have a look at [docs/examples](docs/examples.md) for more examples
+
+```yaml
+dbus:
+  subscriptions:
+    - bus_name: org.mpris.MediaPlayer2.*
+      path: /org/mpris/MediaPlayer2
+      interfaces:
+        - interface: org.freedesktop.DBus.Properties
+          methods:
+            - method: GetAll
+
+      flows:
+        - name: "Publish MPRIS state"
+          triggers:
+            - type: bus_name_added
+            - type: schedule
+              interval: {seconds: 5}
+          actions:
+            - type: context_set
+              context:
+                mpris_bus_name: '{{ dbus_list("org.mpris.MediaPlayer2.*") | first }}'
+                path: /org/mpris/MediaPlayer2
+            - type: mqtt_publish
+              topic: dbus2mqtt/org.mpris.MediaPlayer2/state
+              payload_type: json
+              payload_template: |
+                {{ dbus_call(mpris_bus_name, path, 'org.freedesktop.DBus.Properties', 'GetAll', ['org.mpris.MediaPlayer2.Player']) | to_yaml }}
+```
+
+MQTT connection details can be configured in that same `config.yaml` file or via environment variables. For now create a `.env` file with the following contents.
+
+```bash
+MQTT__HOST=localhost
+MQTT__PORT=1883
+MQTT__USERNAME=
+MQTT__PASSWORD=
+```
+
+### Running from source
+
+To run dbus2mqtt from source (requires uv to be installed)
+
+```bash
+uv run main.py --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
+
+```bash
+# setup configuration
+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 \
+  --volume /run/user:/run/user \
+  --env DBUS_SESSION_BUS_ADDRESS="$DBUS_SESSION_BUS_ADDRESS" \
+  --env-file "$HOME"/.config/dbus2mqtt/.env \
+  --user $(id -u):$(id -g) \
+  --privileged \
+  --restart unless-stopped \
+  jwnmulder/dbus2mqtt \
+  --config "$HOME"/.config/dbus2mqtt/config.yaml
+
+# view logs
+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)
+
+## Configuration reference
+
+dbus2mqtt leverages [jsonargparse](https://jsonargparse.readthedocs.io/en/stable/) which allows configuration via either yaml configuration, CLI or environment variables. Until this is fully documented have a look at the examples in this repository.
+
+### MQTT and D-Bus connection details
+
+```bash
+# dbus_next configuration
+export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus
+
+# dbus2mqtt configuration
+MQTT__HOST=localhost
+MQTT__PORT=1883
+MQTT__USERNAME=
+MQTT__PASSWORD=
+```
+
+or
+
+```yaml
+mqtt:
+  host: localhost
+  port: 1883
+```
+
+### Exposing dbus methods
+
+```yaml
+dbus:
+  subscriptions:
+    - bus_name: org.mpris.MediaPlayer2.*
+      path: /org/mpris/MediaPlayer2
+      interfaces:
+        - interface: org.mpris.MediaPlayer2.Player
+          mqtt_call_method_topic: dbus2mqtt/org.mpris.MediaPlayer2/command
+          methods:
+            - method: Pause
+            - method: Play
+```
+
+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`
+
+```json
+{
+    "method" : "Play",
+}
+```
+
+```json
+{
+    "method" : "OpenUri",
+    "args": []
+}
+```
+
+### Exposing dbus signals
+
+Publishing signals to MQTT topics works by subscribing to the relevant signal and using flows for publishing
+
+```yaml
+dbus:
+  subscriptions:
+    - bus_name: org.mpris.MediaPlayer2.*
+      path: /org/mpris/MediaPlayer2
+      interfaces:
+        - interface: org.freedesktop.DBus.Properties
+           signals:
+             - signal: PropertiesChanged
+
+      flows:
+        - name: "Property Changed flow"
+          triggers:
+            - type: on_signal
+          actions:
+            - type: mqtt_publish
+              topic: dbus2mqtt/org.mpris.MediaPlayer2/signals/PropertiesChanged
+              payload_type: json
+```
+
+## Flows
+
+TODO: Document flows, for now see the [MPRIS to Home Assistant Media Player integration](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