opcua (opcua)

Create OPC UA client object

Description

example

UaClient = opcua(ServerInfoObj) creates an OPC UA client associated with the server specified by ServerInfoObj. You can create server objects with the opcuaserverinfo function.

UaClient = opcua(ServerUrl) creates a client associated with the server referenced by the URL specified in ServerUrl.

UaClient = opcua(Hostname,Portnum) creates an OPC UA client object associated with the server at port Portnum on the host identified by Hostname. The client attempts to retrieve available endpoints, but does not error if the endpoints cannot be retrieved.

Note

Some OPC UA servers require security for any connection to that server. OPC Toolbox™ supports only anonymous, unsecured connections to servers.

Examples

collapse all

Create a client for the first server found on the local host.

S = opcuaserverinfo('localhost');
UaClient = opcua(S(1));

Create a client for the server at port 51210 on the local host.

UaClient = opcua('localhost',51210)
UaClient = 
OPC UA Client UA Sample Server:
    Hostname: localhost
        Port: 51210
     Timeout: 10

      Status: Disconnected

Input Arguments

collapse all

OPC UA server, specified as an OPC UA server object.

Data Types: object

OPC UA server URL, specified as a character vector or string. The server URL must use the opc.tcp protocol; OPC Toolbox does not support http or https connections.

Data Types: char | string

Server host name or IP address, specified as a character vector or string. A host name can be short or a fully qualified domain name.

Example: 'localhost'

Data Types: char | string

Server host port number, specified as a numeric value.

Example: 5000

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

Output Arguments

collapse all

OPC UA client, returned as an opc.ua.Client object, with the following properties.

PropertyDescription
HostnameServer host name or IP address
PortPort number used for TCP/IP connections to the server
NameServer description
TimeoutTime to wait for all operations on the server to complete
EndpointUrlURL to use for connection to the server
NamespaceServer namespace nodes
UserDataFree-form container for user-defined data to associate with the client
MinSampleRateMinimum sample rate in seconds that the server can generally support
AggregateFunctionsList of aggregate functions supported by this server
MaxHistoryValuesPerNodeMaximum history values returned per node in historical read operations
MaxHistoryReadNodesMaximum number of nodes supported by historical read operations
MaxReadNodesMaximum number of nodes supported per read operation
MaxWriteNodesMaximum number of nodes supported per write operation

See Also

Functions

Introduced in R2015b