The NodeOPCUA API The NodeOPCUA API

  • API Docs for Version: 0.5.4

    • APIs

    Show:

    OPCUAClient Class

    Extends OPCUAClientBase
    Defined in: packages\node-opcua-client\src\opcua_client.js:56
    Module: opcua.client

    Constructor

    OPCUAClient

    (
    • options
    )

    Defined in packages\node-opcua-client\src\opcua_client.js:56

    Parameters:

    • options Object
      • [securityMode=MessageSecurityMode.None] MessageSecurityMode optional

        the default security mode.

      • [securityPolicy=SecurityPolicy.NONE] SecurityPolicy optional

        the security mode.

      • [requestedSessionTimeout= 60000] Number optional

        the requested session time out in CreateSession

      • [applicationName="NodeOPCUA-Client"] String optional

        the client application name

      • [endpoint_must_exist=true] Boolean optional

        set to false if the client should accept server endpoint mismatch

      • [keepSessionAlive=false] Boolean optional
      • [certificateFile="certificates/client_selfsigned_cert_1024.pem"] String optional

        client certificate pem file.

      • [privateKeyFile="certificates/client_key_1024.pem"] String optional

        client private key pem file.

      • [clientName=""] String optional

        a client name string that will be used to generate session names.

    Methods

    changeSessionIdentity

    (
    • session
    • userIdentityInfo
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\opcua_client.js:643

    Parameters:

    • session Object
    • userIdentityInfo Object
    • callback Object

    changeSessionIdentity

    (
    • session
    • userIdentityInfo
    )
    Promise async

    Defined in packages\node-opcua-client\src\opcua_client.js:883

    Parameters:

    • session Object
    • userIdentityInfo Object

    Returns:

    Promise:

    closeSession

    (
    • session
    • deleteSubscriptions
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\opcua_client.js:705

    Parameters:

    • session ClientSession
      • the created client session
    • deleteSubscriptions Boolean
      • whether to delete subscriptions or not
    • callback Function
      • the callback
      • err Error | Null
        • the Error if the async method has failed

    closeSession

    (
    • session
    • deleteSubscriptions
    )
    Promise async

    Defined in packages\node-opcua-client\src\opcua_client.js:891

    Parameters:

    • session ClientSession
    • deleteSubscriptions Boolean
      • whether to delete

    Returns:

    Promise:

    Example:

    const session = await client.createSession(); await client.closeSession(session);

    connect

    (
    • endpointUrl
    )
    Promise async

    Inherited from OPCUAClientBase but overwritten in packages\node-opcua-client\src\opcua_client.js:850

    Parameters:

    • endpointUrl String

    Returns:

    Promise:

    createSession

    (
    • [userIdentityInfo]
    )
    Promise async

    Defined in packages\node-opcua-client\src\opcua_client.js:864

    Parameters:

    • [userIdentityInfo] Object optional

      optional

      • [userName] String optional
      • [password] String optional

    Returns:

    Promise:

    Example:

    // create a anonymous session
                    const session = await client.createSession();
    // create a session with a userName and password
                    const userIdentityInfo  = { userName: "JoeDoe", password:"secret"};
                    const session = client.createSession(userIdentityInfo);

    createSession

    (
    • [userIdentityInfo]
    • callback
    )
    async

    Defined in packages\node-opcua-client\src\opcua_client.js:589

    create and activate a new session

    Parameters:

    • [userIdentityInfo] Object optional

      optional

      • [userName] String optional
      • [password] String optional
    • callback Function
      • err Error | Null
        • the Error if the async method has failed
      • session ClientSession
        • the created session object.

    Example:

    : // create a anonymous session client.createSession(function(err,session) { if (err) {} else {} });

    : // create a session with a userName and password client.createSession({userName: "JoeDoe", password:"secret"}, function(err,session) { if (err) {} else {} });

    disconnect

    (
    • callback
    )
    async

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:924

    disconnect client from server

    Parameters:

    • callback Object

      [Function}

    disconnect disconnect client from server

    () Promise async

    Defined in packages\node-opcua-client\src\opcua_client.js:857

    Returns:

    Promise:

    findEndpoint

    () EndPoint

    Inherited from OPCUAClientBase but overwritten in packages\node-opcua-client\src\client_base.js:696

    return the endpoint information matching security mode and security policy.

    Returns:

    EndPoint:

    findServers

    (
    • callback
    )
    async

    Inherited from OPCUAClientBase but overwritten in packages\node-opcua-client\src\client_base.js:780

    send a FindServers request to a discovery server

    Parameters:

    • callback Object

      [Function}

    getEndpoints

    (
    • [options]
    • [options.localeIds}
    • [options.profileUris}
    • callback
    )
    async

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:728

    Parameters:

    • [options] Object optional
      • [endpointUrl] String optional

        the network address that the Client used to access the Discovery Endpoint .

    • [options.localeIds} Array

      List of locales to use.

    • [options.profileUris} Array

      List of transport profiles that the returned Endpoints shall support.

    • callback Function
      • err Error | Null
      • serverEndpoints Array

        the array of endpoint descriptions

    perform_findServers

    (
    • discovery_server_endpointUrl
    • callback
    )
    async

    Inherited from OPCUAClientBase but overwritten in packages\node-opcua-client\src\tools\findservers.js:4

    extract the server endpoints exposed by a discovery server

    Parameters:

    • discovery_server_endpointUrl Object
    • callback Object

    reactivateSession

    (
    • session
    • callback
    )

    Defined in packages\node-opcua-client\src\opcua_client.js:540

    transfer session to this client

    Parameters:

    • session Object
    • callback Object

    Returns:

    :

    readUAAnalogItem

    (
    • session
    • nodeId
    • callback
    )

    Defined in packages\node-opcua-client\src\client_utils.js:36

    Parameters:

    • session Object
    • nodeId Object
    • callback Object

    withSession

    (
    • inner_func
    • callback
    )

    Defined in packages\node-opcua-client\src\opcua_client.js:763

    Parameters:

    • inner_func Function
    • callback Function

    Properties

    bytesRead

    Number

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:990

    total number of bytes read by the client

    bytesWritten

    Number

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:1000

    total number of bytes written by the client

    connectionStrategy

    options.connectionStrategy | MaxRetry, initialDelay, maxDelay, randomisationFactor | | MaxRetry: number, initialDelay: number, maxDelay: number, randomisationFactor: number

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:129

    isReconnecting

    Boolean true if the client is trying to reconnect to the server after a connection break.

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:259

    keepPendingSessionsOnDisconnect²

    Boolean

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:135

    keepSessionAlive

    Boolean

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:116

    true if session shall periodically probe the server to keep the session alive and prevent timeout

    knowsServerEndpoint

    Boolean

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:151

    is true when the client has already requested the server end points.

    reconnectOnFailure

    Boolean

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:448

    true if the connection strategy is set to automatically try to reconnect in case of failure

    securityMode

    MessageSecurityMode

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:96

    serverCertificate

    Certificate

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:110

    transactionsPerformed

    Number

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:1010

    total number of transactions performed by the client

    Events

    after_reconnection

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:326

    notify the observers that the reconnection process has been completed

    Event Payload:

    • err Object

    close

    Inherited from OPCUAClientBase but overwritten in packages\node-opcua-client\src\client_base.js:519

    Event Payload:

    • error Error

    connection_reestablished send when the connection is reestablished after a connection break

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:547

    receive_chunk

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:473

    notify the observer that a message_chunk has been received

    Event Payload:

    • message_chunk Object

    receive_response

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:491

    notify the observer that a response has been received from the server.

    Event Payload:

    • message Object

    send_chunk

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:464

    notify the observer that a message_chunk has been sent

    Event Payload:

    • message_chunk Object

    send_request

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:482

    notify the observer that a request has been sent to the server.

    Event Payload:

    • message Object

    start_reconnection

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:298

    notifies the observer that the OPCUA is now trying to reestablish the connection after having received a connection break...

    timed_out_request

    Inherited from OPCUAClientBase: packages\node-opcua-client\src\client_base.js:574

    send when a request has timed out without receiving a response

    Event Payload:

    • request Object