Connection QML Type

Se conecta a un servidor. Más...

Este tipo está obsoleto desde QtOpcUa 6.9. Desaconsejamos su uso en código nuevo.

• Lista de todos los miembros, incluyendo los heredados

Propiedades

• authenticationInformation : AuthenticationInformation
• availableBackends : stringlist
• backend : string
• connected : bool
• connection : QOpcUaClient
• currentEndpoint : QOpcUaEndpointDescription
• defaultConnection : bool
• namespaces : stringlist
• supportedSecurityPolicies : stringlist
• supportedUserTokenTypes : array[tokenTypes]

Señales

• nodeChanged()
• readNodeAttributesFinished(readResults)
• writeNodeAttributesFinished(writeResults)

Métodos

• void connectToEndpoint(endpointDescription)
• void disconnectFromEndpoint()
• bool readNodeAttributes(valuesToBeRead)
• bool writeNodeAttributes(valuesToBeWritten)

Descripción detallada

La API principal utiliza backends para realizar conexiones. Tiene que establecer el backend antes de cualquier intento de conexión.

import QtOpcUa as QtOpcUa

QtOpcUa.Connection {
    backend: "open62541"
}

Component.onCompleted: {
    connection.connectToEndpoint("opc.tcp://127.0.0.1:43344");
}

Documentación de propiedades

authenticationInformation : AuthenticationInformation

Establece la información de autenticación para esta conexión. La información de autenticación debe establecerse antes de llamar a connectToEndpoint. Si no se establece ninguna información de autenticación, se utilizará el modo anónimo. No tiene ningún efecto sobre la conexión actual. Si el cliente se desconecta y se vuelve a conectar, se utilizarán las nuevas credenciales. Si se lee y escribe esta propiedad antes de establecer backend, las escrituras se ignoran y las lecturas devuelven un AuthenticationInformation inválido.

availableBackends : stringlist [read-only]

Devuelve los nombres de todos los backends disponibles en forma de lista. Se utilizan para seleccionar un backend al conectarse.

Véase también Connection::backend.

backend : string

Establece el backend a utilizar para una conexión al servidor. Debe establecerse antes de cualquier intento de conexión.

Véase también Connection::availableBackends.

connected : bool [read-only]

Estado de la conexión. true cuando hay conexión, en caso contrario false.

connection : QOpcUaClient

Esta propiedad se utiliza sólo para inyectar una conexión desde C++. En caso de una configuración compleja de una conexión se puede utilizar C++ para manejar todos los detalles. Una vez establecida la conexión se puede pasar a QML utilizando esta propiedad. La propiedad del cliente se transfiere a QML.

