Documentation - CSK_Module_MQTTClient 2.1.1

CSK_MQTTClient.addPublishEvent(event, topic, qos, retain)

CSK_MQTTClient.addPublishEventViaUI()

CSK_MQTTClient.addSubscription(topicFilter, qos)

CSK_MQTTClient.addSubscriptionViaUI()

CSK_MQTTClient.clearFlowConfigRelevantConfiguration()

CSK_MQTTClient.connectMQTT(status)

handle = CSK_MQTTClient.getMQTTHandle()

jsonParameters = CSK_MQTTClient.getParameters()

status = CSK_MQTTClient.getStatusModuleActive()

success = CSK_MQTTClient.loadParameters()

empty = CSK_MQTTClient.pageCalled()

CSK_MQTTClient.presetPublishData(data)

CSK_MQTTClient.presetPublishEvent(name)

CSK_MQTTClient.presetPublishQOS(qos)

CSK_MQTTClient.presetPublishRetain(status)

CSK_MQTTClient.presetPublishTopic(topic)

CSK_MQTTClient.presetSubscriptionQOS(qos)

CSK_MQTTClient.presetSubscriptionTopic(topic)

CSK_MQTTClient.publish(topic, data, qos, retain)

CSK_MQTTClient.publishViaUI()

CSK_MQTTClient.removePublishEvent(event)

CSK_MQTTClient.removePublishEventViaUI()

CSK_MQTTClient.resetModule()

CSK_MQTTClient.selectPublishEvent(selection)

CSK_MQTTClient.selectSubscriptionViaUI(selection)

CSK_MQTTClient.sendParameters(noDataSave)

CSK_MQTTClient.setBirthMessageActivation(status)

CSK_MQTTClient.setBirthMessageConfigViaUI()

CSK_MQTTClient.setBrokerIP(ip)

CSK_MQTTClient.setCABundlePath(path)

CSK_MQTTClient.setCleanSession(status)

CSK_MQTTClient.setClientCertificateKeyPassword(password)

CSK_MQTTClient.setClientCertificateKeyPath(path)

CSK_MQTTClient.setClientCertificatePath(path)

CSK_MQTTClient.setClientID(id)

CSK_MQTTClient.setConnectionTimeout(time)

CSK_MQTTClient.setDisconnectWithWillMessage(status)

CSK_MQTTClient.setFlowConfigPriority(status)

CSK_MQTTClient.setForwardReceivedMessages(status)

CSK_MQTTClient.setHostnameVerification(status)

CSK_MQTTClient.setInterface(interface)

CSK_MQTTClient.setKeepAliveInterval(time)

CSK_MQTTClient.setLoadOnReboot(status)

CSK_MQTTClient.setLogAllMessages(status)

CSK_MQTTClient.setMQTTPort(port)

CSK_MQTTClient.setParameterName(name)

CSK_MQTTClient.setPassword(password)

CSK_MQTTClient.setPeerVerification(status)

CSK_MQTTClient.setTLSVersion(version)

CSK_MQTTClient.setTopicPrefix(prefix)

CSK_MQTTClient.setUseCABundle(status)

CSK_MQTTClient.setUseClientCertificate(status)

CSK_MQTTClient.setUseCredentials(status)

CSK_MQTTClient.setUsername(username)

CSK_MQTTClient.setWillMessageActivation(status)

CSK_MQTTClient.setWillMessageConfig(topic, data, qos, retain)

CSK_MQTTClient.setWillMessageConfigViaUI()

CSK_MQTTClient.unsubscribe(topic)

CSK_MQTTClient.unsubscribeViaUI()

function handleOnDataLoadedOnReboot()
  -- Do something
end

Script.register("CSK_MQTTClient.OnDataLoadedOnReboot", "handleOnDataLoadedOnReboot")

function handleOnNewBrokerIP(ip)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewBrokerIP", "handleOnNewBrokerIP")

