Table Of Contents

Get Relay Position (G Dataflow)

Version:
    Last Modified: March 3, 2017

    Returns the relay position for the relay specified in relay name.

    connector_pane_image
    datatype_icon

    session in

    Control that identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology node, the niSwitch Initialize With Options node, or the niSwitch Initialize node.

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    relay name

    Name of the relay or set of relays to control.

    You can supply a single relay name or comma-delimited list of relay names to control these relays. Examples of valid relay names are ch0, ab0, 1wire, and hlselect.

    spd-note-note
    Note  

    Use the niSwitch Wait For Debounce node, the niSwitch Switch Is Debounced node, and the Is Debounced property to determine if the relay has settled.

    datatype_icon

    session out

    Indicator that identifies a particular NI-SWITCH session established with the niSwitch Initialize With Topology node, the niSwitch Initialize With Options node, or the niSwitch Initialize node and used for all subsequent NI-SWITCH calls.

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.
    datatype_icon

    position

    Relay postition.

    Name Description
    Open

    Indicates that the relay is open.

    Closed

    Indicates that the relay is closed.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported


    Recently Viewed Topics