dbus2mqtt 0.2.0__tar.gz → 0.3.0__tar.gz

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/.github/release-drafter.yml

@@ -3,7 +3,7 @@ tag-template: 'v$RESOLVED_VERSION'
 exclude-labels:
   - dependencies
 categories:
-  - title: 💥 Breaking changes
+  - title: 🚨 Breaking changes
     labels:
       - breaking-change
   - title: 🚀 Features
@@ -12,13 +12,14 @@ categories:
       - enhancement
   - title: 🐛 Bug Fixes
     labels:
-      - fix
       - bugfix
-      - bug
   - title: 🧰 Maintenance
     labels:
       - chore
       - documentation
+  - title: ⬆️ Dependency updates
+    labels:
+      - "dependencies"
 exclude-contributors:
   - jwnmulder
 autolabeler:

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/.github/workflows/ci.yml

@@ -24,14 +24,17 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
+          activate-environment: true
           enable-cache: true
-
-      - name: "Set up Python"
-        uses: actions/setup-python@v5
-        with:
           python-version: ${{ matrix.python-version }}
 
+      # - name: "Set up Python"
+      #   uses: actions/setup-python@v5
+      #   with:
+      #     python-version: ${{ matrix.python-version }}
+
       - name: Run tests
-        run: uv run --python ${{ matrix.python-version }} pytest
+        run: uv run pytest
+        # run: uv run --python ${{ matrix.python-version }} pytest

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/.github/workflows/docker-dev.yml

@@ -4,6 +4,9 @@ name: docker-dev
   push:
     branches:
       - main
+    paths-ignore:
+      - 'docs/**'
+      - '.pre-commit-config.yaml'
   workflow_dispatch:
 
 jobs:
@@ -16,14 +19,14 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
 
-      - name: "Set up Python"
-        uses: actions/setup-python@v5
-        with:
-          python-version-file: ".python-version"
+      # - name: "Set up Python"
+      #   uses: actions/setup-python@v5
+      #   with:
+      #     python-version-file: ".python-version"
 
       - name: Determine version from hatch
         id: version
@@ -66,7 +69,7 @@ jobs:
         uses: docker/build-push-action@v6
         with:
           context: .
-          file: ./docker/Dockerfile.latest
+          file: ./docker/Dockerfile.dev
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/.github/workflows/pre-commit.yml

@@ -16,12 +16,12 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
 
-      - name: "Set up Python"
-        uses: actions/setup-python@v5
-        with:
-          python-version-file: ".python-version"
+      # - name: "Set up Python"
+      #   uses: actions/setup-python@v5
+      #   with:
+      #     python-version-file: ".python-version"
 
       - name: Uv sync
         run: uv sync

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/.github/workflows/publish.yml

@@ -17,14 +17,15 @@ jobs:
           persist-credentials: false
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v5
+        uses: astral-sh/setup-uv@v6
         with:
+          activate-environment: true
           enable-cache: true
 
-      - name: "Set up Python"
-        uses: actions/setup-python@v5
-        with:
-          python-version-file: ".python-version"
+      # - name: "Set up Python"
+      #   uses: actions/setup-python@v5
+      #   with:
+      #     python-version-file: ".python-version"
 
       - name: Build
         run: uv build

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/.pre-commit-config.yaml

@@ -26,14 +26,14 @@ repos:
       - id: codespell
 
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.37.0
+    rev: v1.37.1
     hooks:
       - id: yamllint
         args:
           - --strict
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.6
+    rev: v0.11.9
     hooks:
       - id: ruff
         args:
@@ -42,11 +42,11 @@ repos:
           - I
 
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.6.16
+    rev: 0.7.3
     hooks:
       - id: uv-lock
 
   - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.399
+    rev: v1.1.400
     hooks:
       - id: pyright

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-Version: 0.2.0
+Version: 0.3.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
@@ -19,7 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Requires-Dist: apscheduler>=3.11.0
 Requires-Dist: colorlog>=6.9.0
-Requires-Dist: dbus-next>=0.2.3
+Requires-Dist: dbus-fast>=2.44.1
 Requires-Dist: janus>=2.0.0
 Requires-Dist: jinja2-ansible-filters>=1.3.2
 Requires-Dist: jinja2>=3.1.6
@@ -111,7 +111,7 @@ cp docs/examples/home_assistant_media_player.yaml $HOME/.config/dbus2mqtt/config
 cp .env.example $HOME/.config/dbus2mqtt/.env
 
 # run image and automatically start on reboot
