Table of Contents

MQTT Layer (mqtt)

This layer provides MQTT Version 3.1.1 functionality. It can be placed on top of TCP or TLS layers.

MQTT Layer Configuration Parameters

Parameter Type Description
Alias String
Broker Boolean
Clean Session Boolean
ClientId String
DNS Instance String
Debug Log Level Number Debug Level
Dependencies String Other dependencies to this element
Destination Peer Number
Event Filter String Filter of Event
Exact Match Boolean
KeepAlive Interval String
Max Event Queue Size Number Maximum Queue Size
Name String Component Name
No Events Boolean
Passthrough Boolean High-to-Low Layer Passthrough
Password String
Persistence Number
QoS Number
Raw Data To Inject String Data Packet to Inject
Raw Dst L2 To Inject String Destination L2 Address
Raw Dst L3 To Inject String Destination L3 Address
Raw Dst L4 To Inject String Destination L4 Address
Request Timeout Number
Retain Boolean
Save Dynamic Config Boolean
Show Commands Boolean Show Commands
Show Events Boolean Show Events
TXT DNS Number
Topic String
Url String Url Name
Username String SIP Username
Watch Boolean Watch Layer

MQTT Layer Real-Time Parameters

Parameter Type Description
Allow Blocking Event Boolean Blocking Events
Blocked Boolean Disable Component
Debug Log Level Number Debug Level
Max Instances Number Maximum Number of Instances of a Component
Passthrough Boolean High-to-Low Layer Passthrough
Url String Url Name
Username String SIP Username
Watch Boolean Watch Layer

MQTT Layer Functions

Function Type Description
getMqttAllowBlockingEvent(layer) getter Get “Allow Blocking Event” Parameter
getMqttBlocked(layer) getter Get “Blocked” Parameter
getMqttBroker(layer) getter Get “Broker” Parameter
getMqttClientId(layer) getter Get “ClientId” Parameter
getMqttDebugLogLevel(layer) getter Get “Debug Log Level” Parameter
getMqttDestinationPeer(layer) getter Get “Destination Peer” Parameter
getMqttEnablePublish(layer) getter Get “Enable Publish” Parameter
getMqttEnableSubscribe(layer) getter Get “Enable Subscribe” Parameter
getMqttKeepAliveInterval(layer) getter Get “KeepAlive Interval” Parameter
getMqttMaxInstances(layer) getter Get “Max Instances” Parameter
getMqttNoEvents(layer) getter Get “No Events” Parameter
getMqttPassthrough(layer) getter Get “Passthrough” Parameter
getMqttPassword(layer) getter Get “Password” Parameter
getMqttPersistence(layer) getter Get “Persistence” Parameter
getMqttQoS(layer) getter Get “QoS” Parameter
getMqttRetain(layer) getter Get “Retain” Parameter
getMqttTopic(layer) getter Get “Topic” Parameter
getMqttUrl(layer) getter Get “Url” Parameter
getMqttUsername(layer) getter Get “Username” Parameter
getMqttWatch(layer) getter Get “Watch” Parameter
getStatsMqttAvailableInstances(layer) getter Get “Available Instances” Parameter
getStatsMqttDownstreamLastPacket(layer) getter Get “Downstream Last Packet” Parameter
getStatsMqttDownstreamPacketCount(layer) getter Get “Downstream Packet Count” Parameter
getStatsMqttMaxDownstreamDelay(layer) getter Get “Max Downstream Delay” Parameter
getStatsMqttMaxUpstreamDelay(layer) getter Get “Max Upstream Delay” Parameter
getStatsMqttMeanDownstreamDelay(layer) getter Get “Mean Downstream Delay” Parameter
getStatsMqttMeanUpstreamDelay(layer) getter Get “Mean Upstream Delay” Parameter
getStatsMqttMinDownstreamDelay(layer) getter Get “Min Downstream Delay” Parameter
getStatsMqttMinUpstreamDelay(layer) getter Get “Min Upstream Delay” Parameter
getStatsMqttName(layer) getter Get “Name” Parameter
getStatsMqttRateBpsDownstream(layer) getter Get “Rate Bps Downstream” Parameter
getStatsMqttRateBpsUpstream(layer) getter Get “Rate Bps Upstream” Parameter
getStatsMqttTimestampIn(layer) getter Get “Timestamp In” Parameter
getStatsMqttTimestampOut(layer) getter Get “Timestamp Out” Parameter
getStatsMqttType(layer) getter Get “Type” Parameter
getStatsMqttUpstreamLastPacket(layer) getter Get “Upstream Last Packet” Parameter
getStatsMqttUpstreamPacketCount(layer) getter Get “Upstream Packet Count” Parameter
getStatsMqttVarianceDownstreamDelay(layer) getter Get “Variance Downstream Delay” Parameter
getStatsMqttVarianceUpstreamDelay(layer) getter Get “Variance Upstream Delay” Parameter
isEventMqttConnected(event) event MQTT Connected Event
isEventMqttData(event) event MQTT Data Event
isEventMqttRequest(event) event MQTT Request Event
mqttConnect(layer,url,client,username,password) function MQTT Connection Establishment
mqttDisconnect(layer) function MQTT Disconnect
mqttGetErrorCode(event) getter Get Request Error Code
mqttGetStatus(event) getter Get Connection Status
mqttGetValue(event) getter Get Published Value
mqttPublish(layer,topic,value,qos) function MQTT Publish
mqttSubscribe(layer,topic,qos) function MQTT Subscribe
mqttUnsubscribe(layer,topic) function MQTT Unsubscribe
setMqttAllowBlockingEvent(layer,value) setter Set “Allow Blocking Event” Parameter
setMqttBlocked(layer,value) setter Set “Blocked” Parameter
setMqttBroker(layer,value) setter Set “Broker” Parameter
setMqttClientId(layer,value) setter Set “ClientId” Parameter
setMqttDebugLogLevel(layer,value) setter Set “Debug Log Level” Parameter
setMqttEnablePublish(layer,value) setter Set “Enable Publish” Parameter
setMqttEnableSubscribe(layer,value) setter Set “Enable Subscribe” Parameter
setMqttKeepAliveInterval(layer,value) setter Set “KeepAlive Interval” Parameter
setMqttNoEvents(layer,value) setter Set “No Events” Parameter
setMqttPassthrough(layer,value) setter Set “Passthrough” Parameter
setMqttPassword(layer,value) setter Set “Password” Parameter
setMqttPersistence(layer,value) setter Set “Persistence” Parameter
setMqttQoS(layer,value) setter Set “QoS” Parameter
setMqttRetain(layer,value) setter Set “Retain” Parameter
setMqttStatus(layer,value) setter Set “Status” Parameter
setMqttTopic(layer,value) setter Set “Topic” Parameter
setMqttUrl(layer,value) setter Set “Url” Parameter
setMqttUsername(layer,value) setter Set “Username” Parameter
setMqttWatch(layer,value) setter Set “Watch” Parameter