This FunctionalGroupis used to organize runtime configuration parameters and Methods. All standard or vendor specific runtime parameters of AutoID Devicesshall be exposed below this FunctionalGroup. FunctionalGroupscan be nested. The runtime parameters may be also exposed in other parts of the AutoID DeviceOPC UA Server Address Space.

The FunctionalGroupTypeis defined in OPC 10000-100.

Predefined parameters for this FunctionalGroupare defined in Table 8and described below.

The parameter CodeTypesallows the user to determine the supported and to select the configured code types. It is used to expose the list of supported code types.

The Valueof the Variablecontains the currently selected types as a number. The assigned code type Strings are defined in 9.1.3.

CodeTypescan contain the predefined values or vendor specific values.

The ScanSettings FunctionalGroupshall be provided if the ScanActive Variableis supported for the control of the scan behaviour. It contains the following parameters (defined in Table 8):

  • Parameter Durationspecifies the duration of the scan operation in milliseconds. The value 0 is infinite. It is one of the termination conditions for the scan operation. The termination conditions are related to each other. If one of the conditions is fulfilled, the scan operation is stopped.
  • Parameter Cyclesspecifies the duration of the scan operation in ‘number of scan cycles’. The value 0 is infinite. It is one of the termination conditions for the scan operation. The termination conditions are related to each other. If one of the conditions is fulfilled, the scan operation is stopped.
  • If parameter DataAvailableis True, the scan operation is completed as soon as scan data is available. If DataAvailableis False, only the other termination conditions are used.
  • Parameter CodeTypespecifies the format of the LastScanData Variable Valueas string. The CodeTypeDataTypeand the predefined format strings are defined in 9.1.3.

This FunctionalGroupis used to organize IO data from sensors and actuators connected to the AutoID Device. All vendor or configuration specific IO data of AutoID Devicesshall be exposed below this FunctionalGroup. FunctionalGroupscan be nested. The IO data may also be exposed in other parts of the AutoID DeviceOPC UA Server Address Space.

An IO data point is represented by an OPC UA Variable Value. OPC UA Clients can read and write Variable Valuesdepending on the AccessLevelof the Variable. Valuescan also be monitored for changes.

The FunctionalGroupTypeis defined in OPC 10000-100.

This FunctionalGroupis used to organize diagnostic data from the AutoID Device. All diagnostics data of AutoID Devicesshall be exposed below this FunctionalGroup. FunctionalGroupscan be nested. The diagnostics data may also be exposed in other parts of the AutoID DeviceOPC UA Server Address Space.

A diagnostics point is represented by an OPC UA Variable Value. OPC UA Clients can read the Variable Values. Valuescan also be monitored for changes.

The FunctionalGroupTypeis defined in OPC 10000-100.

Predefined parameters for this FunctionalGroupare defined in Table 8and described below.

Presenceidentifies if there currently is seen an AutoID Identifier (e.g. a code or a transponder) by the device. If supported by a device, it may show the concrete number of AutoID Identifiers.

The Logbook FunctionalGroupshall be provided if Logging values are supported for diagnostic purposes. Its predefined parameters are defined in Table 8and described in the following list:

  • Parameter LogColumnsspecifies the column headings of the Logbook.
  • Parameter LastLogEntryspecifies the last entry of the Logbook.

The LastAccess FunctionalGroupshall be provided if values for the last AutoID Identifier access are supported for diagnostic purposes. Its predefined parameters are described in the following list:

  • Parameter Clientspecifies the client application (interface) which was the originator of the AutoID Identifier access.
  • Parameter Commandspecifies executed command, including the Scan 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.
  • Parameter Identifierspecifies theAutoID Identifier which was accessed by the command. The DataTypecan be one of the DataTypesdefined in the ScanData Uniondefined in 9.4.2. Due to the use case for limited OPC UAClients, the DataTypeis normally Stringor ByteString.
  • Parameter Timestampspecifies the point of time the AutoID identifier(e.g. a transponder) was accessed by the command.

The Last Access Variable Valuesbelong together logically. OPC UA does not ensure a consistent delivery of a list of Variable Values. Thus, there are several limitations and the Last Access Variables should only used with OPC Clientslimited to Data Accessfunctionality. It is recommended that complex applications use the AutoIdAccessEventsor RfidAccessEvents.

An OPC UA Servershall set all Variable SourceTimestampswith a consistent value if the Variables Valuesare updated. An OPC UA Client must ensure that it has a constent set of Values. The Clientcan use the DataChangeFilterSTATUS_VALUE_TIMESTAMP_2 to receive updates for all Variablesto verify if all necessary information is available or a Clientcan subscribe only for one Variablelike Timestampand then read the related Variablesincluding a verification of the SourceTimestamp.

This method starts the scan process of the AutoID Devicesynchronous and returns the scan results.

The duration of the scan process is defined by the termination conditions in the Settingsparameter. A Clientshall not set all parameters to infinite for the Scan Method. The values for infinite are defined in the ScanSettings DataTypedefinition in 9.3.7. An additional setting to consider is the TimeoutHintused for the Call Service.

Signature

Scan(

[in]ScanSettings Settings

[out]ScanResult [] Results

[out]AutoIdOperationStatusEnumerationStatus

);

Argument

Description

Settings

Configuration settings for the scan execution. The ScanSettings DataTypeis defined in 9.3.7.

Results

Results of the scan execution. The ScanResult DataTypeis defined in 9.3.8.

Status

