.. 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-Send.MQTT_SendTopicBool`:


.. index::
   single: MQTT_SendTopicBool

.. _`MQTT_SendTopicBool`:

``MQTT_SendTopicBool`` (FUN)
----------------------------

FUNCTION MQTT_SendTopicBool : WORD




This function publishes a boolean value to the specified MQTT topic.

The output ``sent`` is set to ``TRUE`` when the publish operation has been
completed.





InOut:
    +--------+------------------------+-----------------+-------------------------------------------------------------+
    | Scope  | Name                   | Type            | Comment                                                     |
    +========+========================+=================+=============================================================+
    | Return | ``MQTT_SendTopicBool`` | ``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.                                            |
    +        +------------------------+-----------------+-------------------------------------------------------------+
    |        | ``payload``            | ``BOOL``        | Boolean value to publish.                                   |
    +        +------------------------+-----------------+-------------------------------------------------------------+
    |        | ``qos``                | ``WORD``        | Quality of Service level.                                   |
    +        +------------------------+-----------------+-------------------------------------------------------------+
    |        | ``flags``              | ``WORD``        | Publish options: 0-none, 1-retain.                          |
    +--------+------------------------+-----------------+-------------------------------------------------------------+
    | Output | ``sent``               | ``BOOL``        | ``TRUE`` when the publish operation has completed according |
    |        |                        |                 | to the selected QoS.                                        |
    +--------+------------------------+-----------------+-------------------------------------------------------------+







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



