QOpcUaProvider#

QOpcUaProvider creates an instance of QOpcUaClient . More…

Synopsis#

Functions#

def createClient (backend[, backendProperties=QVariantMap()])

Static functions#

def availableBackends ()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

QOpcUaProvider allows the user to create an instance of QOpcUaClient by loading a QOpcUaPlugin using the Qt plugin system.

For the available plugins and their capabilities please refer to the introduction .

Example#

This code creates a client using the first available backend:

QOpcUaProvider provider;
QStringList available = provider.availableBackends();
if (!available.isEmpty()) {
    QOpcUaClient *client = provider.createClient(available[0]);
    if (client)
        qDebug() << "Client successfully created";
}

class PySide6.QtOpcUa.QOpcUaProvider([parent=None])#

Parameters:: parent – PySide6.QtCore.QObject

Creates a new OPC UA provider with a given parent.

static PySide6.QtOpcUa.QOpcUaProvider.availableBackends()#

Return type:: list of strings

Returns a QStringList of available plugins.

PySide6.QtOpcUa.QOpcUaProvider.createClient(backend[, backendProperties=QVariantMap()])#

Parameters:

backend – str
backendProperties – Dictionary with keys of type .QString and values of type QVariant.

Return type:

PySide6.QtOpcUa.QOpcUaClient

Returns a pointer to a QOpcUaClient object by loading the selected backend as a plugin and creating a client object. If the plugin loading fails, nullptr is returned instead.

The user is responsible for deleting the returned QOpcUaClient object when it is no longer needed.

The optional argument backendProperties can be used to pass custom backend specific settings as key value pairs. Those settings are specific to the backend being instantiated.

Available settings are

Setting string

Backend

Description

disableEncryptedPasswordCheck

Unified Automation

By default, the backend refuses to connect to endpoints without encryption to avoid sending passwords in clear text. This parameter allows to disable this feature.

enableVerboseDebugOutput

Unified Automation

Tells the backend to print additional output to the terminal. The backend specific logging level is set to OPCUA_TRACE_OUTPUT_LEVEL_ALL.

minimumClientIterateIntervalMs

open62541

This parameter is no longer evaluated by the backend and has been replaced by clientIterateIntervalMs.

clientIterateIntervalMs

open62541

Defines the client iterate interval for the backend. If the client is causing too much CPU load, setting this value higher than the default will reduce the CPU load at the price of an increased response time to service requests and value updates from subscriptions. The default value is 50ms.

asyncRequestTimeoutMs

open62541

Defines the timeout for asynchronous requests to an OPC UA server. If the server doesn’t reply to a service request before the timeout occurs, the service call fails and the finished signal will contain a bad status code. The default value is 15000ms.

Setting string	Backend	Description
disableEncryptedPasswordCheck	Unified Automation	By default, the backend refuses to connect to endpoints without encryption to avoid sending passwords in clear text. This parameter allows to disable this feature.
enableVerboseDebugOutput	Unified Automation	Tells the backend to print additional output to the terminal. The backend specific logging level is set to `OPCUA_TRACE_OUTPUT_LEVEL_ALL`.
minimumClientIterateIntervalMs	open62541	This parameter is no longer evaluated by the backend and has been replaced by `clientIterateIntervalMs`.
clientIterateIntervalMs	open62541	Defines the client iterate interval for the backend. If the client is causing too much CPU load, setting this value higher than the default will reduce the CPU load at the price of an increased response time to service requests and value updates from subscriptions. The default value is 50ms.
asyncRequestTimeoutMs	open62541	Defines the timeout for asynchronous requests to an OPC UA server. If the server doesn’t reply to a service request before the timeout occurs, the service call fails and the finished signal will contain a `bad` status code. The default value is 15000ms.