Returns the status of the scan operation.

The AutoIdOperationStatusEnumeration DataTypeis defined in 9.2.1.

Method Result Codes

ResultCode

Description

Bad_InvalidState

There is already a scan active

Bad_InvalidArgument

The scan setting contained an invalid value like infinite duration.

Other OPC UA status codes defined for the Call Service in OPC 10000-4.

This method starts the scan process of the AutoID Deviceasynchronous. The scan results are delivered through Events where the EventTypeis a subtype of the AutoIdScanEventTypedefined in 7.2. There is a subtype defined for each concrete AutoID Devicetypes.

The scan process is stopped through the Method ScanStopor if one of the termination conditions in the Settingsparameter is fulfilled.

In addition, the scanning stops if the Clientcloses the Session, or if a new configuration file is stored within the AutoID Device. There might be other conditions depending on technology or device manufacturer.

Signature

ScanStart(

[in]ScanSettings Settings

[out]AutoIdOperationStatusEnumerationStatus

);

Argument

Description

Settings

Configuration settings for the scan execution. The ScanSettings DataTypeis defined in 9.3.7.

Status

Returns the status of the scan start operation.

The AutoIdOperationStatusEnumeration DataTypeis defined in 9.2.1.

Method Result Codes

ResultCode

Description

Bad_InvalidState

There is already a scan active

Other OPC UA status codes defined for the Call Service in OPC 10000-4.

This method stops an active scan process of the AutoID Device.

Signature

ScanStop( );

Method Result Codes

ResultCode

Description

Bad_InvalidState

There is no scan active.

This method returns the location of the AutoID Device.

Signature

GetDeviceLocation(

[in]LocationTypeEnumerationLocationType

[out]Location Location

);

Argument

Description

LocationType

The type of location information to return. The LocationTypeEnumeration DataTypeis defined in 9.2.3.

Location

The location of the AutoID Device. The Location DataType is defined in 9.4.1.

Method Result Codes

ResultCode

Description

Standard OPC UA status codes defined for the Call Service in OPC 10000-4.

This OPC UA Variableallows simple applications to trigger the scan process. Simple appications involve OPC UAClientsthat are limited to Data Accessfunctionality.

The scan is triggered by writing Trueto the Variable Value. The behaviour of the scan is defined by the parameters in the ScanSettings FunctionalGroupdefined in 9.3.7. The Valueof the Variableis changed back to Falseby the Serverif the scan is stopped according to the ScanSettings. The Clientcan stop the scan by writing Falseto the Variable Value.

The write permission can be limited to one Client. OPC 10000-3and OPC 10000-5define capabilities to enforce this limit with Rolesand RolePermissions. Rolescan be limited to a single OPC UA Application.

The scan result is provided through the Variable LastScanData. Further restrictions for this simple mechanism are described for the Variable LastScanData.

This OPC UA Variablerepresents the last scanned AutoID Identifier. The DataTypecan be one of the DataTypesdefined in the ScanData Uniondefined in 9.4.2. Due to the use case for limited OPC UAClients, the DataType is normally Stringor ByteString.

The Variablecan be provided for simple applications where OPC UAClientsare limited to Data Accessfunctionality. Such OPC UA Clientsare typically limited to built-in DataTypeslike Stringor ByteStringtoo. The use of this Variable implies the following restrictions.

  • Only one AutoID Identifiercan be delivered for a scan.
  • The frequency of scans is limited to the sampling interval set by the OPC UA Client.
  • The delivery of scan results depends on the MonitoredItemsettings or Readbehaviour of the OPC UA Client.

It is recommended that complex applications use scan Methodsand Events.

This OPC UA Variableof DataType UtcTimebelongs to the Variable LastScanDataand represents the point of time the last AutoID Identifierwas scanned. The value of this Variableshall be equal to the SourceTimestampof the Variable LastScanData.

The Variablecan be provided for simple applications where OPC UAClientsare limited to Data Accessfunctionality. Such OPC UA Clientsare typically limited to built-in DataTypeslike UtcTime. The use of this Variable implies the following restrictions.

  • Only one AutoID Identifiercan be delivered for a scan.
  • The frequency of scans is limited to the sampling interval set by the OPC UA Client.
  • The delivery of scan results depends on the MonitoredItemsettings or Readbehaviour of the OPC UA Client.

It is recommended that complex applications use scan Methodsand Events.

This OPC UA Propertyof DataType Stringrepresents an AutoID Device additional information, which can be used freely for device management purposes.

This OPC UA Variableof DataType Locationrepresents the AutoID Device location as Union of different coordinate systems and the related units. The DataType Locationis defined in 9.4.1. The VariableType LocationVariableType is defined in 8.1.

The variable can be set during commissioning for fixed-mounted readers or can be updated automatically for mobile readers. The aim is to give the actual position where a specific scan event has been created.

This OPC UA Propertyof DataType Stringrepresents a user defined name of the AutoID Device location.

This variable can be used to assign a real name to the AutoID Device, e.g. “Gate 21”. It allows a device-independent event description in higher IT levels.

This OPC UA Propertyof DataType Stringrepresents the AutoID Device name, which can be used freely for device management purposes.

This OPC UA Propertyof DataType DeviceStatusEnumerationrepresents the AutoID Device status. The DeviceStatusEnumerationis defined in 9.2.2.

This OPC UA Propertyof DataType Stringrepresents the AutoIDInformation Modelversion. The version string for this specification version is “1.00”.