.. first line of object.rst template
.. first line of pou-object.rst template
.. first line of fun-object.rst template
.. _`.fld-FinderOpta.fld-Functions.fld-Read.MQTT_ReadTopicBool`:


.. index::
   single: MQTT_ReadTopicBool

.. _`MQTT_ReadTopicBool`:

``MQTT_ReadTopicBool`` (FUN)
----------------------------

FUNCTION MQTT_ReadTopicBool : WORD




This function subscribes to the specified MQTT topic and returns published messages as booleans.

The output ``valid`` is set to ``TRUE`` when a publication occurs
on the topic and the message payload is copied into ``value``.





InOut:
    +--------+------------------------+-----------------+------------------------------------------------------------+
    | Scope  | Name                   | Type            | Comment                                                    |
    +========+========================+=================+============================================================+
    | Return | ``MQTT_ReadTopicBool`` | ``WORD``        | Status code returned by the runtime (0 means "no errors"). |
    +--------+------------------------+-----------------+------------------------------------------------------------+
    | Inout  | ``id``                 | ``WORD``        | Operation identifier used by the runtime.                  |
    +--------+------------------------+-----------------+------------------------------------------------------------+
    | Input  | ``topic``              | ``STRING(127)`` | MQTT topic name.                                           |
    +        +------------------------+-----------------+------------------------------------------------------------+
    |        | ``qos``                | ``WORD``        | Quality of Service level.                                  |
    +--------+------------------------+-----------------+------------------------------------------------------------+
    | Output | ``value``              | ``BOOL``        | Boolean value received from the topic.                     |
    +        +------------------------+-----------------+------------------------------------------------------------+
    |        | ``valid``              | ``BOOL``        | ``TRUE`` when a valid value has been received.             |
    +--------+------------------------+-----------------+------------------------------------------------------------+







.. last line of fun-object.rst template
.. last line of pou-object.rst template
.. last line of object.rst template



