7 OPC UA ObjectTypes

Figure 7 shows all ObjectTypes which are defined by this companion specification.

7.1 WirelessMachineToolPeripheralType ObjectType Definition

7.1.1 Overview

The WirelessMachineToolPeripheralType provides information about the WMTP itself. This ObjectType is the entry point to the OPC UA interface of a WMTP. An instance of this ObjectType aggregates all information related to one system.

It is highly recommended that all instances of a WirelessMachineToolPeripheralType are referenced from the 3:Machines node defined in OPC 40001-1.

The WirelessMachineToolPeripheralType is formally defined in Table 15.

DeviceConfiguration is representing a collection of all nodes that enable configuration or provide information on the configuration of a WMTP.

DeviceInformation is representing a collection of all nodes that provide information about the WMTP.

WMTPWorkCycleData enables the handling of measured work cycles.

WMTPServiceCycleData enables the handling of service data of the WMTP.

MachineryLifetimeCounters is representing a collection of all counters with a start and an end value. It is used as the MachineryLifetimeCounterType defined in OPC 40001-1. In the information model for WMTP, all counters that are implemented according to the MachineryLifetimeCounterType of the OPC 40001-1 shall be integrated with the HasComponent reference under this Object. This Object shall also be referenced as HasAddIn in the MachineryBuildingBlocks Folder.

MachineryOperationCounters is representing a collection of all incrementing counters. It is used as the MachineryOperationCounterType defined in OPC 40001-1. In the information model for WMTP, all counters that are implemented according to the MachineryLifetimeCounterType of the OPC 40001-1 shall be integrated with the HasComponent reference under this Object. This Object shall also be referenced as HasAddIn in the MachineryBuildingBlocks Folder.

Measurements is representing a collection of all nodes that provide values measured by the WMTP, such as temperature, rotation speed, humidity, etc.

MachineryBuildingBlocks is representing a folder that directly references all those building blocks of the OPC UA for Machinery (OPC 40001-1, OPC 40001-3) which are implemented with an HasAddIn reference in this information model.

The components of the WirelessMachineToolPeripheralType have additional references which are defined in Table 16.

The components of the WirelessMachineToolPeripheralType have additional subcomponents which are defined in Table 17.

CalibrationMode indicates whether the device is currently in calibration mode or not. True means the WMTP is in calibration mode.

SetDeviceTime enables writing the current date and time on the WMTP.

UpdateFirmware enables transferring a new firmware to the WMTP. Possible implementation or monitoring of the installation takes place independently of OPC UA on the respective WMTP and is solved differently by different manufacturers.

SendLicenseData enables transferring license data to the WMTP. Possible implementation or monitoring of the installation takes place independently of OPC UA on the respective WMTP and is solved differently by different manufacturers.

SwitchCalibrationMode enables the WMTP to be switched to calibration mode and back.

Identification is used as defined in OPC 40001-1 and shall also be referenced as AddIn in the

MachineryBuildingBlocks Folder.

BatteryLevel contains all data on the current battery level of the WMTP.

LicenseInformation contains information about the license of the WMTP. How this information looks like is solved differently by different manufacturers.

NextServiceDate is the date when the next maintenance is scheduled.

LastService is the date when the last maintenance of the device was carried out.

LifeCycleStatus is a parameter which outputs the life cycle in the form of four stages (unknown, green, yellow, red). This parameter is generated internally in the WMTP and is solved differently by different manufacturers.

LicenseValidity is used as the MachineryLifetimeCounterType is defined in OPC 40001-1. It is representing a counter that counts down a time value specified by the manufacturer of the WMTP. At the end of this period, the license of the WMTP Software is not valid anymore.

RemainingLifetimeCounter is used as the MachineryLifetimeCounterType is defined in OPC 40001-1. It is representing a counter that counts down a time value specified by the manufacturer of the WMTP. At the end of this period, the WMTP has reached its maximum lifetime.

RemainingCycleCounter is used as the MachineryLifetimeCounterType is defined in OPC 40001-1. It is representing a counter that counts down a number of working cycles specified by the manufacturer of the WMTP. At the end of this period, the WMTP has reached its maximum service life.

NextServiceCounter is used as the MachineryLifetimeCounterType is defined in OPC 40001-1. It is representing a counter that counts down a time value specified by the manufacturer of the WMTP. A service is to be carried out when this time period expires.

