Methods
(async) createAnimation(opts) → {Promise.<LedringAnimation>}
Requires the
homey:manager:ledring
permission. For more information about permissions read the Permissions tutorial.
Parameters:
Name | Type | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
object
|
|
Returns:
- Type:
-
Promise.<LedringAnimation>
(async) createProgressAnimation(opts)
Requires the
homey:manager:ledring
permission. For more information about permissions read the Permissions tutorial.
Parameters:
Name | Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
object
|
|
(async) createSystemAnimation(systemId, opts) → {Promise.<LedringAnimation>}
Requires the
homey:manager:ledring
permission. For more information about permissions read the Permissions tutorial.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
systemId |
string
|
The system animation's ID. Can be either |
|||||||||
opts |
object
|
|
Returns:
- Type:
-
Promise.<LedringAnimation>
(async) registerAnimation(animation) → {Promise.<LedringAnimation>}
Register a LED Ring animation.
Requires the
homey:manager:ledring
permission. For more information about permissions read the Permissions tutorial.
Parameters:
Name | Type | Description |
---|---|---|
animation |
LedringAnimation
|
Returns:
- Type:
-
Promise.<LedringAnimation>
(async) registerScreensaver(name, animation) → {Promise.<any>}
Register a LED Ring screensaver.
Requires the
homey:manager:ledring
permission. For more information about permissions read the Permissions tutorial.
Parameters:
Name | Type | Description |
---|---|---|
name |
string
|
Name of the animation as defined in your app's |
animation |
LedringAnimation
|
Returns:
- Type:
-
Promise.<any>
(async) unregisterAnimation(animation) → {Promise.<LedringAnimation>}
Unregister a LED Ring animation.
Requires the
homey:manager:ledring
permission. For more information about permissions read the Permissions tutorial.
Parameters:
Name | Type | Description |
---|---|---|
animation |
LedringAnimation
|
Returns:
- Type:
-
Promise.<LedringAnimation>
(async) unregisterScreensaver(name, animation) → {Promise.<any>}
Unregister a LED Ring screensaver.
Requires the
homey:manager:ledring
permission. For more information about permissions read the Permissions tutorial.
Parameters:
Name | Type | Description |
---|---|---|
name |
string
|
Name of the animation as defined in your app's |
animation |
LedringAnimation
|
Returns:
- Type:
-
Promise.<any>