BrightnessCommands
@Generated(value = ["GoogleHomePlatformCodegen"])
interface BrightnessCommands
Brightness |
API for the Brightness trait. |
Summary
Public functions |
|
|---|---|
suspend Unit |
brightnessStep(Incremental step brightness. |
BatchableCommand<Unit> |
brightnessStepBatchable(The batchable version of |
suspend Unit |
moveToBrightness(brightnessPercent: UByte)Move the brightness of the device to the specified brightness. |
BatchableCommand<Unit> |
moveToBrightnessBatchable(brightnessPercent: UByte)The batchable version of |
Public functions
brightnessStep
suspend fun brightnessStep(
stepMode: BrightnessTrait.BrightnessStepModeEnum,
step: UByte
): Unit
Incremental step brightness. If brightness + step is greater than 100, the brightness is set to 100. If brightness + step is less than 0, the brightness is set to 0.
| Parameters | |
|---|---|
stepMode: BrightnessTrait.BrightnessStepModeEnum |
Indicates whether to increase or decrease the brightness. |
step: UByte |
Indicates the increment by which to increase or decrease the brightness. Valid values are between 0 and 100. |
brightnessStepBatchable
fun brightnessStepBatchable(
stepMode: BrightnessTrait.BrightnessStepModeEnum,
step: UByte
): BatchableCommand<Unit>
The batchable version of brightnessStep command.
Incremental step brightness. If brightness + step is greater than 100, the brightness is set to 100. If brightness + step is less than 0, the brightness is set to 0.
| Parameters | |
|---|---|
stepMode: BrightnessTrait.BrightnessStepModeEnum |
Indicates whether to increase or decrease the brightness. |
step: UByte |
Indicates the increment by which to increase or decrease the brightness. Valid values are between 0 and 100. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |
moveToBrightness
suspend fun moveToBrightness(brightnessPercent: UByte): Unit
Move the brightness of the device to the specified brightness.
| Parameters | |
|---|---|
brightnessPercent: UByte |
The desired brightness percentage setting in the range of 0 to 100. |
moveToBrightnessBatchable
fun moveToBrightnessBatchable(brightnessPercent: UByte): BatchableCommand<Unit>
The batchable version of moveToBrightness command.
Move the brightness of the device to the specified brightness.
| Parameters | |
|---|---|
brightnessPercent: UByte |
The desired brightness percentage setting in the range of 0 to 100. |
| Returns | |
|---|---|
BatchableCommand<Unit> |
BatchableCommand |