-sudo docker pull jwnmulder/dbus2mqtt
+docker pull jwnmulder/dbus2mqtt
 docker run --detach --name dbus2mqtt \
   --volume "$HOME"/.config/dbus2mqtt:"$HOME"/.config/dbus2mqtt \
   --volume /run/user:/run/user \
@@ -138,7 +138,7 @@ dbus2mqtt leverages [jsonargparse](https://jsonargparse.readthedocs.io/en/stable
 ### MQTT and D-Bus connection details
 
 ```bash
-# dbus_next configuration
+# dbus_fast configuration
 export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus
 
 # dbus2mqtt configuration
@@ -171,7 +171,9 @@ dbus:
             - 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`
+This configuration will expose 2 methods. Triggering methods can be done by publishing json messages to the `dbus2mqtt/org.mpris.MediaPlayer2/command` MQTT topic. Arguments can be passed along in `args`.
+
+Note that methods are called on **all** bus_names matching the configured pattern
 
 ```json
 {

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/README.md

@@ -79,7 +79,7 @@ cp docs/examples/home_assistant_media_player.yaml $HOME/.config/dbus2mqtt/config
 cp .env.example $HOME/.config/dbus2mqtt/.env
 
 # run image and automatically start on reboot
-sudo docker pull jwnmulder/dbus2mqtt
+docker pull jwnmulder/dbus2mqtt
 docker run --detach --name dbus2mqtt \
   --volume "$HOME"/.config/dbus2mqtt:"$HOME"/.config/dbus2mqtt \
   --volume /run/user:/run/user \
@@ -106,7 +106,7 @@ dbus2mqtt leverages [jsonargparse](https://jsonargparse.readthedocs.io/en/stable
 ### MQTT and D-Bus connection details
 
 ```bash
-# dbus_next configuration
+# dbus_fast configuration
 export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus
 
 # dbus2mqtt configuration
@@ -139,7 +139,9 @@ dbus:
             - 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`
+This configuration will expose 2 methods. Triggering methods can be done by publishing json messages to the `dbus2mqtt/org.mpris.MediaPlayer2/command` MQTT topic. Arguments can be passed along in `args`.
+
+Note that methods are called on **all** bus_names matching the configured pattern
 
 ```json
 {

dbus2mqtt-0.3.0/docs/examples/dbus2mqtt_internal_state.md

@@ -0,0 +1,13 @@
+# dbus2mqtt internal state example
+
+Execute the following command to run dbus2mqtt with the example configuration in this repository.
+
+```bash
+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.3.0/docs/examples/dbus2mqtt_internal_state.yaml

@@ -0,0 +1,40 @@
+# mqtt:
+#   host:
+#   port:
+
+dbus:
+  subscriptions:
+
+    # https://manpages.ubuntu.com/manpages/lunar/man5/org.freedesktop.systemd1.5.html
+    - bus_name: org.freedesktop.systemd1
+      path: /org/freedesktop/systemd1
+      interfaces:
+        - interface: org.freedesktop.DBus.Properties
+          signals:
+            - signal: PropertiesChanged
+          methods:
+            - method: GetAll
+
+    # https://lira.no-ip.org:8443/doc/gnome-session/dbus/gnome-session.html
+    - bus_name: org.gnome.SessionManager
+      path: /org/gnome/SessionManager
+      interfaces:
+        - interface: org.freedesktop.DBus.Properties
+          signals:
+            - signal: PropertiesChanged
+          methods:
+            - method: GetAll
+
+flows:
+  - name: "publish internal state"
+    triggers:
+      - type: bus_name_added
+      - type: schedule
+        interval: {seconds: 5}
+    actions:
+      - type: mqtt_publish
+        topic: dbus2mqtt/state
+        payload_type: json
+        payload_template:
+          now: "{{ now().isoformat() }}"
+          dbus_list: "{{ dbus_list('*') }}"

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/docs/examples/home_assistant_media_player.md

@@ -6,8 +6,8 @@ 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 installed and a working MQTT setup
-plugins installed
+* Home-Assistant with a working MQTT setup
+* The [media_player.template](https://github.com/Sennevds/media_player.template/tree/master) plugin
 
 Features:
 
@@ -27,21 +27,23 @@ Execute the following command to run dbus2mqtt with the example configuration in
 dbus2mqtt --config docs/examples/home_assistant_media_player.yaml
 ```
 
-
 ## Tested configurations
 
 The following setup is known to work with Home Assistant.
 
-| Application  | Play<br />Pause<br /> | Stop | Next<br />Previous | Seek<br />SetPosition | Volume | Quit | Media Info | Media Image |
-|--------------|-----------------------|------|--------------------|------|--------|------|------------|-------------|
-| `Firefox`    | ✅ | ✅ | ✅ | ✅ | | ❌ | ✅ | Youtube only |
-| `VLC` | | | | | | | | | |
+| Application  | Play<br />Pause<br /> | Stop | Next<br />Previous | Seek<br />SetPosition | Volume | Quit | Media Info | Media Image | Notes
+|--------------|-----------------------|------|--------------------|------|--------|------|------------|-------------|-------------------|
+| `Firefox`    | ✅ | ✅ | ✅ | ✅ |    | ❌ | ✅ | ✅ |  |
+| `VLC`        | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |    |  |
+| `Chromium`   | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ✅ | ✔️ | Not working when running as snap |
+
+More players that support MPRIS can be found here: <https://wiki.archlinux.org/title/MPRIS>
 
 ## Player commands
 
 The following table lists player commands, their descriptions, and an example JSON payload for invoking them via MQTT.
 
-Dbus methods can be invoked by sendig the JSON payload to MQTT topic `dbus2mqtt/org.mpris.MediaPlayer2/command`. Method calls will be done for all matching players
+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                           |
 |---------------------------------|---------------|------------------------------------------|------------------------------------------------|
@@ -52,7 +54,7 @@ Dbus methods can be invoked by sendig the JSON payload to MQTT topic `dbus2mqtt/
 | `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` | `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" }`                         |
 
@@ -73,15 +75,11 @@ mqtt:
       json_attributes_topic: dbus2mqtt/org.mpris.MediaPlayer2/state
       value_template: >-
         {% set status = value_json.PlaybackStatus %}
-        {% if status == 'Playing' %}
-          playing
-        {% elif status == 'Paused' %}
-          paused
-        {% elif status == 'Stopped' %}
-          idle
-        {% else %}
-          off
-        {% endif %}
+        {{ {'Playing': 'playing', 'Paused': 'paused', 'Stopped': 'idle'}.get(status, 'off') }}
+
+  image:
+    - name: MPRIS Media Player MQTT image
+      image_topic: dbus2mqtt/org.mpris.MediaPlayer2/artUrlImage
 
 media_player:
   - platform: media_player_template
@@ -94,21 +92,31 @@ 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')['xesam:title'] }}"
+        title_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('xesam:title', '') }}"
 
         media_content_type_template: music  # needed to show 'artist'
