7 OPC UA EventTypes

7.1 General

The following Figure 12 provides an overview of the different AutoID reader Scan Event types.

Figure 12 – AutoIdScanEventType overview

The following Figure 13 provides an overview of the different AutoID reader Diagnostic Event types.

Figure 13 – AutoIdDiagnosticEventType overview

The Events created by AutoID devices can be received by all OPC UA clients that subscribe for the Events from a device.

7.2 AutoIdScanEventType

The AutoIdScanEventType is formally defined in Table 17.

Table 17 – AutoIdScanEventType Definition
Attribute Value
BrowseNameAutoIdScanEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of BaseEventType defined in OPC 10000-5.
HasPropertyVariableScanResultScanResult []PropertyTypeMandatory
HasPropertyVariableDeviceNameStringPropertyTypeMandatory

This event is the abstract definition of an AutoID scan event. It will be fired by the AutoID Device after execution of the ScanStart Method or after a scan triggered by the reader device.

The ScanResult contains the results of the scan execution. The ScanResult DataType is defined in 9.3.8.

The DeviceName contains the name of the AutoID Device that executed the scan.

7.3 OcrScanEventType

The OcrScanEventType is formally defined in Table 18.

Table 18 – OcrScanEventType Definition
Attribute Value
BrowseNameOcrScanEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdScanEventType defined in 7.2.
HasPropertyVariableScanResultOcrScanResult []PropertyTypeMandatory

This event is the definition of a scan event for OCR reader devices. It will be fired by the AutoID Device after execution of the ScanStart Method or after a scan triggered by the reader device.

The ScanResult contains the results of the scan execution. The OcrScanResult DataType is defined in 9.3.9.

7.4 OpticalScanEventType

The OpticalScanEventType is formally defined in Table 19.

Table 19 – OpticalScanEventType Definition
Attribute Value
BrowseNameOpticalScanEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdScanEventType defined in 7.2.
HasPropertyVariableScanResultOpticalScanResult []PropertyTypeMandatory

This event is the definition of a scan event for optical code readers. It will be fired by the AutoID Device after execution of the ScanStart Method or after a scan triggered by the reader device.

The ScanResult contains the results of the scan execution. The OpticalScanResult DataType is defined in 9.3.10.

7.5 OpticalVerifierScanEventType

The OpticalVerifierScanEventType is formally defined in Table 20.

Table 20 – OpticalVerifierScanEventType Definition
Attribute Value
BrowseNameOpticalVerifierScanEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of OpticalScanEventType defined in 7.4.
HasPropertyVariableScanResultOpticalVerifierScanResult []PropertyTypeMandatory

This event is the definition of a scan event for optical code verifiers. It will be fired by the AutoID Device after execution of the ScanStart Method or after a scan triggered by the verifier device.

The ScanResult contains the results of the scan execution. The OpticalVerifierScanResult DataType is defined in 9.3.11.

7.6 RfidScanEventType

The RfidScanEventType is formally defined in Table 21.

Table 21 – RfidScanEventType Definition
Attribute Value
BrowseNameRfidScanEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdScanEventType defined in 7.2.
HasPropertyVariableScanResultRfidScanResult []PropertyTypeMandatory

This event is the definition of a scan event for RFID readers. It will be fired by the AutoID Device after execution of the ScanStart Method or after a scan triggered by the reader device.

The ScanResult contains the results of the scan execution. The RfidScanResult DataType is defined in 9.3.12.

7.7 RtlsLocationEventType

The RtlsLocationEventType is formally defined in Table 22.

Table 22 – RtlsLocationEventType Definition
Attribute Value
BrowseNameRtlsLocationEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdScanEventType defined in 7.2.
HasPropertyVariableScanResultRtlsLocationResult []PropertyTypeMandatory

This event is the definition of a location event for RTLS devices or systems. It will be fired by the AutoID Device or system after execution of the ScanStart Method or after a scan triggered by the RTLS device or system.

The ScanResult contains the results of the scan execution. The RtlsLocationResult DataType is defined in 9.3.15.

7.8 AutoIdDiagnosticsEventType

The AutoIdDiagnosticsEventType is formally defined in Table 23.

Table 23 – AutoIdDiagnosticsEventType Definition
Attribute Value
BrowseNameAutoIdDiagnosticsEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of BaseEventType defined in OPC 10000-5.
HasPropertyVariableDeviceNameStringPropertyTypeMandatory

This event is the abstract definition of an AutoID diagnostics event. It will be fired by the AutoID Device after the occurrence of specific diagnostics data.

The DeviceName contains the name of the AutoID Device that performed the diagnostic action.

7.9 AutoIdLogEntryEventType

The AutoIdLogEntryEventType is formally defined in Table 24.

Table 24 – AutoIdLogEntryEventType Definition
Attribute Value
BrowseNameAutoIdLogEntryEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdDiagnosticsEventType defined in 7.8.

This event is the definition of a Log Entry diagnostics event for AutoID devices. It will be fired by the AutoID Device after a new entry to the Logbook was written.

The new entry to the Logbook will be provided in the Event field Message defined by the BaseEventType.

7.10 AutoIdAccessEventType

The AutoIdAccessEventType is formally defined in Table 25.

Table 25 – AutoIdAccessEventType Definition
Attribute Value
BrowseNameAutoIdAccessEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdDiagnosticsEventType defined in 7.8.
HasPropertyVariableClientStringPropertyTypeOptional
HasPropertyVariableCommandStringPropertyTypeOptional
HasPropertyVariableAccessResultAccessResult []PropertyTypeMandatory

This event is the definition of an Access diagnostics event for AutoID devices. It will be fired by the AutoID Device after at least one AutoID Identifier was accessed by a command, including the Scan command.

Client contains the name of the client application which was the originator of the command.

Command contains the executed command. Dependend on the kind of the client application, the names of the commands may vary. When the client application is an OPC UA Client, the names shall correspond to the command names used within this specification, e.g. “ReadTag” for the execution of the ReadTag command.

The AccessResult contains additional values of the AutoID Identifier access. The AccessResult DataType is defined in 9.3.17.

7.11 RfidAccessEventType

The RfidAccessEventType is formally defined in Table 26.

Table 26 – RfidAccessEventType Definition
Attribute Value
BrowseNameRfidAccessEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdAccessEventType defined in 7.8.
HasPropertyVariableAccessResultRfidAccessResult []PropertyTypeMandatory

This event is the definition of a Rfid Access diagnostics event for Rfid devices. It will be fired by the Rfid Device after at least one Rfid Transponder was accessed by a command, including the Scan command.

The AccessResult contains additional values of the transponder access. The RfidAccessResult DataType is defined in 9.3.18.

7.12 AutoIdPresenceEventType

The AutoIdPresenceEventType is formally defined in Table 27.

Table 27 – AutoIdPresenceEventType Definition
Attribute Value
BrowseNameAutoIdPresenceEventType
IsAbstractTrue
References Node Class BrowseName DataType TypeDefinition Modelling Rule
Subtype of AutoIdDiagnosticsEventType defined in 7.8.
HasPropertyVariablePresenceUInt16PropertyTypeMandatory

This event is the definition of a Presence diagnostics event for AutoID devices. It will be fired by the AutoID Device if the number of AutoID Identifiers (e.g. Codes or transponder), seen by the device, changes.

Presence identifies if there currently is seen an AutoID Identifier by the device. If supported by a device, it may show the concrete number of AutoID Identifiers.