10 OPC UA DataTypes

10.1 Structures

10.1.1 StandbyModeTransitionDataType

The StandbyModeTransitionDataType holds information which might change when the device is in a transition state to an Energy Saving Mode.

Table 39 – StandbyModeTransitionDataType Structure
NameTypeDescription
StandbyModeTransitionDataTypeStructure
IDDestination0:ByteMode ID of destination Energy Saving Mode.
CurrentTimeToDestination0:DurationTime needed to reach the mode IDDestination. Shall be a “Worst case” value if ongoing (dynamic) time value is not supported. Shall be 0 if destination Energy Saving Mode is reached.
CurrentTimeToOperate0:DurationTime needed to reach „Ready to operate“ if the Energy Saving Mode is not regularly terminated. The server might update the value after reaching the destination state as long as the TimeMinLengthOfStay of the destination state is not reached.
EnergyConsumptionToDestination0:FloatEnergy consumption for actual transition. Shall be 0 if not in a transition state.

Its representation in the AddressSpace is defined in Table 40.

Table 40 – StandbyModeTransitionDataType Definition
Attribute Value
BrowseNameStandbyModeTransitionDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Structure type defined in [OPC 10000-3]

Figure 12 shows how CurrentTimeToOperate varies in dependence of TimeToPause and TimeMinLengthOfStay of the destination Energy Saving Mode during and immediately after the transition.

The relationship of RegularTimeToOperate and CurrentTimeToOperate during a mode transition shall follow the specification defined by PROFIenergy (See [PE CAP], figure 14).

xxxx

Figure 12 – RegularTimeToOperate vs. CurrentTimeToOperate

10.1.2 EnergyStateInformationDataType

The EnergyStateInformationDataType holds information specific to a certain state which also does not change if the device is in transition state. The members shall have the values characterizing the current state and shall be changed only in case of a transition to a different state.

Table 41 – EnergyStateInformationDataType Structure
NameTypeDescription
EnergyStateInformationDataTypeStructure

IDSource

0:ByteMode ID of current Energy Saving Mode.

IDDestination

0:ByteMode ID of destination Energy Saving Mode.

RegularTimeToOperate

0:DurationTime needed to reach „Ready to operate“ if the Energy Saving Mode is regularly terminated. Shall be 0 if IDSource is equal to 0xFF (The StandbyManagementStatus Variable has the value “Ready to operate”).

ModePowerConsumption

0:FloatPower consumption in actual state.

Its representation in the AddressSpace is defined in Table 42

Table 42 – EnergyStateInformationDataType Definition
Attribute Value
BrowseNameEnergyStateInformationDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Structure type defined in [OPC 10000-3]

If the StandbyManagementStatus Variable of the EnergyStandbyManagementType Object has the value 2 (“Ready to operate”), IDSource and IDDestination shall be equal and have the value 0xFF.

If this StandbyManagementStatus Variable has the value 0 (“Energy saving disabled”), IDSource and IDDestination shall be equal and have the value 0xF0.

If this StandbyManagementStatus Variable has the value 4 (“Energy saving mode”), IDSource and IDDestination shall be equal and have the value of the ID Property of the EnergySavingModeType Object representing the current Energy Saving Mode.

If this StandbyManagementStatus Variable has the value 3 (“Moving to energy saving mode”) and if the previous value was 2 (“Ready to operate”), IDSource shall have the value 0xFF and IDDestination shall have the value of the ID Property of the EnergySavingModeType Object representing the destination Energy Saving Mode.

If this StandbyManagementStatus Variable has the value 3 (“Moving to energy saving mode”) and if the previous value was 4 (“Energy saving mode”, the state transition takes place between two Energy Saving Modes), IDSource shall be the value of the ID Property of the EnergySavingModeType Object representing the source Energy Saving Mode. IDDestination shall have the value of the ID Property of the EnergySavingModeType Object representing the destination Energy Saving Mode.

If this StandbyManagementStatus Variable has the value 5 (“Moving to ready to operate”), IDDestination shall have the value 0xFF. IDSource shall have the value of the ID Property of the EnergySavingModeType Object representing the source Energy Saving Mode.

10.1.3 PeVersionDataType

This structure contains the PROFIenergy version implemented by the device.

Table 43 – PeVersionDataType Structure
NameTypeDescription
PeVersionDataTypeStructure

MajorVersion

0:Byte

MinorVersion

0:Byte

Revision

0:Byte
Table 44 – PeVersionDataType Definition
Attribute Value
BrowseNamePeVersionDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Structure type defined in [OPC 10000-3]