-        media_duration_template: "{{ state_attr('sensor.mpris_media_player', 'Metadata')['mpris:length'] }}"
-        album_template: "{{ state_attr('sensor.mpris_media_player', 'Metadata')['xesam:album'] }}"
-        artist_template: "{{ state_attr('sensor.mpris_media_player', 'Metadata')['xesam:artist'] | first }}"
+        media_duration_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('mpris:length', 0) }}"
+        album_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('xesam:album', '') }}"
+        artist_template: "{{ (state_attr('sensor.mpris_media_player', 'Metadata') or {}).get('xesam:artist', ['']) | first }}"
 
-        # mpris:artUrl is referencing a local file when firefox is used, for now this will provide Youtube img support
+        # mpris:artUrl might contain a file:// schema. In these cases we rely on images published via MQTT
         media_image_url_template: >-
-          {{ state_attr('sensor.mpris_media_player', 'Metadata')['xesam:url']
-            | regex_replace(
-                find='https:\/\/www\\.youtube\\.com\/watch\\?v=([^&]+).*',
-                replace='https://img.youtube.com/vi/\\1/maxresdefault.jpg'
-              )
-          }}
+          {% set mpris_metadata = state_attr('sensor.mpris_media_player', 'Metadata') or {} %}
+          {% set mpris_art_url = mpris_metadata.get('mpris:artUrl', '') %}
+          {% set mpris_url = mpris_metadata.get('xesam:url') %}
+
+          {% if mpris_art_url.startswith('http') %}
+            {{ mpris_art_url }}
+          {% elif mpris_art_url.startswith('file://') %}
+            http://127.0.0.1:8123{{ state_attr('image.mpris_media_player_mqtt_image', 'entity_picture') }}
+          {% else %}
+            {{
+                mpris_url | regex_replace(
+                  find='https:\/\/www\\.youtube\\.com\/watch\\?v=([^&]+).*',
+                  replace='https://img.youtube.com/vi/\\1/maxresdefault.jpg'
+                )
+            }}
+          {% endif %}
 
         turn_off:
           service: mqtt.publish
