LED

A Node object whose type is LED.

Configuration

LedNodeConfig
{
    "function" : LedFunctionConfig
}

Member name	Type	Description
function	LedFunctionConfig	LED Function

LED function configuration

LedFunctionConfig
{
    "value" : Integer,
    "choices" : [LedFunctionChoice, ...]
}

Member name	Type	Description
value	Integer	LED function selection, must match the value member of one of the choices listed in the choices member. Note: Currently, the firmware allows the LED function to be set, but does not report the current function back to the API server. For this reason, the value reported in this member is always 0, which matches a choice with an UNKNOWN details member (see LedFunctionChoice below). When setting this member (see command set property), it must be set to a value other than 0. Note: Not all functions are available for all LEDs. The valid choices are the ones listed in the choices member.
choices	Array of LedFunctionChoice	LED function choices Note: This member is not included in the response of a get settings command.

LED function choice

LedFunctionChoice
{
    "value" : Integer,
    "description" : String,
    "details" : String
}

Member name	Type	Description
value	Integer	Value of this choice
description	String	Human-readable description of this choice.
details	String	Machine-readable name of this function, which is one of the following: UNKNOWN current function is unknown BLINK blinking LED POWER power LED VIDEO_STABLE video is stable NETWORK_TX network TX indicator NETWORK_RX network RX indicator ALWAYS_ON always ON ALWAYS_OFF always OFF

Status

None

Inputs

None

Example

As returned by get device:

{
    "type" : "LED",
    "index" : 0,
    "configuration" : {
        "function" : {
            "value" : 0,
            "choices" : [{
                "value" : 0,
                "description" : "(Unknown)",
                "details" : "UNKNOWN"
            },
            {
                "value" : 1,
                "description" : "Blink LED",
                "details" : "BLINK"
            },
            {
                "value" : 2,
                "description" : "Power indicator LED",
                "details" : "POWER"
            },
            {
                "value" : 6,
                "description" : "LED always on",
                "details" : "ALWAYS_ON"
            },
            {
                "value" : 7,
                "description" : "LED always off",
                "details" : "ALWAYS_OFF"
            }]
        }
    },
    "status" : {},
    "inputs" : []
}