10.1.4 AcPeDataType

This structure can also be seen as L1, L2, L3.

Table 45 – AcPeDataType Structure
NameTypeDescription
AcPeDataTypeStructure

A

0:FloatPhase a-n

B

0:FloatPhase b-n

C

0:FloatPhase c-n
Table 46 – PeVersionDataType Definition
Attribute Value
BrowseNamePeVersionDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Structure type defined in [OPC 10000-3]

10.1.5 AcPpDataType

This structure can also be seen as L1L2, L2L3, L3L1.

Table 47 – AcPpDataType Structure
NameTypeDescription
AcPpDataTypeStructure

A_b

0:FloatPhase a-b

B_c

0:FloatPhase b-c

C_a

0:FloatPhase c-a
Table 48 – AcPpDataType Definition
Attribute Value
BrowseNameAcPpDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Structure type defined in [OPC 10000-3]

10.2 Enumerations

10.2.1 PeClassEnumeration

This enumeration defines the possible values for the PeClass Property of the PeServiceAccessPointType. The enumeration is defined in Table 49.

Table 49 – PeClassEnumeration Items
NameValueDescription
PE_CLASS10The PE Entity supports Standby Management functionality.
PE_CLASS21The PE Entity supports Energy Measurement functionality.
PE_CLASS32The PE Entity supports both Standby Management and Energy Measurement functionality.

Its representation in the AddressSpace is defined in Table 50.

Table 50 – PeClassEnumeration Definition
Attribute Value
BrowseNamePeClassEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in [OPC 10000-5]
0:HasPropertyVariable0:EnumValues0:EnumValueType []0:PropertyType

10.2.2 PeSubclassEnumeration

This enumeration defines the possible values for the PeSubclass Property of the PeServiceAccessPointType. The enumeration is defined in Table 51.

Table 51 – PeSubclassEnumeration Items
NameValueDescription
PE_SUBCLASS10The PE Entity does not support a Standby Management disabled state.
PE_SUBCLASS21The PE Entity supports a Standby Management disabled state.

Its representation in the AddressSpace is defined in Table 52.

Table 52 – PeSubclassEnumeration Definition
Attribute Value
BrowseNamePeSubclassEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in [OPC 10000-5]
0:HasPropertyVariable0:EnumValues0:EnumValueType []0:PropertyType

10.2.3 AccuracyDomainEnumeration

This enumeration defines the possible values for the AccuracyDomain Property of the MeasurementValueType. The enumeration is defined in Table 53.

Table 53 – AccuracyDomainEnumeration Items
NameValueDescription
ACCURACY_DOMAIN_RESERVED0Reserved.
ACCURACY_DOMAIN_PERCENT_FULL_SCALE1The accuracy is given as percent of the full-scale reading.
ACCURACY_DOMAIN_PERCENT_ACTUAL_READING2The accuracy is given as percent of the actual reading.
ACCURACY_DOMAIN_IEC3The accuracy is given according to IEC 61557-12.
ACCURACY_DOMAIN_EN4The accuracy is given as specified in the EN 50470-3, Chapter 8.

Its representation in the AddressSpace is defined in Table 54.

Table 54 – AccuracyDomainEnumeration Definition
Attribute Value
BrowseNameAccuracyDomainEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in [OPC 10000-5]
0:HasPropertyVariable0:EnumValues0:EnumValueType []0:PropertyType

10.2.4 AccuracyClassEnumeration

This enumeration defines the possible values for the AccuracyClass Property of the MeasurementValueType. The enumeration is defined in Table 55.

Table 55 – AccuracyClassEnumeration Items
NameValueDescription
ACCURACY_CLASS_00Reserved.
ACCURACY_CLASS_11.
ACCURACY_CLASS_22
ACCURACY_CLASS_33
ACCURACY_CLASS_44
ACCURACY_CLASS_55
ACCURACY_CLASS_66Meaning of value depends on AccuracyDomain variable value.
ACCURACY_CLASS_77See Table 36, Table 37 and Table 38.
ACCURACY_CLASS_88
ACCURACY_CLASS_99
ACCURACY_CLASS_1010
ACCURACY_CLASS_1111
ACCURACY_CLASS_1212
ACCURACY_CLASS_1313
ACCURACY_CLASS_1414
ACCURACY_CLASS_1515

Its representation in the AddressSpace is defined in Table 56.

Table 56 – AccuracyClassEnumeration Definition
Attribute Value
BrowseNameAccuracyClassEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in [OPC 10000-5]
0:HasPropertyVariable0:EnumValues0:EnumValueType []0:PropertyType