14 Type definitions for Coffee Machines

14.1 General

Figure 18 shows an overview of the object types for the Coffee Machine device class.

Figure 18 — Overview of object types for Coffee Machine

14.2 CoffeeMachineParameterType

14.2.1 General

The CoffeeMachineParameterType defines the parameters of a Coffee Machine.

14.2.2 Definition of the object type

The CoffeeMachineParameterType is formally defined in Table 45.

Table 45 — CoffeeMachineParameterType definition
Attribute Value
BrowseNameCoffeeMachineParameterType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Modelling
Rule AccessLevel
Subtype of KitchenDeviceParameterType
HasComponentVariableCurrentStateCoffeeMachineMode EnumerationBaseDataVariableTypeM, RW
HasComponentVariableBoilerPressureWaterFloatAnalogItemTypeM, R
HasComponentVariableBoilerPressureSteamFloatAnalogItemTypeM, R
HasComponentVariableBoilerTempWaterFloatAnalogItemTypeM, R
HasComponentVariableBoilerTempSteamFloatAnalogItemTypeO, R
HasComponentVariableSystemCleanDateTimeBaseDataVariableTypeM, R
HasComponentVariableTotalBrew_<No.>UInt64BaseDataVariableTypeMP, R
HasComponentVariableTotalMixUInt64BaseDataVariableTypeM, R
HasComponentVariableGrinderRuntime_<No.>UInt64AnalogItemTypeMP, R

14.2.3 ObjectType description

14.2.3.1 CurrentState variable

The CurrentState variable represents the current operating state of a Coffee Machine.

The data type for the CoffeeMachineModeEnumeration is defined in section 14.5.2.

14.2.3.2 BoilerPressureWater variable

The BoilerPressureWater variable represents the pressure of the water boiler in Pa. The pressure of the water boiler can only be read.

The EngineeringUnit property of the AnalogItemType has the value Pa. The value for the EURange property is device-specific.

14.2.3.3 BoilerPressureSteam variable

The BoilerPressureSteam variable represents the pressure of the steam boiler in Pa. The pressure of the steam boiler is not available in every machine. The pressure of the steam boiler can only be read.

The EngineeringUnit property of the AnalogItemType has the value Pa. The value for the EURange property is device-specific.

14.2.3.4 BoilerTempWater variable

This variable represents the temperature in the water boiler in °C. The temperature of the water boiler can only be read.

The EngineeringUnit property of the AnalogItemType has the value °C. The value for the EURange property is device-specific.

14.2.3.5 BoilerTempSteam variable

The BoilerTempSteam variable represents the temperature of the steam boiler in °C. The temperature of the steam boiler is not available in every machine. The temperature of the steam boiler can only be read.

The EngineeringUnit property of the AnalogItemType has the value °C. The value for the EURange property is device-specific.

14.2.3.6 SystemClean variable

The SystemClean variable represents the time in UTC format at which the system cleaning was last carried out. The time can only be read.

14.2.3.7 TotalBrew_<No.> variables

The TotalBrew_<No.> variables represent the number of brews per brewer. At least one brewer exists. Further brewers are named with ascending numbers. The counters can only be read.

14.2.3.8 TotalMix variable

The TotalMix variables represent the number of cycles of the mixer. The number of mixer cycles can only be read.

14.2.3.9 GrinderRuntime_<No.> variables

The GrinderRuntime_<No.> variables represent the running times of the grinders in seconds. At least one grinder exists. Further grinders are named with ascending numbers. The running times can only be read.

The EngineeringUnit property of the AnalogItemType has the value s. The value for the EURange property is device-specific.

14.3 CoffeeMachineRecipeParameterType

14.3.1 General

The CoffeeMachineRecipeParameterType defines the parameters of a recipe for coffee machines.

14.3.2 Definition of the object type

The CoffeeMachineRecipeParameterType is formally defined in Table 46.

Table 46 — CoffeeMachineRecipeParameterType definition
Attribute Value
BrowseNameCoffeeMachineRecipeParameterType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Modelling
Rule AccessLevel
Subtype of KitchenDeviceParameterType
HasComponentVariableBeverageSizeFloatAnalogItemTypeM, RW
HasComponentVariableBeverageSMLBeverageSMLEnumerationBaseDataVariableTypeM, RW
HasComponentVariableGroundsAmountFloatAnalogItemTypeM, RW
HasComponentVariableGroundsWaterFloatAnalogItemTypeM, RW
HasComponentVariableContainerUInt32MultiStateDiscreteTypeM, R
HasComponentVariableCoffeeTypeUInt32MultiStateDiscreteTypeM, RW
HasComponentVariableRcpTypeUInt32MultiStateDiscreteTypeM, RW
HasComponentVariableMilkAmountFloatAnalogItemTypeM, RW
HasComponentVariableFoamAmountFloatAnalogItemTypeM, RW
HasComponentVariablePowderAmountFloatAnalogItemTypeM, RW

