jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 09:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update light documentation with color_temp in K (#1805)

Browse Source
This commit is contained in:
Erik Montnemery 2023-06-19 19:18:47 +02:00 committed by GitHub
parent 56b74db6f1
commit 8f245b6256
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/core/entity/light.md
View File

@ -12,13 +12,13 @@ A light entity controls the brightness, hue and saturation color value, white va
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ----
| brightness | int | None | Return the brightness of this light between 1..255 | brightness | int | None | Return the brightness of this light between 1..255
| color_mode | string | None | Return the color mode of the light. The returned color mode must be present in the `supported_color_modes` property. | color_mode | string | None | Return the color mode of the light. The returned color mode must be present in the `supported_color_modes` property.
| color_temp | int | None | Return the CT color value in mireds. This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.COLOR_TEMP` and ignored otherwise. | color_temp_kelvin | int | None | Return the CT color value in K. This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.COLOR_TEMP` and ignored otherwise.
| effect | String | None | Return the current effect. | effect | String | None | Return the current effect.
| effect_list | list | None | Return the list of supported effects. | effect_list | list | None | Return the list of supported effects.
| hs_color | tuple | None | Return the hue and saturation color value (float, float). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.HS` and ignored otherwise. | hs_color | tuple | None | Return the hue and saturation color value (float, float). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.HS` and ignored otherwise.
| is_on | bool | `None` | Returns if the light entity is on or not. | is_on | bool | `None` | Returns if the light entity is on or not.
| max_mireds | int | int | Return the warmest color_temp that this light supports. | max_color_temp_kelvin | int | int | Return the coldest color_temp_kelvin that this light supports.
| min_mireds | int | int | Return the coldest color_temp that this light supports. | min_color_temp_kelvin | int | int | Return the warmest color_temp_kelvin that this light supports.
| rgb_color | tuple | None | Return the rgb color value (int, int, int). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.RGB` and ignored otherwise. | rgb_color | tuple | None | Return the rgb color value (int, int, int). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.RGB` and ignored otherwise.
| rgbw_color | tuple | None | Return the rgbw color value (int, int, int, int). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.RGBW` and ignored otherwise. | rgbw_color | tuple | None | Return the rgbw color value (int, int, int, int). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.RGBW` and ignored otherwise.
| rgbww_color | tuple | None | Return the rgbww color value (int, int, int, int, int). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.RGBWW` and ignored otherwise. | rgbww_color | tuple | None | Return the rgbww color value (int, int, int, int, int). This property will be copied to the light's state attribute when the light's color mode is set to `ColorMode.RGBWW` and ignored otherwise.