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


icon

Inputs/Outputs

  • cgenclassrntag.png session in —

    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.

  • cerrcodeclst.png error in (no error) —

    The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

  • igenclassrntag.png session out —

    session out is the same as session in, provided for use with subsequent VIs.

  • ierrcodeclst.png error out —

    The error out cluster passes error or warning information out of a VI to be used by other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

    • Description

    You can use the XNET Write (State Ethernet Sleep) VI with any XNET session mode, as long as the session interface is Ethernet. The sleep state applies to the Ethernet interface and therefore applies to all sessions created on that interface.

    After calling the XNET Write (State Ethernet Sleep) VI, the XNET interface transmits the Low Power Sleep (LPS) command to the remote link partner to request sleep if the link is up. The VI waits for the sleep state to be reached before returning; an error will be returned if the sleep state is not reached. If you call the XNET Write (State Ethernet Sleep) VI multiple times, subsequent calls do nothing if the interface is already in the sleep state.

    If an output session is used and a stream is already started with queued data, the data will be discarded once the interface goes to sleep, and any subsequent frame writes will error.

    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 the interface transitions to sleep, the Interface:Ethernet:Operational Status property will indicate Down.