Menu

MQTT Provider

The MQTT Provider connects to a MQTT broker and receives or stores data.
MQTT is an OASIS standard messaging protocol for the Internet of Things (IoT).

Tip
 We provide an open MQTT broker for free data interchange at mqtt.tyckr.io.
See the MQTT Server page for more information.

Configuration

  • Host
    The IP or URL of the MQTT broker to connect to.

  • Port
    The port number of the MQTT broker, default port is 1883.

  • Use SSL
    Enable to use SSL transport encryption, disable for no SSL encryption.

  • Protocol Version
    Use MQTT version 3 or version 5. Version 5 is default.

  • Keep Alive Interval
    Keep alive interval time like 60s, 3m or 1h to keep the connection to the broker alive and validate it.
    0 disables the keep alive feature.

    Caution
    		 The keep alive mechanism is important to validate the session and connection. It should be disabled only for a good reason.
    3m is a good default value.

  • Username
    Set the Username if authentication is required, leave empty if authentication is not necessary.

  • Password
    Set the Password if authentication is required, leave empty if no Password is required.

    Important
    		 Authentication can only be used, if the Master Password is set up in Configuration/Password on the device AND in the App.
    A green lock is visible next to Username and Password when this is set up correctly.

  • Topic
    Subscription topics in form of testtopic/1 or heater/temp/value.

Query

  • Status
    Get the MQTT connection status.

    Text Numeric

    N/A

    0

    No connection to the broker.

    Excellent

    1

    Connected to the broker.

  • Topic
    The subscription topic of the configuration like testtopic/1

    • Param 1
      Subscription index starting from 0.

  • Message
    The plain Message content of the according subscription topic.

    • Param 1
      Subscription index starting from 0.

  • JSON Message
    The message content of the according subscription topic is encoded in JSON format.
    Param 2 sets the JSON path to the data.

    • Param 1
      Subscription index starting from 0.

    • Param 2
      A valid JsonPath expression like $.store.book[*].author to decode a value from the message.

  • ID
    String representation of the Client Identifier.
    This has the format tyckr-XXXXXXXX-YYYYYYYY where X is a fixed 8 letter device ID and Y the 8 letter provider ID.

Action

Used as trigger action, e.g. from a button facelet.

  • Set: Publish with QoS0
    Publish a message to the broker with QoS 0 (At most once).

    • Param 1
      Subscription index starting from 0.

    • Param 2
      The value to publish.

  • Set: Publish with QoS 1
    Publish a message to the broker with QoS 1 (At least once).

    • Param 1
      Subscription index starting from 0.

    • Param 2
      The value to publish.

  • Set: Publish with QoS 2
    Publish a message to the broker with QoS 2 (Exactly once).

    • Param 1
      Subscription index starting from 0.

    • Param 2
      The value to publish.

  • Set: Retain with QoS0
    Publish a retained message to the broker with QoS 0 (At most once).

    • Param 1
      Subscription index starting from 0.

    • Param 2
      The value to publish.

  • Set: Retain with QoS 1
    Publish a retained message to the broker with QoS 1 (At least once).

    • Param 1
      Subscription index starting from 0.

    • Param 2
      The value to publish.

  • Set: Retain with QoS 2
    Publish a retained message to the broker with QoS 2 (Exactly once).

    • Param 1
      Subscription index starting from 0.

    • Param 2
      The value to publish.