BrightnessRelativeCommand

Description

Adjust device relative brightness. When brightness is set to any value greater than 0, if the device is off, it powers on, and the OnOffState.state changes to reflect that the device is on. Likewise, when brightness is set to 0, the device powers off and the OnOffState.state changes accordingly.

Fields

Key Type Description

Key	Type	Description
`devices`	[Device]	Devices such as lights that support changing brightness. Required Variable is allowed.
`brightnessRelativePercent`	Number	The exact percentage of brightness to change. Optional To use this field, all the following fields CANNOT be used: brightnessRelativeWeight Variable is allowed.
`brightnessRelativeWeight`	Number	This indicates the ambiguous amount of the brightness change. From small amount to large amount, this param will be scaled to integer 0 to 5, with the sign to indicate direction. Optional Variable is allowed.

devices

[Device]

Devices such as lights that support changing brightness.

Required

Variable is allowed.

brightnessRelativePercent

Number

The exact percentage of brightness to change.

Optional

To use this field, all the following fields CANNOT be used: brightnessRelativeWeight

Variable is allowed.

brightnessRelativeWeight

Number

This indicates the ambiguous amount of the brightness change. From small amount to large amount, this param will be scaled to integer 0 to 5, with the sign to indicate direction.

Optional

Variable is allowed.

Examples

actions:
  type: device.command.BrightnessRelative
  devices: My Device - Room Name
  brightnessRelativePercent: 50