From 042121b63f1fb96b016d969931fe697bdaad9d64 Mon Sep 17 00:00:00 2001 From: Maurice Makaay Date: Sun, 18 Apr 2021 16:33:25 +0200 Subject: [PATCH] Documented light component options. --- doc/configuration.md | 63 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 60 insertions(+), 3 deletions(-) diff --git a/doc/configuration.md b/doc/configuration.md index 037675c..79ca0bc 100644 --- a/doc/configuration.md +++ b/doc/configuration.md @@ -1,4 +1,4 @@ -[Index](../README.md) | [Flashing guide](flashing.md) > +< [Installation guide](installation.md) | [Index](../README.md) | [Flashing guide](flashing.md) > # Configuration guide @@ -7,7 +7,7 @@ In the following table, you can find what components are used for exposing what | Part | Component(s) | | -------------------------- |--------------------------------------------------------| - | ESP32 pinouts | [platform 'xiaomi_bslamp2'](#platform-xiaomi-bslamp2) | + | ESP32 pinouts | [platform xiaomi_bslamp2](#platform-xiaomi_bslamp2) | | RGBWW LEDs | [light](#light) | | Front Panel Power button | [binary_sensor](#binary_sensor) | | Front Panel Color button | [binary_sensor](#binary_sensor) | @@ -27,7 +27,7 @@ I do mention it here for completeness sake, but generally you will not have to a following configuration option to your yaml file. It is loaded automatically by the components that need it, and the GPIO + I2C configurations are fully prepared to work for the Bedside Lamp 2 wiring out of the box. -Therefore, you will not find this piece of configuration in the [example.yaml](doc/example.yaml). +Therefore, you will not find this piece of configuration in the [example.yaml](example.yaml). Having said that, here are the configuration options: @@ -54,6 +54,60 @@ to different pins. ## Component: light +The light component creates an RGBWW light. This means that it can do colored light and +cold/warm white light based on a color temperature. + +```yaml +light: + - platform: xiaomi_bslamp2 + name: My Bedside Lamp + id: my_bedside_lamp + default_transition_length: 0.5s + effects: + - random: + name: Randomize + transition_length: 3s + update_interval: 3s + on_brightness: + - then: + - logger.log: The brightness changed! + presets: + my_color_presets: + red: { red: 100%, green: 0%, blue: 0% } + green: { red: 0%, green: 100%, blue: 0% } + blue: { red: 0%, green: 0%, blue: 100% } + yellow: { red: 100%, green: 100%, blue: 0% } + purple: { red: 100%, green: 0%, blue: 100% } + randomize: { effect: Randomize } + my_white_presets: + cold: { color_temperature: 153 mireds } + chilly: { color_temperature: 275 mireds } + luke: { color_temperature: 400 mireds } + warm: { color_temperature: 588 mireds +``` + +### Configuration variables: + +* **name** (**Required**, string): The name of the light. +* **id** (*Optional*, ID): Manually specify the ID used for code generation. By providing an id, + you can reference the light from automation rules (e.g. to turn on the light when the power + button is tapped) +* **default_transition_length** (*Optional*, Time): The default transition length to use when + no transition length is set in a light call. Defaults to 1s. +* **effects** (*Optional*, list): A list of [light effects](https://esphome.io/components/light/index.html#light-effects) + to use for this light. +* **presets** (*Optional*, dict): Used to define presets, that can be used from automations. + See [below](#light-presets) for detailed information. +* **on_brightness** (*Optional*, Action): An automation to perform when the brightness of the light is modified. +* All other options from [the base Light implementation](https://esphome.io/components/light/index.html#config-light), + except for options that handle color correction options like `gamma_correct` and `color_correct`. + These options are superceded by the fact that the light component has a fully customized + light model, that closely follows the light model of the original lamp's firmware. + +### Light presets + +TODO + ## Component: binary_sensor ## Component: sensor @@ -61,3 +115,6 @@ to different pins. ## Component: output ## Component: text_output + + +< [Installation guide](installation.md) | [Index](../README.md) | [Flashing guide](flashing.md) >