Skip to content

MQTT

MQTTClient - Connect

Connect the MQTT client

IN

Name Type Description
Timeout Int Timeout value〔s〕.Type : int
InClient DynamicEnum DynamicEnum
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

MQTTClient - Disconnect

Disconnect the MQTT client

IN

Name Type Description
Timeout Int Timeout value〔s〕.Type : int
InClient DynamicEnum DynamicEnum
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

MQTTClient - Publish

Publish value to mqtt server

IN

Name Type Description
Topic String Topic name.
Payload String Payload value to publish.
Qos Enum < MQTTQoS > Defines the QoS parameter's.
Timeout Int Timeout value〔s〕.
InClient DynamicEnum DynamicEnum
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

MQTTClient - Read

Read subscribed value to mqtt server

IN

Name Type Description
Topic String Subscription name.
InClient DynamicEnum DynamicEnum
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Payload String Payload value from subscription.
Error ErrorState Gets the execution error message

MQTTClient - Subscribe

Subscribed value to mqtt server

IN

Name Type Description
Topic String Subscription name.
Timeout Int Timeout value〔s〕.
InClient DynamicEnum DynamicEnum
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

MQTTClient - Unsubscribe

Unsubscribed topic from mqtt server

IN

Name Type Description
Topic String Subscription name.
Timeout Int Timeout value〔s〕.
InClient DynamicEnum DynamicEnum
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message