@@ -144,7 +152,7 @@ media_player:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: >-
+            payload: >
               { "method": "SetPosition", "args": ["{{ state_attr('sensor.mpris_media_player', 'Metadata')['mpris:trackid'] }}", {{ position | int }}] }
         set_volume:
           service: mqtt.publish
@@ -155,10 +163,12 @@ media_player:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"property": "Volume", "value": 0.0 }'
+            payload: >
+              {"property": "Volume", "value": {{ [1, (state_attr('sensor.mpris_media_player', 'Volume') + 0.1)] | min }} }
         volume_down:
           service: mqtt.publish
           data:
             topic: dbus2mqtt/org.mpris.MediaPlayer2/command
-            payload: '{"property": "Volume", "value": 0.0 }'
+            payload: >
+              {"property": "Volume", "value": {{ [0, (state_attr('sensor.mpris_media_player', 'Volume') - 0.1)] | max }} }
 ```

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/docs/examples/home_assistant_media_player.yaml

@@ -24,6 +24,8 @@ dbus:
 
         - interface: org.mpris.MediaPlayer2.Player
           mqtt_command_topic: dbus2mqtt/org.mpris.MediaPlayer2/command
+          signals:
+            - signal: Seeked
           methods:
             - method: Pause
             - method: Play
@@ -38,7 +40,7 @@ dbus:
             - property: Volume
 
       flows:
-        - name: "MPRIS publish player state"
+        - name: "publish player state"
           triggers:
             - type: bus_name_added
             - type: schedule
@@ -47,17 +49,18 @@ dbus:
               interface: org.freedesktop.DBus.Properties
               signal: PropertiesChanged
               # filter: "{{ args[0] == 'org.mpris.MediaPlayer2.Player' }}"
+            - type: dbus_signal
+              interface: org.mpris.MediaPlayer2.Player
+              signal: Seeked
           actions:
             - type: context_set
               context:
                 mpris_bus_name: '{{ dbus_list("org.mpris.MediaPlayer2.*") | first }}'
-                path: /org/mpris/MediaPlayer2
+                mpris_path: /org/mpris/MediaPlayer2
             - type: context_set
               context:
                 player_properties: |
-                  {{ dbus_call(mpris_bus_name, path, 'org.freedesktop.DBus.Properties', 'GetAll', ['org.mpris.MediaPlayer2.Player']) }}
-                volume: |
-                  {{ dbus_property_get(mpris_bus_name, path, 'org.mpris.MediaPlayer2.Player', 'Volume', 0) }}
+                  {{ dbus_call(mpris_bus_name, mpris_path, 'org.freedesktop.DBus.Properties', 'GetAll', ['org.mpris.MediaPlayer2.Player']) }}
             - type: mqtt_publish
               topic: dbus2mqtt/org.mpris.MediaPlayer2/state
               payload_type: json
@@ -65,9 +68,27 @@ dbus:
                 {{
                     { 'bus_name': mpris_bus_name }
                     | combine(player_properties)
-                    | combine({ 'Volume': volume })
                 }}
-        - name: "MPRIS player removed"
+
+        - name: "publish local art image"
+          # mpris:artUrl can have a file:// or http:// schema
+          # Home Assistant is unable to access file:// so we use MQTT for that
+          triggers:
+            - type: bus_name_added
+            - type: dbus_signal
+              interface: org.freedesktop.DBus.Properties
+              signal: PropertiesChanged
+          actions:
+            - type: context_set
+              context:
+                artUrl: "{{ (dbus_property_get(bus_name, path, 'org.mpris.MediaPlayer2.Player', 'Metadata') or {}).get('mpris:artUrl') }}"
+            - type: mqtt_publish
+              topic: dbus2mqtt/org.mpris.MediaPlayer2/artUrlImage
+              payload_type: binary
+              payload_template: |
+                {{ artUrl if artUrl and artUrl.startswith('file://') else None }}
+
+        - name: "player removed"
           triggers:
             - type: bus_name_removed
             # filter: # TODO: Check if this is the last or inactive one #

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/docs/examples.md

@@ -1,4 +1,4 @@
 Examples in this repository
 
 * [MPRIS to Home Assistant Media Player integration](examples/home_assistant_media_player.md)
-* [Some other examples (WIP)](examples/linux_desktop.md)
+* [Publish dbus2mqtt internal state](examples/dbus2mqtt_internal_state.md)

dbus2mqtt-0.3.0/docs/flows.md

@@ -0,0 +1,122 @@
+# Flows
+
+**dbus2mqtt** allows you to add additional processing logic (flows) for when events occur. Configuration is best done in yaml and a complete example can be found here: [MPRIS to Home Assistant Media Player integration](https://github.com/jwnmulder/dbus2mqtt/blob/main/docs/examples/home_assistant_media_player.md)
+
+Flows can be defined on a global or dbus subscription level and can be triggered by any of the following events:
+
+* `schedule` for cron based schedules
+* `dbus_signal` for when dbus signal occur
+* `bus_name_added` when a new bus_name is registered on dbus
+* `bus_name_removed` when a bus_name is removed from dbus
+
+Within each flow a set of actions can be configured. These are executed in order
+
+* `context_set` to set variables
+* `mqtt_publish` to publish a mqtt message
+
+Actions support string templating which is based on jinja2
+
+## Flow triggers
+
+### schedule
+
+```yaml
+type: schedule
+cron: {second: 5}
+interval: {seconds: 5}
+```
+
+Schedule based triggers can be configured by setting either a cron or interval parameter. Scheduling is based on the   APScheduler library and allows the following configuration options
+
+| key | description  |
+|------|-------------|
+| interval | dict of time units and intervals, see <https://apscheduler.readthedocs.io/en/3.x/modules/triggers/interval.html>    |
+| cron     | dict of time units and cron expressions, see <https://apscheduler.readthedocs.io/en/3.x/modules/triggers/cron.html> |
+
+When triggered, the following context parameters are available
+
+| name | description |
+|------|-------------|
+| N/A  | N/A         |
+
+### dbus_signal
+
+DBus signals triggers must be configured with an anterface and path. Note that only subscribed signals can be configured as a trigger.
+
+| key | description  |
+|------|-------------|
+| interface | interface to filter on, e.g. 'org.freedesktop.DBus.Properties' |
+| signal    | signal name to filter on, e.g. PropertiesChanged |
+
+When triggered, the following context parameters are available
+
+| name | type | description |
+|------|------|-------------|
+| bus_name  | string | bus_name of the object that was registered on dbus |
+| path      | string | bus_name path of the object that was registered on dbus |
+| interface | string | name of interface for which the signal was triggered |
+| args      | list   | signal arguments, list of objects |
+
+### bus_name_added
+
+```yaml
+type: bus_name_added
+```
+
+When triggered, the following context parameters are available
+
+| name | description |
+|------|-------------|
+| bus_name | bus_name of the object that was registered on dbus |
+| path     | bus_name path of the object that was registered on dbus |
+
+### bus_name_removed
+
+```yaml
+type: bus_name_removed
+```
+
+When triggered, the following context parameters are available
+
+| name | description |
+|------|-------------|
+| bus_name | bus_name of the object that was registered on dbus |
+| path     | bus_name path of the object that was registered on dbus |
+
+## Flow actions
+
+### context_set
+
+```yaml
+type: context_set
+context: {}
+dbus_object_context: {}
+global_context: {}
+```
+
+| key                 | type             | description  |
+|---------------------|------------------|--------------|
+| context             | dict | Per flow execution context. Value can be a dict of strings or dict of templated strings |
+| dbus_object_context | dict | Per dbus object context, shared between multiple flow executions. Value can be a dict of strings or dict of templated strings |
+| global_context      | dict | Global context, shared between multiple flow executions, over all subscriptions. Value can be a dict of strings or dict of templated strings |
+
+
+
+### mqtt_publish
+
+```yaml
+type: mqtt_publish
+topic: dbus2mqtt/org.mpris.MediaPlayer2/state
+payload_type: json
+payload_template: {PlaybackStatus: "Off"}
+```
+
+| key              | type             | description  |
+|------------------|------------------|-------------|
+| topic            | string | mqtt topic the messaage is published to |
+| payload_type     | string | any of [json, yaml, text], defaults to json, format the message is published in to mqtt |
+| payload_template | string, dict | value can be a string, a dict of strings, a templated string or a nested dict of templated strings |
+
+## Jinja2 based templating
+
+Some configuration values allow the use of jinja 2 templating. dbus2mqtt supports both the builtin filters and comes with additional filters from [jinja2-ansible-filters](https://pypi.org/project/jinja2-ansible-filters/)

{dbus2mqtt-0.2.0 → dbus2mqtt-0.3.0}/pyproject.toml

@@ -40,7 +40,7 @@ requires-python = ">=3.10"
 dependencies = [
     "apscheduler>=3.11.0",
     "colorlog>=6.9.0",
-    "dbus-next>=0.2.3",
+    "dbus-fast>=2.44.1",
     "janus>=2.0.0",
     "jinja2>=3.1.6",
     "jinja2-ansible-filters>=1.3.2",