8 OPC UA ObjectTypes ToC Previous Next

8.1 Standby Management ToC Previous Next

8.1.1 EnergyStandbyManagementType ToC Previous Next

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.

Table 12 – EnergyStandbyManagementType Definition

Attribute Value        
BrowseName EnergyStandbyManagementType        
IsAbstract False        
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in [OPC 10000-5].          
0:HasComponent Variable StandbyManagementStatus Byte 0:MultiStateDiscreteType M, RO
0:HasComponent Object EnergySavingModeStatus   EnergySavingModeStatusType M
0:HasComponent Object EnergySavingModes   EnergySavingModesContainerType O
0:HasComponent Variable PauseTime 0:Duration 0:BaseDataVariableType M, RW
0:HasComponent Object 2:Lock   2:LockingServicesType O
0:HasComponent Method StartPause   O  
0:HasComponent Method EndPause   O  
0:HasComponent Method SwitchToEnergySavingMode   O  

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.

Table 13 – Defined elements of EnumStrings array of StandbyManagementStatus Variable

Element number (starting with 0) Message (for locale “en”)
0 Energy saving disabled
1 Power Off
2 Ready to operate
3 Moving to Energy Saving Mode
4 Energy saving mode
5 Moving to ready to operate
6 Moving to Sleep mode WOL
7 Sleep mode WOL
8 Wake up WOL
9-15 ‘null’-String
16 – 255 Vendor specific

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

Table 14 – EnergyStandbyManagementType Attribute values for child Nodes

Source Path Value Attribute
   StandbyManagementStatus
   0:EnumStrings
Energy saving disabled
Power Off
Ready to operate
Moving to Energy Saving Mode
Energy saving mode
Moving to ready to operate
Moving to Sleep mode WOL
Sleep mode WOL
Wake up WOL

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”.

StartPause Method ToC

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
);

Argument Description
PauseTime Requested pause time.
ModeID ID of the destination Energy Saving Mode if successful, otherwise 0.
CurrentTimeToDestination Time needed to reach the Energy Saving Mode if successful, otherwise 0.
RegularTimeToOperate Time needed to reach “Ready to operate” again if the destination Energy Saving Mode will be regularly terminated if successful, otherwise 0.
TimeMinLengthOfStay Time of minimum stay in the destination Energy Saving Mode if successful, otherwise 0.
ReturnCode Return code. See Table 16.

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

SwitchToEnergySavingMode Method ToC

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
);

Argument Description
ModeID ID of the requested Energy Saving Mode.
EffectiveModeID ID of the effectively chosen Energy Saving Mode if successful, otherwise ID of current mode.
CurrentTimeToDestination Time needed to reach the destination Energy Saving Mode if successful, otherwise 0.
RegularTimeToOperate Time needed to reach “Ready to operate” again if the destination Energy Saving Mode will be regularly terminated if successful, otherwise 0.
TimeMinLengthOfStay Time of minimum stay in the destination Energy Saving Mode if successful, otherwise 0.
ReturnCode Return code. See table Table 16.

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

EndPause Method ToC

This Method ends the current Energy Saving Mode.

Signature

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

Argument Description
CurrentTimeToOperate Time needed to reach “Ready to operate” if successful, 0.
ReturnCode Return code. See table Table 16.

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 15 Possible Method result codes

Result Code Description
Good The Method execution was successful and the ReturnCode parameter has the value 0x00 (”Success”)
Uncertain The Method execution was successful, but the ReturnCode parameter indicates an error.
Bad_UserAccessDenied The user has not the right to execute the Method. The client shall not evaluate the ReturnCode parameter.
Bad_UnexpectedError The server is not able to execute the function because an unexpected error occurred. The device might be temporarily unavailable or unreachable due to network failure. The client shall not evaluate the ReturnCode parameter.

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

Table 16 Possible ReturnCode parameter Values

ReturnCode Description
0x00 Success.
0x50 No suitable energy-saving mode available.
0x52 No switch to requested energy-saving mode because of invalid mode ID.
0x53 No switch to Energy Saving Mode because of state operate.
0x54 Service or function not available due to internal device status.

Previous Next