dbus2mqtt 0.1.0__py3-none-any.whl

dbus2mqtt/template/templating.py

@@ -0,0 +1,129 @@
+
+from datetime import datetime
+from typing import Any
+
+import yaml
+
+from jinja2 import (
+    BaseLoader,
+    Environment,
+    StrictUndefined,
+)
+from yaml import SafeDumper, SafeLoader
+
+
+def _represent_template_str(dumper: SafeDumper, data: str):
+    data = data.replace("{{", "template:{{", 1)
+    data = data.replace("}}", "}}:template", 1)
+    # return dumper.represent_str(f"template:{data}:template")
+    return dumper.represent_str(data)
+
+class _CustomSafeLoader(SafeLoader):
+    def __init__(self, stream):
+        super().__init__(stream)
+
+        # Disable parsing ISO date strings
+        self.add_constructor('tag:yaml.org,2002:timestamp', lambda _l, n: n.value)
+
+class _CustomSafeDumper(SafeDumper):
+    def __init__(self, stream, **kwargs):
+        super().__init__(stream, **kwargs)
+        self.add_representer(_TemplatedStr, _represent_template_str)
+
+class _TemplatedStr(str):
+    """A marker class to force template string formatting in YAML."""
+    pass
+
+def _mark_templates(obj):
+    if isinstance(obj, dict):
+        return {k: _mark_templates(v) for k, v in obj.items()}
+    elif isinstance(obj, list):
+        return [_mark_templates(v) for v in obj]
+    elif isinstance(obj, str):
+        s = obj.strip()
+        if s.startswith("{{") and s.endswith("}}"):
+            return _TemplatedStr(obj)
+    return obj
+
+class TemplateEngine:
+    def __init__(self):
+
+        engine_globals = {}
+        engine_globals['now'] = datetime.now
+
+        self.jinja2_env = Environment(
+            loader=BaseLoader(),
+            extensions=['jinja2_ansible_filters.AnsibleCoreFiltersExtension'],
+            undefined=StrictUndefined,
+            keep_trailing_newline=False
+        )
+
+        self.jinja2_async_env = Environment(
+            loader=BaseLoader(),
+            extensions=['jinja2_ansible_filters.AnsibleCoreFiltersExtension'],
+            undefined=StrictUndefined,
+            enable_async=True
+        )
+
+        self.app_context: dict[str, Any] = {}
+        # self.dbus_context: dict[str, Any] = {}
+
+        self.jinja2_env.globals.update(engine_globals)
+        self.jinja2_async_env.globals.update(engine_globals)
+
+    def add_functions(self, custom_functions: dict[str, Any]):
+        self.jinja2_env.globals.update(custom_functions)
+        self.jinja2_async_env.globals.update(custom_functions)
+
+    def update_app_context(self, context: dict[str, Any]):
+        self.app_context.update(context)
+
+    def _dict_to_templatable_str(self, value: dict[str, Any]) -> str:
+        template_str = _mark_templates(value)
+        template_str = yaml.dump(template_str, Dumper=_CustomSafeDumper)
+        # value= yaml.safe_dump(value, default_style=None)
+        # print(f"_dict_to_templatable_str: {value}")
+        template_str = template_str.replace("template:{{", "{{").replace("}}:template", "}}")
+        # print(value)
+        return template_str
+
+    def _render_result_to_dict(self, value: str) -> dict[str, Any]:
+        return yaml.load(value, _CustomSafeLoader)
+
+    def render_template(self, template: str | dict | None, res_type: type, context: dict[str, Any] = {}) -> Any:
+
+        if not template:
+            return None
+
+        if res_type not in [dict, str]:
+            raise ValueError(f"Unsupported result type: {res_type}")
+
+        dict_template = isinstance(template, dict)
+        if dict_template:
+            template = self._dict_to_templatable_str(template)
+
+        res = self.jinja2_env.from_string(template).render(**context)
+
+        if res_type is dict:
+            res = self._render_result_to_dict(res)
+
+        return res
+
+    async def async_render_template(self, template: str | dict | None, res_type: type, context: dict[str, Any] = {}) -> Any:
+
+        if not template:
+            return None
+
+        if res_type not in [dict, str]:
+            raise ValueError(f"Unsupported result type: {res_type}")
+
+        dict_template = isinstance(template, dict)
+        if dict_template:
+            template = self._dict_to_templatable_str(template)
+
+        res = await self.jinja2_async_env.from_string(template).render_async(**context)
+
+        if res_type is dict:
+            res = self._render_result_to_dict(res)
+
+        return res

