LightEffectsCommands
@Generated(value = ["GoogleHomePlatformCodegen"])
interface LightEffectsCommands
LightEffects |
API for the LightEffects trait. |
Summary
Public functions |
|
|---|---|
suspend Unit |
pulseEffectSet(durationSeconds: UInt, color: LightEffectsTrait.Color)Activates the pulse effect. |
BatchableCommand<Unit> |
pulseEffectSetBatchable(The batchable version of |
suspend Unit |
sleepEffectSet(durationSeconds: UInt)Activates the sleep effect. |
BatchableCommand<Unit> |
sleepEffectSetBatchable(durationSeconds: UInt)The batchable version of |
suspend Unit |
Stops the active effect. |
BatchableCommand<Unit> |
The batchable version of |
suspend Unit |
wakeEffectSet(durationSeconds: UInt)Activates the wake effect. |
BatchableCommand<Unit> |
wakeEffectSetBatchable(durationSeconds: UInt)The batchable version of |
Public functions
pulseEffectSet
suspend fun pulseEffectSet(durationSeconds: UInt, color: LightEffectsTrait.Color): Unit
Activates the pulse effect.
| Parameters | |
|---|---|
durationSeconds: UInt |
Duration for the pulse effect, in seconds. |
color: LightEffectsTrait.Color |
Color of the light for the duration of the effect. |
pulseEffectSetBatchable
fun pulseEffectSetBatchable(
durationSeconds: UInt,
color: LightEffectsTrait.Color
): BatchableCommand<Unit>
The batchable version of pulseEffectSet command.
Activates the pulse effect.
| Parameters | |
|---|---|
durationSeconds: UInt |
Duration for the pulse effect, in seconds. |
color: LightEffectsTrait.Color |
Color of the light for the duration of the effect. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
sleepEffectSet
suspend fun sleepEffectSet(durationSeconds: UInt): Unit
Activates the sleep effect.
| Parameters | |
|---|---|
durationSeconds: UInt |
Duration for the sleep effect, in seconds. |
sleepEffectSetBatchable
fun sleepEffectSetBatchable(durationSeconds: UInt): BatchableCommand<Unit>
The batchable version of sleepEffectSet command.
Activates the sleep effect.
| Parameters | |
|---|---|
durationSeconds: UInt |
Duration for the sleep effect, in seconds. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
stopEffectBatchable
fun stopEffectBatchable(): BatchableCommand<Unit>
The batchable version of stopEffect command.
Stops the active effect.
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
wakeEffectSet
suspend fun wakeEffectSet(durationSeconds: UInt): Unit
Activates the wake effect.
| Parameters | |
|---|---|
durationSeconds: UInt |
Duration for the wake effect, in seconds. |
wakeEffectSetBatchable
fun wakeEffectSetBatchable(durationSeconds: UInt): BatchableCommand<Unit>
The batchable version of wakeEffectSet command.
Activates the wake effect.
| Parameters | |
|---|---|
durationSeconds: UInt |
Duration for the wake effect, in seconds. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |