7.3 ObjectTypes for Sleep Mode WOL Functionality
7.3.1 EnergyDevicePowerOffType
7.3.1.1 Overview
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 0:BaseObjectType | |||||
| 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 | ||
| Conformance Units | |||||
|---|---|---|---|---|---|
| ECM Sleep Mode WOL | |||||
The RegularTimeToOperate Variable shall contain the time value to reach the state “Ready to operate” if the WOL sleep mode is terminated by a wake-up (see below).
The ModePowerConsumption Variable shall contain the energy consumption in the
WOL 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 3802, chapter 7.3.4.9).
The SwitchOffWOL Method initiates the transition into the WOL 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 3802, chapter 7.3.4.9).
7.3.1.2 SwitchOffWOL Method
This Method starts the transition into the special WOL 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. |
The Method Result Codes (defined in Call Service) are defined in Table 33.
ReturnCodes are defined in Table 34.