PySide6.QtOpcUa.QOpcUa

class QOpcUa

The QOpcUa namespace contains miscellaneous identifiers used throughout the Qt OPC UA library. More…

Synopsis

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

class NodeClass

(inherits enum.Flag) This enum specifies the class a node belongs to. OPC UA specifies a fixed set of eight different classes.

Constant

Description

QOpcUa.NodeClass.Undefined

The node class is not known. This is the case before the NodeClass attribute has been read on the server.

QOpcUa.NodeClass.Object

An Object node.

QOpcUa.NodeClass.Variable

A Variable node.

QOpcUa.NodeClass.Method

A Method node.

QOpcUa.NodeClass.ObjectType

An ObjectType node.

QOpcUa.NodeClass.VariableType

A VariableType node.

QOpcUa.NodeClass.ReferenceType

A ReferenceType node.

QOpcUa.NodeClass.DataType

A DataType node.

QOpcUa.NodeClass.View

A View node.
class NodeAttribute

(inherits enum.Flag) This enum contains the 22 node attributes defined in OPC UA 1.05 part 3, 5.

Constant

Description

QOpcUa.NodeAttribute.None

No node attribute.

QOpcUa.NodeAttribute.NodeId

Mandatory for all nodes. Contains the node’s id in the OPC UA address space.

QOpcUa.NodeAttribute.NodeClass

Mandatory for all nodes. Contains the node id describing the node class of the node.

QOpcUa.NodeAttribute.BrowseName

Mandatory for all nodes. Contains a non-localized human readable name of the node.

QOpcUa.NodeAttribute.DisplayName

Mandatory for all nodes. Contains a localized human readable name for display purposes.

QOpcUa.NodeAttribute.Description

Contains a localized human readable description of the node.

QOpcUa.NodeAttribute.WriteMask

Contains a bit mask. Each bit corresponds to a writable attribute (OPC UA 1.05 part 3, 8.60).

QOpcUa.NodeAttribute.UserWriteMask

Same as WriteMask but for the current user.

QOpcUa.NodeAttribute.IsAbstract

True if the node is an abstract type which means that no nodes of this type shall exist.

QOpcUa.NodeAttribute.Symmetric

True if a reference’s meaning is the same seen from both ends.

QOpcUa.NodeAttribute.InverseName

The localized inverse name of a reference (for example “ HasSubtype “ has the InverseName “SubtypeOf”).

QOpcUa.NodeAttribute.ContainsNoLoops

True if there is no way to get back to a node following forward references in the current view.

QOpcUa.NodeAttribute.EventNotifier

Contains a bit mask used to indicate if subscribing to events and access to historic events is supported (OPC UA 1.05 part 3, 8.59).

QOpcUa.NodeAttribute.Value

The value of a Variable node.

QOpcUa.NodeAttribute.DataType

