Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
opcua.client.ua_client.UaClient Class Reference
Inheritance diagram for opcua.client.ua_client.UaClient:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, timeout=1)
 
def activate_session (self, parameters)
 
def add_nodes (self, nodestoadd)
 
def browse (self, parameters)
 
def call (self, methodstocall)
 
def close_secure_channel (self)
 
def close_session (self, deletesubscriptions)
 
def connect_socket (self, host, port)
 
def create_monitored_items (self, params)
 
def create_session (self, parameters)
 
def create_subscription (self, params, callback)
 
def delete_monitored_items (self, params)
 
def delete_nodes (self, params)
 
def delete_subscriptions (self, subscriptionids)
 
def disconnect_socket (self)
 
def find_servers (self, params)
 
def find_servers_on_network (self, params)
 
def get_endpoints (self, params)
 
def history_read (self, params)
 
def modify_monitored_items (self, params)
 
def open_secure_channel (self, params)
 
def publish (self, acks=None)
 
def read (self, parameters)
 
def register_server (self, registered_server)
 
def register_server2 (self, params)
 
def send_hello (self, url)
 
def set_security (self, policy)
 
def translate_browsepaths_to_nodeids (self, browsepaths)
 
def write (self, params)
 

Public Attributes

 logger
 

Private Member Functions

def _call_publish_callback (self, future)
 
def _create_subscription_callback (self, pub_callback, resp_fut, data_fut)
 
def _delete_subscriptions_callback (self, subscriptionids, resp_fut, data_fut)
 

Private Attributes

 _publishcallbacks
 
 _security_policy
 
 _timeout
 
 _uasocket
 

Detailed Description

low level OPC-UA client.

It implements (almost) all methods defined in opcua spec
taking in argument the structures defined in opcua spec.

In this Python implementation  most of the structures are defined in
uaprotocol_auto.py and uaprotocol_hand.py available under opcua.ua

Definition at line 187 of file ua_client.py.

Constructor & Destructor Documentation

def opcua.client.ua_client.UaClient.__init__ (   self,
  timeout = 1 
)

Definition at line 199 of file ua_client.py.

Member Function Documentation

def opcua.client.ua_client.UaClient._call_publish_callback (   self,
  future 
)
private

Definition at line 415 of file ua_client.py.

def opcua.client.ua_client.UaClient._create_subscription_callback (   self,
  pub_callback,
  resp_fut,
  data_fut 
)
private

Definition at line 378 of file ua_client.py.

def opcua.client.ua_client.UaClient._delete_subscriptions_callback (   self,
  subscriptionids,
  resp_fut,
  data_fut 
)
private

Definition at line 396 of file ua_client.py.

def opcua.client.ua_client.UaClient.activate_session (   self,
  parameters 
)

Definition at line 244 of file ua_client.py.

def opcua.client.ua_client.UaClient.add_nodes (   self,
  nodestoadd 
)

Definition at line 487 of file ua_client.py.

def opcua.client.ua_client.UaClient.browse (   self,
  parameters 
)

Definition at line 269 of file ua_client.py.

def opcua.client.ua_client.UaClient.call (   self,
  methodstocall 
)

Definition at line 507 of file ua_client.py.

def opcua.client.ua_client.UaClient.close_secure_channel (   self)
close secure channel. It seems to trigger a shutdown of socket
in most servers, so be prepare to reconnect

Definition at line 226 of file ua_client.py.

def opcua.client.ua_client.UaClient.close_session (   self,
  deletesubscriptions 
)

Definition at line 254 of file ua_client.py.

def opcua.client.ua_client.UaClient.connect_socket (   self,
  host,
  port 
)
connect to server socket and start receiving thread

Definition at line 210 of file ua_client.py.

def opcua.client.ua_client.UaClient.create_monitored_items (   self,
  params 
)

Definition at line 467 of file ua_client.py.

def opcua.client.ua_client.UaClient.create_session (   self,
  parameters 
)

Definition at line 233 of file ua_client.py.

def opcua.client.ua_client.UaClient.create_subscription (   self,
  params,
  callback 
)

Definition at line 369 of file ua_client.py.

def opcua.client.ua_client.UaClient.delete_monitored_items (   self,
  params 
)

Definition at line 477 of file ua_client.py.

def opcua.client.ua_client.UaClient.delete_nodes (   self,
  params 
)

Definition at line 497 of file ua_client.py.

def opcua.client.ua_client.UaClient.delete_subscriptions (   self,
  subscriptionids 
)

Definition at line 387 of file ua_client.py.

def opcua.client.ua_client.UaClient.disconnect_socket (   self)

Definition at line 217 of file ua_client.py.

def opcua.client.ua_client.UaClient.find_servers (   self,
  params 
)

Definition at line 319 of file ua_client.py.

def opcua.client.ua_client.UaClient.find_servers_on_network (   self,
  params 
)

Definition at line 329 of file ua_client.py.

def opcua.client.ua_client.UaClient.get_endpoints (   self,
  params 
)

Definition at line 309 of file ua_client.py.

def opcua.client.ua_client.UaClient.history_read (   self,
  params 
)

Definition at line 516 of file ua_client.py.

def opcua.client.ua_client.UaClient.modify_monitored_items (   self,
  params 
)

Definition at line 526 of file ua_client.py.

def opcua.client.ua_client.UaClient.open_secure_channel (   self,
  params 
)

Definition at line 223 of file ua_client.py.

def opcua.client.ua_client.UaClient.publish (   self,
  acks = None 
)

Definition at line 406 of file ua_client.py.

def opcua.client.ua_client.UaClient.read (   self,
  parameters 
)

Definition at line 279 of file ua_client.py.

def opcua.client.ua_client.UaClient.register_server (   self,
  registered_server 
)

Definition at line 339 of file ua_client.py.

def opcua.client.ua_client.UaClient.register_server2 (   self,
  params 
)

Definition at line 349 of file ua_client.py.

def opcua.client.ua_client.UaClient.send_hello (   self,
  url 
)

Definition at line 220 of file ua_client.py.

def opcua.client.ua_client.UaClient.set_security (   self,
  policy 
)

Definition at line 207 of file ua_client.py.

def opcua.client.ua_client.UaClient.translate_browsepaths_to_nodeids (   self,
  browsepaths 
)

Definition at line 359 of file ua_client.py.

def opcua.client.ua_client.UaClient.write (   self,
  params 
)

Definition at line 299 of file ua_client.py.

Member Data Documentation

opcua.client.ua_client.UaClient._publishcallbacks
private

Definition at line 202 of file ua_client.py.

opcua.client.ua_client.UaClient._security_policy
private

Definition at line 205 of file ua_client.py.

opcua.client.ua_client.UaClient._timeout
private

Definition at line 203 of file ua_client.py.

opcua.client.ua_client.UaClient._uasocket
private

Definition at line 204 of file ua_client.py.

opcua.client.ua_client.UaClient.logger

Definition at line 200 of file ua_client.py.


The documentation for this class was generated from the following file:


ros_opcua_impl_python_opcua
Author(s): Denis Štogl , Daniel Draper
autogenerated on Tue Jan 19 2021 03:12:44