Class Light

constructor

• new Light(ipaddr, timeout?): Light

• Creates an instance of Light.

  Parameters

  • ipaddr: string

    IP Address of the Twinkly device

  • timeout: number = 1000

  Returns Light

activeLoginCall

challenge

ipaddr

net

nleds

token

udpClient

addMovie

• addMovie(movie): Promise<void>

• Parameters

  • movie: Movie

  Returns Promise<void>

autoEndLoginCall

• autoEndLoginCall(): Promise<void>

• Returns Promise<void>

ensureLoggedIn

• ensureLoggedIn(): Promise<void>

• Ensure that we are logged into to the device, and if not initiate a login request

  Returns Promise<void>

getBrightness

• getBrightness(): Promise<number>

• Gets the current brightness level

  Returns Promise<number>

  Current brightness in range 0..100

getDeviceDetails

• getDeviceDetails(): Promise<object>

• Gets details about the device

  Returns Promise<object>

  Results vary, see https://xled-docs.readthedocs.io/en/latest/rest_api.html#device-details

getHSVColour

• getHSVColour(): Promise<hsvColour>

• Gets the current colour in HSV

  Returns Promise<hsvColour>

getLayout

• getLayout(): Promise<any>

• Returns Promise<any>

getListOfMovies

• getListOfMovies(): Promise<Movie[]>

• Returns Promise<Movie[]>

getMode

• getMode(): Promise<deviceMode>

• Gets the LED operation mode

  Returns Promise<deviceMode>

  mode

getNLeds

• getNLeds(): Promise<number>

• Returns Promise<number>

getName

• getName(): Promise<string>

• Get the name of the device

  Returns Promise<string>

  Name of device

getRGBColour

• getRGBColour(): Promise<rgbColour>

• Gets the current colour in RGB

  Returns Promise<rgbColour>

getTimer

• getTimer(): Promise<timer>

• Gets time when lights will turn on and off

  Returns Promise<timer>

login

• login(): Promise<void>

• Sends a login request

  Returns Promise<void>

sendGetRequest

• sendGetRequest(url, params?, requiresToken?): Promise<any>

• Sends a GET request to the device, appending the required tokens

  Parameters

  • url: string

  • Optional params: object

  • requiresToken: boolean = true

  Returns Promise<any>

sendPostRequest

• sendPostRequest(url, params): Promise<any>

• Sends a POST request to the device, appending the required tokens

  Parameters

  • url: string

  • params: object

  Returns Promise<any>

sendRealTimeFrame

• sendRealTimeFrame(frame): Promise<any>

• Parameters

  • frame: Frame

  Returns Promise<any>

sendRealTimeFrameUDP

• sendRealTimeFrameUDP(frame): Promise<void>

• Parameters

  • frame: Frame

  Returns Promise<void>

setBrightness

• setBrightness(value, mode?, type?): Promise<void>

• Sets the brightness level

  Parameters

  • value: number

  • Optional mode: string = "enabled"

  • Optional type: string = "A"

  Returns Promise<void>

setHSVColour

• setHSVColour(colour): Promise<void>

• Sets the colour in HSV when in colour mode

  Parameters

  • colour: hsvColour

    A HSV colour

  Returns Promise<void>

setMode

• setMode(mode): Promise<void>

• Sets the LED operation mode

  Parameters

  • mode: deviceMode

  Returns Promise<void>

setName

• setName(name): Promise<void>

• Sets the name of the device

  Parameters

  • name: string

    Desired device name, max 32 charachters

  Returns Promise<void>

setOff

• setOff(): Promise<void>

• Turns the device off

  Returns Promise<void>

setRGBColour

• setRGBColour(colour): Promise<void>

• Sets the colour in RGB when in colour mode

  Parameters

  • colour: rgbColour

    A RGB colour

  Returns Promise<void>

setRGBColourRealTime

• setRGBColourRealTime(colour): Promise<void>

• Parameters

  • colour: rgbColour

  Returns Promise<void>

setState

• setState(state): Promise<void>
• Experimental

  Sets the state

  Parameters

  • state: boolean

    Set on/off

  Returns Promise<void>

verify

• verify(): Promise<void>

• Check that we are logged in to the device

  Returns Promise<void>