The NodeId of the Value attribute’s data type (for example “ns=0;i=13” for DateTime , see https://opcfoundation.org/UA/schemas/1.05/ NodeIds .csv).

QOpcUa.NodeAttribute.ValueRank

Contains information about the structure of the Value attribute (scalar/array) (OPC UA 1.05 part 3, 5.6.2).

QOpcUa.NodeAttribute.ArrayDimensions

An array containing the length for each dimension of a multi-dimensional array.

QOpcUa.NodeAttribute.AccessLevel

Contains a bit mask. Each bit corresponds to an access capability (OPC UA 1.05 part 3, 5.6.2).

QOpcUa.NodeAttribute.UserAccessLevel

Same as AccessLevel , but for the current user.

QOpcUa.NodeAttribute.MinimumSamplingInterval

Contains the shortest possible interval in which the server is able to sample the value.

QOpcUa.NodeAttribute.Historizing

True if historical data is collected.

QOpcUa.NodeAttribute.Executable

True if the node is currently executable. Only relevant for Method nodes.

QOpcUa.NodeAttribute.UserExecutable

Same as Executable, but for the current user.

QOpcUa.NodeAttribute.DataTypeDefinition

The data type definition attribute of a data type node.
class WriteMaskBit

(inherits enum.Flag) This enum contains all possible bits for the WriteMask and UserWriteMask node attributes defined in OPC UA 1.05 part 3, 8.60.

Constant

Description

QOpcUa.WriteMaskBit.None

No attribute is writable.

QOpcUa.WriteMaskBit.AccessLevel

The AccessLevel attribute is writable.

QOpcUa.WriteMaskBit.ArrayDimensions

The ArrayDimensions attribute is writable.

QOpcUa.WriteMaskBit.BrowseName

The BrowseName attribute is writable.

QOpcUa.WriteMaskBit.ContainsNoLoops

The ContainsNoLoops attribute is writable.

QOpcUa.WriteMaskBit.DataType

The DataType attribute is writable.

QOpcUa.WriteMaskBit.Description

The Description attribute is writable.

QOpcUa.WriteMaskBit.DisplayName

The DisplayName attribute is writable.

QOpcUa.WriteMaskBit.EventNotifier

The EventNotifier attribute is writable.

QOpcUa.WriteMaskBit.Executable

The Executable attribute is writable.

QOpcUa.WriteMaskBit.Historizing

The Historizing attribute is writable.

QOpcUa.WriteMaskBit.InverseName

The InverseName attribute is writable.

QOpcUa.WriteMaskBit.IsAbstract

The IsAbstract attribute is writable.

QOpcUa.WriteMaskBit.MinimumSamplingInterval

The MinimumSamplingInterval attribute is writable.

QOpcUa.WriteMaskBit.NodeClass

The NodeClass attribute is writable.

QOpcUa.WriteMaskBit.NodeId

The NodeId attribute is writable.

QOpcUa.WriteMaskBit.Symmetric

The Symmetric attribute is writable.

QOpcUa.WriteMaskBit.UserAccessLevel

The UserAccessLevel attribute is writable.

QOpcUa.WriteMaskBit.UserExecutable

The UserExecutable attribute is writable.

QOpcUa.WriteMaskBit.UserWriteMask

The UserWriteMask attribute is writable.

QOpcUa.WriteMaskBit.ValueRank

The ValueRank attribute is writable.

QOpcUa.WriteMaskBit.WriteMask

The WriteMask attribute is writable.

QOpcUa.WriteMaskBit.ValueForVariableType

The Value attribute of a variable type is writable.
class AccessLevelBit

(inherits enum.Flag) This enum contains all possible bits for the AccessLevel and UserAccessLevel node attributes defined in OPC UA 1.05 part 3, 8.60.

Constant

Description

QOpcUa.AccessLevelBit.None

No read access to the Value attribute is permitted.

QOpcUa.AccessLevelBit.CurrentRead

The current value can be read.

QOpcUa.AccessLevelBit.CurrentWrite

The current value can be written.

QOpcUa.AccessLevelBit.HistoryRead

The history of the value is readable.

QOpcUa.AccessLevelBit.HistoryWrite

The history of the value is writable.

QOpcUa.AccessLevelBit.SemanticChange

The property variable generates SemanticChangeEvents.

QOpcUa.AccessLevelBit.StatusWrite

The status code of the value is writable.

QOpcUa.AccessLevelBit.TimestampWrite

The SourceTimestamp is writable.
class EventNotifierBit

(inherits enum.Flag) This enum contains all possible bits for the EventNotifier node attribute defined in OPC UA 1.05 part 3, 8.59.

Constant

Description

QOpcUa.EventNotifierBit.None

The node can’t be used to interact with events.

QOpcUa.EventNotifierBit.SubscribeToEvents

A client can subscribe to events.

QOpcUa.EventNotifierBit.HistoryRead

A client can read the event history.

QOpcUa.EventNotifierBit.HistoryWrite

A client can write the event history.
class TimestampsToReturn

This enum contains the options for timestamps to return for service calls. It is specified in OPC UA 1.05, Part 4, 7.40.

Constant

Description

QOpcUa.TimestampsToReturn.Source

Return the source timestamp

QOpcUa.TimestampsToReturn.Server

Return the server timestamp

QOpcUa.TimestampsToReturn.Both

Return the source and the server timestamp

QOpcUa.TimestampsToReturn.Neither

Return no timestamps

QOpcUa.TimestampsToReturn.Invalid

The invalid value specified by OPC UA

Added in version 6.7.

class ReferenceTypeId

This enum contains the reference types specified in OPC UA 1.05 part 3, 7. They are used to filter for a certain reference type in browseChildren and for the reference type information in QOpcUaReferenceDescription .

Constant

Description

QOpcUa.ReferenceTypeId.Unspecified

Not a valid reference type.

QOpcUa.ReferenceTypeId.References

The abstract base type for all references.

QOpcUa.ReferenceTypeId.NonHierarchicalReferences

The abstract base type for all non-hierarchical references.

QOpcUa.ReferenceTypeId.HierarchicalReferences

The abstract base type for all hierarchical references.

QOpcUa.ReferenceTypeId.HasChild

The abstract base type for all non-looping hierarchical references.

QOpcUa.ReferenceTypeId.Organizes

The type for hierarchical references that are used to organize nodes.

QOpcUa.ReferenceTypeId.HasEventSource

The type for non-looping hierarchical references that are used to organize event sources.

QOpcUa.ReferenceTypeId.HasModellingRule

The type for references from instance declarations to modelling rule nodes.

QOpcUa.ReferenceTypeId.HasEncoding

The type for references from data type nodes to to data type encoding nodes.

QOpcUa.ReferenceTypeId.HasDescription

The type for references from data type encoding nodes to data type description nodes.

QOpcUa.ReferenceTypeId.HasTypeDefinition

The type for references from a instance node to its type definition node.

QOpcUa.ReferenceTypeId.GeneratesEvent

The type for references from a node to an event type that is raised by node.

QOpcUa.ReferenceTypeId.Aggregates

The type for non-looping hierarchical references that are used to aggregate nodes into complex types.

QOpcUa.ReferenceTypeId.HasSubtype

The type for non-looping hierarchical references that are used to define sub types.

QOpcUa.ReferenceTypeId.HasProperty

The type for non-looping hierarchical reference from a node to its property.

QOpcUa.ReferenceTypeId.HasComponent

The type for non-looping hierarchical reference from a node to its component.

QOpcUa.ReferenceTypeId.HasNotifier

The type for non-looping hierarchical references that are used to indicate how events propagate from node to node.

QOpcUa.ReferenceTypeId.HasOrderedComponent

The type for non-looping hierarchical reference from a node to its component when the order of references matters.

QOpcUa.ReferenceTypeId.FromState

The type for a reference to the state before a transition.

QOpcUa.ReferenceTypeId.ToState

The type for a reference to the state after a transition.

QOpcUa.ReferenceTypeId.HasCause

The type for a reference to a method that can cause a transition to occur.

QOpcUa.ReferenceTypeId.HasEffect

The type for a reference to an event that may be raised when a transition occurs.

QOpcUa.ReferenceTypeId.HasHistoricalConfiguration

The type for a reference to the historical configuration for a data variable.

QOpcUa.ReferenceTypeId.HasSubStateMachine

The type for a reference to a substate for a state.

QOpcUa.ReferenceTypeId.HasArgumentDescription

The type for a reference to an argument description

QOpcUa.ReferenceTypeId.HasOptionalInputArgumentDescription

The type for a reference to an optional input argument description

QOpcUa.ReferenceTypeId.AlwaysGeneratesEvent

The type for references from a node to an event type that is always raised by node.

QOpcUa.ReferenceTypeId.HasTrueSubState

The type for references from a TRUE super state node to a subordinate state node.

QOpcUa.ReferenceTypeId.HasFalseSubState

The type for references from a FALSE super state node to a subordinate state node.

QOpcUa.ReferenceTypeId.HasCondition

The type for references from a ConditionSource node to a Condition.

QOpcUa.ReferenceTypeId.HasPubSubConnection

The type for a reference to a PubSub connection

QOpcUa.ReferenceTypeId.DataSetToWriter

The type for a reference to a data set writer

QOpcUa.ReferenceTypeId.HasGuard

The type for a reference to a guard

QOpcUa.ReferenceTypeId.HasDataSetWriter

The type for a reference to a data set writer

QOpcUa.ReferenceTypeId.HasDataSetReader

The type for a reference to data set reader

QOpcUa.ReferenceTypeId.HasAlarmSuppressionGroup

The type for a reference to an alarm suppression group

QOpcUa.ReferenceTypeId.AlarmGroupMember

The type for a reference to an alarm group member

QOpcUa.ReferenceTypeId.HasEffectDisable

The type for a reference to an alarm which is disabled by a transition

QOpcUa.ReferenceTypeId.HasDictionaryEntry

The type for a reference to a dictionary entry

QOpcUa.ReferenceTypeId.HasInterface

The type for a reference to an interface

QOpcUa.ReferenceTypeId.HasAddIn

The type for a reference to an addin

QOpcUa.ReferenceTypeId.HasEffectEnable

The type for a reference to an alarm which is enabled by a transition

QOpcUa.ReferenceTypeId.HasEffectSuppressed

The type for a reference to an alarm which is suppressed by a transition

QOpcUa.ReferenceTypeId.HasEffectUnsuppressed

The type for a reference to an alarm which is unsuppressed by a transition

QOpcUa.ReferenceTypeId.HasWriterGroup

The type for a reference to a writer group

QOpcUa.ReferenceTypeId.HasReaderGroup

The type for a reference to a reader group

QOpcUa.ReferenceTypeId.AliasFor

The type for a reference to the node represented by an alias

QOpcUa.ReferenceTypeId.IsDeprecated

The type for a reference to the information model where the starting node was first deprecated

QOpcUa.ReferenceTypeId.HasStructuredComponent

Indicate that a VariableType or Variable also exposes its Structure fields as Variables in the information model

QOpcUa.ReferenceTypeId.AssociatedWith

The type for a reference to indicate an association between two nodes

QOpcUa.ReferenceTypeId.UsesPriorityMappingTable

The type for a reference to indicate usage of a priority mapping table

QOpcUa.ReferenceTypeId.HasLowerLayerInterface

Virtual interfaces shall reference their physical interfaces with this reference type

QOpcUa.ReferenceTypeId.IsExecutableOn

The type for a reference to relate a software component to its execution environment

QOpcUa.ReferenceTypeId.Controls

Relates a controlling component to the components controlled by the controlling component

QOpcUa.ReferenceTypeId.Utilizes

Relates a component to other components that are needed by the component in order to work

QOpcUa.ReferenceTypeId.Requires

Relates a component to other components it requires in order to work

QOpcUa.ReferenceTypeId.IsPhysicallyConnectedTo

Connects two components that are physically connected, without one being a subcomponent of the other

QOpcUa.ReferenceTypeId.RepresentsSameEntityAs

The type for a reference to indicate that two nodes represent the same entity

QOpcUa.ReferenceTypeId.RepresentsSameHardwareAs

The type for a reference to indicate that two nodes represent the same hardware

QOpcUa.ReferenceTypeId.RepresentsSameFunctionalityAs

The type for a reference to indicate that two nodes represent the same functionality

QOpcUa.ReferenceTypeId.IsHostedBy

Relates functionality represented by an OPC UA Node to the hardware and software needed to provide the functionality

QOpcUa.ReferenceTypeId.HasPhysicalComponent

Relates a hardware component to its subcomponent, which is also a hardware component

QOpcUa.ReferenceTypeId.HasContainedComponent

Relates a hardware component to its subcomponent that is inside the component.

QOpcUa.ReferenceTypeId.HasAttachedComponent

Indicates that the subcomponent is attached to the component

QOpcUa.ReferenceTypeId.IsExecutingOn

The type for a reference to relate a software component to its current execution environment

QOpcUa.ReferenceTypeId.HasPushedSecurityGroup

The type for a reference to a pushed security group
class Types

Enumerates the types supported by Qt OPC UA.

Constant

Description

QOpcUa.Boolean

QOpcUa.Int32

QOpcUa.UInt32

QOpcUa.Double

QOpcUa.Float

QOpcUa.String

QOpcUa.LocalizedText

QOpcUa.DateTime

QOpcUa.UInt16

QOpcUa.Int16

QOpcUa.UInt64

QOpcUa.Int64

QOpcUa.Byte

QOpcUa.SByte

QOpcUa.ByteString

QOpcUa.XmlElement

QOpcUa.NodeId

QOpcUa.Guid

QOpcUa.QualifiedName

A name qualified by an OPC UA namespace index.

QOpcUa.StatusCode

QOpcUa.ExtensionObject

A data structure which contains a serialized object.

QOpcUa.Range

A range composed from the two double values low and high.

QOpcUa.EUInformation

The unit of measurement for an analog value.

QOpcUa.ComplexNumber

The OPC UA ComplexNumber type.

QOpcUa.DoubleComplexNumber

The OPC UA DoubleComplexNumber type.

QOpcUa.AxisInformation

Information about an axis.

QOpcUa.XV

A float value with a double precision position on an axis.

QOpcUa.ExpandedNodeId

A node id with additional namespace URI and server index.

QOpcUa.Argument

The OPC UA Argument type.

QOpcUa.StructureDefinition

The OPC UA StructureDefinition type

QOpcUa.StructureField

The OPC UA StructureField type

QOpcUa.EnumDefinition

The OPC UA EnumDefinition type

QOpcUa.EnumField

The OPC UA EnumField type

QOpcUa.DiagnosticInfo

The OPC UA DiagnosticInfo type

QOpcUa.SimpleAttributeOperand

The OPC UA SimpleAttributeOperand type.

QOpcUa.AttributeOperand

The OPC UA AttributeOperand type.

QOpcUa.LiteralOperand

The OPC UA LiteralOperand type.

QOpcUa.ElementOperand

The OPC UA ElementOperand type.

QOpcUa.RelativePathElement

The OPC UA RelativePathElement type.

QOpcUa.ContentFilterElement

The OPC UA ContentFilterElement type.

QOpcUa.EventFilter

The OPC UA EventFilter type.

QOpcUa.Undefined
class UaStatusCode

Enumerates all status codes from https://opcfoundation.org/UA/schemas/1.05/Opc.Ua.StatusCodes.csv

Constant

Description

QOpcUa.Good

The operation succeeded.

QOpcUa.Uncertain

The operation was uncertain.

QOpcUa.Bad

The operation failed.

QOpcUa.BadUnexpectedError

An unexpected error occurred.

QOpcUa.BadInternalError

An internal error occurred as a result of a programming or configuration error.

QOpcUa.BadOutOfMemory

Not enough memory to complete the operation.

QOpcUa.BadResourceUnavailable

An operating system resource is not available.

QOpcUa.BadCommunicationError

A low level communication error occurred.

QOpcUa.BadEncodingError

Encoding halted because of invalid data in the objects being serialized.

QOpcUa.BadDecodingError

Decoding halted because of invalid data in the stream.

QOpcUa.BadEncodingLimitsExceeded

The message encoding/decoding limits imposed by the stack have been exceeded.

QOpcUa.BadRequestTooLarge

The request message size exceeds limits set by the server.

QOpcUa.BadResponseTooLarge

The response message size exceeds limits set by the client.

QOpcUa.BadUnknownResponse

An unrecognized response was received from the server.

QOpcUa.BadTimeout

The operation timed out.

QOpcUa.BadServiceUnsupported

The server does not support the requested service.

QOpcUa.BadShutdown

The operation was cancelled because the application is shutting down.

QOpcUa.BadServerNotConnected

The operation could not complete because the client is not connected to the server.

QOpcUa.BadServerHalted

The server has stopped and cannot process any requests.

QOpcUa.BadNothingToDo

No processing could be done because there was nothing to do.

QOpcUa.BadTooManyOperations

The request could not be processed because it specified too many operations.

QOpcUa.BadTooManyMonitoredItems

The request could not be processed because there are too many monitored items in the subscription.

QOpcUa.BadDataTypeIdUnknown

The extension object cannot be (de)serialized because the data type id is not recognized.

QOpcUa.BadCertificateInvalid

The certificate provided as a parameter is not valid.

QOpcUa.BadSecurityChecksFailed

An error occurred verifying security.

QOpcUa.BadCertificatePolicyCheckFailed

The certificate does not meet the requirements of the security policy.

QOpcUa.BadCertificateTimeInvalid

The certificate has expired or is not yet valid.

QOpcUa.BadCertificateIssuerTimeInvalid

An issuer certificate has expired or is not yet valid.

QOpcUa.BadCertificateHostNameInvalid

The HostName used to connect to a server does not match a HostName in the certificate.

QOpcUa.BadCertificateUriInvalid

The URI specified in the ApplicationDescription does not match the URI in the certificate.

QOpcUa.BadCertificateUseNotAllowed

The certificate may not be used for the requested operation.

QOpcUa.BadCertificateIssuerUseNotAllowed

The issuer certificate may not be used for the requested operation.

QOpcUa.BadCertificateUntrusted

The certificate is not trusted.

QOpcUa.BadCertificateRevocationUnknown

It was not possible to determine if the certificate has been revoked.

QOpcUa.BadCertificateIssuerRevocationUnknown

It was not possible to determine if the issuer certificate has been revoked.

QOpcUa.BadCertificateRevoked

The certificate has been revoked.

QOpcUa.BadCertificateIssuerRevoked

The issuer certificate has been revoked.

QOpcUa.BadCertificateChainIncomplete

The certificate chain is incomplete.

QOpcUa.BadUserAccessDenied

User does not have permission to perform the requested operation.

QOpcUa.BadIdentityTokenInvalid

The user identity token is not valid.

QOpcUa.BadIdentityTokenRejected

The user identity token is valid but the server has rejected it.

QOpcUa.BadSecureChannelIdInvalid

The specified secure channel is no longer valid.

QOpcUa.BadInvalidTimestamp

The timestamp is outside the range allowed by the server.

QOpcUa.BadNonceInvalid

The nonce does appear to be not a random value or it is not the correct length.

QOpcUa.BadSessionIdInvalid

The session id is not valid.

QOpcUa.BadSessionClosed

The session was closed by the client.

QOpcUa.BadSessionNotActivated

The session cannot be used because ActivateSession has not been called.

QOpcUa.BadSubscriptionIdInvalid

The subscription id is not valid.

QOpcUa.BadRequestHeaderInvalid

The header for the request is missing or invalid.

QOpcUa.BadTimestampsToReturnInvalid

The timestamps to return parameter is invalid.

QOpcUa.BadRequestCancelledByClient

The request was cancelled by the client.

QOpcUa.BadTooManyArguments

Too many arguments were provided.

QOpcUa.BadLicenseExpired

The server requires a license to operate in general or to perform a service or operation, but existing license is expired.

QOpcUa.BadLicenseLimitsExceeded

The server has limits on number of allowed operations / objects, based on installed licenses, and these limits where exceeded.

QOpcUa.BadLicenseNotAvailable

The server does not have a license which is required to operate in general or to perform a service or operation.

QOpcUa.GoodSubscriptionTransferred

The subscription was transferred to another session.

QOpcUa.GoodCompletesAsynchronously

The processing will complete asynchronously.

QOpcUa.GoodOverload

Sampling has slowed down due to resource limitations.

QOpcUa.GoodClamped

The value written was accepted but was clamped.

QOpcUa.BadNoCommunication

Communication with the data source is defined, but not established, and there is no last known value available.

QOpcUa.BadWaitingForInitialData

Waiting for the server to obtain values from the underlying data source.

QOpcUa.BadNodeIdInvalid

The syntax of the node id is not valid.

QOpcUa.BadNodeIdUnknown

The node id refers to a node that does not exist in the server address space.

QOpcUa.BadAttributeIdInvalid

The attribute is not supported for the specified Node.

QOpcUa.BadIndexRangeInvalid

The syntax of the index range parameter is invalid.

QOpcUa.BadIndexRangeNoData

No data exists within the range of indexes specified.

QOpcUa.BadDataEncodingInvalid

The data encoding is invalid.

QOpcUa.BadDataEncodingUnsupported

The server does not support the requested data encoding for the node.

QOpcUa.BadNotReadable

The access level does not allow reading or subscribing to the Node.

QOpcUa.BadNotWritable

The access level does not allow writing to the Node.

QOpcUa.BadOutOfRange

The value was out of range.

QOpcUa.BadNotSupported

The requested operation is not supported.

QOpcUa.BadNotFound

A requested item was not found or a search operation ended without success.

QOpcUa.BadObjectDeleted

The object cannot be used because it has been deleted.

QOpcUa.BadNotImplemented

Requested operation is not implemented.

QOpcUa.BadMonitoringModeInvalid

The monitoring mode is invalid.

QOpcUa.BadMonitoredItemIdInvalid

The monitoring item id does not refer to a valid monitored item.

QOpcUa.BadMonitoredItemFilterInvalid

The monitored item filter parameter is not valid.

QOpcUa.BadMonitoredItemFilterUnsupported

The server does not support the requested monitored item filter.

QOpcUa.BadFilterNotAllowed

A monitoring filter cannot be used in combination with the attribute specified.

QOpcUa.BadStructureMissing

A mandatory structured parameter was missing or null.

QOpcUa.BadEventFilterInvalid

The event filter is not valid.

QOpcUa.BadContentFilterInvalid

The content filter is not valid.

QOpcUa.BadFilterOperatorInvalid

An unrecognized operator was provided in a filter.

QOpcUa.BadFilterOperatorUnsupported

A valid operator was provided, but the server does not provide support for this filter operator.

QOpcUa.BadFilterOperandCountMismatch

The number of operands provided for the filter operator was less then expected for the operand provided.

QOpcUa.BadFilterOperandInvalid

The operand used in a content filter is not valid.

QOpcUa.BadFilterElementInvalid

The referenced element is not a valid element in the content filter.

QOpcUa.BadFilterLiteralInvalid

The referenced literal is not a valid value.

QOpcUa.BadContinuationPointInvalid

The continuation point provide is longer valid.

QOpcUa.BadNoContinuationPoints

The operation could not be processed because all continuation points have been allocated.

QOpcUa.BadReferenceTypeIdInvalid

The reference type id does not refer to a valid reference type node.

QOpcUa.BadBrowseDirectionInvalid

The browse direction is not valid.

QOpcUa.BadNodeNotInView

The node is not part of the view.

QOpcUa.BadNumericOverflow

The number was not accepted because of a numeric overflow.

QOpcUa.BadServerUriInvalid

The ServerUri is not a valid URI.

QOpcUa.BadServerNameMissing

No ServerName was specified.

QOpcUa.BadDiscoveryUrlMissing

No DiscoveryUrl was specified.

QOpcUa.BadSempahoreFileMissing

The semaphore file specified by the client is not valid.

QOpcUa.BadRequestTypeInvalid

The security token request type is not valid.

QOpcUa.BadSecurityModeRejected

The security mode does not meet the requirements set by the server.

QOpcUa.BadSecurityPolicyRejected

The security policy does not meet the requirements set by the server.

QOpcUa.BadTooManySessions

The server has reached its maximum number of sessions.

QOpcUa.BadUserSignatureInvalid

The user token signature is missing or invalid.

QOpcUa.BadApplicationSignatureInvalid

The signature generated with the client certificate is missing or invalid.

QOpcUa.BadNoValidCertificates

The client did not provide at least one software certificate that is valid and meets the profile requirements for the server.

QOpcUa.BadIdentityChangeNotSupported

The server does not support changing the user identity assigned to the session.

QOpcUa.BadRequestCancelledByRequest

The request was cancelled by the client with the Cancel service.

QOpcUa.BadParentNodeIdInvalid

The parent node id does not to refer to a valid node.

QOpcUa.BadReferenceNotAllowed

The reference could not be created because it violates constraints imposed by the data model.

QOpcUa.BadNodeIdRejected

The requested node id was reject because it was either invalid or server does not allow node ids to be specified by the client.

QOpcUa.BadNodeIdExists

The requested node id is already used by another node.

QOpcUa.BadNodeClassInvalid

The node class is not valid.

QOpcUa.BadBrowseNameInvalid

The browse name is invalid.

QOpcUa.BadBrowseNameDuplicated

The browse name is not unique among nodes that share the same relationship with the parent.

QOpcUa.BadNodeAttributesInvalid

The node attributes are not valid for the node class.

QOpcUa.BadTypeDefinitionInvalid

The type definition node id does not reference an appropriate type node.

QOpcUa.BadSourceNodeIdInvalid

The source node id does not reference a valid node.

QOpcUa.BadTargetNodeIdInvalid

The target node id does not reference a valid node.

QOpcUa.BadDuplicateReferenceNotAllowed

The reference type between the nodes is already defined.

QOpcUa.BadInvalidSelfReference

The server does not allow this type of self reference on this node.

QOpcUa.BadReferenceLocalOnly

The reference type is not valid for a reference to a remote server.

QOpcUa.BadNoDeleteRights

The server will not allow the node to be deleted.

QOpcUa.UncertainReferenceNotDeleted

The server was not able to delete all target references.

QOpcUa.BadServerIndexInvalid

The server index is not valid.

QOpcUa.BadViewIdUnknown

The view id does not refer to a valid view node.

QOpcUa.BadViewTimestampInvalid

The view timestamp is not available or not supported.

QOpcUa.BadViewParameterMismatch

The view parameters are not consistent with each other.

QOpcUa.BadViewVersionInvalid

The view version is not available or not supported.

QOpcUa.UncertainNotAllNodesAvailable

The list of references may not be complete because the underlying system is not available.

QOpcUa.GoodResultsMayBeIncomplete

The server should have followed a reference to a node in a remote server but did not. The result set may be incomplete.

QOpcUa.BadNotTypeDefinition

The provided Nodeid was not a type definition nodeid.

QOpcUa.UncertainReferenceOutOfServer

One of the references to follow in the relative path references to a node in the address space in another server.

QOpcUa.BadTooManyMatches

The requested operation has too many matches to return.

QOpcUa.BadQueryTooComplex

The requested operation requires too many resources in the server.

QOpcUa.BadNoMatch

The requested operation has no match to return.

QOpcUa.BadMaxAgeInvalid

The max age parameter is invalid.

QOpcUa.BadSecurityModeInsufficient

The operation is not permitted over the current secure channel.

QOpcUa.BadHistoryOperationInvalid

The history details parameter is not valid.

QOpcUa.BadHistoryOperationUnsupported

The server does not support the requested operation.

QOpcUa.BadInvalidTimestampArgument

The defined timestamp to return was invalid.

QOpcUa.BadWriteNotSupported

The server does not support writing the combination of value, status and timestamps provided.

QOpcUa.BadTypeMismatch

The value supplied for the attribute is not of the same type as the attribute’s value.

QOpcUa.BadMethodInvalid

The method id does not refer to a method for the specified object.

QOpcUa.BadArgumentsMissing

The client did not specify all of the input arguments for the method.

QOpcUa.BadNotExecutable

The executable attribute does not allow the execution of the method.

QOpcUa.BadTooManySubscriptions

The server has reached its maximum number of subscriptions.

QOpcUa.BadTooManyPublishRequests

The server has reached the maximum number of queued publish requests.

QOpcUa.BadNoSubscription

There is no subscription available for this session.

QOpcUa.BadSequenceNumberUnknown

The sequence number is unknown to the server.

QOpcUa.GoodRetransmissionQueueNotSupported

The Server does not support retransmission queue and acknowledgement of sequence numbers is not available.

QOpcUa.BadMessageNotAvailable

The requested notification message is no longer available.

QOpcUa.BadInsufficientClientProfile

The client of the current session does not support one or more Profiles that are necessary for the subscription.

QOpcUa.BadStateNotActive

The sub-state machine is not currently active.

QOpcUa.BadAlreadyExists

An equivalent rule already exists.

QOpcUa.BadTcpServerTooBusy

The server cannot process the request because it is too busy.

QOpcUa.BadTcpMessageTypeInvalid

The type of the message specified in the header invalid.

QOpcUa.BadTcpSecureChannelUnknown

The SecureChannelId and/or TokenId are not currently in use.

QOpcUa.BadTcpMessageTooLarge

The size of the message chunk specified in the header is too large.

QOpcUa.BadTcpNotEnoughResources

There are not enough resources to process the request.

QOpcUa.BadTcpInternalError

An internal error occurred.

QOpcUa.BadTcpEndpointUrlInvalid

The server does not recognize the QueryString specified.

QOpcUa.BadRequestInterrupted

The request could not be sent because of a network interruption.

QOpcUa.BadRequestTimeout

Timeout occurred while processing the request.

QOpcUa.BadSecureChannelClosed

The secure channel has been closed.

QOpcUa.BadSecureChannelTokenUnknown

The token has expired or is not recognized.

QOpcUa.BadSequenceNumberInvalid

The sequence number is not valid.

QOpcUa.BadProtocolVersionUnsupported

The applications do not have compatible protocol versions.

QOpcUa.BadConfigurationError

There is a problem with the configuration that affects the usefulness of the value.

QOpcUa.BadNotConnected

The variable should receive its value from another variable, but has never been configured to do so.

QOpcUa.BadDeviceFailure

There has been a failure in the device/data source that generates the value that has affected the value.

QOpcUa.BadSensorFailure

There has been a failure in the sensor from which the value is derived by the device/data source.

QOpcUa.BadOutOfService

The source of the data is not operational.

QOpcUa.BadDeadbandFilterInvalid

The deadband filter is not valid.

QOpcUa.UncertainNoCommunicationLastUsableValue

Communication to the data source has failed. The variable value is the last value that had a good quality.

QOpcUa.UncertainLastUsableValue

Whatever was updating this value has stopped doing so.

QOpcUa.UncertainSubstituteValue

The value is an operational value that was manually overwritten.

QOpcUa.UncertainInitialValue

The value is an initial value for a variable that normally receives its value from another variable.

QOpcUa.UncertainSensorNotAccurate

The value is at one of the sensor limits.

QOpcUa.UncertainEngineeringUnitsExceeded

The value is outside of the range of values defined for this parameter.

QOpcUa.UncertainSubNormal

The value is derived from multiple sources and has less than the required number of Good sources.

QOpcUa.GoodLocalOverride

The value has been overridden.

QOpcUa.BadRefreshInProgress

This Condition refresh failed, a Condition refresh operation is already in progress.

QOpcUa.BadConditionAlreadyDisabled

This condition has already been disabled.

QOpcUa.BadConditionAlreadyEnabled

This condition has already been enabled.

QOpcUa.BadConditionDisabled

Property not available, this condition is disabled.

QOpcUa.BadEventIdUnknown

The specified event id is not recognized.

QOpcUa.BadEventNotAcknowledgeable

The event cannot be acknowledged.

QOpcUa.BadDialogNotActive

The dialog condition is not active.

QOpcUa.BadDialogResponseInvalid

The response is not valid for the dialog.

QOpcUa.BadConditionBranchAlreadyAcked

The condition branch has already been acknowledged.

QOpcUa.BadConditionBranchAlreadyConfirmed

The condition branch has already been confirmed.

QOpcUa.BadConditionAlreadyShelved

The condition has already been shelved.

QOpcUa.BadConditionNotShelved

The condition is not currently shelved.

QOpcUa.BadShelvingTimeOutOfRange

The shelving time not within an acceptable range.

QOpcUa.BadNoData

No data exists for the requested time range or event filter.

QOpcUa.BadBoundNotFound

No data found to provide upper or lower bound value.

QOpcUa.BadBoundNotSupported

The server cannot retrieve a bound for the variable.

QOpcUa.BadDataLost

Data is missing due to collection started/stopped/lost.

QOpcUa.BadDataUnavailable

Expected data is unavailable for the requested time range due to an un-mounted volume, an off-line archive or tape, or similar reason for temporary unavailability.

QOpcUa.BadEntryExists

The data or event was not successfully inserted because a matching entry exists.

QOpcUa.BadNoEntryExists

The data or event was not successfully updated because no matching entry exists.

QOpcUa.BadTimestampNotSupported

The client requested history using a timestamp format the server does not support (i.e requested ServerTimestamp when server only supports SourceTimestamp).

QOpcUa.GoodEntryInserted

The data or event was successfully inserted into the historical database.

QOpcUa.GoodEntryReplaced

The data or event field was successfully replaced in the historical database.

QOpcUa.UncertainDataSubNormal

The value is derived from multiple values and has less than the required number of Good values.

QOpcUa.GoodNoData

No data exists for the requested time range or event filter.

QOpcUa.GoodMoreData

The data or event field was successfully replaced in the historical database.

QOpcUa.BadAggregateListMismatch

The requested number of Aggregates does not match the requested number of NodeIds .

QOpcUa.BadAggregateNotSupported

The requested Aggregate is not support by the server.

QOpcUa.BadAggregateInvalidInputs

The aggregate value could not be derived due to invalid data inputs.

QOpcUa.BadAggregateConfigurationRejected

The aggregate configuration is not valid for specified node.

QOpcUa.GoodDataIgnored

The request specifies fields which are not valid for the EventType or cannot be saved by the historian.

QOpcUa.BadRequestNotAllowed

The request was rejected by the server because it did not meet the criteria set by the server.

QOpcUa.BadRequestNotComplete

The request has not been processed by the server yet.

QOpcUa.BadTicketRequired

The device identity needs a ticket before it can be accepted.

QOpcUa.BadTicketInvalid

The device identity needs a ticket before it can be accepted.

QOpcUa.GoodEdited

The value does not come from the real source and has been edited by the server.

QOpcUa.GoodPostActionFailed

There was an error in execution of these post-actions.

QOpcUa.UncertainDominantValueChanged

The related EngineeringUnit has been changed but the Variable Value is still provided based on the previous unit.

QOpcUa.GoodDependentValueChanged

A dependent value has been changed but the change has not been applied to the device.

QOpcUa.BadDominantValueChanged

The related EngineeringUnit has been changed but this change has not been applied to the device. The Variable Value is still dependent on the previous unit but its status is currently Bad.

QOpcUa.UncertainDependentValueChanged

A dependent value has been changed but the change has not been applied to the device. The quality of the dominant variable is uncertain.

QOpcUa.BadDependentValueChanged

A dependent value has been changed but the change has not been applied to the device. The quality of the dominant variable is Bad.

QOpcUa.GoodEdited_DependentValueChanged

It is delivered with a dominant Variable value when a dependent Variable has changed but the change has not been applied.

QOpcUa.GoodEdited_DominantValueChanged

It is delivered with a dependent Variable value when a dominant Variable has changed but the change has not been applied.

QOpcUa.GoodEdited_DominantValueChanged_DependentValueChanged

It is delivered with a dependent Variable value when a dominant or dependent Variable has changed but change has not been applied.

QOpcUa.BadEdited_OutOfRange

It is delivered with a Variable value when Variable has changed but the value is not legal.

QOpcUa.BadInitialValue_OutOfRange

It is delivered with a Variable value when a source Variable has changed but the value is not legal.

QOpcUa.BadOutOfRange_DominantValueChanged

It is delivered with a dependent Variable value when a dominant Variable has changed and the value is not legal.

QOpcUa.BadEdited_OutOfRange_DominantValueChanged

It is delivered with a dependent Variable value when a dominant Variable has changed, the value is not legal and the change has not been applied.

QOpcUa.BadOutOfRange_DominantValueChanged_DependentValueChanged

It is delivered with a dependent Variable value when a dominant or dependent Variable has changed and the value is not legal.

QOpcUa.BadEdited_OutOfRange_DominantValueChanged_DependentValueChanged

It is delivered with a dependent Variable value when a dominant or dependent Variable has changed, the value is not legal and the change has not been applied.

QOpcUa.GoodCommunicationEvent

The communication layer has raised an event.

QOpcUa.GoodShutdownEvent

The system is shutting down.

QOpcUa.GoodCallAgain

The operation is not finished and needs to be called again.

QOpcUa.GoodNonCriticalTimeout

A non-critical timeout occurred.

QOpcUa.BadInvalidArgument

One or more arguments are invalid.

QOpcUa.BadConnectionRejected

Could not establish a network connection to remote server.

QOpcUa.BadDisconnect

The server has disconnected from the client.

QOpcUa.BadConnectionClosed

The network connection has been closed.

QOpcUa.BadInvalidState

The operation cannot be completed because the object is closed, uninitialized or in some other invalid state.

QOpcUa.BadEndOfStream

Cannot move beyond end of the stream.

QOpcUa.BadNoDataAvailable

No data is currently available for reading from a non-blocking stream.

QOpcUa.BadWaitingForResponse

The asynchronous operation is waiting for a response.

QOpcUa.BadOperationAbandoned

The asynchronous operation was abandoned by the caller.

QOpcUa.BadExpectedStreamToBlock

The stream did not return all data requested (possibly because it is a non-blocking stream).

QOpcUa.BadWouldBlock

Non blocking behaviour is required and the operation would block.

QOpcUa.BadSyntaxError

A value had an invalid syntax.

QOpcUa.BadMaxConnectionsReached

The operation could not be finished because all available connections are in use.

QOpcUa.UncertainTransducerInManual

The value may not be accurate because the transducer is in manual mode.

QOpcUa.UncertainSimulatedValue

The value is simulated.

QOpcUa.UncertainSensorCalibration

The value may not be accurate due to a sensor calibration fault.

QOpcUa.UncertainConfigurationError

The value may not be accurate due to a configuration issue.

QOpcUa.GoodCascadeInitializationAcknowledged

The value source supports cascade handshaking and the value has been Initialized based on an initialization request from a cascade secondary.

QOpcUa.GoodCascadeInitializationRequest

The value source supports cascade handshaking and is requesting initialization of a cascade primary.

QOpcUa.GoodCascadeNotInvited

The value source supports cascade handshaking, however, the source’s current state does not allow for cascade.

QOpcUa.GoodCascadeNotSelected

The value source supports cascade handshaking, however, the source has not selected the corresponding cascade primary for use.

QOpcUa.GoodFaultStateActive

There is a fault state condition active in the value source.

QOpcUa.GoodInitiateFaultState

A fault state condition is being requested of the destination.

QOpcUa.GoodCascade

The value is accurate, and the signal source supports cascade handshaking.

QOpcUa.BadDataSetIdInvalid

The DataSet specified for the DataSetWriter creation is invalid.
class ErrorCategory

This enum contains simplified categories for OPC UA errors.

Constant

Description

QOpcUa.ErrorCategory.NoError

The operation has been successful.

QOpcUa.ErrorCategory.NodeError

There is a problem with the node, e. g. it does not exist.

QOpcUa.ErrorCategory.AttributeError

The attributes to operate on where invalid.

QOpcUa.ErrorCategory.PermissionError

The user did not have the permission to perform the operation.

QOpcUa.ErrorCategory.ArgumentError

The arguments supplied by the user were invalid or incomplete.

QOpcUa.ErrorCategory.TypeError

There has been a type mismatch for a write operation.

QOpcUa.ErrorCategory.ConnectionError

Communication with the server did not work as expected.

QOpcUa.ErrorCategory.UnspecifiedError

Any error that is not categorized. The detailed status code must be checked.
class AxisScale

The AxisScale enum as defined by OPC UA 1.05 part 8, 5.6.7.

Constant

Description

QOpcUa.AxisScale.Linear

QOpcUa.AxisScale.Log

QOpcUa.AxisScale.Ln
class IsAbstract

Added in version 6.7.

static errorCategory(statusCode)
Parameters:

statusCode – UaStatusCode

Return type:

ErrorCategory

Converts statusCode to an ErrorCategory . ErrorCategory can be used in cases where the exact error is not important.

For error handling dependent on status codes, the full status code must be used instead. The meaning of the status codes for the different services is documented in OPC UA part 4.

If statusCode has not been categorized, UnspecifiedError is returned. In this case, the user must check the full status code.

static isSecurePolicy(securityPolicy)
Parameters:

securityPolicy – str

Return type:

bool

Returns true if securityPolicy is a secure policy, false otherwise.

static isSuccessStatus(statusCode)
Parameters:

statusCode – UaStatusCode

Return type:

bool

This method can be used to check if a call has successfully finished.

Returns true if statusCode's severity field is Good.

static metaTypeToQOpcUaType(type)
Parameters:

type – Type

Return type:

Types

Returns the Qt OPC UA type from type. In case the type does not map, QOpcUa::Undefined is returned.

static namespace0Id(id)
Parameters:

id – Namespace0

Return type:

str

Returns a node id string for the namespace 0 identifier id.

static namespace0IdFromNodeId(nodeId)
Parameters:

nodeId – str

Return type:

Namespace0

Returns the enum value from Namespace0 for nodeId.

If the node id is not in namespace 0 or doesn’t have a numeric identifier which is part of the OPC Foundation’s NodeIds .csv file, Unknown is returned.

If Qt OPC UA has been configured with -no-feature-ns0idnames, the check if the numeric identifier is part of the NodeIds .csv file is omitted. If the node id is in namespace 0 and has a numeric identifier, the identifier is returned regardless if it is part of the Namespace0 enum.

static namespace0IdName(id)
Parameters:

id – Namespace0

Return type:

str

Returns the name of the namespace 0 node id id.

If id is unknown or Qt OPC UA has been configured with -no-feature-ns0idnames, an empty string is returned.

static nodeIdEquals(first, second)
Parameters:

  • first – str

  • second – str

Return type:

bool

Returns true if the two node ids first and second have the same namespace index and identifier. A node id string without a namespace index is assumed to be in namespace 0.

static nodeIdFromByteString(ns, identifier)
Parameters:
Return type:

str

Creates a node id string from the namespace index ns and the byte string identifier.

See also

QOpcUaNode

static nodeIdFromGuid(ns, identifier)
Parameters:

  • ns – int

  • identifier – QUuid

Return type:

str

Creates a node id string from the namespace index ns and the GUID identifier.

See also

QOpcUaNode

static nodeIdFromInteger(ns, identifier)
Parameters:

  • ns – int

  • identifier – int

Return type:

str

Creates a node id string from the namespace index ns and the integer identifier.

See also

QOpcUaNode

static nodeIdFromReferenceType(referenceType)
Parameters:

referenceType – ReferenceTypeId

Return type:

str

Creates a node id string for the reference type id referenceType.

static nodeIdFromString(ns, identifier)
Parameters:

  • ns – int

  • identifier – str

Return type:

str

Creates a node id string from the namespace index ns and the string identifier.

See also

QOpcUaNode

static opcUaDataTypeToQOpcUaType(type)
Parameters:

type – str

Return type:

Types

static qHash(attr)
Parameters:

attr – NodeAttribute

Return type:

int

Returns a QHash key for attr.

static statusToString(statusCode)
Parameters:

statusCode – UaStatusCode

Return type:

str

Returns a textual representation of statusCode.

Currently, this is the name of the enum value but may be a real message in future releases.