OperationSinceLastServiceCounter is representing a counter that counts the duration of use since the last service of the WMTP.

Temperature contains all data on the measured temperature.

RotationSpeed contains all data on the measured rotational speed.

Humidity contains all data on the measured humidity.

Acceleration contains all data on the measured acceleration of the WMTP.

Force contains all data on the measured force.

Torque contains all data on the measured torque.

Position contains all data on the measured position of the WMTP.

Dimension contains all data on the measured dimension.

NOTE: The list of measurements is representing the most used types. The model can be extended as required by the end user.

A child Node of the WirelessMachineToolPeripheralType has an additional Attribute value defined in Table 18.

7.1.2 SetDeviceTime

The Method SetDeviceTime allows to set the device time. The signature of this Method is specified below.

Signature

	SetDeviceTime (
		[in]	0:DateTime		DateTime,
		[in]	0:TimeZoneDataType	TimeZoneOffset
	);
	

NOTE: A call with DateTime = "2024-02-03 12:00" (UTC time) and TimeZoneOffset = {120; true}, sets the (local) machine time to "03-02-2024 14:00" and the time zone to "UTC+2".

7.1.3 UpdateFirmware

The Method UpdateFirmware sends a new firmware to be transferred to the WMTP. The signature of this Method is specified below.

Signature

	UpdateFirmware (
		[in]	0:Byte[]	FirmwareData
	);
	

7.1.4 SendLicenseData

The Method SendLicenseData sends license data to the WMTP. The signature of this Method is specified below.

Signature

	SendLicenseData (
		[in]	0:Byte[]	LicenseData
	);
	

7.1.5 SwitchCalibrationMode

The Method SwitchCalibrationMode enables to switch the WMTP between "Calibrate" mode and "Use" mode. The signature of this Method is specified below.

Signature

	SwitchCalibrationMode (
		[in]	0:UInt16	TargetMode
	);
	

7.2 ObjectTypes for data transfer and management

7.2.1 WMTPWorkCycleDataType ObjectType Definition

The WMTPWorkCycleDataType provides the Methods that are required for reading out and deleting the work cycle data of a WMTP. It is formally defined in Table 27.

DeleteAllStoredRecords enables to permanently delete all stored data from the WMTP.

DeleteStoredRecordsTime enables to permanently delete a desired section of stored data from the WMTP, chosen by the time of measurement.

DeleteStoredRecordsIndex enables to permanently delete a desired section of stored data from the WMTP, chosen by the index of measurement.

AbortOperation enables the termination of the process currently being executed by the WMTP. This is necessary as some transfer processes can take several minutes.

ReportNumberOfStoredRecords enables querying the number of data records available on the WMTP.

ReportNumberOfStoredRecordsTime enables querying the number of data records available on the WMTP according to a given timespan.

CombinedReportAll enables to request all stored data from the WMTP.

CombinedReportIndex enables to request the stored data from the WMTP according to the index of the measurements. Using this method, it is possible to request the entire data set as well as desired sections.

CombinedReportTime enables to request the stored data from the WMTP according to the timestamp of the measurements. Using this method, it is possible to request the entire data set as well as desired sections.

7.2.2 WMTPServiceCycleDataType ObjectType Definition

The WMTPServiceCycleDataType provides the Methods that are required for reading out and deleting the service cycle data of a WMTP. It is formally defined in Table 28.

DeleteStoredAllRecords enables to permanently delete all stored data from the WMTP. Using this method, it is possible to remove the entire data set as well as desired sections.

DeleteStoredRecordsTime enables to permanently delete a desired section of stored data from the WMTP, chosen by the time of measurement.

DeleteStoredRecordsNumber enables to permanently delete a desired section of stored data from the WMTP, chosen by the index of measurement.

AbortOperation enables the termination of the process currently being executed by the WMTP. This is necessary as some transfer processes can take several minutes.

ReportNumberOfStoredRecords enables querying the number of data records available on the WMTP.

ReportNumberOfStoredRecordsTime enables querying the number of data records available on the WMTP according to a given timespan.

CombinedReportAll enables to request all stored data from the WMTP.

CombinedReportIndex enables to request the stored data from the WMTP according to the index of the measurements. Using this method, it is possible to request the entire data set as well as desired sections.

