5 General type definitions for commercial kitchen devices

5.1 Definitions for the properties of the DeviceType

Figure 6 shows an overview of the DeviceType with its Properties.

5.1.1 General

The general DeviceType from the OPC UA information model for the device configuration is taken as the basis in this specification. This information model is defined in IEC62541-100:2015.

All sub types derived from CommercialKitchenDevice can be supplemented by vendor-specific types.

5.1.2 DeviceClass property

The DeviceType defines the DeviceClass property. The classification is industry-specific and is defined for commercial kitchen devices in Table 9.

5.1.3 Manufacturer property

The manufacturer of the device is provided as freely definable text in the Manufacturer property.

5.1.4 Model property

The device designation is provided as freely definable text in the Model property.

5.1.5 SerialNumber property

The identification number, e.g. the serial number of the device, is provided as freely definable text in the SerialNumber property.

5.1.6 HardwareRevision property

The hardware version of the device is provided as freely definable text in the HardwareRevision property.

5.1.7 SoftwareRevision property

The software version of the device is provided as freely definable text in the SoftwareRevision property.

5.1.8 DeviceHealth property

The status of the device is provided as DeviceHealth enumeration in the DeviceHealth property. The possible values are NORMAL_0, FAILURE_1, CHECK_FUNCTION_2, OFF_SPEC_3 and MAINTENANCE_REQUIRED_4.

5.2 CommercialKitchenDeviceType

5.2.1 General

The CommercialKitchenDeviceType represents the basic type for all device classes according to Table 9. It is derived from the general DeviceType from the OPC UA information model for the device configuration. This information model is defined in IEC 62541-100:2015.

Figure 7 shows an overview of the CommercialKitchenDeviceType with its properties and associated Objects. The type is formally defined in Table 10.

5.2.2 Object type definition

The CommercialKitchenDeviceType is formally defined in Table 10.

5.2.3 Object type description

5.2.3.1 DeviceClass Property

The property DeviceClass of the DeviceType is overwritten in order to change the ModellingRule to Mandatory. The DeviceClass Strings used for this specification are defined in Table 9.

5.2.3.2 DeviceLocationName Property

The DeviceLocationName property represents a user-defined designation of the machine location.

Using this property the user can assign a name to the location, e.g. a room number.

5.2.3.3 BatchInformation Object

The BatchInformation object contains information on batch and article tracking. The BatchInformationType is defined in section 5.3.

5.2.3.4 ErrorConditions Object

The ErrorConditions object contains a list of currently pending error messages.

The basis for the processing of error messages is the Alarm and Condition Model from OPC UA, which is defined in IEC 62541-9:2015.

An error message is represented by an object of the type AlarmConditionType or by a type derived from it.

The AlarmConditionType and its base types define various states such as EnabledState, AckedState or ActiveState and further properties such as Severity, Message, Time and SourceNode. The Retain Property indicates whether an error message is of interest to the client.

Changes to the status of an error message are supplied to the clients via Events. A client can request the current status for all error messages where Retain = true as an event via the ConditionRefresh method. Clients can thus request a list of pending error messages after establishment of a connection.

Clients can confirm error messages via Methods in order, for example, to change the AckedState of the error message.

5.2.3.5 InformationConditions Object

The InformationConditions object contains a list of currently pending information messages.

The basis for the processing of information messages is the Alarm and Condition Model from OPC UA, which is defined in IEC 62541-0:2015.

An item of information is represented by an object of the type AlarmConditionType or by a type derived from it.

5.2.3.6 HACCPValues object

The HACCPValues object contains a list of HACCP-relevant measured values.

If a device provides HACCP-relevant measured values, these measured values must be referenced via the FunctionalGroup HACCPValues.

For HACCP-relevant measured values the corresponding variable must reference an information object of the type KitchenDeviceHAConfigType with the name "HA Configuration". The KitchenDeviceHAConfigType and its use are defined in section 5.4.

5.3 BatchInformationType

5.3.1 General

The BatchInformationType defines the data for the tracking of batches and articles.

Figure 8 shows an overview of the BatchInformationType with its Properties. The type is formally defined in Table 11.

5.3.2 Object type definition

The BatchInformationType is formally defined in Table 11.

5.3.3 ObjectType description

5.3.3.1 OrderId property

The OrderId Property represents the machine user's order number for the traceability.

5.3.3.2 BatchId property

The BatchId Property represents the machine user's batch number for the traceability.

5.3.3.3 SystemTime property

The SystemTime Property represents the current system time as a coordinated world time in UTC format.

5.3.3.3.1 LocalTime property

The LocalTime property represents the current difference between the local time and the UTC time. The data type TimeZoneDataType is defined in OPC 10000-5.

5.4 KitchenDeviceHAConfigType

5.4.1 General

The KitchenDeviceHAConfigType configures the logging of HACCP-relevant data.

Figure 9 shows an overview of the KitchenDeviceHAConfigType with its Properties. The type is formally defined in Table 12.

In the case of variables for which HACCP-relevant measured values are logged on the device, the corresponding variable must offer the settings relevant for the logging via an object with the name "HA Configuration". The BrowseName must have the Namespace Index 0. The KitchenDeviceHAConfigType or a type derived from it is used as the type for this Object.

5.4.2 Object type definition

The KitchenDeviceHAConfigType is formally defined in Table 12.

5.4.3 ObjectType description

5.4.3.1 HistoryDuration property

The HistoryDuration Property represents the logging time in milliseconds for which data are stored in the device.

5.4.3.2 SamplingInterval property

The SamplingInterval Property represents the sampling rate for the logging in milliseconds.

5.5 KitchenDeviceParameterType

5.5.1 Object type definition

The KitchenDeviceParameterType is formally defined in Table 13. It represents the abstract base type for the device-specific parameter object types.

5.5.2 ObjectType description

5.5.2.1 ProgramId variable

The ProgramId Variable with the data type Int32 represents the program number of the currently selected program.

5.5.2.2 ProgramName variable

The ProgramName Variable with the data type LocalizedText represents the program name of the currently selected program. If no names are available, the program number can also be used as text.

5.5.2.3 ProgramUId variable

The ProgramUId Variable with the data type Guid represents the globally unique identifier of the currently selected program.