esppy.connectors.OPCUAPublisher

class esppy.connectors.OPCUAPublisher(opcuaendpoint=None, name=None, is_active=None, opcuanamespaceuri=None, opcuausername=None, opcuapassword=None, opcuanodeids=None, publishinterval=None, transactional=None, blocksize=None, configfilesection=None, publishwithupsert=None, maxevents=None)

Bases: esppy.connectors.base.Connector

Publish OPC-UA operations

Parameters
opcuaendpointstring, optional

Specifies the OPC-UA server endpoint (only the portion following opc.tcp://).

opcuanamespaceuristring, optional

Specifies the OPC-UA server namespace URI. The default is the namespace at index=0.

opcuausernamestring, optional

Specifies the OPC-UA user name. The default is none.

opcuapasswordstring, optional

Specifies the OPC-UA password. The default is none.

opcuanodeidsstring, optional

Specifies a comma-separated list of Node IDs to map to ESP window schema fields, in the form <identifier type>_<identifier>. The list size must be equal to the number of fields in the subscribed window schema. Window field names are in Node ID form by default.

publishintervalint, optional

Specifies an interval in seconds when current values of all nodes in the Source window schema are published. The default is to publish when one or more values changes.

transactionalstring, optional

Sets the event block type to transactional. The default value is normal.

blocksizeint, optional

Specifies the number of events to include in a published event block. The default value is 1.

configfilesectionstring, optional

Specifies the name of the section in the connector config file to parse for configuration parameters. Specify the value as [configfilesection].

publishwithupsertboolean, optional

Builds events with opcode=Upsert instead of Insert.

maxeventsint, optional

Specifies the maximum number of events to publish.

Returns
OPCUAPublisher
__init__(self, opcuaendpoint=None, name=None, is_active=None, opcuanamespaceuri=None, opcuausername=None, opcuapassword=None, opcuanodeids=None, publishinterval=None, transactional=None, blocksize=None, configfilesection=None, publishwithupsert=None, maxevents=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self[, opcuaendpoint, name, …])

Initialize self.

clear(self)

copy(self[, deep])

Return a copy of the object

from_element(data[, session])

Construct connector from XML definition

from_parameters(conncls[, type, name, …])

from_xml(data[, session])

Construct connector from XML definition

get(self, key[, default])

items(self)

keys(self)

pop(self, key[, default])

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem(self)

as a 2-tuple; but raise KeyError if D is empty.

set_properties(self, \*\*kwargs)

Set connector properties

setdefault(self, key[, default])

to_element(self)

Export connector definition to ElementTree.Element

to_xml(self[, pretty])

Export connector definition to XML

update(\*args, \*\*kwds)

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values(self)

Attributes

connector_key

property_defs