OpcLabs.Mqtt communication package: Difference between revisions
From OPC Labs Knowledge Base
| Line 20: | Line 20: | ||
|- | |- | ||
|ClientWaitTimeout | |ClientWaitTimeout | ||
|System.Int32 | |||
| | | | ||
|- | |- | ||
|ErrorWaitDelay | |ErrorWaitDelay | ||
|System.Int32 | |||
| | | | ||
|- | |- | ||
|MqttConfiguration | |MqttConfiguration | ||
|System.Net.Mqtt.MqttConfiguration | |||
|General configuration used across the protocol implementation. | |General configuration used across the protocol implementation. | ||
|- | |- | ||
|MqttConfiguration.AllowWildcardsInTopicFilters | |MqttConfiguration.AllowWildcardsInTopicFilters | ||
|System.Boolean | |||
|Determines if multi level (#) and single level (+) wildcards are allowed on topic filters. Default value is true. | |Determines if multi level (#) and single level (+) wildcards are allowed on topic filters. Default value is true. | ||
|- | |- | ||
|MqttConfiguration.BufferSize | |MqttConfiguration.BufferSize | ||
|System.Int32 | |||
|Size in bytes of the receive buffer of the underlying transport protocol. Only use it when the property applies to the undelrying protocol used. | |Size in bytes of the receive buffer of the underlying transport protocol. Only use it when the property applies to the undelrying protocol used. | ||
|- | |- | ||
|MqttConfiguration.ConnectionTimeoutSecs | |MqttConfiguration.ConnectionTimeoutSecs | ||
|System.Int32 | |||
|Seconds to wait for a channel connection until the operation timeouts. This value is generally used to wait for the MQTT channel to open. Default value is 5 seconds. | |Seconds to wait for a channel connection until the operation timeouts. This value is generally used to wait for the MQTT channel to open. Default value is 5 seconds. | ||
|- | |- | ||
|MqttConfiguration.KeepAliveSecs | |MqttConfiguration.KeepAliveSecs | ||
|System.UInt16 | |||
|Seconds to wait for the MQTT Keep Alive mechanism until a Ping packet is sent to maintain the connection alive. Default value is 0 seconds, which means Keep Alive disabled. | |Seconds to wait for the MQTT Keep Alive mechanism until a Ping packet is sent to maintain the connection alive. Default value is 0 seconds, which means Keep Alive disabled. | ||
|- | |- | ||
|MqttConfiguration.MaximumQualityOfService | |MqttConfiguration.MaximumQualityOfService | ||
|System.Net.Mqtt.MqttQualityOfService | |||
|Maximum Quality of Service (QoS) to support. Default value is AtMostOnce, which means QoS 0. | |Maximum Quality of Service (QoS) to support. Default value is AtMostOnce, which means QoS 0. | ||
|- | |- | ||
|MqttConfiguration.Port | |MqttConfiguration.Port | ||
|System.Int32 | |||
|Port to connect a Client to a Server. | |Port to connect a Client to a Server. | ||
|- | |- | ||
|MqttConfiguration.WaitTimeoutSecs | |MqttConfiguration.WaitTimeoutSecs | ||
|System.Int32 | |||
|Seconds to wait for an incoming required message until the operation timeouts. This value is generally used to wait for Server or Client acknowledgements. Default value is 5 seconds. | |Seconds to wait for an incoming required message until the operation timeouts. This value is generally used to wait for Server or Client acknowledgements. Default value is 5 seconds. | ||
|- | |- | ||
|OpenFailureWaitDelay | |OpenFailureWaitDelay | ||
|System.Int32 | |||
| | | | ||
|- | |- | ||
|RemoteDisconnectedWaitDelay | |RemoteDisconnectedWaitDelay | ||
|System.Int32 | |||
| | | | ||
|} | |} | ||
Revision as of 16:41, 12 December 2019
OpcLabs.Mqtt
Specifying the communication package
In order to select this communication package in OPC UA PubSub tools, you need to set a custom property on a PubSub connection as follows:
- Property namespace: http://opclabs.com/OpcUA/PubSub
- Property name: MessageChannel!
- Property value (String): OpcLabs.Mqtt.MqttClientMessageChannel,OpcLabs.Mqtt
How this is done depends on the concrete software you are using.
EasyUASubscriber object
OpcCmd tool
UADemoPublisher tool
Configuring the communication package
| ClientWaitTimeout | System.Int32 | |
| ErrorWaitDelay | System.Int32 | |
| MqttConfiguration | System.Net.Mqtt.MqttConfiguration | General configuration used across the protocol implementation. |
| MqttConfiguration.AllowWildcardsInTopicFilters | System.Boolean | Determines if multi level (#) and single level (+) wildcards are allowed on topic filters. Default value is true. |
| MqttConfiguration.BufferSize | System.Int32 | Size in bytes of the receive buffer of the underlying transport protocol. Only use it when the property applies to the undelrying protocol used. |
| MqttConfiguration.ConnectionTimeoutSecs | System.Int32 | Seconds to wait for a channel connection until the operation timeouts. This value is generally used to wait for the MQTT channel to open. Default value is 5 seconds. |
| MqttConfiguration.KeepAliveSecs | System.UInt16 | Seconds to wait for the MQTT Keep Alive mechanism until a Ping packet is sent to maintain the connection alive. Default value is 0 seconds, which means Keep Alive disabled. |
| MqttConfiguration.MaximumQualityOfService | System.Net.Mqtt.MqttQualityOfService | Maximum Quality of Service (QoS) to support. Default value is AtMostOnce, which means QoS 0. |
| MqttConfiguration.Port | System.Int32 | Port to connect a Client to a Server. |
| MqttConfiguration.WaitTimeoutSecs | System.Int32 | Seconds to wait for an incoming required message until the operation timeouts. This value is generally used to wait for Server or Client acknowledgements. Default value is 5 seconds. |
| OpenFailureWaitDelay | System.Int32 | |
| RemoteDisconnectedWaitDelay | System.Int32 |
