[light] Tidy up name/id (#4145)

* [light] Tidy up name/id

* Update components/light/shelly_dimmer.rst

---------

Co-authored-by: Keith Burzinski <kbx81x@gmail.com>

components/light/binary.rst

@@ -24,12 +24,7 @@ The ``binary`` light platform creates a simple ON/OFF-only light from a
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
-- **output** (**Required**, :ref:`config-id`): The id of the
-  binary :ref:`output` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light, though binary lights
-  only support very few of them.
+- **output** (**Required**, :ref:`config-id`): The id of the binary :ref:`output` to use for this light.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/color_temperature.rst

@@ -23,7 +23,6 @@ and the other channel controls the brightness.
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **color_temperature** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the color temperature.
 - **brightness** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the brightness.
 - **cold_white_color_temperature** (**Required**, float): The coldest color temperature supported by this light. This
@@ -32,8 +31,6 @@ Configuration variables:
 - **warm_white_color_temperature** (**Required**, float): The warmest color temperature supported by this light. This
   is the highest value when expressed in `mireds <https://en.wikipedia.org/wiki/Mired>`__, or the lowest value when
   expressed in Kelvin.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/cwww.rst

@@ -36,7 +36,6 @@ calculation assumes that both lights have the same illuminance, which might not
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **cold_white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the cold white channel.
 - **warm_white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the warm white channel.
 - **cold_white_color_temperature** (*Optional*, float): The color temperature (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
@@ -44,8 +43,6 @@ Configuration variables:
 - **warm_white_color_temperature** (*Optional*, float): The color temperature (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
   of the warm white channel. Note that this option is required to control the mixing from Home Assistant.
 - **constant_brightness** (*Optional*, boolean): When enabled, this will keep the overall brightness of the cold and warm white channels constant by limiting the combined output to 100% of a single channel. This reduces the possible overall brightness but is necessary for some power supplies that are not able to run both channels at full brightness at once. Defaults to ``false``.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/fastled.rst

@@ -55,7 +55,6 @@ Clockless FastLED lights differ from the
 Configuration variables:
 ************************
 
-- **name** (**Required**, string): The name of the light.
 - **chipset** (**Required**, string): Set a chipset to use.
   See :ref:`fastled_clockless-chipsets` for options.
 - **pin** (**Required**, :ref:`config-pin`): The pin for the data line of the FastLED light.
@@ -67,8 +66,6 @@ Configuration variables:
 - **max_refresh_rate** (*Optional*, :ref:`config-time`):
   A time interval used to limit the number of commands a light can handle per second. For example
   16ms will limit the light to a refresh rate of about 60Hz. Defaults to the default value for the used chipset.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 .. _fastled_clockless-chipsets:
@@ -135,7 +132,6 @@ whereas the clockless lights only need a single pin.
 Configuration variables:
 ************************
 
-- **name** (**Required**, string): The name of the light.
 - **chipset** (**Required**, string): Set a chipset to use. See :ref:`fastled_spi-chipsets` for options.
 - **data_pin** (**Required**, :ref:`config-pin`): The pin for the data line of the FastLED light.
 - **clock_pin** (**Required**, :ref:`config-pin`): The pin for the clock line of the FastLED light.
@@ -150,7 +146,6 @@ Configuration variables:
 - **data_rate** (*Optional*, frequency): The data rate to use for shifting data to the light. Can help if you
   have long cables or slow level-shifters.
 - **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 .. _fastled_spi-chipsets:

components/light/hbridge.rst

@@ -34,8 +34,6 @@ control the colors in the :ref:`light control actions <light-turn_on_action>`, y
 Configuration variables:
 ------------------------
 
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-- **name** (**Required**, string): The name of the light.
 - **pin_a** (**Required**, :ref:`config-id`): The id of the first float :ref:`output` to use for this light.
 - **pin_b** (**Required**, :ref:`config-id`): The id of the second float :ref:`output` to use for this light.
 - All other options from :ref:`Light <config-light>`.

components/light/index.rst

@@ -26,7 +26,8 @@ All light configuration schemas inherit these options.
 
 Configuration variables:
 
-- **name** (**Required**, string): The name of the light.
+- **id** (*Optional*, string): Manually specify the ID for code generation. At least one of **id** and **name** must be specified.
+- **name** (*Optional*, string): The name of the light. At least one of **id** and **name** must be specified.
 
   .. note::
 

components/light/monochromatic.rst

@@ -30,10 +30,7 @@ The ``monochromatic`` light platform creates a simple brightness-only light from
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **output** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for this light.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/neopixelbus.rst

@@ -37,10 +37,7 @@ Configuration variables:
 
 **Base Options:**
 
-- **name** (**Required**, string): The name of the light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - **num_leds** (**Required**, int): The number of LEDs attached.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
 
 **Type Options:**
 
@@ -87,8 +84,6 @@ If you have one line, only specify ``pin``, otherwise specify both ``clock_pin``
 - **clock_pin** (**Required**, :ref:`config-pin`): The pin for the clock line of the light, for two-wire lights.
 - **data_pin** (**Required**, :ref:`config-pin`): The pin for the data line of the light, for two-wire lights.
 
-**Advanced Options:**
-
 - All other options from :ref:`Light <config-light>`.
 
 .. warning::

components/light/partition.rst

@@ -90,7 +90,6 @@ Joining multiple LED lights into one
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **segments** (**Required**, list): A list of segments included in this partition.
 
   *For addressable segments:*
@@ -106,9 +105,6 @@ Configuration variables:
   - **single_light_id** (**Required**, :ref:`config-id`): The ID of a single addressable or non-addressable light.
     If an addressable light is specified, it will be treated as a single light in the partition.
 
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-
 - All other options from :ref:`Light <config-light>`.
 
 .. note::

components/light/rgb.rst

@@ -60,12 +60,9 @@ perceived intensity of different colors will generally vary. This can be done by
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **red** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the red channel.
 - **green** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the green channel.
 - **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/rgbct.rst

@@ -25,7 +25,6 @@ light from 5 :ref:`float output components <output>` (one for each channel).
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **red** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the red channel.
 - **green** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the green channel.
 - **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel.
@@ -41,8 +40,6 @@ Configuration variables:
   expressed in Kelvin.
 - **color_interlock** (*Optional*, boolean): When enabled, this will prevent white leds being on at the same
   time as RGB leds. See :ref:`rgbw_color_interlock` for more information. Defaults to ``false``.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/rgbw.rst

@@ -64,15 +64,12 @@ the ``color_mode`` option of the :ref:`light control actions <light-turn_on_acti
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **red** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the red channel.
 - **green** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the green channel.
 - **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel.
 - **white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the white channel.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
 - **color_interlock** (*Optional*, boolean): When enabled, this will prevent white leds being on at the same
   time as RGB leds. See :ref:`rgbw_color_interlock` for more information. Defaults to ``false``.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/rgbww.rst

@@ -69,7 +69,6 @@ the ``color_mode`` option of the :ref:`light control actions <light-turn_on_acti
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **red** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the red channel.
 - **green** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the green channel.
 - **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel.
@@ -89,8 +88,6 @@ Configuration variables:
   both channels at full brightness at once. Defaults to ``false``.
 - **color_interlock** (*Optional*, boolean): When enabled, this will prevent white leds being on at the same
   time as RGB leds. See :ref:`rgbw_color_interlock` for more information. Defaults to ``false``.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Light <config-light>`.
 
 See Also

components/light/shelly_dimmer.rst

@@ -10,7 +10,6 @@ A detailed analysis of the Shelly Dimmer 2 hardware is given `here <https://gith
 
 Warning!!! At the time of writing there seems to be no way to revert back to the "stock firmware", because there seems to be no way to revert to firmware of the STM32 co-processor.
 
-The 
 
 .. figure:: ../../images/shellydimmer2.jpg
     :align: center
@@ -49,7 +48,6 @@ An example of a configuration of this component:
 Configuration variables:
 ------------------------
 
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.
 
 .. note::
@@ -64,7 +62,6 @@ Configuration variables:
             baud_rate: 115200
 
 
-- **name** (**Required**, string): The name of the light.
 - **leading_edge** (*Optional*, boolean): `Dimming mode <https://en.wikipedia.org/wiki/Dimmer#Solid-state_dimmer>`_: ``true`` means leading edge, ``false`` is trailing edge. Defaults to ``false``.
 - **min_brightness** (*Optional*, int): Minimum brightness value on a scale from 0..1000, the default is 0.
 - **max_brightness** (*Optional*, int): Maximum brightness value on a scale from 0..1000, the default is 1000.

components/light/sonoff_d1.rst

@@ -94,8 +94,6 @@ This component is useless for devices other than Sonoff D1 dimmer.
 Configuration variables:
 ------------------------
 
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-- **name** (**Required**, string): The name of the light.
 - **use_rm433_remote** (*Optional*, boolean): Set to ``True`` if your setup uses Sonoff RM433
   or any other radio remote control. Properly setting this parameter allows the platform to
   identify what to do with incoming UART commands. RF chip is known to catch random commands

components/light/spi_led_strip.rst

@@ -35,10 +35,7 @@ perceived intensity of different colors will generally vary. This can be done by
 Configuration variables:
 ------------------------
 
-- **name** (**Required**, string): The name of the light.
 - **num_leds** (*Optional*, int): The number of LEDs attached. The default is 1.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - **data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz``, ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz`` (default), ``200kHz``, ``75kHz`` or ``1kHz``.
 - All other options from :ref:`Light <config-light>`.
 

components/light/status_led.rst

@@ -34,12 +34,8 @@ When the device is in OK state, the LED will be restored to the state of the ``b
 Configuration variables:
 ------------------------
 
-- **name** (*Optional*, string): The name of the light.
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - **pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The GPIO pin to operate the LED on.
 - **output** (*Optional*, :ref:`config-id`): The id of the binary :ref:`output` to use for this light.
-- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light, though binary lights
-  only support very few of them.
 - All other options from :ref:`Light <config-light>`.
 
 .. note::

components/light/tuya.rst

@@ -42,8 +42,6 @@ Now you can create the light.
 Configuration variables:
 ------------------------
 
-- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
-- **name** (**Required**, string): The name of the light.
 - **dimmer_datapoint** (*Optional*, int): The datapoint id number of the dimmer value.
 - **min_value_datapoint** (*Optional*, int): The datapoint id number of the MCU minimum value
   setting.  If this is set then ESPHome will sync the **min_value** to the MCU on startup.