LedringAnimation

This class contains an animation that can be played on Homey's LED Ring.

Methods

registerScreensaver

(async) registerScreensaver(screensaverName): Promise.<any>

Register this animation as a screensaver. This is a shorthand method to ManagerLedring#registerScreensaver.

Parameters

Name Type Description
screensaverName
string

The name of the screensaver, as defined in /app.json

Returns

Promise.<any>

start

(async) start(): Promise.<any>

Start the animation.

Returns

Promise.<any>

stop

(async) stop(): Promise.<any>

Stop the animation.

Returns

Promise.<any>

unregister

(async) unregister(): Promise.<LedringAnimation>

Unregister the animation. This is a shorthand method to ManagerLedring#unregisterAnimation.

Returns

Promise.<LedringAnimation>

unregisterScreensaver

(async) unregisterScreensaver(screensaverName): Promise.<any>

Unregister this animation as a screensaver. This is a shorthand method to ManagerLedring#unregisterScreensaver.

Parameters

Name Type Description
screensaverName
string

The name of the screensaver, as defined in /app.json

Returns

Promise.<any>

updateFrames

(async) updateFrames(frames): Promise.<any>

Update the animation frames.

Parameters

Name Type Description
frames
Array.<LedringAnimation.Frame>

Returns

Promise.<any>

Type Definitions

Frame

Frame

Properties

Name Type Description
r
number

between 0 and 255.

g
number

between 0 and 255.

b
number

between 0 and 255.

Events

finish

.on('finish')

This event is fired when the animation has finished (duration has been reached).

start

.on('start')

This event is fired when the animation has started.

stop

.on('stop')

This event is fired when the animation has stopped.