8 OPC UA ObjectTypes

8.1 Standby Management

8.1.1 EnergyStandbyManagementType

The EnergyStandbyManagementType ObjectTypes provide access to the Standby Management functionality of one Standby Management Entity. Parallel access of Clients to the read only data shall be possible but write operations and Method invocation can be limited to one Client at a time with the Lock Object.

The StandbyManagementStatus Variable shall contain the current state of the Standby Management. The value of this Variable shall be consistent with the content of the EnergySavingModeStatus Object.

The values of the 0:EnumStrings of the StandbyManagementStatus shall follow the definition of Table 13. Each instance shall have the values 0 to 8. Element numbers 9-15 are reserved for future use. If vendors add specific elements, the range 9-15 shall be filled with ‘null’-strings.

The Variables of the EnergyStandbyManagementType have additional Attributes defined in Table 14

The EnergySavingModes container Object contains References to EnergySavingModeType Objects representing the supported Energy Saving Modes.

Writing the PauseTime Variable can be used to update the pause time alternatively to the StartPause Method. Setting the PauseTime Variable with a value not equal to 0 shall have the same effect as invoking the StartPause Method passing the PauseTime value. Setting the PauseTime Variable with a value equal to 0 shall have the same effect as invoking the EndPause Method. An additional benefit is that the Variable PauseTime can be used in a PubSub communication scenario where the PauseTime is distributed by a central time management client using a broadcast telegram to which every Standby Management Entity subscribes.

The Lock Object ensures exclusive write access and Method call for one client. Write access and Method calls from Clients shall be blocked unless the client has locked the Object by invoking the InitLock Method of the Lock Object.

The StartPause Method starts the transition to an Energy Saving Mode. The SwitchToEnergySavingMode allows the transition into a specific Energy Saving Mode. The EndPause Method ends the Energy Saving Mode.

A RepresentedBy Reference may connect the Object to the representing PROFIenergy service access point Object (see PeServiceAccessPointType). The BrowseName of the Reference shall be “PESAP”.

8.1.1.1 StartPause Method

This Method starts the transition into an Energy Saving Mode.

Signature

	StartPause (
		[in]  0:Duration	PauseTime
		[out] 0:Byte		ModeID
		[out] 0:Duration	CurrentTimeToDestination
		[out] 0:Duration	RegularTimeToOperate
		[out] 0:Duration	TimeMinLengthOfStay
		[out] 0:Byte		ReturnCode
		);
	

The Method Result Codes (defined in Call Service) are defined in Table 15.

8.1.1.2 SwitchToEnergySavingMode Method

This Method initiates a switch to a certain Energy Saving Mode.

Signature

	SwitchToEnergySavingMode (
		[in]  0:Byte		ModeID
	[out] 0:Byte		EffectiveModeID
	[out] 0:Duration	CurrentTimeToDestination
		[out] 0:Duration	RegularTimeToOperate
		[out] 0:Duration	TimeMinLengthOfStay
		[out] 0:Byte		ReturnCode
		);
	

The Method Result Codes (defined in Call Service) are defined in Table 15.

8.1.1.3 EndPause Method

This Method ends the current Energy Saving Mode.

Signature

	EndPause (
		[out] 0:Duration	CurrentTimeToOperate
		[out] 0:Byte		ReturnCode
		);
	

The Method Result Codes (defined in Call Service) are defined in Table 15.

Table 15 shows the possible values for the Method call result codes.

Table 16 shows the possible values for the out parameter ReturnCode.

8.1.2 EnergySavingModesContainerType

8.1.3 EnergySavingModeStatusType

The CurrentTransitionData Variable contains details for the state transition indicated by the StateInformation Variable.

The StateInformation Variable contains details for the actual Energy Saving Mode state.

8.1.4 EnergySavingModeType

The EnergySavingModeType provides detailed information for a specific Energy Saving Mode.

The BrowseName shall contain a unique name for the Energy Saving Mode.

The ID Variable shall contain a unique mode ID for the Energy Saving Mode. The mode ID’s 0x00, 0xF0, 0xFE and 0xFF are reserved for predefined states.

DynamicData shall indicate whether the time, energy consumption and power values can vary (slightly) during runtime.

The TimeMinPause Variable shall contain the minimum pause time for this Energy Saving Mode.

The TimeToPause Variable shall contain the expected time to switch to this Energy Saving Mode.

The TimeMinLengthOfStay Variable shall contain the time of minimum stay in this Energy Saving Mode.

The TimeMaxLengthOfStay Variable shall contain the time of maximum stay in this Energy Saving Mode.

The RegularTimeToOperate Variable shall contain the time value to reach ”Ready to operate” (see Figure 1) if this Energy Saving Mode will be regularly terminated.

The ModePowerConsumption Variable shall contain the power consumption in this Energy Saving Mode. Unit: [kW].

The EnergyConsumptionToPause Variable shall contain the energy consumption from ”Ready to operate” to this Energy Saving Mode. Unit: [kWh].

The EnergyConsumptionToOperate Variable shall contain the energy consumption from this Energy Saving Mode to ”Ready to operate”. Unit: [kWh].

Mapping to PROFIenergy properties:

8.2 Energy Measurement

8.2.1 Overview

The Energy Measurement Objects provide access to the Energy Measurement values. For each Metering Point one EnergyMeasurementType Object shall exist.

