6 OPC UA ObjectTypes ToC Previous Next

6.1 AutoIdDeviceType ToC Previous Next

6.1.3 ObjectType Description ToC Previous Next

6.1.3.1 Object RuntimeParameters ToC

This FunctionalGroup is used to organize runtime configuration parameters and Methods. All standard or vendor specific runtime parameters of AutoID Devices shall be exposed below this FunctionalGroup. FunctionalGroups can be nested. The runtime parameters may be also exposed in other parts of the AutoID Device OPC UA Server Address Space.

The FunctionalGroupType is defined in OPC 10000-100.

Predefined parameters are described in Table 8. For all parameters, the ReferenceType is Organizes, the NodeClass is Variable, the TypeDefinition is BaseDataVariableType and the ModellingRule is Optional.

Table 8 – Predefined RuntimeParameters

Attribute Value  
BrowseName RuntimeParameters  
BrowseName DataType Description
ComponentOf the AutoIdDeviceType    
CodeTypes UInt32 [] Allows the user to determine the supported CodeTypes and to select the configured CodeTypes.
The VariableType for this Parameter shall be MultiStateDiscreteType.
This Property is used to expose the list of supported CodeTypes. This list can contain the predefined Strings or vendor specific Strings.
The Value of the Variable contains the currently selected types.
The CodeType Strings are defined in 9.1.3
     
OcrReaderDeviceType and OpticalReaderDevice    
TemplateName String Activate template which defines a specific identification task. The templates have to be defined during configuration.
MatchCode String Defines the target value for 2D or OCR decoding.
     
RfidReaderDeviceType    
TagTypes UInt32 [] Allows the user to determine the expected tags in a multi-type environment (e.g. ISO14443 or ISO15693).
The VariableType for this Parameter shall be MultiStateDiscreteType.
The MultiStateDiscreteType defines an EnumStrings Property.
This Property is used to expose the list of supported tag types. This list can contain the predefined Strings or vendor specific Strings.
The Value of the Variable contains the currently selected types.
The following Strings are defined by this specification.
* ISO14443
* ISO15693
* ISO18000-2
* ISO18000-3 Mode1
* ISO18000-3 Mode2
* ISO18000-3 Mode3
* ISO18000-4
* ISO18000-61
* ISO18000-62
* ISO18000-63
* ISO18000-64
* EPC Class1 Gen2 V1
* EPC Class1 Gen2 V2
RfPower SByte Adjust radio transmission power, per antenna.
MinRssi Int32 Lowest acceptable RSSI value (see also Strength parameter in RFIDSigthing)

6.1.3.2 Object IOData ToC

This FunctionalGroup is used to organize IO data from sensors and actuators connected to the AutoID Device. All vendor or configuration specific IO data of AutoID Devices shall be exposed below this FunctionalGroup. FunctionalGroups can be nested. The IO data may also be exposed in other parts of the AutoID Device OPC UA Server Address Space.

An IO data point is represented by an OPC UA Variable Value. OPC UA Clients can read and write Variable Values depending on the AccessLevel of the Variable. Values can also be monitored for changes.

The FunctionalGroupType is defined in OPC 10000-100.

6.1.3.3 Method Scan ToC

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

The duration of the scan process is defined by the termination conditions in the Settings parameter. A Client shall not set all parameters to infinite for the Scan Method. The values for infinite are defined in the ScanSettings DataType definition in 9.3.7. An additional setting to consider is the TimeoutHint used for the Call Service.

Signature

Scan (
[in]	ScanSettings				Settings
[out]	ScanResult []				Results
[out]	AutoIdOperationStatusEnumeration	Status
);

Argument Description
Settings Configuration settings for the scan execution. The ScanSettings DataType is defined in 9.3.7.
Results Results of the scan execution. The ScanResult DataType is defined in 9.3.8.
Status Returns the status of the scan operation.
The AutoIdOperationStatusEnumeration DataType is 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.

6.1.3.4 Method ScanStart ToC

This method starts the scan process of the AutoID Device asynchronous. The scan results are delivered through Events where the EventType is a subtype of the AutoIdScanEventType defined in 7.2. There is a subtype defined for each concrete AutoID Device types.

The scan process is stopped through the Method ScanStop or if one of the termination conditions in the Settings parameter is fulfilled.

In addition, the scanning stops if the Client closes 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]	AutoIdOperationStatusEnumeration	Status
);

Argument Description
Settings Configuration settings for the scan execution. The ScanSettings DataType is defined in 9.3.7.
Status Returns the status of the scan start operation.
The AutoIdOperationStatusEnumeration DataType is 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.

6.1.3.5 Method ScanStop ToC

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.

6.1.3.6 Method GetDeviceLocation ToC

This method returns the location of the AutoID Device.

Signature

GetDeviceLocation (
[in]	LocationTypeEnumeration	LocationType
[out]	Location				Location
);

Argument Description
LocationType The type of location information to return. The LocationTypeEnumeration DataType is 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.

6.1.3.7 Variable LastScanData ToC

This OPC UA Variable represents the last scanned AutoID Identifier. The DataType can be one of the DataTypes defined in the ScanData Union defined in 9.4.2. Due to the use case for limited OPC UA Clients, the DataType is normally String or ByteString.

The Variable can be provided for simple applications where OPC UA Clients are limited to Data Access functionality. Such OPC UA Clients are typically limited to built-in DataTypes like String or ByteString too. The use of this Variable implies the following restrictions.

  • Only one AutoID Identifier can 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 MonitoredItem settings or Read behaviour of the OPC UA Client.

    6.1.3.8 Variable DeviceLocation ToC

    This OPC UA Variable of DataType Location represents the AutoID Device location as Union of different coordinate systems and the related units. The DataType Location is 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.

6.1.3.9 Variable DeviceLocationName ToC

This OPC UA Property of DataType String represents 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.

6.1.3.10 Variable DeviceName ToC

This OPC UA Property of DataType String represents the AutoID Device name, which can be used freely for device management purposes.

6.1.3.11 Variable DeviceStatus ToC

This OPC UA Property of DataType DeviceStatusEnumeration represents the AutoID Device status. The DeviceStatusEnumeration is defined in9.2.2.

6.1.3.12 Variable AutoIdModelVersion ToC

This OPC UA Property of DataType String represents the AutoID Information Model version. The version string for this specification version is “1.00”.

Previous Next