Feature Request: Add 'retained' status to @mqtt_trigger

[3735943886]

Currently, when a function decorated with @mqtt_trigger is triggered, there is no way to access the retain flag of the incoming MQTT message.
How about adding a new keyword argument, retain, to the list of available variables passed to the decorated function. This variable would be a boolean (True or False) indicating the retained status of the message.

[ALERTua]

Could you please provide code examples "before-after"?

[3735943886]

I'm not fully familiar with the specific mqttmsg object used here, but if it has a .retain attribute (like paho), this change would add the retain status to the func_args dictionary.

in mqtt.py

    def mqtt_message_handler_maker(cls, subscribed_topic):
        """Closure for mqtt_message_handler."""

        async def mqtt_message_handler(mqttmsg):
            """Listen for MQTT messages."""
            func_args = {
                "trigger_type": "mqtt",
                "topic": mqttmsg.topic,
                "payload": mqttmsg.payload,
                "qos": mqttmsg.qos,
                "retain": mqttmsg.retain,
            }

            try:
                func_args["payload_obj"] = json.loads(mqttmsg.payload)
            except ValueError:
                pass

            await cls.update(subscribed_topic, func_args)

        return mqtt_message_handler

[3735943886]

I'm not fully familiar with the specific mqttmsg object used here, but if it has a .retain attribute (like paho), this change would add the retain status to the func_args dictionary.

in mqtt.py

    def mqtt_message_handler_maker(cls, subscribed_topic):
        """Closure for mqtt_message_handler."""

        async def mqtt_message_handler(mqttmsg):
            """Listen for MQTT messages."""
            func_args = {
                "trigger_type": "mqtt",
                "topic": mqttmsg.topic,
                "payload": mqttmsg.payload,
                "qos": mqttmsg.qos,
                "retain": mqttmsg.retain,
            }

            try:
                func_args["payload_obj"] = json.loads(mqttmsg.payload)
            except ValueError:
                pass

            await cls.update(subscribed_topic, func_args)

        return mqtt_message_handler

I tried it, but it didn't work. I'll look for another way.

run_coro: got exception Traceback (most recent call last): File "/config/custom_components/pyscript/eval.py", line 756, in call raise TypeError(f"{self.name}() called with unexpected keyword arguments: {unexpected}") TypeError: mqtt2ble() called with unexpected keyword arguments: retain

[3735943886]

I've opened PR #755 to add this feature. Looking forward to your review.