Properties

address config name state type

Events

onError onStateChanged

Methods

pulse ramp ready setColor start stop wave

Properties

address

address: Number

The address this device is connected to the Nexmosphere controller.

config

config: any

The device config.

name

name: string

The name of the device.

state

state: DeviceState

The device state.

type

type: string

The type of the device.

Events

onError

  • Registers a callback which will be triggered when the device encounters an error.

    Parameters

    • callback: ((error: Error) => void)

      The callback which will be called once the device encountered an error.

        • (error: Error): void

        • Parameters

          • error: Error

          Returns void

    Returns EventSubscription

onStateChanged

Methods

pulse

  • Parameters

    • color0Intensity: Number
    • color0Number: Number
    • color0Time: Number
    • color1Intensity: Number
    • color1Number: Number
    • color1Time: Number
    • pulseCount: Number
    • rampTime: Number

    Returns void

ramp

  • Parameters

    • intensity: Number
    • colorLabel: Number
    • rampTime: Number

    Returns void

ready

  • Returns a promise which is fulfilled when the device is started.

    Returns Promise<any>

setColor

  • Parameters

    • colorNumber: Number
    • red: Number
    • green: Number
    • blue: Number

    Returns void

start

  • Starts the device when needed and returns a promise which is fulfilled when the device is started.

    Returns Promise<any>

stop

  • Stops the device.

    Returns Promise<any>

wave

  • Parameters

    • color0Intensity: Number
    • color0Number: Number
    • duration: Number
    • animationOption: Number
    • color1Intensity: Number
    • color1Number: Number
    • numberOfLeds: Number

    Returns void

Generated using TypeDoc