dbus2mqtt-0.1.0.dist-info/METADATA

@@ -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

dbus2mqtt-0.1.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+dbus2mqtt/__init__.py,sha256=VunubKEH4_lne9Ttd2YRpyXjZMIAzyD2eiJ2sfvvTFU,362
+dbus2mqtt/__main__.py,sha256=NAoa3nwgBSQI22eWzzRx61SIDThDwXmUofWWZU3_4-Q,71
+dbus2mqtt/config.py,sha256=zcRP0Q_PHz4ypOhSvvxwlJyT6C3BE1vpjcbiUqXcXDw,4198
+dbus2mqtt/event_broker.py,sha256=bFxjrQae87XFWmV6OrYcxpiDPrVQEJv0DJucnI7HZFY,1926
+dbus2mqtt/main.py,sha256=3-2rorUesggZ9Gv3FksqZw_wapfjNRvjibaX51mVadA,4281
+dbus2mqtt/dbus/dbus_client.py,sha256=Hoa7p9zUyFCPKQtl90gCG8eBuQ8annrQoAsvjAekEMI,21882
+dbus2mqtt/dbus/dbus_types.py,sha256=bUik8LWPnLLJhhJExPuvyn1_MmkUjTn4jxXh3EkYgzI,495
+dbus2mqtt/dbus/dbus_util.py,sha256=Lk8w57j8TQxUs8d-DnTcB8wLx-cwkzzHtJY3RbTcXbo,570
+dbus2mqtt/flow/__init__.py,sha256=oatdVeBUjAJkUwM9DZsj67Z2rptOHWUn_QFVJrRu2DA,1063
+dbus2mqtt/flow/flow_processor.py,sha256=v5LvcNe-IpEXkWgBW0mK76khrqb5aFkZF0Nw2IvxIEs,7834
+dbus2mqtt/flow/actions/context_set.py,sha256=_XWJ-xHx6nhRYVrd8pBKE3rePc1KL0VU1W0q1pqYRBE,1085
+dbus2mqtt/flow/actions/mqtt_publish.py,sha256=CmW-CPIYjJ0VldcLjbK6uYDkyE65btQzT1797F2F1D0,1650
+dbus2mqtt/mqtt/mqtt_client.py,sha256=FxP82_P5mIbiFk5LOYBPRZN7zYp8XQY7xed2HCVXQoo,4071
+dbus2mqtt/template/dbus_template_functions.py,sha256=mSZr4s7XzmMCYnJYV1MlBWOBz71MGEBj6mLJzIapNf8,2427
+dbus2mqtt/template/templating.py,sha256=aBDLW6RaqiivvWjzu3jhTDdZvtZCWMtxGxm_VCaZDKs,4202
+dbus2mqtt-0.1.0.dist-info/METADATA,sha256=-qhv2PDi4q8xdDT3Gi26cdkL38HnNi026T9zOFIzOKc,7496
+dbus2mqtt-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dbus2mqtt-0.1.0.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
+dbus2mqtt-0.1.0.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
+dbus2mqtt-0.1.0.dist-info/RECORD,,

dbus2mqtt-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

dbus2mqtt-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dbus2mqtt = dbus2mqtt.main:main

dbus2mqtt-0.1.0.dist-info/licenses/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.