Public Member Functions
def	__enter__
def	__exit__
def	__init__
def	allow_remote_admin
def	create_custom_data_type
def	create_custom_event_type
def	create_custom_object_type
def	create_custom_variable_type
def	create_subscription
def	dehistorize_node_data_change
def	dehistorize_node_event
def	delete_nodes
def	disable_clock
def	export_xml
def	export_xml_by_ns
def	find_servers
def	get_client_to_discovery
def	get_endpoints
def	get_event_generator
def	get_namespace_array
def	get_namespace_index
def	get_node
def	get_objects_node
def	get_root_node
def	get_server_node
def	historize_node_data_change
def	historize_node_event
def	import_xml
def	link_method
def	load_certificate
def	load_private_key
def	register_namespace
def	register_to_discovery
def	set_application_uri
def	set_endpoint
def	set_server_name
def	start
def	stop
def	subscribe_server_callback
def	unregister_to_discovery
def	unsubscribe_server_callback
Public Attributes
	application_type
	application_uri
	bserver
	certificate
	default_timeout
	endpoint
	iserver
	logger
	name
	nodes
	private_key
	product_uri
Private Member Functions
def	_create_custom_type
def	_renew_registration
def	_set_endpoints
def	_setup_server_nodes
Private Attributes
	_discovery_clients
	_discovery_period
	_policies

Detailed Description

High level Server class

This class creates an opcua server with default values

Create your own namespace and then populate your server address space
using use the get_root() or get_objects() to get Node objects.
and get_event_object() to fire events.
Then start server. See example_server.py
All methods are threadsafe

If you need more flexibility you call directly the Ua Service methods
on the iserver  or iserver.isesssion object members.

During startup the standard address space will be constructed, which may be
time-consuming when running a server on a less powerful device (e.g. a
Raspberry Pi). In order to improve startup performance, a optional path to a
cache file can be passed to the server constructor.
If the parameter is defined, the address space will be loaded from the
cache file or the file will be created if it does not exist yet.
As a result the first startup will be even slower due to the cache file
generation but all further start ups will be significantly faster.

:ivar application_uri:
:vartype application_uri: uri
:ivar product_uri:
:vartype product_uri: uri
:ivar name:
:vartype name: string
:ivar default_timeout: timeout in milliseconds for sessions and secure channel
:vartype default_timeout: int
:ivar iserver: internal server object
:vartype default_timeout: InternalServer
:ivar bserver: binary protocol server
:vartype bserver: BinaryServer
:ivar nodes: shortcuts to common nodes
:vartype nodes: Shortcuts

Definition at line 36 of file opcua/server/server.py.

Constructor & Destructor Documentation

def opcua.server.server.Server.__init__	(	self,
		shelffile = `None`,
		iserver = `None`
	)

Definition at line 78 of file opcua/server/server.py.

Member Function Documentation

def opcua.server.server.Server.__enter__ ( self )

Definition at line 103 of file opcua/server/server.py.

def opcua.server.server.Server.__exit__	(	self,
		exc_type,
		exc_value,
		traceback
	)

Definition at line 107 of file opcua/server/server.py.

def opcua.server.server.Server._create_custom_type	(	self,
		idx,
		name,
		basetype,
		properties,
		variables,
		methods
	)	`[private]`

Definition at line 393 of file opcua/server/server.py.

def opcua.server.server.Server._renew_registration ( self ) [private]

Definition at line 171 of file opcua/server/server.py.

def opcua.server.server.Server._set_endpoints	(	self,
		policy = `ua.SecurityPolicy`,
		mode = `ua.MessageSecurityMode.None_`
	)	`[private]`

Definition at line 230 of file opcua/server/server.py.

def opcua.server.server.Server._setup_server_nodes ( self ) [private]

Definition at line 196 of file opcua/server/server.py.

def opcua.server.server.Server.allow_remote_admin	(	self,
		allow
	)

Enable or disable the builtin Admin user from network clients

Definition at line 184 of file opcua/server/server.py.

def opcua.server.server.Server.create_custom_data_type	(	self,
		idx,
		name,
		basetype = `ua.ObjectIds.BaseDataType`,
		properties = `None`
	)

Definition at line 362 of file opcua/server/server.py.

def opcua.server.server.Server.create_custom_event_type	(	self,
		idx,
		name,
		basetype = `ua.ObjectIds.BaseEventType`,
		properties = `None`
	)

Definition at line 367 of file opcua/server/server.py.

def opcua.server.server.Server.create_custom_object_type	(	self,
		idx,
		name,
		basetype = `ua.ObjectIds.BaseObjectType`,
		properties = `None`,
		variables = `None`,
		methods = `None`
	)

Definition at line 372 of file opcua/server/server.py.

def opcua.server.server.Server.create_custom_variable_type	(	self,
		idx,
		name,
		basetype = `ua.ObjectIds.BaseVariableType`,
		properties = `None`,
		variables = `None`,
		methods = `None`
	)

Definition at line 384 of file opcua/server/server.py.

def opcua.server.server.Server.create_subscription	(	self,
		period,
		handler
	)

Create a subscription.
returns a Subscription object which allow
to subscribe to events or data on server

Definition at line 312 of file opcua/server/server.py.

def opcua.server.server.Server.dehistorize_node_data_change	(	self,
		node
	)

Stop historizing supplied nodes; see history module
Args:
    node: node or list of nodes that can be historized (UA variables/properties)

