Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/reference.rst @mqtt_trigger and callbacks #707

Merged
merged 2 commits into from
Mar 10, 2025
+7 −4
Merged

docs/reference.rst @mqtt_trigger and callbacks #707

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25c9b5a
Update reference.rst @mqtt_trigger
dfries Mar 9, 2025
1e78770
Update reference.rst Language Limiations
dfries Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions docs/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -774,15 +774,16 @@ on that topic. Multiple ``@mqtt_trigger`` decorators can be applied to a single
to trigger off different mqtt topics.

An optional ``str_expr`` can be used to match the MQTT message data, and the trigger will only occur
if that expression evaluates to ``True`` or non-zero. This expression has available these four
if that expression evaluates to ``True`` or non-zero. This expression has available these
variables:

- ``trigger_type`` is set to "mqtt"
- ``topic`` is set to the topic the message was received on
- ``qos`` is set to the message QoS.
- ``payload`` is set to the string payload of the message
- ``payload_obj`` if the payload was valid JSON, this will be set to the native Python object
representing that payload.
- ``qos`` is set to the message QoS.
representing that payload. A null message will not be converted. If payload_obj is a
required function argument an exception will be thrown, use payload_obj=None.

When the ``@mqtt_trigger`` occurs, those same variables are passed as keyword arguments to the
function in case it needs them. Additional keyword parameters can be specified by setting the
Expand All @@ -792,6 +793,7 @@ Wildcards in topics are supported. The ``topic`` variables will be set to the fu
the message arrived on.

Wildcards are:

- ``+`` matches a single level in the topic hierarchy.
- ``#`` matches zero or more levels in the topic hierarchy, can only be last.

Expand Down Expand Up @@ -2144,7 +2146,8 @@ it doesn't faithfully mimic Python. Here are some areas where pyscript differs
won't be able to call that pyscript function unless it uses ``await``, which requires that function to
be declared ``async``. Unless the Python module is designed to support async callbacks, it is not
currently possible to have Python modules and packages call pyscript functions. The workaround is
to move your callbacks from pyscript and make them native Python functions; see `Importing <#importing>`__.
to move your callbacks from pyscript and make them native Python functions; see `Importing <#importing>`__,
call a function with the ``@pyscript_compile`` decorator, or a lambda (which is also compiled).
- Continuing that point, special methods (e.g., ``__eq__``) in a class created in `pyscript` will not work since
they are async functions and Python will not be able to call them. The two workarounds are to
use the ``@pyscript_compile`` decorator so the method is compiled to a native (non-async) Python
Expand Down