StandardLibraryCollection/furhat.libraries.standard.utils/LEDCommands

LEDCommands

class LEDCommands

Helper class to use the LEDs effectively.

See also

Constructors

fun LEDCommands()

Types

class PulseLEDStart(val pulseColor: Color = Color.BLUE, val minBrightness: Int = 20, val maxBrightness: Int = 70, val periodInMs: Int = 8000) : Event

Event to be used when starting a pulsing LED state.

class PulseLEDStop : Event

Event to use to stop a pulsing LED state.

TurnOffListenGlow

class TurnOffListenGlow : Event

Event to use to turn of ListenGlow in a parallel state.

TurnOnListenGlow

class TurnOnListenGlow : Event

Event to use to turn on ListenGlow in a parallel state.

Functions

ListenGlowState

fun ListenGlowState(listenLedColor: Color = Color(0,30,60), defaultLedColor: Color = Color(5,5,5)): State

The ListenGlow State should be included as a parallel state, and can then be toggled by raising the TurnOnListenGlow or TurnOffListenGlow events.

fun pulseLEDStart(pulseColor: Color = Color.BLUE, minBrightness: Int = 20, maxBrightness: Int = 70, periodInMs: Int = 8000): LEDCommands.PulseLEDStart

Getter function for the PulseLEDStart event.

Properties

val PulseLEDState: State

The PulseLEDState should be included as a parallel state, and can then be toggled by raising the PulseLEDStart or PulseLEDStop events. The PulseLEDStart event is used to define the behavior.

val pulseLEDStop: LEDCommands.PulseLEDStop

Getter variable for the PulseLEDStop event.

turnOffListenGlow

val turnOffListenGlow: LEDCommands.TurnOffListenGlow

Getter variable for the TurnOffListenGlow event.

turnOnListenGlow

val turnOnListenGlow: LEDCommands.TurnOnListenGlow

Getter variable for the TurnOnListenGlow event.