Interface ILed

interface ILed {
    close(): Promise<void>;
    isOpen(): boolean;
    open(): Promise<void>;
    setColor(color: Color, mode?: LedMode): Promise<void>;
}

Hierarchy (View Summary)

Methods

close isOpen open setColor

Methods

close

  • close(): Promise<void>

    Release control of the LED. Any configurations of color will be reset.

    Returns Promise<void>

isOpen

  • isOpen(): boolean

    Determines whether it is currently open.

    Returns boolean

open

  • open(): Promise<void>

    Opens the LED for control. Any color previously set on the LED by other functionality may be cleared.

    Returns Promise<void>

setColor

  • setColor(color: Color, mode?: LedMode): Promise<void>

    Set the color and mode of the LED. If mode is not specified, the default mode is LedMode.on.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods