From 8f245b62569c8e2ac7df3493fd10bc51d1cc1cf8 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Mon, 19 Jun 2023 19:18:47 +0200 Subject: [PATCH] Update light documentation with color_temp in K (#1805) --- docs/core/entity/light.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/core/entity/light.md b/docs/core/entity/light.md index 20ae067b..ee7eced5 100644 --- a/docs/core/entity/light.md +++ b/docs/core/entity/light.md @@ -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 | 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_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. | 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. -| min_mireds | int | int | Return the coldest color_temp that this light supports. +| max_color_temp_kelvin | int | int | Return the coldest color_temp_kelvin 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. | 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.