From ff435a269fd8f68e58e0366df9e74643c4896277 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Fri, 1 May 2020 22:58:53 +0200 Subject: [PATCH] Rename Light to LightEntity (#477) * Rename Light to LightEntity * Add link to base class * Apply suggestions from code review Co-authored-by: Martin Hjelmare --- docs/entity_light.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/entity_light.md b/docs/entity_light.md index 05ff8119..eec06418 100644 --- a/docs/entity_light.md +++ b/docs/entity_light.md @@ -4,7 +4,7 @@ sidebar_label: Light --- -A light entity is a device that controls the brightness, RGB value,color temperature and effects of a light source. +A light entity controls the brightness, hue and saturation color value, white value, color temperature and effects of a light source. Derive platform entities from [`homeassistant.components.light.LightEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/__init__.py). ## Properties @@ -38,7 +38,7 @@ A light entity is a device that controls the brightness, RGB value,color tempera # Turn on Light Device ```python -class MyLightDevice(LightDevice): +class MyLightEntity(LightEntity): def turn_on(self, **kwargs): """Turn the device on.""" @@ -49,7 +49,7 @@ class MyLightDevice(LightDevice): # Turn Off Light Device ```python -class MyLightDevice(LightDevice): +class MyLightEntity(LightEntity): def turn_off(self, **kwargs): """Turn the device off."""