dbus2mqtt 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

dbus2mqtt/config.py

@@ -15,8 +15,9 @@ class SignalConfig:
     filter: str | None = None
 
     def matches_filter(self, template_engine: TemplateEngine, *args) -> bool:
-        res = template_engine.render_template(self.filter, str, { "args": args })
-        return res == "True"
+        if self.filter:
+            return template_engine.render_template(self.filter, bool, { "args": args })
+        return True
 
 @dataclass
 class MethodConfig:
@@ -29,13 +30,15 @@ class PropertyConfig:
 @dataclass
 class InterfaceConfig:
     interface: str
-    mqtt_call_method_topic: str | None = None
+    mqtt_command_topic: str | None = None
     signals: list[SignalConfig] = field(default_factory=list)
     methods: list[MethodConfig] = field(default_factory=list)
     properties: list[PropertyConfig] = field(default_factory=list)
 
-    def render_mqtt_call_method_topic(self, template_engine: TemplateEngine, context: dict[str, Any]) -> Any:
-        return template_engine.render_template(self.mqtt_call_method_topic, str, context)
+    def render_mqtt_command_topic(self, template_engine: TemplateEngine, context: dict[str, Any]) -> Any:
+        if self.mqtt_command_topic:
+            return template_engine.render_template(self.mqtt_command_topic, str, context)
+        return None
 
 @dataclass
 class FlowTriggerMqttConfig:
@@ -84,8 +87,6 @@ class FlowActionContextSetConfig:
 class FlowActionMqttPublishConfig:
     topic: str
     payload_template: str | dict[str, Any]
-    """should be a dict if payload_type is json/yaml
-    or a string if payload_type is text"""
     type: Literal["mqtt_publish"] = "mqtt_publish"
     payload_type: Literal["json", "yaml", "text"] = "json"
 

dbus2mqtt/dbus/dbus_client.py

@@ -389,7 +389,7 @@ class DbusClient:
         for subscription_configs in self.config.subscriptions:
             for interface_config in subscription_configs.interfaces:
                 # TODO, performance improvement
-                mqtt_topic = interface_config.render_mqtt_call_method_topic(self.templating, {})
+                mqtt_topic = interface_config.render_mqtt_command_topic(self.templating, {})
                 found_matching_topic |= mqtt_topic == msg.topic
 
         if not found_matching_topic:

dbus2mqtt/flow/__init__.py

@@ -6,15 +6,34 @@ class FlowExecutionContext:
 
     def __init__(self, name: str | None, global_flows_context: dict[str, Any], flow_context: dict[str, Any]):
         self.name = name
+
         self.global_flows_context = global_flows_context
+        """
+        Global flows context which is shared across all flows.
+        Modifiable by user.
+        **Not** cleaned up after flow execution.
+        """
+
         self.flow_context = flow_context
+        """
+        Flow context which contains flow specific context like 'subscription_bus_name'.
+        **Not** modifiable by user.
+        **Not** cleaned up after flow execution.
+        """
 
-        # per flow execution context
         self.context: dict[str, Any] = {}
+        """
+        Per flow execution context.
+        Modifiable by user.
+        Cleaned up after each flow execution
+        """
 
     def get_aggregated_context(self) -> dict[str, Any]:
-        """Get the aggregated context for the flow execution."""
-        # Merge global flows context, flow context, and local context
+        """
+        Get the aggregated context for the flow execution.
+        Merges global flows context, flow context, and local context
+        """
+
         context = {}
         if self.global_flows_context:
             context.update(self.global_flows_context)

dbus2mqtt/flow/actions/context_set.py

@@ -15,12 +15,14 @@ class ContextSetAction(FlowAction):
     async def execute(self, context: FlowExecutionContext):
 
         aggregated_context = context.get_aggregated_context()
+
         if self.config.global_context:
             context_new = await self.templating.async_render_template(self.config.global_context, dict, aggregated_context)
             logger.debug(f"Update global_context with: {context_new}")
             context.global_flows_context.update(context_new)
 
         if self.config.context:
+
             context_new = await self.templating.async_render_template(self.config.context, dict, aggregated_context)
             logger.debug(f"Update context with: {context_new}")
             context.context.update(context_new)

dbus2mqtt/flow/actions/mqtt_publish.py

@@ -1,7 +1,7 @@
 
 import logging
 
-from jinja2.exceptions import TemplateRuntimeError
+from jinja2.exceptions import TemplateError
 
 from dbus2mqtt import AppContext
 from dbus2mqtt.config import FlowActionMqttPublishConfig
@@ -24,14 +24,20 @@ class MqttPublishAction(FlowAction):
         try:
             mqtt_topic = await self.templating.async_render_template(self.config.topic, str, render_context)
 