8.2.2 EnergyMeasurementType

The EnergyMeasurementType contains References to MeasurementValueType Objects.

The PeObjectNumber Variable shall contain the Object number of the related PROFIenergy measurement Object.

The MeasurementValue Variable contains one actual measurement value. For each measurement value of a Metering Point one MeasurementValueType Variable shall exist.

If one of the MeasurementValueType Variables is used as energy counter, the ResetEnergyCounter Method can be used to set the value of this Variable to 0. See section 9.1, ”MeasurementValueType” for further details.

A RepresentedBy Reference may connect the Object to the representing PROFIenergy service access point Object (see PeServiceAccessPointType). The BrowseName of the Reference shall be “PESAP”. If the PESAP is not part of the Information Model, the RepresentedBy Reference in the EnergyMeasurementType Object is omitted.

Mapping to PROFIenergy properties:

8.2.3 Interfaces for EnergyProfiles

EnergyMeasurementType Objects should support Interfaces for standardized energy data profiles, so called EnergyProfiles. The supported measurement values demanded by an energy data profile are specified by Interfaces applied to instances of the EnergyMeasurementType.

Table 21 shows the definitions of the Interfaces for the standardized energy data profiles. The EnergyProfiles represent standard Energy Measurement use cases and are therefore the preferred way to represent Energy Measurement data. It is recommended to support at least one of the EnergyProfiles.

Figure 11 shows an example how different EnergyProfiles can be supported by EnergyMeasurementType Object instances.

8.2.3.1 IEnergyProfileE0Type

The IEnergyProfileE0Type contains the References to MeasurementValueType Variables needed for EnergyProfile E0.

8.2.3.2 IEnergyProfileE1Type

The IEnergyProfileE1Type contains the References to MeasurementValueType Variables needed for EnergyProfile E1.

8.2.3.3 IEnergyProfileE2Type

The IEnergyProfileE2Type contains the References to MeasurementValueType Variables needed for EnergyProfile E2.

8.2.3.4 IEnergyProfileE3Type

The IEnergyProfileE3Type contains the References to MeasurementValueType Variables needed for EnergyProfile E3.

8.2.3.5 IEnergyProfileD0Type

The IEnergyProfileD0Type Interface contains a Reference to a MeasurementValueType Variable representing direct current (EnergyProfile D0).

8.3 Sleep Mode WOL Functionality

8.3.1 EnergyDevicePowerOffType

The EnergyDevicePowerOffType type provides access to the Sleep Mode WOL functionality of the device if supported.

A RepresentedBy Reference may connect the Object to the representing PROFIenergy service access point Object (see PeServiceAccessPointType). The BrowseName of the Reference shall be “PESAP”. If the PESAP is not part of the Information Model, the RepresentedBy Reference in the EnergyDevicePowerOffType Object is omitted.

The RegularTimeToOperate Variable shall contain the time value to reach the state “Ready to operate” if the Wake-on-LAN sleep mode is terminated by a wake-up (see below).

The ModePowerConsumption Variable shall contain the power consumption in the
Wake-on-LAN sleep mode. Unit: [kW].

The WOLMagicPacket Variable shall contain the 6 bytes MAC address to be used with the magic packet sent for wake-up (see [PE CAP], chapter 7.3.4.9).

The SwitchOffWOL Method initiates the transition into the Wake-on-LAN sleep mode. In this mode the device is effectively switched off and unavailable for network communication. The device can be awakened using the magic packet (see [PE CAP], chapter 7.3.4.9).

8.3.1.1 SwitchOffWOL Method

This Method starts the transition into the special Wake-on-LAN mode.

Signature

	SwitchOffWOL (
		[out] 0:Byte			ModeID
		[out] 0:Duration		CurrentTimeToDestination
		[out] 0:Duration		RegularTimeToOperate
		[out] 0:Duration		TimeMinLengthOfStay
		[out] 0:Byte			ReturnCode
		);
	

The Method Result Codes (defined in Call Service) are defined in Table 15.

8.4 PeServiceAccessPointType

The PeServiceAccessPointType connects the PE Energy Management Objects belonging to one PE Entity. The PeServiceAccessPointType Object could be included in the PE Energy Management model to model the PROFIenergy Service Access Point within PROFINET devices. Independent from the PeServiceAccessPointType Object, the PE Energy Management functionality can be directly managed by OPC UA access.

The BrowseName of a PeServiceAccessPointType instance should be “PESAP@<Subslot>, where <Subslot> shall be the content of the subslot Variable of the Object which is the source of the 0:HasAddin Reference pointing to the service access point Object in hexadecimal number string format.

The PeSubclass Property shall be provided in conjunction with the Class Property: If the Class Property has the value PE_CLASS1 or the value PE_CLASS3, this Property is mandatory.

The PeVersion Property shall contain the implemented PROFIenergy version number.

A Represents Reference with the BrowseName “Standby” is mandatory for PROFIenergy class 1 and class 3 and shall point to the EnergyStandbyManagementType Object representing the Standby Management functionality.

A Represents Reference with the BrowseName “Measurement” is mandatory for PROFIenergy class 2 and class 3 and shall point to the EnergyMeasurementType Object representing the Energy Measurement functionality.

One optional Represents Reference with the BrowseName “EnergyPowerOff” points to an EnergyDevicePowerOffType Object if “Sleep Mode WOL” is supported.