14.3.3 ObjectType description

14.3.3.1 BeverageSize variable

The BeverageSize variable with the data type Float represents the beverage size as a percentage change in the set recipe parameters. The value of the variable can be read and written.

The EngineeringUnit property of the AnalogItemType has the value % and the EURange property has the minimum value 50 and the maximum value 150.

14.3.3.2 BeverageSML variable

The BeverageSML variable with the data type BeverageSMLEnumeration represents the beverage size preselection. The data type is defined in section 14.4.2. The value of the variable can be read and written.

14.3.3.3 GroundsAmount variable

The GroundsAmount variable with the data type Float represents the coffee grounds quantity. The value of the variable can be read and written.

The EngineeringUnit property of the AnalogItemType has the value g. The value for the EURange property is device-specific.

14.3.3.4 GroundsWater variable

The GroundsWater variable with the data type Float represents the water quantity. The value of the variable can be read and written.

The EngineeringUnit property of the AnalogItemType has the value ml. The value for the EURange property is device-specific.

14.3.3.5 Container variable

The Container variable represents the coffee container.

A selection of possible containers can be made available for the specific device via the EnumStrings property of the MultiStateDiscreteType.

14.3.3.6 CoffeeType variable

The CoffeeType variable represents the beverage type, for example espresso, cafe crème or filter coffee, and thus defines the basic recipe.

The beverage type can be made available via the EnumStrings property of the MultiStateDiscreteType.

14.3.3.7 RcpType variable

The RcpType variable represents the recipe type of the beverage.

The recipe type of the beverage can be made available via the EnumStrings property of the MultiStateDiscreteType.

14.3.3.8 MilkAmount variable

The MilkAmount variable represents the amount of milk in a beverage. The value of the variable can be read and written.

The EngineeringUnit property of the AnalogItemType has the value ml. The value for the EURange property is device-specific.

14.3.3.9 FoamAmount variable

The FoamAmount variable represents the amount of milk foam in a beverage. The value of the variable can be read and written.

The EngineeringUnit property of the AnalogItemType has the value ml. The value for the EURange property is device-specific.

14.3.3.10 PowderAmount variable

The PowderAmount variable represents the amount of powder in a beverage. The value of the variable can be read and written.

The EngineeringUnit property of the AnalogItemType has the value g. The value for the EURange property is device-specific.

14.4 CoffeeMachineDeviceType

14.4.1 General

CoffeeMachineDeviceType describes a device from the commercial Coffee Machine device class.

14.4.2 Definition of the object type

The CoffeeMachineDeviceType is formally defined in Table 47.

Table 47 — CoffeeMachineDeviceType definition
Attribute Value
BrowseNameCoffeeMachineDeviceType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Modelling
Rule AccessLevel
Subtype of CommercialKitchenDeviceType
HasComponentObjectParametersCoffeeMachineParameterTypeM, R
HasComponentObject<RecipeName>CoffeeMachineRecipeParameterTypeMP, RW

14.4.3 Description of the object type

14.4.3.1 Parameters object

The Parameters object contains the parameters for the Coffee Machine.

14.4.3.2 <RecipeName> objects

The objects from the <RecipeName> list represent the recipes of the Coffee Machine. The names of the objects arise from the recipe name or a recipe number.

14.5 Data types for enumerations

14.5.1 BevarageSMLEnumeration

This data type is an enumeration of the possible SML values. The possible values are defined in Table 48.

Table 48 — BeverageSMLEnumeration values
Value Description
Inactive_0Standard SML is medium
Small_1Small
Large_2Large
ExtraLarge_3Extra Large

14.5.2 CoffeeMachineModeEnumeration

This data type is an enumeration of the possible operating states of the commercial coffee machine. The possible values are defined in Table 49.

Table 49 — CoffeeMachineModeEnumeration values
Value Description
Off_0Machine off
Standby_1Ready to operate
Error_2Error
Cleaning_3Cleaning running