-            payload_res_type = str if self.config.payload_type == "text" else dict
-            payload = await self.templating.async_render_template(self.config.payload_template, payload_res_type, render_context)
+            if self.config.payload_type == "text":
+                res_type = str
+            else:
+                res_type = dict
 
-        except TemplateRuntimeError as e:
-            logger.warning(f"Error rendering jinja template, flow: '{context.name}', error: {str(e)}. render_context={render_context}", exc_info=True)
+            payload = await self.templating.async_render_template(self.config.payload_template, res_type, render_context)
+
+        except TemplateError as e:
+            logger.warning(f"Error rendering jinja template, flow: '{context.name or ''}', msg={e}, payload_template={self.config.payload_template}, render_context={render_context}", exc_info=True)
             return
         except Exception as e:
-            logger.warning(f"Error rendering jinja template, flow: '{context.name}', error: {str(e)}. render_context={render_context}", exc_info=False)
+            # Dont log full exception info to avoid log spamming on dbus errors
+            # due to clients disconnecting
+            logger.warning(f"Error rendering jinja template, flow: '{context.name or ''}', msg={e} payload_template={self.config.payload_template}, render_context={render_context}")
             return
 
         logger.debug(f"public_mqtt: flow={context.name}, payload={payload}")

dbus2mqtt/main.py

@@ -121,15 +121,6 @@ def main():
         apscheduler_logger = logging.getLogger("apscheduler")
         apscheduler_logger.setLevel(logging.WARNING)
 
-
-    # handler.setFormatter(colorlog.ColoredFormatter('%(log_color)s%(levelname)s:%(name)s:%(message)s'))
-
-    # logger = colorlog.getLogger('')
-    # for handler in logger.handlers:
-    #     print(handler.st)
-    #     if isinstance(handler, colorlog.StreamHandler):
-    #         handler.setFormatter(colorlog.ColoredFormatter('%(log_color)s%(levelname)s:%(name)s:%(message)s'))
-
     logger.debug(f"config: {config}")
 
     asyncio.run(run(config))

dbus2mqtt/mqtt/mqtt_client.py

@@ -43,15 +43,14 @@ class MqttClient:
             port=self.config.port
         )
 
-    # def on_dbus_signal(self, bus_name: str, path: str, interface: str, signal: str, topic, msg: dict[str, Any]):
-    #     payload = json.dumps(msg)
-    #     logger.debug(f"on_dbus_signal: payload={payload}")
-    #     self.client.publish(topic=topic, payload=payload)
-
     async def mqtt_publish_queue_processor_task(self):
+
+        first_message = True
+
         """Continuously processes messages from the async queue."""
         while True:
             msg = await self.event_broker.mqtt_publish_queue.async_q.get()  # Wait for a message
+
             try:
                 payload = msg.payload
                 type = msg.payload_serialization_type
@@ -65,6 +64,11 @@ class MqttClient:
 
                 logger.debug(f"mqtt_publish_queue_processor_task: payload={payload}")
                 self.client.publish(topic=msg.topic, payload=payload)
+
+                if first_message:
+                    logger.info(f"First message published: topic={msg.topic}, payload={payload}")
+                    first_message = False
+
             except Exception as e:
                 logger.warning(f"mqtt_publish_queue_processor_task: Exception {e}", exc_info=True)
             finally:

dbus2mqtt/template/templating.py

@@ -1,49 +1,11 @@
 
 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
+from typing import Any, TypeVar
+
+from jinja2 import BaseLoader, StrictUndefined, TemplateError
+from jinja2.nativetypes import NativeEnvironment
+
+TemplateResultType = TypeVar('TemplateResultType')
 
 class TemplateEngine:
     def __init__(self):
@@ -51,14 +13,14 @@ class TemplateEngine:
         engine_globals = {}
         engine_globals['now'] = datetime.now
 