CombinedReportTime enables to request the stored data from the WMTP according to the timestamp of the measurements. Using this method, it is possible to request the entire data set as well as desired sections.

7.2.3 Methods used for data transfer and management

7.2.3.1 DeleteAllStoredRecords

The Method DeleteAllStoredRecords enables to permanently delete all stored data from the WMTP. Using this method, it is possible to remove the entire data set. The signature of this Method is specified below.

Signature

	DeleteAllStoredRecords (
	);

7.2.3.2 DeleteStoredRecordsTime

The Method DeleteStoredRecordsTime enables to permanently delete the stored data from the WMTP from a specific given time. The signature of this Method is specified below.

Signature

	DeleteStoredRecordsTime (
		[in]	0:DateTime	FromTimestamp,
		[in]	0:DateTime	ToTimestamp,
	);
	

7.2.3.3 DeleteStoredRecordsIndex

The Method DeleteStoredRecordsIndex enables to permanently delete the stored data from the WMTP from a specific given time. The signature of this Method is specified below.

Signature

	DeleteStoredRecordsIndex (
		[in]	0:UInt32	FromIndex,
		[in]	0:UInt32	ToIndex,
	);
	

7.2.3.4 AbortOperation

The Method AbortOperation enables the termination of the process currently being executed by the WMTP. This is necessary as some transfer processes can take several minutes. The signature of this Method is specified below.

Signature

	AbortOperation (
	);

7.2.3.5 ReportNumberOfStoredRecords

The Method ReportNumberOfStoredRecords enables to report how many records are currently stored at the WMTP.

Signature

	ReportNumberOfStoredRecords (
		[out]	0:UInt32	NumberOfStoredRecords);
	

7.2.3.6 ReportNumberOfStoredRecordsTime

The Method ReportNumberOfStoredRecordsTime enables to report how many records are currently stored at the WMTP in a specific timespan.

Signature

	ReportNumberOfStoredRecordsTime (
		[in]	0:DateTime	FromTimestamp,
		[in]	0:DateTime	ToTimestamp,
		[out]	0:UInt32	NumberOfStoredRecords);
	

7.2.3.7 CombinedReportAll

The Method CombinedReportAll enables access to the entire data set stored on the WMTP. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportAll (
		[out]	WMTPOutputDataType[]	CombinedReport
	);
	

NOTE: If all measured values exceed the maximum size of an OPC UA message, this method cannot be used. In this case, the data should be queried in packets, for example using the CombinedReportIndex.

7.2.3.8 CombinedReportIndex

The Method CombinedReportIndex enables access to the entire data set stored on the WMTP based on the index of the measurements. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportIndex (
		[in]	0:UInt32	FromIndex,
		[in]	0:UInt32	ToIndex,
		[out]	WMTPOutputDataType[]	CombinedReport
	);
	

7.2.3.9 CombinedReportLastValue

The Method CombinedReportLastValue enables access to the last measurement stored on the WMTP. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportLastValue (
		[out]	WMTPOutputDataType	CombinedReport
	);
	

7.2.3.10 CombinedReportFirstValue

The Method CombinedReportFirstValue enables access to the first measurement stored on the WMTP. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportFirstValue (
		[out]	WMTPOutputDataType	CombinedReport
	);
	

7.2.3.11 CombinedReportTime

The Method CombinedReportTime enables access to the entire data set stored on the WMTP based on the timestamp of the measurements. A record transfer is defined within this specification as a transfer of a “copy” of the records and not a “move” of the records because the server retains the original log entries. The signature of this Method is specified below.

Signature

	CombinedReportTime (
		[in]	0:DateTime	FromTimestamp,
		[in]	0:DateTime	ToTimestamp,
		[out]	WMTPOutputDataType[]	CombinedReport
	
	);
	

7.3 WMTPMeasurementType ObjectType Definition

7.3.1 Overview

The WMTPMeasurementType is a subtype of the ProcessValueType defined in OPC 40001-2.

Figure 9 shows an overview of the WMTPMeasurementType. The blue marked Variables 5:AnalogSignal and Status are inherited from the respective supertypes and are complemented by the WMTPMeasurementType.

The WMTPMeasurementType is formally defined in Table 47.