Returns:

Definition at line 465 of file opcua/server/server.py.

def opcua.server.server.Server.dehistorize_node_event	(	self,
		node
	)

Stop historizing events from node (typically a UA object); see history module
Args:
   node: node or list of nodes that can be historized (UA objects)

Returns:

Definition at line 491 of file opcua/server/server.py.

def opcua.server.server.Server.delete_nodes	(	self,
		nodes,
		recursive = `False`
	)

Definition at line 448 of file opcua/server/server.py.

def opcua.server.server.Server.disable_clock	(	self,
		val = `True`
	)

for debugging you may want to disable clock that write every second
to address space

Definition at line 119 of file opcua/server/server.py.

def opcua.server.server.Server.export_xml	(	self,
		nodes,
		path
	)

Export defined nodes to xml

Definition at line 424 of file opcua/server/server.py.

def opcua.server.server.Server.export_xml_by_ns	(	self,
		path,
		namespaces = `None`
	)

Export nodes of one or more namespaces to an XML file.  
Namespaces used by nodes are always exported for consistency.
Args:
    server: opc ua server to use
    path: name of the xml file to write
    namespaces: list of string uris or int indexes of the namespace to export, if not provide all ns are used except 0
    
Returns:

Definition at line 432 of file opcua/server/server.py.

def opcua.server.server.Server.find_servers	(	self,
		uris = `None`
	)

find_servers. mainly implemented for symmetry with client

Definition at line 136 of file opcua/server/server.py.

def opcua.server.server.Server.get_client_to_discovery	(	self,
		url = `"opc.tcp://localhost:4840"`
	)

Create a client to discovery server and return it

Definition at line 176 of file opcua/server/server.py.

def opcua.server.server.Server.get_endpoints ( self )

Definition at line 193 of file opcua/server/server.py.

def opcua.server.server.Server.get_event_generator	(	self,
		etype = `None`,
		source = `ua.ObjectIds.Server`
	)

Returns an event object using an event type from address space.
Use this object to fire events

Definition at line 353 of file opcua/server/server.py.

def opcua.server.server.Server.get_namespace_array ( self )

get all namespace defined in server

Definition at line 327 of file opcua/server/server.py.

def opcua.server.server.Server.get_namespace_index	(	self,
		uri
	)

get index of a namespace using its uri

Definition at line 346 of file opcua/server/server.py.

def opcua.server.server.Server.get_node	(	self,
		nodeid
	)

Get a specific node using NodeId object or a string representing a NodeId

Definition at line 306 of file opcua/server/server.py.

def opcua.server.server.Server.get_objects_node ( self )

Get Objects node of server. Returns a Node object.

Definition at line 294 of file opcua/server/server.py.

def opcua.server.server.Server.get_root_node ( self )

Get Root node of server. Returns a Node object.

Definition at line 288 of file opcua/server/server.py.

def opcua.server.server.Server.get_server_node ( self )

Get Server node of server. Returns a Node object.

Definition at line 300 of file opcua/server/server.py.

def opcua.server.server.Server.historize_node_data_change	(	self,
		node,
		period = `timedelta(days=7)`,
		count = `0`
	)

Start historizing supplied nodes; see history module
Args:
    node: node or list of nodes that can be historized (variables/properties)
    period: time delta to store the history; older data will be deleted from the storage
    count: number of changes to store in the history

Returns:

Definition at line 451 of file opcua/server/server.py.

def opcua.server.server.Server.historize_node_event	(	self,
		node,
		period = `timedelta(days=7)`,
		count = `0`
	)

Start historizing events from node (typically a UA object); see history module
Args:
    node: node or list of nodes that can be historized (UA objects)
    period: time delta to store the history; older data will be deleted from the storage
    count: number of events to store in the history

Returns:

Definition at line 477 of file opcua/server/server.py.

def opcua.server.server.Server.import_xml	(	self,
		path
	)

Import nodes defined in xml

Definition at line 417 of file opcua/server/server.py.

def opcua.server.server.Server.link_method	(	self,
		node,
		callback
	)

Link a python function to a UA method in the address space; required when a UA method has been imported
to the address space via XML; the python executable must be linked manually
Args:
    node: UA method node
    callback: python function that the UA method will call

Returns:

Definition at line 509 of file opcua/server/server.py.

def opcua.server.server.Server.load_certificate	(	self,
		path
	)

load server certificate from file, either pem or der

Definition at line 110 of file opcua/server/server.py.

def opcua.server.server.Server.load_private_key	(	self,
		path
	)

Definition at line 116 of file opcua/server/server.py.

def opcua.server.server.Server.register_namespace	(	self,
		uri
	)

Register a new namespace. Nodes should in custom namespace, not 0.

Definition at line 334 of file opcua/server/server.py.

def opcua.server.server.Server.register_to_discovery	(	self,
		url = `"opc.tcp://localhost:4840"`,
		period = `60`
	)

Register to an OPC-UA Discovery server. Registering must be renewed at
least every 10 minutes, so this method will use our asyncio thread to
re-register every period seconds
if period is 0 registration is not automatically renewed

Definition at line 147 of file opcua/server/server.py.

def opcua.server.server.Server.set_application_uri	(	self,
		uri
	)

Set application/server URI.
This uri is supposed to be unique. If you intent to register
your server to a discovery server, it really should be unique in
your system!
default is : "urn:freeopcua:python:server"

Definition at line 126 of file opcua/server/server.py.