-        self.jinja2_env = Environment(
+        self.jinja2_env = NativeEnvironment(
             loader=BaseLoader(),
             extensions=['jinja2_ansible_filters.AnsibleCoreFiltersExtension'],
             undefined=StrictUndefined,
             keep_trailing_newline=False
         )
 
-        self.jinja2_async_env = Environment(
+        self.jinja2_async_env = NativeEnvironment(
             loader=BaseLoader(),
             extensions=['jinja2_ansible_filters.AnsibleCoreFiltersExtension'],
             undefined=StrictUndefined,
@@ -66,7 +28,6 @@ class TemplateEngine:
         )
 
         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)
@@ -78,52 +39,65 @@ class TemplateEngine:
     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 _convert_value(self, res: Any, res_type: type[TemplateResultType]) -> TemplateResultType:
 
-    def _render_result_to_dict(self, value: str) -> dict[str, Any]:
-        return yaml.load(value, _CustomSafeLoader)
+        if isinstance(res, res_type):
+            return res
 
-    def render_template(self, template: str | dict | None, res_type: type, context: dict[str, Any] = {}) -> Any:
+        try:
+            return res_type(res) # type: ignore
 
-        if not template:
-            return None
+        except Exception as e:
+            raise ValueError(f"Error converting rendered template result from '{type(res).__name__}' to '{res_type.__name__}'") from e
 
-        if res_type not in [dict, str]:
-            raise ValueError(f"Unsupported result type: {res_type}")
+    def _render_template_nested(self, templatable: str | dict[str, Any], context: dict[str, Any] = {}) -> Any:
 
-        dict_template = isinstance(template, dict)
-        if dict_template:
-            template = self._dict_to_templatable_str(template)
+        if isinstance(templatable, str):
+            try:
+                return self.jinja2_env.from_string(templatable).render(**context)
+            except TemplateError as e:
+                raise TemplateError(f"Error compiling template, template={templatable}: {e}") from e
 
-        res = self.jinja2_env.from_string(template).render(**context)
+        elif isinstance(templatable, dict):
+            res = {}
+            for k, v in templatable.items():
+                if isinstance(v, dict) or isinstance(v, str):
+                    res[k] = self._render_template_nested(v, context)
+                else:
+                    res[k] = v
+            return res
 
-        if res_type is dict:
-            res = self._render_result_to_dict(res)
+    def render_template(self, templatable: str | dict[str, Any], res_type: type[TemplateResultType], context: dict[str, Any] = {}) -> TemplateResultType:
 
-        return res
+        if isinstance(templatable, dict) and res_type is not dict:
+            raise ValueError(f"res_type should dict for dictionary templates, templatable={templatable}")
 
-    async def async_render_template(self, template: str | dict | None, res_type: type, context: dict[str, Any] = {}) -> Any:
+        res = self._render_template_nested(templatable, context)
+        res = self._convert_value(res, res_type)
+        return res
 
-        if not template:
-            return None
+    async def _async_render_template_nested(self, templatable: str | dict[str, Any], context: dict[str, Any] = {}) -> Any:
 
-        if res_type not in [dict, str]:
-            raise ValueError(f"Unsupported result type: {res_type}")
+        if isinstance(templatable, str):
+            try:
+                return await self.jinja2_async_env.from_string(templatable).render_async(**context)
+            except TemplateError as e:
+                raise TemplateError(f"Error compiling template, template={templatable}: {e}") from e
 
-        dict_template = isinstance(template, dict)
-        if dict_template:
-            template = self._dict_to_templatable_str(template)
+        elif isinstance(templatable, dict):
+            res = {}
+            for k, v in templatable.items():
+                if isinstance(v, dict) or isinstance(v, str):
+                    res[k] = await self._async_render_template_nested(v, context)
+                else:
+                    res[k] = v
+            return res
 
-        res = await self.jinja2_async_env.from_string(template).render_async(**context)
+    async def async_render_template(self, templatable: str | dict[str, Any], res_type: type[TemplateResultType], context: dict[str, Any] = {}) -> TemplateResultType:
 
-        if res_type is dict:
-            res = self._render_result_to_dict(res)
+        if isinstance(templatable, dict) and res_type is not dict:
+            raise ValueError(f"res_type should be dict for dictionary templates, templatable={templatable}")
 
+        res = await self._async_render_template_nested(templatable, context)
+        res = self._convert_value(res, res_type)
         return res

{dbus2mqtt-0.1.2.dist-info → dbus2mqtt-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbus2mqtt
-Version: 0.1.2
+Version: 0.2.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
@@ -51,12 +51,6 @@ This makes it easy to integrate Linux desktop services or system signals into MQ
 
 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
-
-* 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
@@ -86,7 +80,7 @@ dbus:
               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 }}