LimitCounters is used as the MachineryOperationCounterType defined in OPC 40001-1. The WMTPMeasurementType is using the LimitCounters to structure the two counters OperationAboveHigh and OperationAboveHighHigh. The LimitCounters shall also be referenced as AddIn in the MachineryBuildingBlocks Folder to provide better access from a higher level.

TriggerSettings represents the time period from one measurement point to the next. If the relevant sensor of the WMTP does not define the measurement triggering using the TriggerSettings, the default value 0 shall be assumed.

SetTriggerSettings enables the TriggerSettings to be adjusted.

DeltaCondition represents the delta value that needs to be reached before the WMTP triggers the next measurement transmission. If the relevant sensor of the WMTP does not define the measurement triggering using the DeltaCondition, the default value 0 shall be assumed.

SetDeltaCondition enables the DeltaCondition to be adjusted.

NOTE: A WMTP sensor requires at least one value for the TriggerSettings or the DeltaCondition, as these variables are used to determine the measuring frequency. It is also possible to convert both conditions. If one of the variables is not required, the default value must be set for this variable. It must be ensured that both values are not zero at the same time.

TypeOfMeasurement describes which physical type of measurement is represented by this Instance of the WMTPMeasurementType. A list of possible options can be found in Table 48.

TypeOfSample defines the category of the measurement set. This specification defines standardized values for resources Table 48.

RelativeUncertainty is representing the percent uncertainty of measurement.

AbsoluteUncertainty is representing the measurement error in the same unit as the measured value.

Timestamp is representing the exact time of the measurement. Since the WMTP collects the data at a different time than when it is transferred to the OPC UA server, the time of data collection should be stored within this property.

Index is representing the number of the measurement.

MeasurementPeriod defines the time period over which the WMTPMeasurementType was recorded.

InternalUpdateInterval defines the sampling rate of the sensor.

Status is inherited from the from OPC 40001-2.

NOTE: The 6:ProcessValueType already provides the Variable SignalTag from the Object SignalType (OPC 30081), which can be used by inheritance in subtypes, is used to describe the location of the measurement. This variable can be used, for example, if several sensors are installed and the measured values must be clearly assignable.

NOTE: The 6:ProcessValueType already provides the Variable ValuePrecision from the Object 0:DataItemType, which can be used by inheritance in subtypes, is used to describe the precision (resolution) of the measured value or the sensor. It specifies the smallest increment of the measurement.

A Node of the WMTPMeasurementType has an additional Attribute value defined in Table 48.

The components of the WMTPMeasurementType have additional subcomponents which are defined in Table 49.

OperationAboveHigh represents a counter that records the time that the Status variable has the value 9 (ABOVE_HIGH_LIMIT) or 10 (ABOVE_HIGHHIGH_LIMIT). All the different statuses are defined in OPC 40001-2.

OperationAboveHighHigh represents a counter that records the time that the Status variable has the value 10 (ABOVE_HIGHHIGH_LIMIT). All the different statuses are defined in OPC 40001-2.

NOTE: The WMTPMeasurementType is a subtype of the ProcessValueType from OPC 40001-2. The additional subcomponents mentioned above are referring to the mandatory 5:AnalogSignal Variable and the Status Variable of the ProcessValueType which are inherited to the WMTPMeasurementType.

The components of the WMTPMeasurementType have additional references which are defined in Table 50.

7.3.2 SetTriggerSettings

The Method SetTriggerSettings enables to adjust the trigger settings of the relevant sensor of the WMTP. TriggerSettings represents the time period from one measurement point to the next. If the relevant sensor of the WMTP does not define the measurement triggering using the TriggerSettings, the default value 0 shall be assumed.

Signature

	SetTriggerSettings (
		[in]	0:Duration	TriggerDuration
	);
	

7.3.3 SetDeltaCondition

The Method SetDeltaCondition enables to adjust the delta condition of the relevant sensor of the WMTP. DeltaCondition represents the delta value that needs to be reached before the WMTP triggers the next measurement transmission. If the relevant sensor of the WMTP does not define the measurement triggering using the DeltaCondition, the default value 0 shall be assumed.

Signature

	SetDeltaCondition (
		[in]	0:Number	DeltaValue
	);
	
	
	NOTE: The DeltaValue parameter must be adapted to the existing measured value of the WMTPMeasurementType. The EngineeringUnit and the DataType of the number must therefore also be used here in this input parameter of the method.