[components] Tidy up name/id (#4155)

2024-11-10 10:11:29 +01:00 · 2024-08-14 14:01:19 +12:00 · 2024-08-14 14:01:19 +12:00 · 3a5ecc9055
commit 3a5ecc9055
parent 9169262e5f
7 changed files with 9 additions and 47 deletions
--- a/components/copy.rst
+++ b/components/copy.rst
@ -26,7 +26,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The binary sensor that should be mirrored.
- **name** (**Required**, string): The name of the binary sensor.
 - All other options from :ref:`Binary Sensor <config-binary_sensor>`.

 Copy Button
@ -44,7 +43,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The button that should be mirrored.
- **name** (**Required**, string): The name of the button.
 - All other options from :ref:`Button <config-button>`.

 Copy Cover
@ -62,7 +60,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The cover that should be mirrored.
- **name** (**Required**, string): The name of the cover.
 - All other options from :ref:`Cover <config-cover>`.

 Copy Fan
@ -80,7 +77,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The fan that should be mirrored.
- **name** (**Required**, string): The name of the fan.
 - All other options from :ref:`Fan <config-fan>`.

 Copy Lock
@ -98,7 +94,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The lock that should be mirrored.
- **name** (**Required**, string): The name of the lock.
 - All other options from :ref:`Lock <config-lock>`.

 Copy Number
@ -116,7 +111,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The number that should be mirrored.
- **name** (**Required**, string): The name of the number.
 - All other options from :ref:`Number <config-number>`.

 Copy Select
@ -134,7 +128,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The select that should be mirrored.
- **name** (**Required**, string): The name of the select.
 - All other options from :ref:`Select <config-select>`.

 .. _copy-sensor:
@ -154,7 +147,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The sensor that should be mirrored.
- **name** (**Required**, string): The name of the sensor.
 - All other options from :ref:`Sensor <config-sensor>`.

 Copy Switch
@ -172,7 +164,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The switch that should be mirrored.
- **name** (**Required**, string): The name of the switch.
 - All other options from :ref:`Switch <config-switch>`.

 Copy Text Sensor
@ -190,7 +181,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The text sensor that should be mirrored.
- **name** (**Required**, string): The name of the text sensor.
 - All other options from :ref:`Text Sensor <config-text_sensor>`.

 Copy Text
@ -208,7 +198,6 @@ Configuration variables:
 ************************

 - **source_id** (**Required**, :ref:`config-id`): The text that should be mirrored.
- **name** (**Required**, string): The name of the number.
 - All other options from :ref:`Text <config-text>`.

 See Also
--- a/components/fingerprint_grow.rst
+++ b/components/fingerprint_grow.rst
@ -83,9 +83,7 @@ Binary Sensor

 Configuration variables:

- **name** (**Required**, string): The name for the enrolling binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
+- All options from :ref:`Binary Sensor <config-binary_sensor>`.


 Sensor
--- a/components/gps.rst
+++ b/components/gps.rst
@ -49,39 +49,27 @@ Configuration variables:
 ------------------------
 - **latitude** (*Optional*): Include the Latitude as a sensor

-  - **name** (**Required**, string): The name to give the latitude sensor
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  - All options from :ref:`Sensor <config-sensor>`.

 - **longitude** (*Optional*): Include the Longitude as a sensor

-  - **name** (**Required**, string): The name to give the longitude sensor
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  - All options from :ref:`Sensor <config-sensor>`.

 - **speed** (*Optional*): Include the measured speed as a sensor

-  - **name** (**Required**, string): The name to give the speed sensor
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  - All options from :ref:`Sensor <config-sensor>`.

 - **course** (*Optional*): Include the measured course as a sensor

-  - **name** (**Required**, string): The name to give the course sensor
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  - All options from :ref:`Sensor <config-sensor>`.

 - **altitude** (*Optional*): Include the measured altitude as a sensor

-  - **name** (**Required**, string): The name to give the altitude sensor
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  - All options from :ref:`Sensor <config-sensor>`.

 - **satellites** (*Optional*): Include the number of tracking satellites being used as a sensor

-  - **name** (**Required**, string): The name to give the tracking satellites sensor
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  - All options from :ref:`Sensor <config-sensor>`.

 See Also
 --------
--- a/components/remote_receiver.rst
+++ b/components/remote_receiver.rst
@ -234,8 +234,6 @@ then immediately OFF.
 Configuration variables:
 ************************

- **name** (**Required**, string): The name for the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - **receiver_id** (*Optional*, :ref:`config-id`): The remote receiver to receive the
  remote code with. Required if multiple receivers configured.
 - All other options from :ref:`Binary Sensor <config-binary_sensor>`.
--- a/components/sim800l.rst
+++ b/components/sim800l.rst
@ -76,9 +76,7 @@ Configuration variables:

 - **rssi** (*Optional*): The informed Received signal strength indication (RSSI) in dBm.

-  - **name** (**Required**, string): The name for the rssi sensor.
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Sensor <config-sensor>`.
+  - All options from :ref:`Sensor <config-sensor>`.


 Binary Sensor
@ -95,9 +93,7 @@ Configuration variables:

 - **registered** (*Optional*): Indicates if the SIM800L has successfully registered in the cellular network.

-  - **name** (**Required**, string): The name for the registered binary sensor.
-  - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
-  - All other options from :ref:`Binary Sensor <config-binary_sensor>`.
+  - All options from :ref:`Binary Sensor <config-binary_sensor>`.

 .. _sim800l-on_sms_received:

--- a/components/sun.rst
+++ b/components/sun.rst
@ -81,8 +81,6 @@ Configuration variables:

 - **type** (**Required**, string): The type of value to track. One of ``elevation`` and
  ``azimuth``.
- **name** (**Required**, string): The name of the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Sensor <config-sensor>`.

 ``sun`` Text Sensor
@ -109,13 +107,10 @@ Configuration variables:

 - **type** (**Required**, string): The type of value to track. One of ``sunrise`` and
  ``sunset``.
- **name** (**Required**, string): The name of the text sensor.
 - **elevation** (*Optional*, float): The elevation to calculate the next sunrise/sunset event
  for. Defaults to -0.833° (the horizon, slightly less than 0° to compensate for atmospheric refraction).
 - **format** (*Optional*, string): The format to format the time value with, see :ref:`strftime`
  for more information. Defaults to ``%X``.
-
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - All other options from :ref:`Text Sensor <config-text_sensor>`.

 .. _sun-is_above_below_horizon-condition:
--- a/components/touchscreen/index.rst
+++ b/components/touchscreen/index.rst
@ -292,8 +292,6 @@ buttons.
 Configuration variables:
 ************************

- **name** (*Optional*, string): The name for the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
 - **touchscreen_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the touchscreen.
 - **x_min** (**Required**, int): Left coordinate of the screen area to be detected as the virtual button.
 - **x_max** (**Required**, int): Right coordinate of the screen area to be detected as the virtual button.