function handleOnNewConnectionStatus(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewConnectionStatus", "handleOnNewConnectionStatus")

function handleOnNewLog(logs)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewLog", "handleOnNewLog")

function handleOnNewMQTTPort(port)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewMQTTPort", "handleOnNewMQTTPort")

function handleOnNewParameterName(name)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewParameterName", "handleOnNewParameterName")

function handleOnNewStatusActivateConnection(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusActivateConnection", "handleOnNewStatusActivateConnection")

function handleOnNewStatusBirthMessageActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusBirthMessageActive", "handleOnNewStatusBirthMessageActive")

function handleOnNewStatusBirthMessageConfig(config)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusBirthMessageConfig", "handleOnNewStatusBirthMessageConfig")

function handleOnNewStatusCABundleActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusCABundleActive", "handleOnNewStatusCABundleActive")

function handleOnNewStatusCABundlePath(path)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusCABundlePath", "handleOnNewStatusCABundlePath")

function handleOnNewStatusCleanSession(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusCleanSession", "handleOnNewStatusCleanSession")

function handleOnNewStatusClientCertificateActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusClientCertificateActive", "handleOnNewStatusClientCertificateActive")

function handleOnNewstatusClientCertificateKeyPath(path)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewstatusClientCertificateKeyPath", "handleOnNewstatusClientCertificateKeyPath")

function handleOnNewStatusClientCertificatePath(path)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusClientCertificatePath", "handleOnNewStatusClientCertificatePath")

function handleOnNewStatusClientID(id)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusClientID", "handleOnNewStatusClientID")

function handleOnNewStatusConnectionTimeout(time)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusConnectionTimeout", "handleOnNewStatusConnectionTimeout")

function handleOnNewStatusCSKStyle(theme)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusCSKStyle", "handleOnNewStatusCSKStyle")

function handleOnNewStatusCurrentlyConnected(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusCurrentlyConnected", "handleOnNewStatusCurrentlyConnected")

function handleOnNewStatusDisconnectWithWillMessage(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusDisconnectWithWillMessage", "handleOnNewStatusDisconnectWithWillMessage")

function handleOnNewStatusFlowConfigPriority(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusFlowConfigPriority", "handleOnNewStatusFlowConfigPriority")

function handleOnNewStatusForwardReceivedMsg(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusForwardReceivedMsg", "handleOnNewStatusForwardReceivedMsg")

function handleOnNewStatusHostnameVerification(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusHostnameVerification", "handleOnNewStatusHostnameVerification")

function handleOnNewStatusInterface(interface)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusInterface", "handleOnNewStatusInterface")

function handleOnNewStatusInterfaceList(interfaceList)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusInterfaceList", "handleOnNewStatusInterfaceList")

function handleOnNewStatusKeepAliveInterval(time)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusKeepAliveInterval", "handleOnNewStatusKeepAliveInterval")

function handleOnNewStatusLoadParameterOnReboot(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusLoadParameterOnReboot", "handleOnNewStatusLoadParameterOnReboot")

function handleOnNewStatusLogAllMessages(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusLogAllMessages", "handleOnNewStatusLogAllMessages")

function handleOnNewStatusModuleIsActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusModuleIsActive", "handleOnNewStatusModuleIsActive")

function handleOnNewStatusModuleVersion(version)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusModuleVersion", "handleOnNewStatusModuleVersion")

function handleOnNewStatusPeerVerification(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusPeerVerification", "handleOnNewStatusPeerVerification")

function handleOnNewStatusPublishData(data)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusPublishData", "handleOnNewStatusPublishData")

function handleOnNewStatusPublishEventList(list)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusPublishEventList", "handleOnNewStatusPublishEventList")

function handleOnNewStatusPublishEventName(name)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusPublishEventName", "handleOnNewStatusPublishEventName")

function handleOnNewStatusPublishQOS(qos)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusPublishQOS", "handleOnNewStatusPublishQOS")

function handleOnNewStatusPublishRetain(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusPublishRetain", "handleOnNewStatusPublishRetain")

function handleOnNewStatusPublishTopic(topic)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusPublishTopic", "handleOnNewStatusPublishTopic")

function handleOnNewStatusSubscriptionList(list)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusSubscriptionList", "handleOnNewStatusSubscriptionList")

function handleOnNewStatusSubscriptionQOS(qos)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusSubscriptionQOS", "handleOnNewStatusSubscriptionQOS")

function handleOnNewStatusSubscriptionTopic(topic)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusSubscriptionTopic", "handleOnNewStatusSubscriptionTopic")

function handleOnNewStatusTLS(version)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusTLS", "handleOnNewStatusTLS")

function handleOnNewStatusTopicPrefix(prefix)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusTopicPrefix", "handleOnNewStatusTopicPrefix")

function handleOnNewStatusUseCredentials(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusUseCredentials", "handleOnNewStatusUseCredentials")

function handleOnNewStatusUsername(username)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusUsername", "handleOnNewStatusUsername")

function handleOnNewStatusWillMessageActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusWillMessageActive", "handleOnNewStatusWillMessageActive")

function handleOnNewStatusWillMessageConfig(config)
  -- Do something
end

Script.register("CSK_MQTTClient.OnNewStatusWillMessageConfig", "handleOnNewStatusWillMessageConfig")

function handleOnPersistentDataModuleAvailable(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnPersistentDataModuleAvailable", "handleOnPersistentDataModuleAvailable")

function handleOnReceive(topic, data, qos, retain)
  -- Do something
end

Script.register("CSK_MQTTClient.OnReceive", "handleOnReceive")

function handleOnReceiveFullString(msg)
  -- Do something
end

Script.register("CSK_MQTTClient.OnReceiveFullString", "handleOnReceiveFullString")

function handleOnUserLevelAdminActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnUserLevelAdminActive", "handleOnUserLevelAdminActive")

function handleOnUserLevelMaintenanceActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnUserLevelMaintenanceActive", "handleOnUserLevelMaintenanceActive")

function handleOnUserLevelOperatorActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnUserLevelOperatorActive", "handleOnUserLevelOperatorActive")

function handleOnUserLevelServiceActive(status)
  -- Do something
end

Script.register("CSK_MQTTClient.OnUserLevelServiceActive", "handleOnUserLevelServiceActive")

handle = MQTTClient_FC.OnReceive.create()

success = MQTTClient_FC.OnReceive.register(handle, eventname, callback)

function handleOnReceive(handle, OnReceive)
  -- Do something
end

Script.register("MQTTClient_FC.OnReceive.OnReceive", "handleOnReceive")

handle = MQTTClient_FC.Publish.create(Topic, QoS, Retain)

MQTTClient_FC.Publish.publish(handle, data1, data2, data3, data4)