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.
| Attribute | Value | ||||
| BrowseName | EnergyDevicePowerOffType | ||||
| IsAbstract | False | ||||
| References | Node Class | BrowseName | DataType | TypeDefinition | Other |
|---|---|---|---|---|---|
| Subtype of the BaseObjectType defined in [OPC 10000-5]. | |||||
| 0:HasComponent | Variable | RegularTimeToOperate | 0:Duration | 0:BaseDataVariableType | M, RO |
| 0:HasComponent | Variable | TimeMinPause | 0:Duration | 0:BaseDataVariableType | M, RO |
| 0:HasComponent | Variable | ModePowerConsumption | 0:UInt32 | 0:BaseDataVariableType | M, RO |
| 0:HasProperty | Variable | WOLMagicPacket | 0:ByteString | 0:PropertyType | M, RO |
| 0:HasComponent | Method | SwitchOffWOL | M | ||
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
);
| Argument | Description |
| ModeID | ID of the “Sleep Mode WOL” (0xFE) 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 Wake-on-LAN sleep mode will be regularly terminated if successful, otherwise 0. |
| TimeMinLengthOfStay | Time of minimum stay in the Wake-on-LAN sleep mode if successful, otherwise 0. |
| ReturnCode | Return code. See Table 16. |
The Method Result Codes (defined in Call Service) are defined in Table 15.