.. 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_ReadTopicInteger`:


.. index::
   single: MQTT_ReadTopicInteger

.. _`MQTT_ReadTopicInteger`:

``MQTT_ReadTopicInteger`` (FUN)
-------------------------------

FUNCTION MQTT_ReadTopicInteger : WORD




This function subscribes to the specified MQTT topic and returns published messages as integers (DWORDs).

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_ReadTopicInteger`` | ``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``                 | ``DWORD``       | Integer 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



