XNET Write (State Ethernet Wake).vi

XNET Write (State Ethernet Wake).vi

Purpose

Writes a request for the local Ethernet interface and its remote link partner to wake up. You can use this XNET Write VI with any input or output session for Ethernet.

Format

Inputs

	session in is the session to use for the state change. This session is selected from the LabVIEW project or returned from the XNET Create Session VI.
	error in is the error cluster input (refer to Error Handling).

Outputs

	session out is the same as session in, provided for use with subsequent VIs.
	error out is the error cluster output (refer to Error Handling).

Description

You can use the XNET Write (State Ethernet Wake) VI with any XNET session mode, as long as the session interface is Ethernet. The wake up commands apply to the Ethernet interface and therefore apply to all sessions created on that interface.

The command that is sent after calling the XNET Write (State Ethernet Wake) VI depends on the current PHY Power Mode of the interface. If the XNET interface is in Sleep mode, the XNET interface wakes up and transmits the Wake Up Pulse (WUP) command to the remote link partner to wake up. If the XNET interface is in Normal mode (i.e., is already awake), the XNET interface transmits the Wake Up Request (WUR) command to the remote link partner, which is intended to be sent over active links. The VI waits for the PHY Power Mode to reach the Normal state before returning; an error will be returned if the wake command is unsuccessful. If you call the XNET Write (State Ethernet Wake) VI multiple times, subsequent calls will transmit the WUR command if the interface is already awake.

Note  The sleep/wake capability is based on the OPEN Alliance TC10 Sleep/Wake 2.0 specification and is only supported on the PXIe-8523. The port must be configured for a link speed of 100 Mbps and a port mode of Direct to use the sleep/wake capability.

Note  After waking the interface from sleep, there may be a slight delay before the interface is ready to send or receive data. Query the Interface:Ethernet:Operational Status property to ensure Operational Status is Up before data is sent or received.