MQTT Base object describing all MQTT related parameters and objects. {{numentries}} {{numentries}} Indicates the MQTT capabilities of the device. Indicates the supported protocol versions. {{enum}} Protocol according to {{bibref|MQTT31}} Protocol according to {{bibref|MQTT311}} Protocol according to {{bibref|MQTT50}} Indicates the supported transport protocols. {{enum}} Unencrypted MQTT connection TLS encrypted MQTT connection Unencrypted MQTT connection over a WebSocket transport TLS encrypted MQTT connection over a WebSocket transport Indicates the maximum number of subscriptions per MQTT client, which can be stored in the {{object|#.Client.{i}.Subscription}} table. A value of 0 means no limit. Indicates the maximum number of bridges, which can be configured in the {{object|#.Broker.{i}.Bridge}} table. A value of 0 means no limit. Indicates the maximum number of subscriptions, which can be stored per bridge instance in the {{object|#.Broker.{i}.Bridge.{i}.Subscription}} table. A value of 0 means no limit. MQTT client table. Contains a list of configured MQTT clients. {{datatype|expand}} The textual name of the MQTT client. Allows to enable or disable the MQTT client. If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the {{object|Subscription.}} table. If the {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}} and {{param|CleanSession}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT311|section 3.1.2.4}}). If the {{param|ProtocolVersion}} is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}} and {{param|CleanStart}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT50|section 3.1.2.4}}). If a connected MQTT client gets disabled ({{param|Status}} is either {{enum|Connecting|Status}} or {{enum|Connected|Status}}) then the MQTT client has to send a MQTT DISCONNECT packet to disconnect from the MQTT broker (see {{bibref|MQTT311|section 3.14}} or {{bibref|MQTT50|section 3.14}}), before setting the {{param|Status}} to {{enum|Disabled|Status}}. Indicates the status of this MQTT client. {{enum}} The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid (e.g. The MQTT client can not use the defined port, because it is blocked) The {{enum|Error_BrokerUnreachable}} value indicates that the connection to the MQTT broker could not be established. The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition. The IP Interface associated with the {{object}} entry. {{template|INTERFACE-ROUTING}} Specifies the MQTT protocol version used in the communication with the MQTT broker. When {{true}}, encryption MUST be used for this MQTT {{object}} instance. {{deprecated|2.15|because it duplicates the functionality already handled by the {{param|TransportProtocol}} parameter}} Host name or IP address of the MQTT Broker. Port number of the MQTT broker. Indicates the transport protocol to be used for the MQTT broker connection. The value of the MQTT clean session flag in the MQTT CONNECT packet (see {{bibref|MQTT311|section 3.1}} and {{bibref|MQTT311|section 3.1.2.4}}). If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. {{template|MQTTReconnect}} This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}. The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see {{bibref|MQTT50|section 3.1.2.4}}. If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. {{template|MQTTReconnect}}. {{template|MQTT50ONLY}} Enables or disables the will handling (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.2.5}}) or {{bibref|MQTT50|section 3.1.2.5}}). If the connection gets enabled and this parameter is set to {{true}} and either the parameter {{param|WillTopic}} or {{param|WillValue}} are {{empty}}, the CPE MUST set the {{param|Status}} to {{enum|Error_Misconfigured|Status}}. {{template|MQTTReconnect}}. The MQTT QoS level assigned with the will message (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.2.6}}) or {{bibref|MQTT50|section 3.1.2.6}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. {{template|MQTTWillChange}} Indicate to the MQTT broker to retain the Will over a Disconnect (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.2.7}}) or {{bibref|MQTT50|section 3.1.2.7}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. {{template|MQTTWillChange}} Keep Alive Time in {{units}} defines the maximum wait time after which a packet has to be sent to the MQTT broker (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.2.10}}) or {{bibref|MQTT50|section 3.1.2.10}}). If no regular packet can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive packets are sent and the MQTT client is not disconnected by the server. {{template|MQTTReconnect}} Session expiry interval in {{units}} defines the wait time before a session expires after the connection has been closed by the MQTT client {{bibref|MQTT50|section 3.1.2.11.2}}). {{template|MQTT50ONLY}} The MQTT client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently (see {{bibref|MQTT50|section 3.1.2.11.3}}). {{template|MQTTReconnect}} {{template|MQTT50ONLY}} The maximum packet size in {{units}} the MQTT client can and will accept from the MQTT broker. A value of 0 means no limit. If the value is set to another value, the MQTT client will inform the broker in the next CONNECT packet {{bibref|MQTT50|section 3.1.2.11.4}}). {{template|MQTTReconnect}} {{template|MQTT50ONLY}} This value indicates the highest value that the MQTT client will accept as a Topic Alias sent by the Server (see {{bibref|MQTT50|section 3.1.2.11.5}}). The MQTT client uses this value to limit the number of Topic Aliases that it is willing to hold on this connection. A value of 0 indicates that Topic Alias is not supported. {{template|MQTTReconnect}} {{template|MQTT50ONLY}} The MQTT client uses this value in a MQTT CONNECT packet to request the Server to return Response Information in the MQTT CONNACK (see {{bibref|MQTT50|section 3.1.2.11.6}}). {{template|MQTTReconnect}} {{template|MQTT50ONLY}} This value indicates whether the Reason String or User Properties are sent in the case of failures.(see {{bibref|MQTT50|section 3.1.2.11.7}}). {{template|MQTTReconnect}} {{template|MQTT50ONLY}} This value defines the extended authentication method to be used (see {{bibref|MQTT50|section 3.1.2.11.9}}). If the parameter is empty, no extended authentication is performed. {{template|MQTTReconnect}} {{template|MQTT50ONLY}} The MQTT client identifier used in the MQTT CONNECT packet (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.3.1}}) or {{bibref|MQTT50|section 3.1.3.1}}). If {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}, this parameter MUST NOT be an empty string. If {{param|ProtocolVersion}} is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}}, an empty string is allowed. {{template|MQTTReconnect}} The delay in {{units}} after the session is disconnected, before sending the Will message {{bibref|MQTT50|section 3.1.3.2.2}}). A value of 0 indicates that there is no delay. {{template|MQTTWillChange}} {{template|MQTT50ONLY}} The lifetime in {{units}} of a Will Message (see {{bibref|MQTT50|section 3.1.3.2.4}}). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet. {{template|MQTT50ONLY}} Describes the type of the {{param|WillValue}} {{bibref|MQTT50|section 3.1.3.2.5}}). {{template|MQTTWillChange}} {{template|MQTT50ONLY}} Topic Name for a will response message. The presence of a Response Topic identifies the Will Message as a Request {{bibref|MQTT50|section 3.1.3.2.6}}). If the {{param}} is an empty string the will response topic will not be sent in a MQTT CONNECT packet. {{template|MQTTWillChange}} {{template|MQTT50ONLY}} The Topic sent in the Will Message (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.3.3}}) or {{bibref|MQTT50|section 3.1.3.3}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. {{template|MQTTWillChange}} The value sent in the Will Message (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.2.5}}) or {{bibref|MQTT50|section 3.1.3.4}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. {{template|MQTTWillChange}} Username used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.3.4}} or {{bibref|MQTT50|section 3.1.3.5}}). If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT packet. Password used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.3.5}} or {{bibref|MQTT50|section 3.1.3.6}}). This password is only sent in the MQTT CONNECT packet if {{param|Username}} is not {{empty}}. The lifetime in {{units}} of a PUBLISH Message (see {{bibref|MQTT50|section 3.3.2.3.3}}). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet. {{template|MQTT50ONLY}} Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT311|section 4.2}}). This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}}. Connect retry time in {{units}} defines the wait time before a failed MQTT broker connection is retried. A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. If the parameter {{param|ConnectRetryIntervalMultiplier}} is defined, the MQTT client MUST use a random value between {{param}}*({{param|ConnectRetryIntervalMultiplier}}/1000)^(n-1) and {{param}}*({{param|ConnectRetryIntervalMultiplier}}/1000)^n for the connect retry time, with n equals the current retry number. The max number of n is 10, starting with the 11th retry always the value n = 10 is used. If the parameters {{param|ConnectRetryIntervalMultiplier}} and {{param|ConnectRetryMaxInterval}} are defined, the MQTT client MUST use the value of {{param|ConnectRetryMaxInterval}} if the calculated random value exceeds the value of {{param|ConnectRetryMaxInterval}}. Configures the retry interval multiplier. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The maximum reconnection wait interval, in {{units}}. The value of the CONNACK Response Information property supplied by a MQTT 5.0 server. This value is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If the value of {{param}} is not a subset (wildcarded or precise match) of any of the {{param|Subscription.{i}.Topic}} values the MQTT client MUST subscribe to this Topic. {{numentries}} {{numentries}} List of MQTT subscriptions handled by the MQTT client. The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter {{param|Enable}} is set to {{true}}, when it establishes a new connection to the MQTT broker. Disabled subscription instances with {{param|Enable}} set to {{false}} will be ignored during connection establishment. {{datatype|expand}} When a MQTT client connects to a MQTT server, it MUST send a SUBSCRIBE message including all instances with {{param}} set to {{true}}. If the MQTT client is already connected with the MQTT server ({{param|#.Status}} is {{enum|Connected|#.Status}}), a MQTT SUBSCRIBE or UNSUBSCRIBE message MUST be sent directly when {{param}} is changed to {{true}} or {{false}}, respectively. The actual status of the subscription is indicated with {{param|Status}}. Indicates the status of this subscription. {{enum}} The {{enum|Subscribed}} value indicates that the topic was successfully subscribed with the MQTT broker, the MQTT client received the SUBACK message for this topic from the server. The {{enum|Subscribing}} value MAY be used by the CPE to indicate that the a SUBSCRIBE message for this topic was sent, and the CPE is waiting for a SUBACK message. The {{enum|Unsubscribed}} value indicates that the topic is not registered with the MQTT broker. The {{enum|Unsubscribing}} value MAY be used by the CPE to indicate that an UNSUBSCRIBE message for this topic was sent, and the CPE is waiting for an UNSUBACK message. If the {{param|Enable}} is set to {{false}} the status MUST be either {{enum|Unsubscribed}} or if the unsubscription failed {{enum|Error}}. Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT311|section Appendix A}}, {{bibref|MQTT311|section 4.7}} or {{bibref|MQTT50|4.7}}. The MQTT QoS level assigned with the subscription (see {{bibref|MQTT311|section 4.1}}, {{bibref|MQTT311|section 4.3}}) or {{bibref|MQTT50|4.3}}. List of user properties used by the MQTT client. This table only applies if {{param|#.ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}. {{datatype|expand}} Setting Enable to {{true}} means the user property is used in the indicated control packet(s). The user property will be applied to all control packets of the same control packet type (e.g PUBLISH). Name of the user property Value of the user property {{list}} Each entry defines the control packet type(s) in which the user property is included. User property will be added in the AUTH control packet (see {{bibref|MQTT50|section 3.15.2.2.5}}) User property will be added in the CONNECT packet (see {{bibref|MQTT50|section 3.1.3.2.8}}) User property will be added in the DISCONNECT packet (see {{bibref|MQTT50|section 3.14.2.2.4}}) User property will be added in the PUBLISH packet (see {{bibref|MQTT50|section 3.3.2.3.7}}) User property will be added in the PUBACK packet (see {{bibref|MQTT50|section 3.4.2.2.3}}) User property will be added in the PUBREC packet (see {{bibref|MQTT50|section 3.5.2.2.3}}) User property will be added in the PUBREL packet (see {{bibref|MQTT50|section 3.6.2.2.3}}) User property will be added in the PUBCOMP packet (see {{bibref|MQTT50|section 3.7.2.2.3}}) User property will be added in the SUBSCRIBE packet (see {{bibref|MQTT50|section 3.8.2.1.3}}) User property will be added in the UNSUBSCRIBE packet (see {{bibref|MQTT50|section 3.10.2.1.2}}) User property will be added in the WILL properties (see {{bibref|MQTT50|section 3.1.3.2}}) Contains the MQTT client statistics and usage information. The CPE MUST reset the Stats parameters after the MQTT client gets (re-)enabled or if the MQTT client connects with a new MQTT broker (e.g. {{param|#.BrokerAddress}} has changed). The CPE MAY retain the values across a reboot if it reconnects with the same MQTT broker. Time when the MQTT broker connection was established. Time when the last publish message was sent to the MQTT broker. Time when the last publish message was received from the MQTT broker. Number of publish messages sent to the MQTT broker. Number of publish messages received from to the MQTT broker. Number of subscribe messages sent to the MQTT broker. Number of unsubscribe messages sent to the MQTT broker. Total number of MQTT messages sent to the MQTT broker. Total number of MQTT messages received from the MQTT broker. Number of connection errors. Number of errors which prevented sending publish messages. MQTT broker table. Contains a list of configured MQTT brokers. {{datatype|expand}} The textual name of the MQTT broker. Allows to enable or disable the MQTT broker. Indicates the status of the MQTT broker. {{enum}} The "{{enum|Error_Misconfigured}}" value indicates that a necessary configuration value is undefined or invalid. The "{{enum|Error}}" value MAY be used by the CPE to indicate a locally defined error condition. Port used by the MQTT Broker. If {{empty}} is specified, the CPE MUST bind the MQTT broker to all available interfaces. User name used to authenticate the MQTT clients, which connect to the MQTT broker. If this parameter is {{empty}} no authentication is used. Password used used to authenticate the MQTT clients, which connect to the MQTT broker. This password is only used if {{param|Username}} is not {{empty}}. {{numentries}} Configures MQTT bridges, which are used to communicate with other MQTT brokers. {{datatype|expand}} The textual name of the MQTT bridge used for identification. Allows to enable or disable the MQTT Bridge. Indicates the status of this MQTT Bridge. {{enum}} The {{enum|Disabled}} value indicates that the MQTT bridge is not in service; parameter {{param|Enable}} is set to {{false}}. The {{enum|Connecting}} value indicates that the MQTT bridge is currently established. The {{enum|Connected}} value indicates that the MQTT bridge is currently active. The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid (e.g. No active Server entry, the MQTT broker can not use the defined bridge port, because it is blocked) The {{enum|Error_BrokerUnreachable}} value indicates that the MQTT bridge connection to the remote MQTT broker could not be established. The {{enum|Error}} value MAY be used to indicate a locally defined error condition. {{deleted|2.11|because it's covered by {{enum|Connecting}} and {{enum|Connected}}}} Specifies the MQTT protocol version used in the MQTT bridge connection. Indicates the transport protocol to be used for the MQTT bridge connection. The value of the MQTT clean session flag in the MQTT CONNECT packet (see {{bibref|MQTT311|section 3.1}} and {{bibref|MQTT311|section 3.1.2.4}}) to establish a MQTT bridge connection. If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. {{template|MQTTReconnect}} This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}. The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see {{bibref|MQTT50|section 3.1.2.4}} to establish a MQTT bridge connection. If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. {{template|MQTTReconnect}}. This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}. Keep Alive Time in {{units}} defines the maximum wait time after which a packet has to be sent to the remote MQTT broker (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.2.10}}) or {{bibref|MQTT50|section 3.1.2.10}}). If no regular packet can be sent a MQTT PINGREQ packet is sent. A value of zero (0) means no keep alive packets are sent and the bridge is not disconnected by the server. {{template|MQTTReconnect}} The MQTT client identifier used in the CONNECT packet (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.3.1}}) or {{bibref|MQTT50|section 3.1.3.1}}). If {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}, this parameter MUST NOT be an empty string. If {{param|ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}, an empty string is allowed. {{template|MQTTReconnect}} User name used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.3.4}} or {{bibref|MQTT50|section 3.1.3.5}}). If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT packet. Password used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT311|section 3.1}}, {{bibref|MQTT311|section 3.1.3.5}} or {{bibref|MQTT50|section 3.1.3.6}}). This password is only sent in the MQTT CONNECT packet if {{param|Username}} is not {{empty}}. Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT311|section 4.2}}. This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}}. Connect retry time in {{units}} defines the wait time before a failed bridge connection is retried. A failure can either be on the connection level (e.g. the TCP/IP or TLS connection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. The algorithm used to select a server entry from the {{object|Server}} table Select the server from the {{object|Server.}} table according to the sequence defined with the {{param|Server.{i}.Priority}} and {{param|Server.{i}.Weight}} values. Select the servers round robin. Select the servers randomly. {{reference|the {{object|Server.}} instance that is used for this {{object}}, while the {{param|Status}} is {{enum|Connecting|Status}} or {{enum|Connected|Status}}. If the MQTT bridge is not connected the value MUST be an empty string}} {{numentries}} {{numentries}} Each {{object}} instance represents a MQTT bridge server to be used for a {{object|##.Bridge}}. A remote MQTT broker, which is connected by a MQTT bridge can be reachable via several host addresses each represented by its own {{object}} table entry. For an active MQTT bridge at least one enabled entry has to exist. If a MQTT bridge gets enabled by setting the parameter {{param|##.Bridge.{i}.Enable}} to {{true}}, which either has an empty {{object}} table or the {{object}} table only contains instances whose {{param|Enable}} is set to {{false}}, the {{param|##.Bridge.{i}.Status}} has to be set to {{enum|Error_Misconfigured|##.Bridge.{i}.Status}}. Any attempt to delete an instance, which is currently in use ({{param|##.Bridge.{i}.ServerConnection}} refers to the instance to be deleted), has to be rejected. Enables or disables this {{object}}. {{datatype|expand}} The priority of this {{object}} that is used by the {{object|##.Bridge}} when determining the {{object}} to connect to. The {{object|##.Bridge}} MUST contact the {{object}} with the lowest-numbered priority that the {{object|##.Bridge}} can reach as defined in {{bibref|RFC2782}}. The selection of {{object}}s with the same {{param}} value utilizes the {{param|Weight}} parameter to determine which {{object}} is selected by the {{object|##.Bridge}}. This value is only used if {{param|##.Bridge.{i}.ServerSelectionAlgorithm}} is set to {{enum|Priority|##.Bridge.{i}.ServerSelectionAlgorithm}}. This parameter specifies a relative weight for entries with the same {{param|Priority}}. The mechanism is defined in {{bibref|RFC2782}}. A value of -1 indicates that the implementation of this parameter is specific to the Vendor. This value is only used if {{param|##.Bridge.{i}.ServerSelectionAlgorithm}} is set to {{enum|Priority|##.Bridge.{i}.ServerSelectionAlgorithm}}. Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this {{object|##.Bridge}} connects to. If the value of this parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attempted (in an implementation-specific order) until a connection can be made or all addresses are exhausted, in which case the next {{object}} instance (based on rules defined over the selected {{param|##.Bridge.{i}.ServerSelectionAlgorithm}}) SHOULD be used. Port number of the MQTT broker server this {{object|##.Bridge}} connects to. List of MQTT subscriptions handled over the bridge. {{datatype|expand}} Setting Enable to {{true}} activates the handling of this subscription instance. In case of incoming directions ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}) the topic is subscribed over the bridge at the remote MQTT broker with a MQTT SUBSCRIBE message if {{param}} is set to {{true}} or unsubscribed from the remote MQTT broker with a MQTT UNSUBSCRIBE message if the value is set to {{false}}. The actual status of the subscription is indicated with {{param|Status}}. Indicates the status of this subscription. {{enum}} The {{enum|Enabled}} value indicates that the this subscription is active. In case of incoming directions ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}) the topic was successfully subscribed with the remote MQTT broker. The {{enum|Disabled}} value indicates that this subscription is not used. The {{enum|Error}} value indicates that an error occurred (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use. Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT311|section Appendix A}}, {{bibref|MQTT311|section 4.7}} or {{bibref|MQTT50|4.7}}. The direction of the subscription. {{enum}}. Indicates that all matching topics will be sent over the bridge to the next MQTT broker. Indicates that all matching topics will be received over the bridge from the next MQTT broker. Indicates that all matching topics will be sent and received over the bridge. The MQTT QoS level assigned with the subscription (see {{bibref|MQTT311|section 4.1}}, {{bibref|MQTT311|section 4.3}}) or {{bibref|MQTT50|4.3}}. The local prefix is used for remapping received topics to the local topics of the MQTT broker and to select the topics to be sent over bridge to the remote MQTT broker. * In incoming direction ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}): : For remote topics received over the bridge the MQTT broker adds the LocalPrefix in front of the received topic, before processing it. :: '' '' : ''Example:'' :: Topic is "/bus/+", LocalPrefix is "/local", Direction is "in" :: MQTT broker receives message with topic "/bus/tr181" over bridge => MQTT broker uses topic "/local/bus/tr181" for internal processing * In outgoing direction ({{param|Direction}} is either {{enum|out|Direction}} or {{enum|both|Direction}}): : For selection of the topics to be sent over the bridge the MQTT broker uses the combination of {{param}} and {{param|Topic}} to match the topics to be sent over bridge, and removes the {{param}} from the selected topic before sending it over the bridge. :: '' '' : ''Example:'' :: Topic is "/bus/+", LocalPrefix is "/local", Direction is "out" :: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/bus/tr181" to remote MQTT broker The remote prefix is used for remapping topics to the remote MQTT broker topic lists. * In incoming direction ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}): : For remote topics received over the bridge the MQTT broker removes the remote prefix topic from the received topic (before handling the {{param|LocalPrefix}}), before processing it. :: '' '' : ''Example:'' :: Topic is "/bus/+", LocalPrefix is "/local", RemotePrefix is "/remote", Direction is "in" :: MQTT broker receives message with topic "/remote/bus/tr181" over bridge => MQTT broker uses topic "/local/bus/tr181" for internal processing : During activation of the bridge, the MQTT broker prepends the {{param|Topic}} with {{param}} topic and subscribes to the remote MQTT broker with it, in order to receive all applicable remote topics. :: '' '' : ''Example:'' :: Topic is "/bus/+", RemotePrefix is "/remote", Direction is "in" :: MQTT broker sends a subscription to the remote MQTT broker with the topic "/remote/bus/+". * In outgoing direction ({{param|Direction}} is either {{enum|out|Direction}} or {{enum|both|Direction}}): : For all topics to be sent over the bridge ({{param|Direction}} is either {{enum|out|Direction}} or {{enum|both|Direction}}), the RemotePrefix will be prepended to the topic after the {{param|LocalPrefix}} has been processed and before sending the message over the bridge. :: '' '' : ''Example:'' :: Topic is "/bus/+", LocalPrefix is "/local", RemotePrefix is "/remote" Direction is "out" :: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/remote/bus/tr181" to remote MQTT broker The MQTT broker statistics values. These will reset with each MQTT broker start, either after reboot or if the MQTT broker gets (re-)enabled. Total number of MQTT clients registered with the MQTT broker. Number of MQTT clients, which have a connection with the MQTT broker established. Number of MQTT clients, which have no connection with the MQTT broker established. Number of subscriptions held by the MQTT broker. Number of publish messages sent by the MQTT broker. Number of publish messages received by the MQTT broker. Total number of MQTT messages sent by the MQTT broker. Total number of MQTT messages received by the MQTT broker. Number of connection errors. Number of errors which prevented sending publish messages Provides MQTT client control Provides basic MQTT client control and statistics Adds client subscription control and access to received topics Provides basic MQTT broker control and statistics Adds parameters for MQTT network interconnection with Bridges Adds client authentication and extends statistics