+                {{ dbus_call(mpris_bus_name, path, 'org.freedesktop.DBus.Properties', 'GetAll', ['org.mpris.MediaPlayer2.Player']) }}
 ```
 
 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.
@@ -117,6 +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 run --detach --name dbus2mqtt \
   --volume "$HOME"/.config/dbus2mqtt:"$HOME"/.config/dbus2mqtt \
   --volume /run/user:/run/user \
@@ -170,7 +165,7 @@ dbus:
       path: /org/mpris/MediaPlayer2
       interfaces:
         - interface: org.mpris.MediaPlayer2.Player
-          mqtt_call_method_topic: dbus2mqtt/org.mpris.MediaPlayer2/command
+          mqtt_command_topic: dbus2mqtt/org.mpris.MediaPlayer2/command
           methods:
             - method: Pause
             - method: Play

dbus2mqtt-0.2.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=aTAWR4G1y12-96w1db2rjdCafEy6gF9gAiNFcW3Sz4M,4152
+dbus2mqtt/event_broker.py,sha256=GG7vZZHu08vJgCH5cA-yw3yWU3I2wWHhiEFNMHA4oJk,1836
+dbus2mqtt/main.py,sha256=1zodEH7s-u75eY4fYLSpV-mtcCV_VL38Do2VXLinrh4,3898
+dbus2mqtt/dbus/dbus_client.py,sha256=Y5upYGX84TCZRzJb7cQhxv9irXBfxo6bFmUil-jdlo4,22005
+dbus2mqtt/dbus/dbus_types.py,sha256=bUik8LWPnLLJhhJExPuvyn1_MmkUjTn4jxXh3EkYgzI,495
+dbus2mqtt/dbus/dbus_util.py,sha256=kAqA9SPR1N45fzXeXmBXlhulFEIFKrOIvr_LeygO928,569
+dbus2mqtt/flow/__init__.py,sha256=tAL-CjXQHq_tGTKctIdOZ5teVKBtcJs6Astq_RdruV8,1540
+dbus2mqtt/flow/flow_processor.py,sha256=v5LvcNe-IpEXkWgBW0mK76khrqb5aFkZF0Nw2IvxIEs,7834
+dbus2mqtt/flow/actions/context_set.py,sha256=dIT39MJJVb0wuRI_ZM3ssnXYfa-iyB4o_UZD-1BZL2g,1087
+dbus2mqtt/flow/actions/mqtt_publish.py,sha256=-qQtyc1KspPzAus3AK0iO629RP3RIAMwUecMqqBIrRY,1878
+dbus2mqtt/mqtt/mqtt_client.py,sha256=xUJzkkv2uE3xWy0-SINeRjwfMNnDNLytdxEe3ahIIvk,4006
+dbus2mqtt/template/dbus_template_functions.py,sha256=mSZr4s7XzmMCYnJYV1MlBWOBz71MGEBj6mLJzIapNf8,2427
+dbus2mqtt/template/templating.py,sha256=phmh18uslexw1CmjYHotMHc4zfzIEUflwLnrnBGfAVs,4096
+dbus2mqtt-0.2.0.dist-info/METADATA,sha256=qwjAjBYoDxEsbFkwZXnhEW7hzwXICEd4qFj8sdo8xTw,7750
+dbus2mqtt-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dbus2mqtt-0.2.0.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
+dbus2mqtt-0.2.0.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
+dbus2mqtt-0.2.0.dist-info/RECORD,,

dbus2mqtt-0.1.2.dist-info/RECORD

@@ -1,20 +0,0 @@
-dbus2mqtt/__init__.py,sha256=VunubKEH4_lne9Ttd2YRpyXjZMIAzyD2eiJ2sfvvTFU,362
-dbus2mqtt/__main__.py,sha256=NAoa3nwgBSQI22eWzzRx61SIDThDwXmUofWWZU3_4-Q,71
-dbus2mqtt/config.py,sha256=wRXT_qYCVRFLioE8H-1sNQiSCRCcE4imGohudZvMEW0,4179
-dbus2mqtt/event_broker.py,sha256=GG7vZZHu08vJgCH5cA-yw3yWU3I2wWHhiEFNMHA4oJk,1836
-dbus2mqtt/main.py,sha256=3-2rorUesggZ9Gv3FksqZw_wapfjNRvjibaX51mVadA,4281
-dbus2mqtt/dbus/dbus_client.py,sha256=3falwDADq9SoLiaQFGGRH6pcm8eD23tujrL2x-CBoyw,22009
-dbus2mqtt/dbus/dbus_types.py,sha256=bUik8LWPnLLJhhJExPuvyn1_MmkUjTn4jxXh3EkYgzI,495
-dbus2mqtt/dbus/dbus_util.py,sha256=kAqA9SPR1N45fzXeXmBXlhulFEIFKrOIvr_LeygO928,569
-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.2.dist-info/METADATA,sha256=syl_84CzV7dH7XUI2fqt-vtQn3w2Dania2gdN989voQ,8090
-dbus2mqtt-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dbus2mqtt-0.1.2.dist-info/entry_points.txt,sha256=pmmacoHCsvTTUB5dIPaY4i0H9gX7BQlpd3rBU-Jbv3A,50
-dbus2mqtt-0.1.2.dist-info/licenses/LICENSE,sha256=a4bIEgyA9rrnAfUN90CgbgZ6BQIFHeABkk0JihiBaxM,1074
-dbus2mqtt-0.1.2.dist-info/RECORD,,