class MyClass : public QObject {
    Q_OBJECT
    Q_PROPERTY(QOpcUaClient* connection READ connection NOTIFY connectionChanged)

public:
    MyClass (QObject* parent = nullptr);
    QOpcUaClient *connection() const;

signals:
    void connectionChanged(QOpcUaClient *);

Emitiendo la señal connectionChanged cuando la configuración del cliente se haya completado, el código QML de abajo utilizará la conexión.

import QtOpcUa as QtOpcUa

MyClass {
    id: myclass
}

QtOpcUa.Connection {
    connection: myclass.connection
 }

currentEndpoint : QOpcUaEndpointDescription

Una descripción del punto final del servidor al que está conectada la conexión. Cuando no se establece la conexión, se devuelve una descripción de endpoint vacía.

defaultConnection : bool

Hace que ésta sea la conexión por defecto. Normalmente es necesario dar a cada nodo una conexión a utilizar. Si esta propiedad se establece en true, esta conexión se utilizará en todos los casos en que un nodo no tenga establecida ninguna conexión. Las conexiones ya establecidas no se verán afectadas. Si defaultConnection se establece en true en varias conexiones, se utilizará la última.

QtOpcUa.Connection {
    ...
    defaultConnection: true
    ...
}

Véase también Node.

namespaces : stringlist [read-only]

Lista de cadenas de todos los URI de espacios de nombres registrados en el servidor conectado.

supportedSecurityPolicies : stringlist

Una lista de cadenas que contiene las políticas de seguridad soportadas.

Esta propiedad está actualmente disponible como Muestra de Tecnología, y por lo tanto la API y la funcionalidad proporcionada pueden estar sujetas a cambios en cualquier momento sin previo aviso.

supportedUserTokenTypes : array[tokenTypes]

Una matriz de tipos de políticas de token de usuario de todos los tipos de token de usuario admitidos.

Esta propiedad está actualmente disponible como Muestra de Tecnología, y por lo tanto la API y la funcionalidad proporcionada pueden estar sujetas a cambios en cualquier momento sin previo aviso.

Documentación de Signal

nodeChanged()

Se emite cuando el nodo subyacente ha cambiado. Esto ocurre cuando ha cambiado el espacio de nombres o el identificador de NodeId.

readNodeAttributesFinished(readResults)

Se emite cuando finaliza la petición de lectura iniciada con readNodeAttributes(). El parámetro readResults es un array de entradas ReadResult, que contiene los valores solicitados al servidor.

connection.onReadNodeAttributesFinished(results) {
    for (var i = 0; results.length; i++) {
        if (results[i].status.isGood) {
            console.log(results[i].value);
        } else {
            // handle error
        }
    }
}

Véase también readNodeAttributes() y ReadResult.

writeNodeAttributesFinished(writeResults)

Se emite cuando finaliza la petición de escritura iniciada con writeNodeAttributes(). El parámetro writeResults es un array de entradas WriteResult, que contiene los valores solicitados al servidor.

for (var i = 0; i < writeResults.length; i++) {
    console.log(writeResults[i].nodeId);
    console.log(writeResults[i].namespaceName);
    console.log(writeResults[i].attribute);

    if (writeResults[i].status.isBad) {
        // value was not written
    }
}

Véase también writeNodeAttributes() y WriteResult.

Documentación del método

void connectToEndpoint(endpointDescription)

Se conecta al punto final especificado con endpointDescription.

Véase también EndpointDescription.

void disconnectFromEndpoint()

Desconecta una conexión establecida.

bool readNodeAttributes(valuesToBeRead)

Esta función se utiliza para leer varios valores de un servidor de una sola vez. Devuelve true si la solicitud de lectura se ha enviado correctamente.

El parámetro valuesToBeRead debe ser una matriz JavaScript de entradas ReadItem.

// List of items to read
var readItemList = [];
// Item to be added to the list of items to be read
var readItem;

// Prepare an item to be read

// Create a new read item and fill properties
readItem = QtOpcUa.ReadItem.create();
readItem.ns = "http://qt-project.org";
readItem.nodeId = "s=Demo.Static.Scalar.Double";
readItem.attribute = QtOpcUa.Constants.NodeAttribute.DisplayName;

// Add the prepared item to the list of items to be read
readItemList.push(readItem);

// Add further items
[...]

if (!connection.readNodeAttributes(readItemList)) {
    // handle error
}

El resultado de la petición de lectura se proporciona mediante la señal readNodeAttributesFinished().

Véase también readNodeAttributesFinished() y ReadItem.

bool writeNodeAttributes(valuesToBeWritten)

Esta función se utiliza para escribir varios valores en un servidor de una sola vez. Devuelve true si la solicitud de escritura se ha enviado correctamente.

El parámetro valuesToBeWritten debe ser un array JavaScript de entradas WriteItem.

// List of items to write
var writeItemList = [];
// Item to be added to the list of items to be written
var writeItem;

// Prepare an item to be written

// Create a new write item and fill properties
writeItem = QtOpcUa.WriteItem.create();
writeItem.ns = "http://qt-project.org";
writeItem.nodeId = "s=Demo.Static.Scalar.Double";
writeItem.attribute = QtOpcUa.Constants.NodeAttribute.Value;
writeItem.value = 32.1;
writeItem.valueType = QtOpcUa.Constants.Double;

// Add the prepared item to the list of items to be written
writeItemList.push(writeItem);

// Add further items
[...]

if (!connection.writeNodeAttributes(writeItemList)) {
    // handle error
}

El resultado de la solicitud de escritura se proporciona mediante la señal Connection::writeNodeAttributesFinished().

Véase también Connection::writeNodeAttributesFinished() y WriteItem.