From af3bc031ffe290dfde4c71ed41f6dbff734951f8 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Tue, 13 Aug 2024 17:21:16 +1200 Subject: [PATCH 01/22] Add redirect from /components/images to /components/image (#4130) --- _redirects | 1 + 1 file changed, 1 insertion(+) diff --git a/_redirects b/_redirects index 6964b2242..0b7f37536 100644 --- a/_redirects +++ b/_redirects @@ -41,3 +41,4 @@ /cookbook/dual-r2-cover.html /cookbook/lambda_magic.html#one-button-cover-control 301 /ready-made/projects /projects/ 301 +/components/images /components/image 301 From 6e51acbfe7d0d0aadb0dc5568c0bed5a93b6a7c0 Mon Sep 17 00:00:00 2001 From: NP v/d Spek Date: Tue, 13 Aug 2024 07:21:58 +0200 Subject: [PATCH 02/22] fixed default *bits_per_sample* value (#4100) --- components/microphone/i2s_audio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/microphone/i2s_audio.rst b/components/microphone/i2s_audio.rst index dc44ccbe1..42aa8f389 100644 --- a/components/microphone/i2s_audio.rst +++ b/components/microphone/i2s_audio.rst @@ -44,7 +44,7 @@ Configuration variables: - **sample_rate** (*Optional*, positive integer): I2S sample rate. Defaults to ``16000``. - **bits_per_sample** (*Optional*, enum): The bit depth of the audio samples. Note that while set to ``32bit``, the samples will be scaled down to 16bit before being forwarded. - One of ``16bit`` or ``32bit``. Defaults to ``16bit``. + One of ``16bit`` or ``32bit``. Defaults to ``32bit``. - **use_apll** (*Optional*, boolean): I2S using APLL as main I2S clock, enable it to get accurate clock. Defaults to ``false``. - **i2s_mode** (*Optional*, enum): The I²S mode to use. One of ``primary`` or ``secondary``. Defaults to ``primary``. - **i2s_audio_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`I²S Audio ` you wish to use for this microphone. From cfdcb53878e79ade1ff4a68a12032e57bb57af8b Mon Sep 17 00:00:00 2001 From: Joeri de Graaf <4146844+jadegraaf@users.noreply.github.com> Date: Tue, 13 Aug 2024 07:24:01 +0200 Subject: [PATCH 03/22] Correct ENS160 default address (#4075) --- components/sensor/ens160.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/sensor/ens160.rst b/components/sensor/ens160.rst index 5325bf9f1..bd79ec2c0 100644 --- a/components/sensor/ens160.rst +++ b/components/sensor/ens160.rst @@ -81,7 +81,7 @@ Configuration variables: frequency of the ENS160 which is up to 1 second. - **address** (*Optional*, int): *I²C only.* Manually specify the I²C address of - the sensor. Defaults to ``0x53``. Another address can be ``0x52``. + the sensor. Defaults to ``0x52``. Another address can be ``0x53``. - **cs_pin** (*Required*, :ref:`Pin Schema `): *SPI only.* The Chip Select pin. From 9169262e5fd5ebefd821ee1a39b3ba48cd533a42 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 13:59:54 +1200 Subject: [PATCH 04/22] [switch] Tidy up name/id (#4151) --- components/switch/ble_client.rst | 1 - components/switch/factory_reset.rst | 4 +--- components/switch/index.rst | 3 ++- components/switch/modbus_controller.rst | 4 +--- components/switch/nextion.rst | 1 - components/switch/output.rst | 3 --- components/switch/restart.rst | 4 +--- components/switch/safe_mode.rst | 6 ++---- components/switch/shutdown.rst | 4 +--- components/switch/template.rst | 2 -- components/switch/tuya.rst | 2 -- components/switch/uart.rst | 2 -- 12 files changed, 8 insertions(+), 28 deletions(-) diff --git a/components/switch/ble_client.rst b/components/switch/ble_client.rst index 13ab0cabf..4e5d05e4f 100644 --- a/components/switch/ble_client.rst +++ b/components/switch/ble_client.rst @@ -35,7 +35,6 @@ Configuration variables: ------------------------ - **ble_client_id** (**Required**, :ref:`config-id`): ID of the associated BLE client. -- **id** (*Optional*, :ref:`config-id`): The ID to use for code generation, and for reference by dependent components. - All other options from :ref:`Switch `. See Also diff --git a/components/switch/factory_reset.rst b/components/switch/factory_reset.rst index 8c9eb5b00..71c870448 100644 --- a/components/switch/factory_reset.rst +++ b/components/switch/factory_reset.rst @@ -35,9 +35,7 @@ After reboot all states, parameters and variables will be reinitialized with the Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the switch. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Switch `. +- All options from :ref:`Switch `. See Also -------- diff --git a/components/switch/index.rst b/components/switch/index.rst index a9c8be4ca..4cbca2778 100644 --- a/components/switch/index.rst +++ b/components/switch/index.rst @@ -22,7 +22,8 @@ Base Switch Configuration Configuration variables: -- **name** (**Required**, string): The name of the switch. +- **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 switch. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/switch/modbus_controller.rst b/components/switch/modbus_controller.rst index 5114fd47e..bdbd0f844 100644 --- a/components/switch/modbus_controller.rst +++ b/components/switch/modbus_controller.rst @@ -11,8 +11,6 @@ and requires :doc:`/components/modbus_controller` to be configured. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the sensor. - **register_type** (**Required**): type of the modbus register. - ``coil``: Coils are 1-bit registers (on/off values) that are used to control discrete outputs. They may be read and/or written. Modbus *Function Code 1 (Read Coil Status)* will be used. @@ -48,7 +46,7 @@ Configuration variables: See :ref:`modbus_custom_command` how to use ``custom_command`` - **offset** (*Optional*, int): Offset from start address in bytes (only required for uncommon response encodings). If more than one register is written in a command, this value is used to find the start of this datapoint relative to the start address. The component calculates the size of the range based on offset and size of the value type. The value for offset depends on the register type. For holding input registers, the offset is in bytes. For coil and discrete input resisters, the LSB of the first data byte contains the coil addressed in the request. The other coils follow toward the high-order end of this byte and from low order to high order in subsequent bytes. For registers, the offset is the position of the relevant bit. To get the value of the coil register, 2 can be retrieved using ``address: 2`` / ``offset: 0`` or ``address: 0`` / ``offset 2``. - **restore_mode** (*Optional*): See :ref:`Switch `, since this configuration variable is inherited. The default value for this setting is ``DISABLED`` (recommended). - ``DISABLED`` leaves the initial state up to the hardware: usually the state lives in the device and ESPHome does not need to remember it. The switch frontend will show an undetermined + ``DISABLED`` leaves the initial state up to the hardware: usually the state lives in the device and ESPHome does not need to remember it. The switch frontend will show an undetermined state until the real state is retrieved from the device on the next refresh. Use any other setting if a reboot of your ESPHome device is tied to a reboot of the modbus device. diff --git a/components/switch/nextion.rst b/components/switch/nextion.rst index b8055bd36..c7824a702 100644 --- a/components/switch/nextion.rst +++ b/components/switch/nextion.rst @@ -34,7 +34,6 @@ See :doc:`/components/display/nextion` for setting up the display Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display. - **component_name** (*Optional*, string): The name of the Nextion component. - **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considered to be **on** diff --git a/components/switch/output.rst b/components/switch/output.rst index 5282f3564..8d0a4a493 100644 --- a/components/switch/output.rst +++ b/components/switch/output.rst @@ -27,9 +27,6 @@ Configuration variables: ------------------------ - **output** (**Required**, :ref:`config-id`): The ID of the output component to use. -- **name** (**Required**, string): The name for the switch. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - - All other options from :ref:`Switch `. See Also diff --git a/components/switch/restart.rst b/components/switch/restart.rst index e66be7c1e..b21f60e9b 100644 --- a/components/switch/restart.rst +++ b/components/switch/restart.rst @@ -22,9 +22,7 @@ through Home Assistant. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the switch. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Switch `. +- All options from :ref:`Switch `. See Also -------- diff --git a/components/switch/safe_mode.rst b/components/switch/safe_mode.rst index 9274eeb0e..e53a62741 100644 --- a/components/switch/safe_mode.rst +++ b/components/switch/safe_mode.rst @@ -5,7 +5,7 @@ Safe Mode Switch :description: Instructions for setting up switches that can remotely reboot the ESP in ESPHome into safe mode. :image: restart.svg -The ``safe_mode`` switch allows you to remotely reboot your node into :doc:`/components/safe_mode`. This is useful in certain situations where a misbehaving component, or low memory state is preventing Over-The-Air updates from completing successfully. +The ``safe_mode`` switch allows you to remotely reboot your node into :doc:`/components/safe_mode`. This is useful in certain situations where a misbehaving component, or low memory state is preventing Over-The-Air updates from completing successfully. This component requires :doc:`/components/safe_mode` to be configured. @@ -23,9 +23,7 @@ This component requires :doc:`/components/safe_mode` to be configured. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the switch. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Switch `. +- All options from :ref:`Switch `. See Also -------- diff --git a/components/switch/shutdown.rst b/components/switch/shutdown.rst index f2d331a86..7f1559e80 100644 --- a/components/switch/shutdown.rst +++ b/components/switch/shutdown.rst @@ -24,9 +24,7 @@ pressing the reset button or restarting the power supply. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the switch. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Switch `. +- All options from :ref:`Switch `. See Also -------- diff --git a/components/switch/template.rst b/components/switch/template.rst index 6164bbd58..74aec5b79 100644 --- a/components/switch/template.rst +++ b/components/switch/template.rst @@ -36,7 +36,6 @@ Possible return values for the optional lambda: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the switch. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated repeatedly to get the current state of the switch. - **turn_on_action** (*Optional*, :ref:`Action `): The action that should @@ -49,7 +48,6 @@ Configuration variables: - **assumed_state** (*Optional*, boolean): Whether the true state of the switch is not known. This will make the Home Assistant frontend show buttons for both ON and OFF actions, instead of hiding one of them when the switch is ON/OFF. Defaults to ``false``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Switch `. .. _switch-template-publish_action: diff --git a/components/switch/tuya.rst b/components/switch/tuya.rst index 8f1136668..0afff5a00 100644 --- a/components/switch/tuya.rst +++ b/components/switch/tuya.rst @@ -35,8 +35,6 @@ Based on this, you can create the switch as follows: Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the switch. - **switch_datapoint** (**Required**, int): The datapoint id number of the switch. - All other options from :ref:`Switch `. diff --git a/components/switch/uart.rst b/components/switch/uart.rst index 98957a318..fc8d53c2a 100644 --- a/components/switch/uart.rst +++ b/components/switch/uart.rst @@ -31,8 +31,6 @@ The ``uart`` switch platform allows you to send a pre-defined sequence of bytes Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (*Optional*, string): The name for the switch. - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub. - **data** (*Optional*, string or list of bytes): The data to send via UART. Either an ASCII string or a list of bytes or one or both of the following nested options (see example above). From 3a5ecc9055fac9fc9cd5738643ab914514f69415 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:01:19 +1200 Subject: [PATCH 05/22] [components] Tidy up name/id (#4155) --- components/copy.rst | 11 ----------- components/fingerprint_grow.rst | 4 +--- components/gps.rst | 24 ++++++------------------ components/remote_receiver.rst | 2 -- components/sim800l.rst | 8 ++------ components/sun.rst | 5 ----- components/touchscreen/index.rst | 2 -- 7 files changed, 9 insertions(+), 47 deletions(-) diff --git a/components/copy.rst b/components/copy.rst index 5cc7191c8..a2c212d93 100644 --- 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 `. 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 `. 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 `. 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 `. 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 `. 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 `. 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 `. .. _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 `. 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 `. 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 `. 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 `. See Also diff --git a/components/fingerprint_grow.rst b/components/fingerprint_grow.rst index cdba66074..9f1357bd8 100644 --- 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 `. +- All options from :ref:`Binary Sensor `. Sensor diff --git a/components/gps.rst b/components/gps.rst index 94a4efbc0..4a40483f7 100644 --- 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 `. + - All options from :ref:`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 `. + - All options from :ref:`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 `. + - All options from :ref:`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 `. + - All options from :ref:`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 `. + - All options from :ref:`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 `. + - All options from :ref:`Sensor `. See Also -------- diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst index 490b635cc..d2374f7c0 100644 --- 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 `. diff --git a/components/sim800l.rst b/components/sim800l.rst index 1f993dc37..73b8ea88c 100644 --- 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 `. + - All options from :ref:`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 `. + - All options from :ref:`Binary Sensor `. .. _sim800l-on_sms_received: diff --git a/components/sun.rst b/components/sun.rst index 0e0b7d936..656621a14 100644 --- 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 `. ``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 `. .. _sun-is_above_below_horizon-condition: diff --git a/components/touchscreen/index.rst b/components/touchscreen/index.rst index b1c2d0e6f..2e4bcb8be 100644 --- 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. From dc2c7aa02f3abf4b16fb5cd0e346aaea4a8f3095 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:02:34 +1200 Subject: [PATCH 06/22] [valve] Tidy up name/id (#4154) --- components/valve/index.rst | 3 ++- components/valve/template.rst | 2 -- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/components/valve/index.rst b/components/valve/index.rst index c6f196ac1..912bc676c 100644 --- a/components/valve/index.rst +++ b/components/valve/index.rst @@ -30,7 +30,8 @@ All valve config schemas inherit from this schema - you can set these keys for v Configuration variables: -- **name** (**Required**, string): The name for the valve. +- **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 for the valve. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/valve/template.rst b/components/valve/template.rst index ddb517a58..d295920e3 100644 --- a/components/valve/template.rst +++ b/components/valve/template.rst @@ -41,7 +41,6 @@ Possible return values for the optional lambda: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the valve. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated repeatedly to get the current state of the valve. - **open_action** (*Optional*, :ref:`Action `): The action that should be performed when the remote @@ -65,7 +64,6 @@ Configuration variables: - **position_action** (*Optional*, :ref:`Action `): The action that should be performed when the remote (like Home Assistant's frontend) requests the valve be set to a specific position. The desired position is available in the lambda in the ``pos`` variable. Requires ``has_position`` (above) to be set to ``true``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Valve `. .. _valve-template-publish_action: From 9839ac3a5009672f868bacd5a1ffdef45847118e Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:03:19 +1200 Subject: [PATCH 07/22] [update] Tidy up name/id (#4153) --- components/update/index.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/components/update/index.rst b/components/update/index.rst index d4ac6a4c0..e1eb18454 100644 --- a/components/update/index.rst +++ b/components/update/index.rst @@ -21,8 +21,14 @@ install it on its own. Configuration variables: ------------------------ -- **name** (*Optional*, string): The name to use for the update component. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. At least one of **id** and **name** must be specified. +- **name** (*Optional*, string): The name of the update entity. At least one of **id** and **name** must be specified. + + .. note:: + + If you have a :ref:`friendly_name ` set for your device and + you want the light to use that name, you can set ``name: None``. + - **device_class** (*Optional*, string): The device class for the update entity. See https://www.home-assistant.io/integrations/binary_sensor/#device-class for a list of available options. - **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend From 9892a0fce91793fe1d48bd1002d4892af4930bbc Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:33:05 +1200 Subject: [PATCH 08/22] [sensor] Tidy up name/id (#4150) * [sensor] Tidy up name/id * Add missing line * Add missing line to sen5x --- components/sensor/a01nyub.rst | 5 +- components/sensor/a02yyuw.rst | 5 +- components/sensor/absolute_humidity.rst | 1 - components/sensor/adc.rst | 2 - components/sensor/ads1115.rst | 3 +- components/sensor/aht10.rst | 8 +- components/sensor/am2320.rst | 8 +- components/sensor/am43.rst | 9 +- components/sensor/apds9960.rst | 4 - components/sensor/b_parasite.rst | 19 ++- components/sensor/bh1750.rst | 3 - components/sensor/binary_sensor_map.rst | 1 - components/sensor/ble_rssi.rst | 2 - components/sensor/bme680.rst | 12 +- components/sensor/bme680_bsec.rst | 30 +--- components/sensor/bmp085.rst | 9 +- components/sensor/bmp280.rst | 5 - components/sensor/ccs811.rst | 16 +- components/sensor/ct_clamp.rst | 2 - components/sensor/dht.rst | 8 +- components/sensor/dht12.rst | 8 +- components/sensor/dps310.rst | 9 +- components/sensor/dsmr.rst | 180 ++++++--------------- components/sensor/ee895.rst | 12 +- components/sensor/ens160.rst | 32 ++-- components/sensor/ens210.rst | 8 +- components/sensor/esp32_hall.rst | 2 - components/sensor/ezo.rst | 1 - components/sensor/hdc1080.rst | 8 +- components/sensor/hm3301.rst | 14 +- components/sensor/homeassistant.rst | 2 - components/sensor/honeywellabp.rst | 4 +- components/sensor/hte501.rst | 8 +- components/sensor/hx711.rst | 2 - components/sensor/hydreon_rgxx.rst | 24 +-- components/sensor/hyt271.rst | 10 +- components/sensor/inkbird_ibsth1_mini.rst | 16 +- components/sensor/integration.rst | 2 - components/sensor/internal_temperature.rst | 2 - components/sensor/jsn_sr04t.rst | 9 +- components/sensor/max31855.rst | 7 +- components/sensor/max31865.rst | 2 - components/sensor/max44009.rst | 6 +- components/sensor/max6675.rst | 2 - components/sensor/max9611.rst | 12 +- components/sensor/mcp9600.rst | 9 +- components/sensor/mcp9808.rst | 2 - components/sensor/mlx90393.rst | 8 - components/sensor/modbus_controller.rst | 2 - components/sensor/mpl3115a2.rst | 12 +- components/sensor/mqtt_subscribe.rst | 2 - components/sensor/ms5611.rst | 9 +- components/sensor/nextion.rst | 1 - components/sensor/ntc.rst | 2 - components/sensor/pulse_counter.rst | 7 - components/sensor/pulse_meter.rst | 1 - components/sensor/qmp6988.rst | 11 +- components/sensor/resistance.rst | 2 - components/sensor/rotary_encoder.rst | 2 - components/sensor/ruuvitag.rst | 56 ++----- components/sensor/scd30.rst | 14 +- components/sensor/scd4x.rst | 12 +- components/sensor/sdp3x.rst | 2 - components/sensor/sen5x.rst | 28 +--- components/sensor/senseair.rst | 4 +- components/sensor/sgp30.rst | 16 +- components/sensor/sgp4x.rst | 4 - components/sensor/sht3xd.rst | 8 +- components/sensor/sht4x.rst | 8 +- components/sensor/shtcx.rst | 8 +- components/sensor/sm300d2.rst | 30 +--- components/sensor/smt100.rst | 15 +- components/sensor/sps30.rst | 40 ++--- components/sensor/sts3x.rst | 2 - components/sensor/tee501.rst | 2 - components/sensor/template.rst | 2 - components/sensor/tmp102.rst | 2 - components/sensor/tmp1075.rst | 5 +- components/sensor/tmp117.rst | 3 +- components/sensor/tof10120.rst | 2 - components/sensor/total_daily_energy.rst | 2 - components/sensor/tsl2561.rst | 2 - components/sensor/tsl2591.rst | 15 +- components/sensor/tuya.rst | 2 - components/sensor/ultrasonic.rst | 1 - components/sensor/veml7700.rst | 34 ++-- components/sensor/wifi_signal.rst | 4 +- components/sensor/xiaomi_ble.rst | 2 +- components/sensor/xiaomi_miscale.rst | 6 +- components/sensor/zyaura.rst | 12 +- 90 files changed, 242 insertions(+), 705 deletions(-) diff --git a/components/sensor/a01nyub.rst b/components/sensor/a01nyub.rst index 04371bd0a..be57d228d 100644 --- a/components/sensor/a01nyub.rst +++ b/components/sensor/a01nyub.rst @@ -6,7 +6,7 @@ A01NYUB Waterproof Ultrasonic Sensor :image: a01nyub.jpg :keywords: ultrasonic, DFRobot, A01NYUB -This sensor allows you to use A01NYUB waterproof ultrasonic sensor by DFRobot +This sensor allows you to use A01NYUB waterproof ultrasonic sensor by DFRobot (`datasheet `__) with ESPHome to measure distances. This sensor can measure ranges between 28 centimeters and 750 centimeters with a resolution of 1 milimeter. @@ -27,12 +27,11 @@ To use the sensor, first set up an :ref:`uart` with a baud rate of 9600 and conn sensor: - platform: "a01nyub" name: "Distance" - + Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus ` you wish to use for this sensor. Use this if you want to use multiple UART buses at once. - All other options from :ref:`Sensor `. diff --git a/components/sensor/a02yyuw.rst b/components/sensor/a02yyuw.rst index 2fc928380..d090d0a8e 100644 --- a/components/sensor/a02yyuw.rst +++ b/components/sensor/a02yyuw.rst @@ -6,7 +6,7 @@ A02YYUW Waterproof Ultrasonic Sensor :image: a02yyuw.jpg :keywords: ultrasonic, DFRobot, A02YYUW -This sensor allows you to use A02YYUW waterproof ultrasonic sensor by DFRobot +This sensor allows you to use A02YYUW waterproof ultrasonic sensor by DFRobot (`datasheet `__) with ESPHome to measure distances. This sensor can measure ranges between 3 centimeters and 450 centimeters with a resolution of 1 milimeter. @@ -27,12 +27,11 @@ To use the sensor, first set up an :ref:`uart` with a baud rate of 9600 and conn sensor: - platform: "a02yyuw" name: "Distance" - + Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus ` you wish to use for this sensor. Use this if you want to use multiple UART buses at once. - All other options from :ref:`Sensor `. diff --git a/components/sensor/absolute_humidity.rst b/components/sensor/absolute_humidity.rst index 3ba963a81..b4a27de86 100644 --- a/components/sensor/absolute_humidity.rst +++ b/components/sensor/absolute_humidity.rst @@ -30,7 +30,6 @@ See the links at the bottom of the page for details on absolute humidity and the Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the absolute humidity sensor. - **temperature** (**Required**, :ref:`config-id`): The sensor that is used to measure the current temperature, in °C. - **humidity** (**Required**, :ref:`config-id`): The sensor that is used to measure the current relative humidity, in %. - **equation** (*Optional*): The saturated vapor pressure equation to use (see below). diff --git a/components/sensor/adc.rst b/components/sensor/adc.rst index d5fe6c2ef..364ba80b7 100644 --- a/components/sensor/adc.rst +++ b/components/sensor/adc.rst @@ -31,14 +31,12 @@ Configuration variables: - **pin** (**Required**, :ref:`config-pin`): The pin to measure the voltage on. Or on the ESP8266 or Raspberry Pi Pico it could alternatively be set to ``VCC``, see :ref:`adc-vcc`. -- **name** (**Required**, string): The name of the voltage sensor. - **attenuation** (*Optional*): Only on ESP32. Specify the ADC attenuation to use. See :ref:`adc-esp32_attenuation`. Defaults to ``0db``. - **raw** (*Optional*): Allows to read the raw ADC output without any conversion or calibration. See :ref:`adc-raw`. Defaults to ``false``. - **samples** (*Optional*): The amount of ADC readings to take per sensor update. On the ESP32 this value is ignored if ``attenuation`` is set to ``auto``. Defaults to ``1``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. .. note:: diff --git a/components/sensor/ads1115.rst b/components/sensor/ads1115.rst index 3e2eb83c4..eae66c79f 100644 --- a/components/sensor/ads1115.rst +++ b/components/sensor/ads1115.rst @@ -88,17 +88,16 @@ Configuration variables: - **multiplexer** (**Required**): The multiplexer channel of this sensor. Effectively means between which pins you want to measure voltage. - **gain** (**Required**, float): The gain of this sensor. -- **name** (**Required**, string): The name for this sensor. - **ads1115_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`ADS1115 Hub ` you want to use this sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **resolution** (*Optional*, string): the resolution of this sensor. Defaults to ``16 bits``. - ``16 bits`` - ``12 bits`` +- All other options from :ref:`Sensor `. Multiplexer and Gain -------------------- diff --git a/components/sensor/aht10.rst b/components/sensor/aht10.rst index e3550ce51..d41fec0cb 100644 --- a/components/sensor/aht10.rst +++ b/components/sensor/aht10.rst @@ -47,15 +47,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/am2320.rst b/components/sensor/am2320.rst index 9ed04dde9..6670626b2 100644 --- a/components/sensor/am2320.rst +++ b/components/sensor/am2320.rst @@ -40,15 +40,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/am43.rst b/components/sensor/am43.rst index 79637cda1..c057d8d4b 100644 --- a/components/sensor/am43.rst +++ b/components/sensor/am43.rst @@ -45,14 +45,11 @@ Configuration variables: - **ble_client_id** (**Required**, :ref:`config-id`): The id of the ``ble_client`` entry associated with the device. - **battery_level** (*Optional*): The information for the battery level sensor. - - **name** (**Required**, string): The name for the battery level sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. + - **illuminance** (*Optional*): The information for the light level sensor. - - **name** (**Required**, string): The name for the light level sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/apds9960.rst b/components/sensor/apds9960.rst index 0838841cf..60883aec6 100644 --- a/components/sensor/apds9960.rst +++ b/components/sensor/apds9960.rst @@ -69,7 +69,6 @@ measurements. Configuration variables: -- **name** (**Required**, string): The name for the sensor. - **type** (**Required**, string): The type of sensor measurement. One of - ``CLEAR`` @@ -78,7 +77,6 @@ Configuration variables: - ``BLUE`` - ``PROXIMITY`` -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. Binary Sensor @@ -89,7 +87,6 @@ measurements. Configuration variables: -- **name** (**Required**, string): The name for the binary sensor. - **direction** (**Required**, string): The direction to measure. One of: - ``UP`` @@ -97,7 +94,6 @@ Configuration variables: - ``LEFT`` - ``RIGHT`` -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. Troubleshooting: diff --git a/components/sensor/b_parasite.rst b/components/sensor/b_parasite.rst index 42089f036..661767093 100644 --- a/components/sensor/b_parasite.rst +++ b/components/sensor/b_parasite.rst @@ -42,24 +42,23 @@ Configuration variables - **mac_address** (**Required**): The MAC address of the device. - **temperature** (*Optional*): Air temperature in Celsius. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. + - **humidity** (*Optional*): Relative air humidity in %. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. + - **moisture** (*Optional*): Soil moisture in %. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. + - **battery_voltage** (*Optional*): Battery voltage in volts. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. + - **illuminance** (*Optional*): Illuminance in lux. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. See Also -------- diff --git a/components/sensor/bh1750.rst b/components/sensor/bh1750.rst index b571bef6e..ab2eb8399 100644 --- a/components/sensor/bh1750.rst +++ b/components/sensor/bh1750.rst @@ -35,14 +35,11 @@ your configuration for this sensor to work. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the sensor. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x23`` (address if address pin is pulled low). If the address pin is pulled high, the address is ``0x5C``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code - generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/binary_sensor_map.rst b/components/sensor/binary_sensor_map.rst index e23d0a014..132800a45 100644 --- a/components/sensor/binary_sensor_map.rst +++ b/components/sensor/binary_sensor_map.rst @@ -121,7 +121,6 @@ The maximum amount of observations/channels supported is 64. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **type** (**Required**, string): The sensor type. Should be one of: ``BAYESIAN``, ``GROUP``, or ``SUM``. - **channels** (**Required for GROUP or SUM types**): A list of channels that are mapped to certain values. diff --git a/components/sensor/ble_rssi.rst b/components/sensor/ble_rssi.rst index 4590f368c..56ebe944b 100644 --- a/components/sensor/ble_rssi.rst +++ b/components/sensor/ble_rssi.rst @@ -49,7 +49,6 @@ instructions for setting up this platform. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **mac_address** (*Optional*, MAC Address): The MAC address to track for this sensor. Note that exactly one of ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid`` must be present. @@ -67,7 +66,6 @@ Configuration variables: same building. - **ibeacon_minor** (*Optional*, int): The iBeacon minor identifier of the beacon that needs to be tracked. Usually used to identify beacons within an iBeacon group. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/bme680.rst b/components/sensor/bme680.rst index b8e581514..5aaf05a1f 100644 --- a/components/sensor/bme680.rst +++ b/components/sensor/bme680.rst @@ -41,33 +41,25 @@ Configuration variables: - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. See :ref:`bme680-oversampling`. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. - **pressure** (*Optional*): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. See :ref:`bme680-oversampling`. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. - **humidity** (*Optional*): The information for the humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. See :ref:`bme680-oversampling`. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. - **gas_resistance** (*Optional*): The information for the gas sensor. - - **name** (**Required**, string): The name for the gas resistance sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x76``. Another address can be ``0x77``. @@ -132,7 +124,7 @@ Add indoor air quality (IAQ) calculation and IAQ label, based on the values in t name: "BME680 Indoor Air Quality" id: iaq icon: "mdi:gauge" - # calculation: comp_gas = log(R_gas[ohm]) + 0.04 log(Ohm)/%rh * hum[%rh] + # calculation: comp_gas = log(R_gas[ohm]) + 0.04 log(Ohm)/%rh * hum[%rh] lambda: |- return log(id(gas_resistance).state) + 0.04 * id(humidity).state; state_class: "measurement" diff --git a/components/sensor/bme680_bsec.rst b/components/sensor/bme680_bsec.rst index 2b3e0780b..95d73f04c 100644 --- a/components/sensor/bme680_bsec.rst +++ b/components/sensor/bme680_bsec.rst @@ -125,54 +125,38 @@ Configuration variables: - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **sample_rate** (*Optional*, string): Optional sample rate override for this sensor. Can be ``lp`` for low power consumption, sampling every 3 seconds or ``ulp`` for ultra-low power, sampling every 5 minutes. - All other options from :ref:`Sensor `. - **pressure** (*Optional*): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **sample_rate** (*Optional*, string): Optional sample rate override for this sensor. Can be ``lp`` for low power consumption, sampling every 3 seconds or ``ulp`` for ultra-low power, sampling every 5 minutes. - All other options from :ref:`Sensor `. - **humidity** (*Optional*): The information for the humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **sample_rate** (*Optional*, string): Optional sample rate override for this sensor. Can be ``lp`` for low power consumption, sampling every 3 seconds or ``ulp`` for ultra-low power, sampling every 5 minutes. - All other options from :ref:`Sensor `. - **gas_resistance** (*Optional*): The information for the gas sensor. - - **name** (**Required**, string): The name for the gas resistance sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **iaq** (*Optional*): The information for the IAQ sensor. - - **name** (**Required**, string): The name for the IAQ sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **iaq_accuracy** (*Optional*): The information for the numeric IAQ accuracy sensor. - - **name** (**Required**, string): The name for the IAQ accuracy sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **co2_equivalent** (*Optional*): The information for the CO₂ equivalent sensor. - - **name** (**Required**, string): The name for the CO₂ equivalent sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **breath_voc_equivalent** (*Optional*): The information for the Breath VOC equivalent humidity sensor. - - **name** (**Required**, string): The name for the Breath VOC equivalent sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. Text Sensor ----------- @@ -186,9 +170,7 @@ Configuration variables: - **iaq_accuracy** (*Optional*): The information for the IAQ accuracy sensor. Shows: Stabilizing, Uncertain, Calibrating, Calibrated. - - **name** (**Required**, string): The name for the IAQ accuracy sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`TextSensor `. + - All options from :ref:`TextSensor `. .. figure:: images/bme680-bsec-ui.png :align: center diff --git a/components/sensor/bmp085.rst b/components/sensor/bmp085.rst index 3f3c6d82a..f8402f737 100644 --- a/components/sensor/bmp085.rst +++ b/components/sensor/bmp085.rst @@ -40,16 +40,11 @@ Configuration variables: - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature - sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pressure** (*Optional*): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x77``. diff --git a/components/sensor/bmp280.rst b/components/sensor/bmp280.rst index df7bc8041..ff0c6abbc 100644 --- a/components/sensor/bmp280.rst +++ b/components/sensor/bmp280.rst @@ -38,19 +38,14 @@ Configuration variables: - **temperature** (*Optional*): The information for the temperature. sensor - - **name** (**Required**, string): The name for the temperature - sensor. - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. See :ref:`Oversampling Options `. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. - **pressure** (*Optional*): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - **oversampling** (*Optional*): The oversampling parameter for the pressure sensor. See :ref:`Oversampling Options `. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of diff --git a/components/sensor/ccs811.rst b/components/sensor/ccs811.rst index 95b4bde42..2eb08eab9 100644 --- a/components/sensor/ccs811.rst +++ b/components/sensor/ccs811.rst @@ -10,10 +10,10 @@ The ``ccs811`` sensor platform allows you to use CCS811 eCO_2 and volatile organ .. note:: - Most CCS811 modules require the WAK pin to be pulled low to wake up the sensor, as outlined in the data sheets. - Outside low-power scenarios, connecting WAK to ground is the recommended configuration. For low power installations, + Most CCS811 modules require the WAK pin to be pulled low to wake up the sensor, as outlined in the data sheets. + Outside low-power scenarios, connecting WAK to ground is the recommended configuration. For low power installations, pulling WAK low should happen in software prior to taking the measures. - + .. figure:: images/ccs811-full.jpg :align: center :width: 50.0% @@ -46,23 +46,19 @@ Configuration variables: - **eco2** (**Required**): The eCO_2 data from the sensor in parts per million (ppm). - - **name** (**Required**, string): The name for the CO_2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **tvoc** (**Required**): The information for the total volatile organic compound sensor in parts per billion (ppb). - - **name** (**Required**, string): The name for the tvoc sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - **version** (*Optional*): This sensor reports the firmware ('application') version in text, with the internal hex representation of the version number behind it, so version 1.0.0 will be reported as '1.0.0 (0x1000)'. - - **name** (**Required**, string): The name for the version sensor. + - All options from :ref:`Text Sensor `. Advanced: diff --git a/components/sensor/ct_clamp.rst b/components/sensor/ct_clamp.rst index 27f9e5eb1..c21a3921c 100644 --- a/components/sensor/ct_clamp.rst +++ b/components/sensor/ct_clamp.rst @@ -35,13 +35,11 @@ as an introduction to the working principle of CT clamp sensors and how to hook Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **sensor** (**Required**, :ref:`config-id`): The source sensor to measure voltage values from. - **sample_duration** (*Optional*, :ref:`config-time`): The time duration to sample the current clamp with. Higher values can increase accuracy. Defaults to ``200ms`` which would be 10 whole cycles on a 50Hz system. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. The **update_interval** for ``ct_clamp`` has to be greater than **sample_duration**. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. Calibration diff --git a/components/sensor/dht.rst b/components/sensor/dht.rst index f8943d6c0..2b16241eb 100644 --- a/components/sensor/dht.rst +++ b/components/sensor/dht.rst @@ -51,15 +51,11 @@ Configuration variables: - **pin** (**Required**, :ref:`config-pin`): The pin where the DHT bus is connected. - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **model** (*Optional*, int): Manually specify the DHT model, can be diff --git a/components/sensor/dht12.rst b/components/sensor/dht12.rst index 0588bbcf2..53afa28cf 100644 --- a/components/sensor/dht12.rst +++ b/components/sensor/dht12.rst @@ -38,15 +38,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/dps310.rst b/components/sensor/dps310.rst index 4cd5f5baa..8130925fa 100644 --- a/components/sensor/dps310.rst +++ b/components/sensor/dps310.rst @@ -33,17 +33,12 @@ Configuration variables: - **pressure** (**Required**): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (**Required**): The information for the temperature. sensor - - **name** (**Required**, string): The name for the temperature - sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x77``. diff --git a/components/sensor/dsmr.rst b/components/sensor/dsmr.rst index 0181270e0..4d5fb1fc2 100644 --- a/components/sensor/dsmr.rst +++ b/components/sensor/dsmr.rst @@ -71,205 +71,139 @@ Configuration variables: - **energy_delivered_tariff1** (*Optional*): Energy Consumed Tariff 1. - - **name** (**Required**, string): The name for the energy_delivered_tariff1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **energy_delivered_tariff2** (*Optional*): Energy Consumed Tariff 2. - - **name** (**Required**, string): The name for the energy_delivered_tariff2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **energy_returned_tariff1** (*Optional*): Energy Produced Tariff 1. - - **name** (**Required**, string): The name for the energy_returned_tariff1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **energy_returned_tariff2** (*Optional*): Energy Produced Tariff 2. - - **name** (**Required**, string): The name for the energy_returned_tariff2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_delivered** (*Optional*): Power Consumed. - - **name** (**Required**, string): The name for the power_delivered sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_returned** (*Optional*): Power Produced. - - **name** (**Required**, string): The name for the power_returned sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_failures** (*Optional*): Electricity Failures. - - **name** (**Required**, string): The name for the electricity_failures sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_long_failures** (*Optional*): Long Electricity Failures. - - **name** (**Required**, string): The name for the electricity_long_failures sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_sags_l1** (*Optional*): Number of voltage sags in phase L1. - - **name** (**Required**, string): The name for the electricity_sags_l1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_sags_l2** (*Optional*): Number of voltage sags in phase L2. - - **name** (**Required**, string): The name for the electricity_sags_l2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_sags_l3** (*Optional*): Number of voltage sags in phase L3. - - **name** (**Required**, string): The name for the electricity_sags_l3 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_swells_l1** (*Optional*): Number of voltage swells in phase L1. - - **name** (**Required**, string): The name for the electricity_swells_l1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_swells_l2** (*Optional*): Number of voltage swells in phase L2. - - **name** (**Required**, string): The name for the electricity_swells_l2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **electricity_swells_l3** (*Optional*): Number of voltage swells in phase L3. - - **name** (**Required**, string): The name for the electricity_swells_l3 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **voltage_l1** (*Optional*): Voltage Phase 1. - - **name** (**Required**, string): The name for the voltage_l1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **voltage_l2** (*Optional*): Voltage Phase 2. - - **name** (**Required**, string): The name for the voltage_l2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **voltage_l3** (*Optional*): Voltage Phase 3. - - **name** (**Required**, string): The name for the voltage_l3 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **current_l1** (*Optional*): Current Phase 1. - - **name** (**Required**, string): The name for the current_l1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **current_l2** (*Optional*): Current Phase 2. - - **name** (**Required**, string): The name for the current_l2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **current_l3** (*Optional*): Current Phase 3. - - **name** (**Required**, string): The name for the current_l3 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_delivered_l1** (*Optional*): Power Consumed Phase 1. - - **name** (**Required**, string): The name for the power_delivered_l1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_delivered_l2** (*Optional*): Power Consumed Phase 2. - - **name** (**Required**, string): The name for the power_delivered_l2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_delivered_l3** (*Optional*): Power Consumed Phase 3. - - **name** (**Required**, string): The name for the power_delivered_l3 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_returned_l1** (*Optional*): Power Produced Phase 1. - - **name** (**Required**, string): The name for the power_returned_l1 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_returned_l2** (*Optional*): Power Produced Phase 2. - - **name** (**Required**, string): The name for the power_returned_l2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_returned_l3** (*Optional*): Power Produced Phase 3. - - **name** (**Required**, string): The name for the power_returned_l3 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **gas_delivered** (*Optional*): Gas Consumed. - - **name** (**Required**, string): The name for the gas_delivered sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. Belgium - **gas_delivered_be** (*Optional*): Gas Consumed Belgium. - - **name** (**Required**, string): The name for the gas_delivered_be sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **active_energy_import_current_average_demand** (*Optional*): Current Average Quarterly Demand for Peak Tarrif Belgium. - - **name** (**Required**, string): The name for the active_energy_import_current_average_demand sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **active_energy_import_maximum_demand_running_month** (*Optional*): Current Month's Maximum Quarterly Demand for Peak Tarrif Belgium. - - **name** (**Required**, string): The name for the active_energy_import_maximum_demand_running_month sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **active_energy_import_maximum_demand_last_13_months** (*Optional*): 13 Month Maximum Quarterly Demand for Peak Tarrif Belgium. - - **name** (**Required**, string): The name for the active_energy_import_maximum_demand_last_13_months sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. Luxembourg - **energy_delivered_lux** (*Optional*): Energy Consumed Luxembourg - - **name** (**Required**, string): The name for the energy_delivered_lux sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **energy_returned_lux** (*Optional*): Energy Produced Luxembourg - - **name** (**Required**, string): The name for the energy_returned_lux sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. Text Sensor ----------- @@ -278,79 +212,55 @@ Configuration variables: - **identification** (*Optional*): DSMR Identification - - **name** (**Required**, string): The name for the identification text sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **p1_version** (*Optional*): DSMR Version - - **name** (**Required**, string): The name for the p1_version text sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **timestamp** (*Optional*): Timestamp - - **name** (**Required**, string): The name for the timestamp sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **electricity_tariff** (*Optional*): The current tariff. According to the specs value '0001' means 'normal tariff' and value '0002' means 'low tariff'. Your meter may report differently. - - **name** (**Required**, string): The name for the electricity_tariff sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **electricity_failure_log** (*Optional*): Electricity Failure Log - - **name** (**Required**, string): The name for the electricity_failure_log sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **message_short** (*Optional*): Message Short - - **name** (**Required**, string): The name for the message_short sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **message_long** (*Optional*): Message Long - - **name** (**Required**, string): The name for the message_long sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **gas_equipment_id** (*Optional*): Gas Equipment ID. - - **name** (**Required**, string): The name for the gas_equipment_id sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **water_equipment_id** (*Optional*): Water Equipment ID - - **name** (**Required**, string): The name for the water_equipment_id sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **sub_equipment_id** (*Optional*): Sub Equipment ID - - **name** (**Required**, string): The name for the sub_equipment_id sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. - **gas_delivered_text** (*Optional*): A text sensor which unformatted gas data. You need to apply a custom parsing of this value depending on your meter format. - - **name** (**Required**, string): The name for the p1_version text sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. Belgium - **p1_version_be** (*Optional*): DSMR Version Belgium - - **name** (**Required**, string): The name for the p1_version_be text sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Text Sensor `. + - All options from :ref:`Text Sensor `. Older DSMR meters support ------------------------- diff --git a/components/sensor/ee895.rst b/components/sensor/ee895.rst index dfb5f2b7d..ebad7741d 100644 --- a/components/sensor/ee895.rst +++ b/components/sensor/ee895.rst @@ -38,21 +38,15 @@ Configuration variables: - **temperature** (**Required**): The information for the Temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **co2** (**Required**): The information for the CO₂ sensor. - - **name** (**Required**, string): The name for the CO₂eq sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pressure** (**Required**): The information for the Pressure sensor. - - **name** (**Required**, string): The name for the Pressure sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x5F``. diff --git a/components/sensor/ens160.rst b/components/sensor/ens160.rst index bd79ec2c0..4693123cd 100644 --- a/components/sensor/ens160.rst +++ b/components/sensor/ens160.rst @@ -6,15 +6,15 @@ ENS160 Sensor :keywords: ENS160 The ``ens160`` sensor platform allows you to use your ENS160 -(`datasheet `__) air-quality sensors with ESPHome. +(`datasheet `__) air-quality sensors with ESPHome. The :ref:`I²C ` or :ref:`SPI ` is required to be set up in your configuration for this sensor to work. .. note:: On first power-up of the ENS160 sensor, there is a 1 hour initial startup delay before readings will be available. - For subsequent starts or reboots, there is a 3 minute warm up period before readings are available. Also, be aware that the + For subsequent starts or reboots, there is a 3 minute warm up period before readings are available. Also, be aware that the ENS160 can take up to 1 second for sucessive data measurements to be ready. - + .. figure:: images/ens160.jpg :align: center :width: 80.0% @@ -33,7 +33,7 @@ The :ref:`I²C ` or :ref:`SPI ` is required to be set up in your confi aqi: id: ens160_air_quality_index name: "ENS160 Air Quality Index" - update_interval: 60s + update_interval: 60s address: 0x53 compensation: temperature: id_temperature_sensor @@ -48,7 +48,7 @@ The :ref:`I²C ` or :ref:`SPI ` is required to be set up in your confi name: "ENS160 Total Volatile Organic Compounds" aqi: name: "ENS160 Air Quality Index" - update_interval: 60s + update_interval: 60s cs_pin: GPIO5 compensation: temperature: id_temperature_sensor @@ -60,21 +60,15 @@ Configuration variables: - **eco2** (**Required**): Configuration for the eCO2 sensor. - - **name** (**Required**, string): The name for the eCO2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **tvoc** (**Required**): Configuration for the TVOC sensor. - - **name** (**Required**, string): The name for the TVOC sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **aqi** (*Optional*): Configuration for the air quality index sensor. - - **name** (**Required**, string): The name for the AQI sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. The update interval should be greater than the measurement @@ -88,20 +82,20 @@ Configuration variables: Advanced: -- **compensation** (*Optional*): The block containing sensors used for compensation. +- **compensation** (*Optional*): The block containing sensors used for compensation. Temperature and humidity compensation improves the accuracy of sensor readings. Without compensation, the ENS160 internally assumes 25°C temperature and 50% humidity, with readings noticeably diverting from real changes without compensation in temperature and humidity. - + - **temperature** (**Required**, :ref:`config-id`): The ID of an external temperature sensor. - **humidity** (**Required**, :ref:`config-id`): The ID of an external humidity sensor. - + Example Text Sensor configuration --------------------------------- The Air Quality Index(AQI) from this sensor is a number between 1 and 5. The ENS160 (`datasheet `__) states that "The AQI-UBA air quality index is derived from a guideline by the German Federal Environmental -Agency based on a TVOC sum signal". The following is an example configuration to convert the numeric ENS160 AQI to the rating text. +Agency based on a TVOC sum signal". The following is an example configuration to convert the numeric ENS160 AQI to the rating text. .. code-block:: yaml @@ -114,7 +108,7 @@ Agency based on a TVOC sum signal". The following is an example configuration to case 2: return {"Good"}; case 3: return {"Moderate"}; case 4: return {"Poor"}; - case 5: return {"Unhealthy"}; + case 5: return {"Unhealthy"}; default: return {"Not Available"}; } diff --git a/components/sensor/ens210.rst b/components/sensor/ens210.rst index 782af1510..3503a5651 100644 --- a/components/sensor/ens210.rst +++ b/components/sensor/ens210.rst @@ -35,15 +35,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/esp32_hall.rst b/components/sensor/esp32_hall.rst index 436b8610a..7cbcc5e5e 100644 --- a/components/sensor/esp32_hall.rst +++ b/components/sensor/esp32_hall.rst @@ -30,10 +30,8 @@ by the hall sensor. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the hall effect sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. .. warning:: diff --git a/components/sensor/ezo.rst b/components/sensor/ezo.rst index 515bb8c96..41508e2fa 100644 --- a/components/sensor/ezo.rst +++ b/components/sensor/ezo.rst @@ -42,7 +42,6 @@ Configuration variables: - **address** (**Required**, int): Specify the I²C address of the sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. Automation triggers: diff --git a/components/sensor/hdc1080.rst b/components/sensor/hdc1080.rst index 19bc5a7fd..b4cd76b65 100644 --- a/components/sensor/hdc1080.rst +++ b/components/sensor/hdc1080.rst @@ -41,15 +41,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/hm3301.rst b/components/sensor/hm3301.rst index d6f71e7f5..ac73b956b 100644 --- a/components/sensor/hm3301.rst +++ b/components/sensor/hm3301.rst @@ -33,27 +33,19 @@ Configuration variables: - **pm_1_0** (*Optional*): Use the concentration of particulates of size less than 1.0µm in µg per cubic meter. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_2_5** (*Optional*): Use the concentration of particulates of size less than 2.5µm in µg per cubic meter. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_10_0** (*Optional*): Use the concentration of particulates of size less than 10.0µm in µg per cubic meter. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **aqi** (*Optional*): AQI sensor. Requires the ``pm_2_5`` and ``pm_10_0`` sensors defined. See below. - **calculation_type** (**Required**): One of: ``AQI`` or ``CAQI``. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. Air Quality Sensor: diff --git a/components/sensor/homeassistant.rst b/components/sensor/homeassistant.rst index b8d0ea0e9..631615702 100644 --- a/components/sensor/homeassistant.rst +++ b/components/sensor/homeassistant.rst @@ -39,11 +39,9 @@ Entity state attributes can also be imported: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **entity_id** (**Required**, string): The entity ID to import from Home Assistant. - **attribute** (*Optional*, string): The name of the state attribute to import from the specified entity. The entity state is used when this option is omitted. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. diff --git a/components/sensor/honeywellabp.rst b/components/sensor/honeywellabp.rst index d85582e9a..5da92211a 100644 --- a/components/sensor/honeywellabp.rst +++ b/components/sensor/honeywellabp.rst @@ -49,9 +49,7 @@ datasheet indicates that the sensor does not measure temperature. - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **cs_pin** (**Required**, :ref:`SPI `): Chip select pin. diff --git a/components/sensor/hte501.rst b/components/sensor/hte501.rst index 4e052de0e..27c16778c 100644 --- a/components/sensor/hte501.rst +++ b/components/sensor/hte501.rst @@ -33,15 +33,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x40``. diff --git a/components/sensor/hx711.rst b/components/sensor/hx711.rst index 8855113a6..8555b7545 100644 --- a/components/sensor/hx711.rst +++ b/components/sensor/hx711.rst @@ -36,7 +36,6 @@ and ``CLK`` (or ``SCK``) to free GPIO pins. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the load cell sensor. - **dout_pin** (**Required**, :ref:`Pin Schema `): The DOUT (or DAT) pin. - **clk_pin** (**Required**, :ref:`Pin Schema `): The CLK pin. - **gain** (*Optional*, enum): The gain. Implicitly selects the channel. Defaults to ``128``. @@ -47,7 +46,6 @@ Configuration variables: - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. diff --git a/components/sensor/hydreon_rgxx.rst b/components/sensor/hydreon_rgxx.rst index 04e08c06d..04a919b80 100644 --- a/components/sensor/hydreon_rgxx.rst +++ b/components/sensor/hydreon_rgxx.rst @@ -74,42 +74,30 @@ Configuration variables: - **moisture** (*Optional*): Rain intensity level from 0-7 (`more detail `__). Only on RG-9. - - **name** (**Required**, string): The name for the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): Device internal temperature in Celsius. Accuracy is ±5°C. Only on RG-9 firmware version 1.100-onwards. - - **name** (**Required**, string): The name for the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **resolution** (*Optional*, string): Specify rain sensor resolution. Must be either ``low`` or ``high``. Default resolution is ``high``. Only applies to RG-15. - **acc** (*Optional*): Amount of rain since last message (see ``update_interval``), in ``mm``. Only on RG-15. - - **name** (**Required**, string): The name for the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **event_acc** (*Optional*): Amount of rain for this event (i.e. since it last stopped raining), in ``mm``. Only on RG-15. - - **name** (**Required**, string): The name for the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **total_acc** (*Optional*): Total amount of rain this sensor has ever measured, in ``mm``. Only on RG-15. - - **name** (**Required**, string): The name for the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **r_int** (*Optional*): Current rain intensity in ``mm/h``. Only on RG-15. - - **name** (**Required**, string): The name for the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/hyt271.rst b/components/sensor/hyt271.rst index 658b66f83..84693eeef 100644 --- a/components/sensor/hyt271.rst +++ b/components/sensor/hyt271.rst @@ -6,7 +6,7 @@ HYT271 Temperature & Humidity Sensor :image: hyt271.jpg :keywords: HYT271 -The HYT271 Temperature & Humidity sensors with ESPHome. +The HYT271 Temperature & Humidity sensors with ESPHome. The :ref:`I²C Bus ` is required to be set up in your configuration for this sensor to work. Example sensors: @@ -27,15 +27,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/inkbird_ibsth1_mini.rst b/components/sensor/inkbird_ibsth1_mini.rst index ac82f8eff..ac18f2e85 100644 --- a/components/sensor/inkbird_ibsth1_mini.rst +++ b/components/sensor/inkbird_ibsth1_mini.rst @@ -54,27 +54,19 @@ Configuration variables: - **mac_address** (**Required**, MAC Address): The MAC address of the Inkbird IBS-TH1 device. - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **external_temperature** (*Optional*): The information for the external temperature sensor. - - **name** (**Required**, string): The name for the external temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (*Optional*): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **battery_level** (*Optional*): The information for the battery level sensor - - **name** (**Required**, string): The name for the battery level sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. Setting Up Devices diff --git a/components/sensor/integration.rst b/components/sensor/integration.rst index de9dc7f44..d2a2534bf 100644 --- a/components/sensor/integration.rst +++ b/components/sensor/integration.rst @@ -29,7 +29,6 @@ Configuration variables: ------------------------ - **sensor** (**Required**, :ref:`config-id`): The ID of the sensor to integrate over time. -- **name** (**Required**, string): The name of the integration sensor. - **time_unit** (**Required**, string): The time unit to integrate with, one of ``ms``, ``s``, ``min``, ``h`` or ``d``. - **integration_method** (*Optional*, string): The integration method to use. One of @@ -37,7 +36,6 @@ Configuration variables: - **restore** (*Optional*, boolean): Whether to store the intermediate result on the device so that the value can be restored upon power cycle or reboot. Warning: this option can wear out your flash. Defaults to ``false``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. .. _sensor-integration-reset_action: diff --git a/components/sensor/internal_temperature.rst b/components/sensor/internal_temperature.rst index 066aafecf..38d8679fd 100644 --- a/components/sensor/internal_temperature.rst +++ b/components/sensor/internal_temperature.rst @@ -28,10 +28,8 @@ temperature sensor of the ESP32, RP2040 and BK72XX chip. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the temperature sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/jsn_sr04t.rst b/components/sensor/jsn_sr04t.rst index 700701255..c8f3bcb9f 100644 --- a/components/sensor/jsn_sr04t.rst +++ b/components/sensor/jsn_sr04t.rst @@ -6,7 +6,7 @@ JSN-SR04T Waterproof Ultrasonic Range Finder :image: jsn-sr04t-v3.jpg :keywords: JSN-SR04T -This sensor allows you to use the JSN-SR04T Waterproof Ultrasonic Range Finder **in Mode 1 and 2** +This sensor allows you to use the JSN-SR04T Waterproof Ultrasonic Range Finder **in Mode 1 and 2** with ESPHome to measure distances. This sensor can measure ranges between 25 centimeters and 600 centimeters with a resolution of 1 millimeter. @@ -24,10 +24,10 @@ Configure the JSN-SR04T for mode 2: JSN-SR04T Waterproof Ultrasonic Range Finder Mode Select Pads. -In mode 1 the module continuously takes measurements approximately every 100mS and outputs the distance on the TX pin at 9600 baud. +In mode 1 the module continuously takes measurements approximately every 100mS and outputs the distance on the TX pin at 9600 baud. In this mode :ref:`sensor-filters` are highly recommended. -In mode 2 the module takes a measurement only when a trigger command of 0x55 is sent to the RX pin on the module. +In mode 2 the module takes a measurement only when a trigger command of 0x55 is sent to the RX pin on the module. The module then outputs the distance on its TX pin. The frequency of the measurements can be set with the **update_interval** option. To use the sensor, first set up an :ref:`uart` with a baud rate of 9600 and connect the sensor to the specified pin. @@ -45,12 +45,11 @@ To use the sensor, first set up an :ref:`uart` with a baud rate of 9600 and conn - platform: "jsn_sr04t" name: "Distance" update_interval: 1s - + Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. Not applicable in mode 1. - **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus ` you wish to use for this sensor. diff --git a/components/sensor/max31855.rst b/components/sensor/max31855.rst index fea7c71bc..f7749d9af 100644 --- a/components/sensor/max31855.rst +++ b/components/sensor/max31855.rst @@ -34,12 +34,13 @@ Connect ``GND`` to ``GND``, ``VCC`` to ``3.3V`` and the other three ``MISO`` (or Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. - **cs_pin** (**Required**, :ref:`Pin Schema `): The Chip Select pin of the SPI interface. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **reference_temperature** (*Optional*, :ref:`config-id`): Access the internal temperature sensor of the MAX31855. Requires a **name** and/or **id**. +- **reference_temperature** (*Optional*, :ref:`config-id`): Access the internal temperature sensor of the MAX31855. + + - All options from :ref:`Sensor `. + - **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component ` if you want to use multiple SPI buses. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/max31865.rst b/components/sensor/max31865.rst index 1282ec1b7..343892d60 100644 --- a/components/sensor/max31865.rst +++ b/components/sensor/max31865.rst @@ -46,7 +46,6 @@ to have an :ref:`spi bus ` in your configuration with both **miso_pin** and Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. - **cs_pin** (**Required**, :ref:`Pin Schema `): The Chip Select pin of the SPI interface. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - **reference_resistance** (**Required**, float): Reference resistor on the PCB. Adafruit's PT100 (#3328) uses 430 Ω, their PT1000 (#3648) uses 4300 Ω. @@ -54,7 +53,6 @@ Configuration variables: - **mains_filter** (*Optional*, string): The mains power frequency to reject (``50 Hz`` or ``60 Hz``). Defaults to ``60 Hz``. - **rtd_wires** (*Optional*, int): The number of RTD wires. Be sure to solder board jumpers to match! Defaults to ``4``. - **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component ` if you want to use multiple SPI buses. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/max44009.rst b/components/sensor/max44009.rst index b1c41cb7f..31e04e148 100644 --- a/components/sensor/max44009.rst +++ b/components/sensor/max44009.rst @@ -8,8 +8,8 @@ MAX44009 Ambient Light Sensor The ``max44009`` sensor platform allows you to use your MAX44009 (`datasheet `__) -ambient light sensor with ESPHome. This sensor features an ultra-wide 22-bit dynamic range -from 0.045 lux to 188,000 lux. The :ref:`I²C bus ` is required to be set up in your +ambient light sensor with ESPHome. This sensor features an ultra-wide 22-bit dynamic range +from 0.045 lux to 188,000 lux. The :ref:`I²C bus ` is required to be set up in your configuration for this sensor to work. The ``max44009`` sensor can operate in two modes: ``low_power`` (default) and ``continuous``: @@ -28,12 +28,10 @@ The ``max44009`` sensor can operate in two modes: ``low_power`` (default) and `` Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the sensor. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x4A``. - **mode** (*Optional*, string): Measurement mode. One of ``auto``, ``low_power``, ``continuous``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/max6675.rst b/components/sensor/max6675.rst index 1eef16620..a965ad8b6 100644 --- a/components/sensor/max6675.rst +++ b/components/sensor/max6675.rst @@ -42,13 +42,11 @@ Connect ``GND`` to ``GND``, ``VCC`` to ``3.3V`` and the other three ``MISO`` (or Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. - **cs_pin** (**Required**, :ref:`Pin Schema `): The Chip Select pin of the SPI interface. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component ` if you want to use multiple SPI buses. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/max9611.rst b/components/sensor/max9611.rst index 5cfbd5ff5..dd9e2cca6 100644 --- a/components/sensor/max9611.rst +++ b/components/sensor/max9611.rst @@ -47,23 +47,19 @@ Configuration variables: - **voltage** (*Optional*): The information for the voltage sensor - - **name** (**Required**, string): The name for the voltage sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **current** (*Optional*): The information for the current sensor, scaled by the gain factor and multiplied by voltage - - **name** (**Required**, string): The name for the current sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power** (*Optional*): The information for the power sensor - - **name** (**Required**, string): The name for the power sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): The information for the temperature sensor - - **name** (**Required**, string): The name for the temperature sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of diff --git a/components/sensor/mcp9600.rst b/components/sensor/mcp9600.rst index 5d5a6a809..5294470ac 100644 --- a/components/sensor/mcp9600.rst +++ b/components/sensor/mcp9600.rst @@ -41,16 +41,11 @@ Configuration variables: - **hot_junction** (*Optional*): The information for the Hot Junction temperature sensor. - - **name** (**Required**, string): The name for the temperature - sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **cold_junction** (*Optional*): The information for the Cold Junction temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **thermocouple_type** (*Optional*): Set the thermocouple type. Options are: K, J, T, N, S, E, B and R type thermocouple. Defaults to ``K``. diff --git a/components/sensor/mcp9808.rst b/components/sensor/mcp9808.rst index 6bd23f940..9162f4add 100644 --- a/components/sensor/mcp9808.rst +++ b/components/sensor/mcp9808.rst @@ -32,8 +32,6 @@ required to be set up in your configuration for this sensor to work. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x18``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - All other options from :ref:`Sensor `. diff --git a/components/sensor/mlx90393.rst b/components/sensor/mlx90393.rst index fb4700e24..643456ab1 100644 --- a/components/sensor/mlx90393.rst +++ b/components/sensor/mlx90393.rst @@ -37,8 +37,6 @@ Configuration variables: - **x_axis** (*Optional*): The information for the x-axis. - - **name** (**Required**, string): The name for the x-axis sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **resolution** (*Optional*, int): Set resolution. Defaults to ``19BIT``. Must be one of: - ``16BIT`` @@ -50,8 +48,6 @@ Configuration variables: - **y_axis** (*Optional*): The information for the y-axis. - - **name** (**Required**, string): The name for the y-axis sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **resolution** (*Optional*, int): Set resolution. Defaults to ``19BIT``. Must be one of: - ``16BIT`` @@ -63,8 +59,6 @@ Configuration variables: - **z_axis** (*Optional*): The information for the z-axis. - - **name** (**Required**, string): The name for the z-axis sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **resolution** (*Optional*, int): Set resolution. Defaults to ``16BIT``. Must be one of: - ``16BIT`` @@ -76,8 +70,6 @@ Configuration variables: - **temperature** (*Optional*): Built-in temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - **oversampling** (*Optional*, int): On-chip oversampling for the temperature sensor. Defaults to ``0``. Must be between ``0`` and ``3``. - All other options from :ref:`Sensor `. diff --git a/components/sensor/modbus_controller.rst b/components/sensor/modbus_controller.rst index a0ae94dae..4d9d7c183 100644 --- a/components/sensor/modbus_controller.rst +++ b/components/sensor/modbus_controller.rst @@ -11,8 +11,6 @@ and requires :doc:`/components/modbus_controller` to be configured. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the sensor. - **register_type** (**Required**): type of the modbus register. - ``coil``: Coils are 1-bit registers (ON/OFF values) that are used to control discrete outputs. They may be read and/or written. Modbus *Function Code 1 (Read Coil Status)* will be used. diff --git a/components/sensor/mpl3115a2.rst b/components/sensor/mpl3115a2.rst index 4333ed9c7..77dcaa135 100644 --- a/components/sensor/mpl3115a2.rst +++ b/components/sensor/mpl3115a2.rst @@ -37,21 +37,15 @@ sensor is configured. - **pressure** (*Optional*): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **altitude** (*Optional*): The information for the altitude sensor. - - **name** (**Required**, string): The name for the altitude sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x60``. diff --git a/components/sensor/mqtt_subscribe.rst b/components/sensor/mqtt_subscribe.rst index ae8e723e0..0db66d45e 100644 --- a/components/sensor/mqtt_subscribe.rst +++ b/components/sensor/mqtt_subscribe.rst @@ -26,10 +26,8 @@ text sensor for importing arbitrary text into the ESPHome ecosystem. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **topic** (**Required**, string): The MQTT topic to listen for numeric messages. - **qos** (*Optional*, int): The MQTT QoS to subscribe with. Defaults to ``0``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/ms5611.rst b/components/sensor/ms5611.rst index 4ef9c05a1..9474bb1ef 100644 --- a/components/sensor/ms5611.rst +++ b/components/sensor/ms5611.rst @@ -39,17 +39,12 @@ Configuration variables: - **pressure** (**Required**): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (**Required**): The information for the temperature. sensor - - **name** (**Required**, string): The name for the temperature - sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x77``. diff --git a/components/sensor/nextion.rst b/components/sensor/nextion.rst index b5d23af9b..ff8389c3d 100644 --- a/components/sensor/nextion.rst +++ b/components/sensor/nextion.rst @@ -54,7 +54,6 @@ See :doc:`/components/display/nextion` for setting up the display Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **nextion_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the Nextion display. - **component_name** (*Optional*, string): Manually specify the name of the Nextion component. - **variable_name** (*Optional*, string): Manually specify the name of the Nextion variable. diff --git a/components/sensor/ntc.rst b/components/sensor/ntc.rst index 5977da1d8..c7b90c78b 100644 --- a/components/sensor/ntc.rst +++ b/components/sensor/ntc.rst @@ -73,12 +73,10 @@ calibration parameter: Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the sensor. - **sensor** (**Required**, :ref:`config-id`): The sensor to read the resistance values from to convert to temperature readings. - **calibration** (**Required**, float): The calibration parameters of the sensor - see above for more details. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. Self-Heating diff --git a/components/sensor/pulse_counter.rst b/components/sensor/pulse_counter.rst index 9486bd4de..2bf6b07c2 100644 --- a/components/sensor/pulse_counter.rst +++ b/components/sensor/pulse_counter.rst @@ -28,7 +28,6 @@ Configuration variables ------------------------ - **pin** (**Required**, :ref:`config-pin`): The pin to count pulses on. -- **name** (**Required**, string): The name of the sensor. - **count_mode** (*Optional*): Configure how the counter should behave on a detected rising edge/falling edge. @@ -40,18 +39,12 @@ Configuration variables Defaults to ``DISABLE``. - **use_pcnt** (*Optional*, boolean): Use hardware ``PCNT`` pulse counter. Only supported on ESP32. Defaults to ``true``. - - **internal_filter** (*Optional*, :ref:`config-time`): If a pulse shorter than this time is detected, it’s discarded and no pulse is counted. Defaults to ``13us``. On the ESP32, when using the hardware pulse counter this value can not be higher than ``13us``, for the ESP8266 or with ``use_pcnt: false`` you can use larger intervals too. If you enable this, set up the ``count_mode`` to increase on the falling edge, not leading edge. For S0 pulse meters that are used to meter power consumption 50-100 ms is a reasonable value. - - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - - **total** (*Optional*): Report the total number of pulses. - - All other options from :ref:`Sensor `. .. note:: diff --git a/components/sensor/pulse_meter.rst b/components/sensor/pulse_meter.rst index 785f299c5..2e999846b 100644 --- a/components/sensor/pulse_meter.rst +++ b/components/sensor/pulse_meter.rst @@ -29,7 +29,6 @@ Configuration variables ------------------------ - **pin** (**Required**, :ref:`config-pin`): The pin to count pulses on. -- **name** (**Required**, string): The name of the sensor. - **internal_filter** (*Optional*, :ref:`config-time`): If a pulse shorter than this time is detected, it is discarded. Defaults to ``13us``. diff --git a/components/sensor/qmp6988.rst b/components/sensor/qmp6988.rst index 8d777dfb4..de6f54ff5 100644 --- a/components/sensor/qmp6988.rst +++ b/components/sensor/qmp6988.rst @@ -38,19 +38,14 @@ Configuration variables: - **temperature** (*Optional*): The information for the temperature sensor - - **name** (**Required**, string): The name for the temperature - sensor. - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. See :ref:`Oversampling Options `. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. - **pressure** (*Optional*): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - **oversampling** (*Optional*): The oversampling parameter for the temperature sensor. See :ref:`Oversampling Options `. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of @@ -73,9 +68,9 @@ configure this amount. Possible oversampling values: - ``2x`` - ``4x`` - ``8x`` (default) -- ``16x`` -- ``32x`` -- ``64x`` +- ``16x`` +- ``32x`` +- ``64x`` See Also -------- diff --git a/components/sensor/resistance.rst b/components/sensor/resistance.rst index cc6ce039e..85934b41d 100644 --- a/components/sensor/resistance.rst +++ b/components/sensor/resistance.rst @@ -60,7 +60,6 @@ Some boards like NodeMCUv2 needs to multiply ADC reading by 3.3 to provide accur Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the sensor. - **sensor** (**Required**, :ref:`config-id`): The sensor to read the voltage values from to convert to resistance readings. - **configuration** (**Required**, string): The type of circuit, one of ``DOWNSTREAM`` or @@ -68,7 +67,6 @@ Configuration variables: - **resistor** (**Required**, float): The value of the resistor with a constant value. - **reference_voltage** (*Optional*, float): The reference voltage. Defaults to ``3.3V``. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/rotary_encoder.rst b/components/sensor/rotary_encoder.rst index c5c9aa5e0..c29310843 100644 --- a/components/sensor/rotary_encoder.rst +++ b/components/sensor/rotary_encoder.rst @@ -55,7 +55,6 @@ Configuration variables: The first pin for determining the step value. Must not be a pin from an external I/O expander. - **pin_b** (**Required**, :ref:`Pin Schema `): The second pin for determining the step value. Must not be a pin from an external I/O expander. -- **name** (**Required**, string): The name of the rotary encoder sensor. - **pin_reset** (*Optional*, :ref:`Pin Schema `): An optional pin that resets the step value. This is useful with rotary encoders that have a third pin. Defaults to no reset pin. @@ -66,7 +65,6 @@ Configuration variables: - ``2`` - ``4`` -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **min_value** (*Optional*, int): The minimum value this rotary encoder will go to, turning the knob further will not decrease the number. Defaults to no minimum. - **max_value** (*Optional*, int): The maximum value this rotary encoder will go to, turning diff --git a/components/sensor/ruuvitag.rst b/components/sensor/ruuvitag.rst index b69d7a3dd..ee6df690e 100644 --- a/components/sensor/ruuvitag.rst +++ b/components/sensor/ruuvitag.rst @@ -61,91 +61,57 @@ Configuration variables: device. - **humidity** (*Optional*): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pressure** (*Optional*): The information for the pressure sensor. - - **name** (**Required**, string): The name for the pressure sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **acceleration** (*Optional*): The information for the acceleration sensor. - - **name** (**Required**, string): The name for the acceleration sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **acceleration_x** (*Optional*): The information for the acceleration x sensor. - - **name** (**Required**, string): The name for the acceleration x sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **acceleration_y** (*Optional*): The information for the acceleration y sensor. - - **name** (**Required**, string): The name for the acceleration y sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **acceleration_z** (*Optional*): The information for the acceleration z sensor. - - **name** (**Required**, string): The name for the acceleration z sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **battery_voltage** (*Optional*): The information for the battery voltage sensor. - - **name** (**Required**, string): The name for the battery voltage sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **tx_power** (*Optional*): The information for the transmit power sensor - - **name** (**Required**, string): The name for the transmit power sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - Only available if RAWv2 protocol is used. - **movement_counter** (*Optional*): The information for the movement count sensor - - **name** (**Required**, string): The name for the movement count sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - Only available if RAWv2 protocol is used. - **measurement_sequence_number** (*Optional*): The information for the measurement sequence number sensor - - **name** (**Required**, string): The name for the measurement sequence - number sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use - in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - Only available if RAWv2 protocol is used. Setting Up Devices diff --git a/components/sensor/scd30.rst b/components/sensor/scd30.rst index 4081d8a14..3f52b0727 100644 --- a/components/sensor/scd30.rst +++ b/components/sensor/scd30.rst @@ -36,21 +36,15 @@ Configuration variables: - **co2** (*Optional*): The information for the CO₂ sensor. - - **name** (**Required**, string): The name for the CO₂eq sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): The information for the Temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (*Optional*): The information for the Humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature_offset** (*Optional*, float): Temperature and humidity offsets may occur when operating the sensor in end-customer @@ -90,7 +84,7 @@ Manual calibration: then: - scd30.force_recalibration_with_reference: value: !lambda 'return id(co2_cal).state;' - + number: - platform: template name: "CO2 calibration value" diff --git a/components/sensor/scd4x.rst b/components/sensor/scd4x.rst index f2d32ecaf..892e5dea0 100644 --- a/components/sensor/scd4x.rst +++ b/components/sensor/scd4x.rst @@ -31,22 +31,16 @@ Configuration variables: - **co2** (*Optional*): The information for the CO₂ sensor. - - **name** (**Required**, string): The name for the CO₂eq sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): The information for the Temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (*Optional*): The information for the Humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature_offset** (*Optional*, float): The temperature offset can depend on various factors such as the SCD4x measurement mode, self-heating of close diff --git a/components/sensor/sdp3x.rst b/components/sensor/sdp3x.rst index 8944c1b1b..27f610ee6 100644 --- a/components/sensor/sdp3x.rst +++ b/components/sensor/sdp3x.rst @@ -32,8 +32,6 @@ To use the sensor, set up an :ref:`I²C Bus ` and connect the sensor to the Configuration variables: ------------------------ -- **name** (**Required**, string): The name for this sensor. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for lambdas/multiple sensors. - **address** (*Optional*, int): The I²C address of the sensor. Defaults to ``0x21``. - **measurement_mode** (*Optional*): The measurement mode of the sensor. Valid options are ``differential_pressure`` and ``mass_flow``. Defaults to ``differential_pressure``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/sen5x.rst b/components/sensor/sen5x.rst index 560943b41..f8385e079 100644 --- a/components/sensor/sen5x.rst +++ b/components/sensor/sen5x.rst @@ -66,42 +66,31 @@ Configuration variables: - **pm_1_0** (*Optional*): The information for the **Weight Concentration** sensor for fine particles up to 1μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_2_5** (*Optional*): The information for the **Weight Concentration** sensor for fine particles up to 2.5μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_4_0** (*Optional*): The information for the **Weight Concentration** sensor for coarse particles up to 4μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_10_0** (*Optional*): The information for the **Weight Concentration** sensor for coarse particles up to 10μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **auto_cleaning_interval** (*Optional*): Reads/Writes the interval in seconds of the periodic fan-cleaning. - **temperature** (*Optional*): Temperature.Note only available with Sen54 or Sen55. The sensor will be ignored on unsupported models. - - **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 `. + - All options from :ref:`Sensor `. - **humidity** (*Optional*): Relative Humidity. Note only available with Sen54 or Sen55. The sensor will be ignored on unsupported models. -- **voc** (*Optional*): VOC Index. Note only available with Sen54 or Sen55. The sensor will be ignored on unsupported models. + - All options from :ref:`Sensor `. - - **name** (**Required**, string): The name of the sensor. - - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. +- **voc** (*Optional*): VOC Index. Note only available with Sen54 or Sen55. The sensor will be ignored on unsupported models. - **algorithm_tuning** (*Optional*): The VOC algorithm can be customized by tuning 6 different parameters. For more details see `Engineering Guidelines for SEN5x `__ @@ -116,9 +105,6 @@ Configuration variables: - **nox** (*Optional*): NOx Index. Note: Only available with Sen55. The sensor will be ignored on unsupported models. - - **name** (**Required**, string): The name of the sensor. - - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - - **algorithm_tuning** (*Optional*): The NOx algorithm can be customized by tuning 5 different parameters.For more details see `Engineering Guidelines for SEN5x `__ - **index_offset** (*Optional*): NOx index representing typical (average) conditions. Allowed values are in range 1..250. The default value is 100. diff --git a/components/sensor/senseair.rst b/components/sensor/senseair.rst index 11540f1f4..087cb200e 100644 --- a/components/sensor/senseair.rst +++ b/components/sensor/senseair.rst @@ -42,9 +42,7 @@ Configuration variables: - **co2** (**Required**): The CO_2 data from the sensor in parts per million (ppm). - - **name** (**Required**, string): The name for the CO_2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. diff --git a/components/sensor/sgp30.rst b/components/sensor/sgp30.rst index 341da383b..665123683 100644 --- a/components/sensor/sgp30.rst +++ b/components/sensor/sgp30.rst @@ -33,15 +33,11 @@ Configuration variables: - **eco2** (**Required**): The information for the CO₂eq. sensor. - - **name** (**Required**, string): The name for the CO₂eq sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **tvoc** (**Required**): The information for the total Volatile Organic Compounds sensor. - - **name** (**Required**, string): The name for the TVOC sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **store_baseline** (*Optional*, boolean): Store the sensor baselines persistently when calculated or updated. Defaults to yes. @@ -62,15 +58,11 @@ Advanced: - **eco2_baseline** (*Optional*): The information for the CO₂eq. baseline value sensor. Baseline value is published in decimals. - - **name** (**Required**, string): The name for the CO₂eq baseline value sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **tvoc_baseline** (*Optional*): The information for the TVOC baseline value sensor. Baseline value is published in decimals. - - **name** (**Required**, string): The name for the TVOC baseline value sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **compensation** (*Optional*): The block containing sensors used for compensation. Both values must be supplied in order to be able to generate the absolute humidity to be reported to the sensor. diff --git a/components/sensor/sgp4x.rst b/components/sensor/sgp4x.rst index 726d0f40e..f73612c65 100644 --- a/components/sensor/sgp4x.rst +++ b/components/sensor/sgp4x.rst @@ -39,8 +39,6 @@ Configuration variables: - **voc** (*Optional*): VOC Index - - **name** (**Required**, string): The name of the sensor. - - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **algorithm_tuning** (*Optional*): The VOC algorithm can be customized by tuning 6 different parameters. For more details see `Engineering Guidelines for SEN5x `__ - **index_offset** (*Optional*): VOC index representing typical (average) conditions. Allowed values are in range 1..250. The default value is 100. @@ -55,8 +53,6 @@ Configuration variables: - **nox** (*Optional*): NOx Index. Only available with SGP41. If a SGP40 sensor is detected this sensor will be ignored - - **name** (**Required**, string): The name of the sensor. - - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **algorithm_tuning** (*Optional*): The NOx algorithm can be customized by tuning 5 different parameters.For more details see `Engineering Guidelines for SEN5x `__ - **index_offset** (*Optional*): NOx index representing typical (average) conditions. Allowed values are in range 1..250. The default value is 100. diff --git a/components/sensor/sht3xd.rst b/components/sensor/sht3xd.rst index 73a968f49..beffd6692 100644 --- a/components/sensor/sht3xd.rst +++ b/components/sensor/sht3xd.rst @@ -35,15 +35,11 @@ Configuration variables: - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (*Optional*): The information for the humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x44``. For SHT3x, an alternate address can be ``0x45`` while SHT85 supports only address ``0x44`` diff --git a/components/sensor/sht4x.rst b/components/sensor/sht4x.rst index 4cb37c1b2..350fde231 100644 --- a/components/sensor/sht4x.rst +++ b/components/sensor/sht4x.rst @@ -30,15 +30,11 @@ Configuration variables: - **temperature** (*Optional*): Temperature. - - **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 `. + - All options from :ref:`Sensor `. - **humidity** (*Optional*): Relative Humidity. - - **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 `. + - All options from :ref:`Sensor `. - **precision** (*Optional*, string): The measurement precision, either ``High``, ``Med`` or ``Low``. Default is ``High``. - **heater_max_duty** (*Optional*, float): The maximum duty cycle of the heater (limited to ``0.05``). Default is ``0.0``, i.e. heater off. diff --git a/components/sensor/shtcx.rst b/components/sensor/shtcx.rst index a5fce79eb..d029d19ad 100644 --- a/components/sensor/shtcx.rst +++ b/components/sensor/shtcx.rst @@ -37,15 +37,11 @@ Configuration variables: - **temperature** (**Required**): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the humidity sensor. - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x70``. diff --git a/components/sensor/sm300d2.rst b/components/sensor/sm300d2.rst index 1e0ac5ade..ab8817461 100644 --- a/components/sensor/sm300d2.rst +++ b/components/sensor/sm300d2.rst @@ -64,45 +64,31 @@ Configuration variables: - **co2** (**Required**): The information for the CO₂ sensor. Readings in parts per million (ppm). - - **name** (**Required**, string): The name of the CO₂ sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **formaldehyde** (**Required**): The information for the formaldehyde sensor. Readings in µg/m³. - - **name** (**Required**, string): The name of the formaldehyde sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **tvoc** (**Required**): The information for the total volatile organic compounds (TVOC) sensor. Readings in µg/m³. - - **name** (**Required**, string): The name of the TVOC sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_2_5** (**Required**): The information for the **Weight Concentration** sensor for fine particles up to 2.5μm. Readings in µg/m³. - - **name** (**Required**, string): The name of the PM2.5 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_10_0** (**Required**): The information for the **Weight Concentration** sensor for coarse particles up to 10μm. Readings in µg/m³. - - **name** (**Required**, string): The name of the PM10 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (**Required**): The information for the temperature sensor. Readings in degrees celsius (°C). - - **name** (**Required**, string): The name of the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (**Required**): The information for the relative humidity sensor. Readings in %. - - **name** (**Required**, string): The name of the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. @@ -129,7 +115,7 @@ Configuration variables: to connect the UART ``5V`` pin to the ESP's ``VIN`` and then power everything through either the LCD module or the ESP module, with a single power cable. If you choose to power the ESP separately from the sensor board, leave the UART ``5V`` pin unconnected. - + See Also -------- diff --git a/components/sensor/smt100.rst b/components/sensor/smt100.rst index cfabbd757..4856a3829 100644 --- a/components/sensor/smt100.rst +++ b/components/sensor/smt100.rst @@ -46,28 +46,23 @@ Configuration variables: - **counts** (*Optional*): Raw measurement data from the sensor electronics (dimensionless quantity). Higher counts mean less moisture. May be used for material specific calibrations. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **dielectric_constant** (*Optional*): Dielectric coefficient or permittivity of the material to be measured (dimensionless quantity). Higher permittivity means higher water content. May be used for material specific calibration. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): Soil temperature in degrees Celsius. Please note that the temperature sensor is inside the black sensor enclosure and requires some time to equilibrate with the soil temperature. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **moisture** (*Optional*): Soil moisture (volumetric water content in %). - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **voltage** (*Optional*): Supply voltage of the sensor in Volt. - - **name** (**Required**): Sensor name. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component ` if you want to use multiple UART buses. diff --git a/components/sensor/sps30.rst b/components/sensor/sps30.rst index bfb0e9640..18d4148a7 100644 --- a/components/sensor/sps30.rst +++ b/components/sensor/sps30.rst @@ -59,63 +59,43 @@ Configuration variables: - **pm_1_0** (*Optional*): The information for the **Weight Concentration** sensor for fine particles up to 1μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_2_5** (*Optional*): The information for the **Weight Concentration** sensor for fine particles up to 2.5μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_4_0** (*Optional*): The information for the **Weight Concentration** sensor for coarse particles up to 4μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_10_0** (*Optional*): The information for the **Weight Concentration** sensor for coarse particles up to 10μm. Readings in µg/m³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pmc_0_5** (*Optional*): The information for the **Number Concentration** sensor for ultrafine particles up to 0.5μm. Readings in particles/cm³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pmc_1_0** (*Optional*): The information for the **Number Concentration** sensor for fine particles up to 1μm. Readings in particles/cm³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pmc_2_5** (*Optional*): The information for the **Number Concentration** sensor for fine particles up to 2.5μm. Readings in particles/cm³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pmc_4_0** (*Optional*): The information for the **Number Concentration** sensor for coarse particles up to 4μm. Readings in particles/cm³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pmc_10_0** (*Optional*): The information for the **Number Concentration** sensor for coarse particles up to 10μm. Readings in particles/cm³. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **pm_size** (*Optional*): Typical particle size in μm. - - **name** (**Required**, string): The name for this sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in automation and lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **auto_cleaning_interval** (*Optional*): The interval in seconds of the periodic fan-cleaning. diff --git a/components/sensor/sts3x.rst b/components/sensor/sts3x.rst index b3f1b84be..0dad70e74 100644 --- a/components/sensor/sts3x.rst +++ b/components/sensor/sts3x.rst @@ -27,12 +27,10 @@ required to be set up in your configuration for this sensor to work. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x4A``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/tee501.rst b/components/sensor/tee501.rst index 6901247f3..94a974b2f 100644 --- a/components/sensor/tee501.rst +++ b/components/sensor/tee501.rst @@ -27,12 +27,10 @@ required to be set up in your configuration for this sensor to work. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x48``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/template.rst b/components/sensor/template.rst index 8c971a066..60ca1a390 100644 --- a/components/sensor/template.rst +++ b/components/sensor/template.rst @@ -32,12 +32,10 @@ Possible return values for the lambda: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated every update interval to get the new value of the sensor - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Set to ``never`` to disable updates. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. .. _sensor-template-publish_action: diff --git a/components/sensor/tmp102.rst b/components/sensor/tmp102.rst index 96f0e1ac5..c8c9f4a0d 100644 --- a/components/sensor/tmp102.rst +++ b/components/sensor/tmp102.rst @@ -32,11 +32,9 @@ configuration for this sensor to work. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - **address** (*Optional*, int): The I²C address of the sensor. Defaults to ``0x48``. See :ref:`I²C Addresses ` for more information. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/tmp1075.rst b/components/sensor/tmp1075.rst index d44c482df..6702a81ff 100644 --- a/components/sensor/tmp1075.rst +++ b/components/sensor/tmp1075.rst @@ -45,8 +45,6 @@ to the specified pins. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the temperature sensor. -- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for lambdas/multiple sensors. - **address** (*Optional*, int): The I²C address of the sensor. See :ref:`I²C Addresses ` for more information. Defaults to ``0x48``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check @@ -57,12 +55,13 @@ Configuration variables: checks the sensor. Possible values are ``27.5ms``, ``55ms``, ``110ms``, and ``220ms``. Defaults to ``27.5ms``. - **alert** (*Optional*): Configure the alert pin behaviour. - + - **function** (*Optional*, enum): Function of the alert pin, either ``comparator`` or ``interrupt``. Defaults to ``comparator``. - **polarity** (*Optional*, enum): Polarity of the alert pin, either ``active_high`` or ``active_low``. Defaults to ``active_high``. - **limit_low** (*Optional*, int): Lower temperature limit, in °C. Defaults to ``-128`` (the lowest possible limit value). - **limit_high** (*Optional*, int): Higher temperature limit, in °C. Defaults to ``127.9375`` (the highest possible limit value). - **fault_count** (*Optional*, int): Number of measurements. required for the alert pin to act. Must be between ``1`` and ``4``, inclusive. Defaults to ``1``. +- All other options from :ref:`Sensor `. .. _tmp1075_i2c_addresses: diff --git a/components/sensor/tmp117.rst b/components/sensor/tmp117.rst index 749df70a4..42c78ad09 100644 --- a/components/sensor/tmp117.rst +++ b/components/sensor/tmp117.rst @@ -37,11 +37,10 @@ If accuracy is a must, see section 8.2.2.2 of the `datasheet ` for more information. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. The sensor component sets the maximum possible averaging in the sensor based on this. +- All other options from :ref:`Sensor `. .. _tmp117_i2c_addresses: diff --git a/components/sensor/tof10120.rst b/components/sensor/tof10120.rst index 9b7a7f748..50bb564cb 100644 --- a/components/sensor/tof10120.rst +++ b/components/sensor/tof10120.rst @@ -37,11 +37,9 @@ required to be set up in your configuration for this sensor to work. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - **address** (*Optional*, int): Manually specify the I^2C address of the sensor. Defaults to ``0x52``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/total_daily_energy.rst b/components/sensor/total_daily_energy.rst index 3fcd89581..16013bf41 100644 --- a/components/sensor/total_daily_energy.rst +++ b/components/sensor/total_daily_energy.rst @@ -43,8 +43,6 @@ Configuration variables: - **power_id** (**Required**, :ref:`config-id`): The ID of the power sensor to integrate over time. -- **name** (**Required**, string): The name of the sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **restore** (*Optional*, boolean): Whether to store the intermediate result on the device so that the value can be restored upon power cycle or reboot. Defaults to ``true``. diff --git a/components/sensor/tsl2561.rst b/components/sensor/tsl2561.rst index 9e88a8ae0..1c0afbaf9 100644 --- a/components/sensor/tsl2561.rst +++ b/components/sensor/tsl2561.rst @@ -36,7 +36,6 @@ your configuration for this sensor to work. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the sensor. - **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x39``. - **integration_time** (*Optional*, :ref:`config-time`): The time the sensor will take for each measurement. Longer means more accurate values. One of @@ -48,7 +47,6 @@ Configuration variables: package. Defaults to ``false``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. See Also diff --git a/components/sensor/tsl2591.rst b/components/sensor/tsl2591.rst index a7df0e95e..e5f97f1ee 100644 --- a/components/sensor/tsl2591.rst +++ b/components/sensor/tsl2591.rst @@ -154,28 +154,23 @@ Each configured sensor is reported separately on each ``update_interval``. - **full_spectrum** (*Optional*): The reading for the full spectrum sensor. - - **name** (**Required**, string): The name for the sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **infrared** (*Optional*): The reading for the infrared sensor. - - **name** (**Required**, string): The name for the sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **visible** (*Optional*): The reading for visible light. - - **name** (**Required**, string): The name for the sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **calculated_lux** (*Optional*): The value of the calculated lux. - - **name** (**Required**, string): The name for the sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **actual_gain** (*Optional*): The value of gain used for reported values. Particularly useful when gain is set to "auto". - - **name** (**Required**, string): The name for the sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. Power save mode ............... diff --git a/components/sensor/tuya.rst b/components/sensor/tuya.rst index da036ae6b..470db3c64 100644 --- a/components/sensor/tuya.rst +++ b/components/sensor/tuya.rst @@ -35,8 +35,6 @@ Based on this, you can create the sensor as follows: Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the sensor. - **sensor_datapoint** (**Required**, int): The datapoint id number of the sensor. - All other options from :ref:`Sensor `. diff --git a/components/sensor/ultrasonic.rst b/components/sensor/ultrasonic.rst index 0fc25fa34..bf36bf2e1 100644 --- a/components/sensor/ultrasonic.rst +++ b/components/sensor/ultrasonic.rst @@ -46,7 +46,6 @@ Configuration variables: periodically send the trigger pulse to. - **echo_pin** (**Required**, :ref:`Pin Schema `): The input pin on which to wait for the echo. -- **name** (**Required**, string): The name of the sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. - All other options from :ref:`Sensor `. diff --git a/components/sensor/veml7700.rst b/components/sensor/veml7700.rst index cacb844ff..fe92a0099 100644 --- a/components/sensor/veml7700.rst +++ b/components/sensor/veml7700.rst @@ -7,11 +7,11 @@ VEML7700 and VEML6030 Ambient Light Sensors :keywords: VEML7700, VEML6300 The ``veml7700`` sensor platform allows you to use the Vishay VEML7700 and VEML6030 ambient light sensors with ESPHome. -Communication with the device is over :ref:`I²C `, which must be present in your configuration. VEML7700 and VEML6030 -are basically the same but in different packages. The VEML7700 uses a fixed address of ``0x10``, while the smaller VEML6030 +Communication with the device is over :ref:`I²C `, which must be present in your configuration. VEML7700 and VEML6030 +are basically the same but in different packages. The VEML7700 uses a fixed address of ``0x10``, while the smaller VEML6030 can be configured to use either ``0x10`` or ``0x48``. -The VEML 7700/6030 devices are available on breakout boards from a number of vendors including `Adafruit`_, `SparkFun`_, +The VEML 7700/6030 devices are available on breakout boards from a number of vendors including `Adafruit`_, `SparkFun`_, `DFRobot`_, and others. .. _Adafruit: http://www.adafruit.com/products/4162 @@ -20,7 +20,7 @@ The VEML 7700/6030 devices are available on breakout boards from a number of ven .. figure:: images/veml7700-full.jpg - :align: center + :align: center :width: 70.0% VEML7700 Ambient Light Sensor on a board and standalone sensors. @@ -33,7 +33,7 @@ The VEML 7700/6030 devices are available on breakout boards from a number of ven The sensor is a high accuracy ambient light digital 16-bit resolution sensor with dynamic range from 0 lux to about 120,000 lux. Its wide range of measurements is enabled by four configurable *gain* levels and six different *integration time* options. -Higher gain values are typically used for lower light conditions. +Higher gain values are typically used for lower light conditions. The sensor has two photodiodes with different spectral response represented by two channels: an *ALS* channel and a *WHITE* channel. The *ALS*, or *Ambient light* channel follows a so-called human eye curve very closely. The *WHITE* channel covers a much wider wavelength/spectrum, capturing quite a lot of near-infrared radiance. @@ -50,12 +50,12 @@ taking several measurements. To do so, it follows a process recommended by the Should you desire to manually control those parameters - please note that: -- Gain levels of 1/8 and 1/4 shall be used in most cases. +- Gain levels of 1/8 and 1/4 shall be used in most cases. - Gain levels of 1 an 2 are only intended to be used in low light conditions < 100 lux. For very high illuminations it shows high non-linearity. -- In the range of 0 lux - 1000 lux the sensor measurements are stricly linear for Gain 1/4 and 1/8, after 1000 lux it shows non-linearity. +- In the range of 0 lux - 1000 lux the sensor measurements are stricly linear for Gain 1/4 and 1/8, after 1000 lux it shows non-linearity. -A lux compensation formula is used to get better readings in bright conditions. +A lux compensation formula is used to get better readings in bright conditions. However, it gives quite high error in very bright direct sunlight (instead of 100-120 kilolux it might give 150-200k+). This Wikipedia `article `__ has a table of some lux values for comparison. @@ -63,9 +63,9 @@ This Wikipedia `article `__ has a table of so Automatic measurement mode -------------------------- -In automatic measurement mode the component starts from Gain 1/8 and 100 ms (*default*). +In automatic measurement mode the component starts from Gain 1/8 and 100 ms (*default*). -- If illuminance is higher than 46 lx (100 counts) it gradually reduces integration time to get good reading (best in range 100 - 10,000 counts). +- If illuminance is higher than 46 lx (100 counts) it gradually reduces integration time to get good reading (best in range 100 - 10,000 counts). - In case of low illuminance (less than 46 lx) it tries to gradually increase gain and only then increase integration time. Please note, that in low light conditions measurement process might take several seconds due to long exposure periods and sensor reconfigurations. @@ -119,11 +119,11 @@ Example configuration - platform: veml7700 address: 0x10 update_interval: 60s - + # short variant of sensor definition: ambient_light: "Ambient light" # longer variant of sensor definition: - actual_gain: + actual_gain: name: "Actual gain" @@ -134,24 +134,24 @@ Configuration variables: - **integration_time** (*Optional*, :ref:`config-time`): The amount of time the sensor is exposed. Valid values are ``25ms``, ``50ms``, ``100ms`` *(default)*, ``200ms``, ``400ms``, ``800ms``. *In automatic mode it sets starting value*. -- **gain** (*Optional*, string): The gain the device will use for the internal ADC. Valid values are +- **gain** (*Optional*, string): The gain the device will use for the internal ADC. Valid values are ``1/8x`` *(default)*, ``1/4x``, ``1x``, ``2x``. Higher values are better in low-light conditions. *In automatic mode it sets starting gain value*. - **lux_compensation** (*Optional*, boolean): Lux compensation formula is used as per manufacturer. Defaults to ``True``. -- **glass_attenuation_factor** (*Optional*): The attenuation factor of glass if it's behind some glass +- **glass_attenuation_factor** (*Optional*): The attenuation factor of glass if it's behind some glass or plastic facia. Default is ``1.0`` means ``100%`` transmissivity. ``2`` means ``50%`` transmissivity etc. - **update_interval** (*Optional*, :ref:`config-time`): The interval for checking the sensors. Defaults to ``60s``. -- All other options for I²C devices described at :ref:`I²C Bus `. +- All other options for I²C devices described at :ref:`I²C Bus `. The sensor supports bus modes "standard" and "fast": 10 kHz to 400 kHz. Sensors ....... You can configure all or any subset of the sensors described earlier. -Each configured sensor is reported separately on each ``update_interval``. **name** (**Required**, string) is required for -every sensor. All other options from :ref:`Sensor `. +Each configured sensor is reported separately on each ``update_interval``. +All options from :ref:`Sensor ` are supported. However, if you don't need any other options, you can just use shorthands like this: ``ambient_light: Ambient light``. diff --git a/components/sensor/wifi_signal.rst b/components/sensor/wifi_signal.rst index 63b8ff905..54933f64a 100644 --- a/components/sensor/wifi_signal.rst +++ b/components/sensor/wifi_signal.rst @@ -34,7 +34,7 @@ To additionally display signal strength in percentage use the :ref:`copy-sensor` id: wifi_signal_db update_interval: 60s entity_category: "diagnostic" - + - platform: copy # Reports the WiFi signal strength in % source_id: wifi_signal_db name: "WiFi Signal Percent" @@ -47,10 +47,8 @@ To additionally display signal strength in percentage use the :ref:`copy-sensor` Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the WiFi signal sensor. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Sensor `. .. warning:: diff --git a/components/sensor/xiaomi_ble.rst b/components/sensor/xiaomi_ble.rst index cf88a30bf..6a750dfe0 100644 --- a/components/sensor/xiaomi_ble.rst +++ b/components/sensor/xiaomi_ble.rst @@ -539,7 +539,7 @@ Required: - **mac_address** (MAC Address): The MAC address of the device. - **bindkey** (string, 32 characters, case insensitive): The key to decrypt the BLE advertisements for encrypted sensor types -Optional with **name**, **id** (:ref:`config-id`) and all other options from :ref:`Sensor `: +All options from :ref:`Sensor ` are supported for: - **temperature** - **humidity** diff --git a/components/sensor/xiaomi_miscale.rst b/components/sensor/xiaomi_miscale.rst index 61dbba5ab..4860035b0 100644 --- a/components/sensor/xiaomi_miscale.rst +++ b/components/sensor/xiaomi_miscale.rst @@ -38,13 +38,11 @@ Configuration variables: - **mac_address** (**Required**, MAC Address): The MAC address of the scale. - **weight** (*Optional*): The information for the weight sensor. - - **name** (**Required**, string): The name for the weight sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **impedance** (*Optional*): The information for the impedance sensor. **Only available on MiScale2** - - **name** (**Required**, string): The name for the impedance sensor. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **clear_impedance** (*Optional*): Clear the impedance information if a weight reading without impedance is received. Defaults to ``false``. **Only available on MiScale2** diff --git a/components/sensor/zyaura.rst b/components/sensor/zyaura.rst index 1f7f81619..ee6d9441f 100644 --- a/components/sensor/zyaura.rst +++ b/components/sensor/zyaura.rst @@ -46,21 +46,15 @@ Configuration variables: - **data_pin** (**Required**, :ref:`config-pin`): The pin where the data bus is connected. - **co2** (*Optional*): The information for the CO2 sensor. - - **name** (**Required**, string): The name for the CO2 sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **temperature** (*Optional*): The information for the temperature sensor. - - **name** (**Required**, string): The name for the temperature sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity** (*Optional*): The information for the humidity sensor - - **name** (**Required**, string): The name for the humidity sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. From 7d4690f3625261e819e72a2abbe575691475c53e Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:33:14 +1200 Subject: [PATCH 09/22] [select] Tidy up name/id (#4149) --- components/select/index.rst | 3 ++- components/select/modbus_controller.rst | 4 +--- components/select/template.rst | 2 -- components/select/tuya.rst | 2 -- 4 files changed, 3 insertions(+), 8 deletions(-) diff --git a/components/select/index.rst b/components/select/index.rst index 5c05a65b0..688f4132b 100644 --- a/components/select/index.rst +++ b/components/select/index.rst @@ -30,7 +30,8 @@ All selects in ESPHome have a name and an optional icon. Configuration variables: -- **name** (**Required**, string): The name for the select. +- **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 for the select. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/select/modbus_controller.rst b/components/select/modbus_controller.rst index 1c90d8526..76cfa56e8 100644 --- a/components/select/modbus_controller.rst +++ b/components/select/modbus_controller.rst @@ -10,7 +10,6 @@ registers. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the Select. - **address** (**Required**, int): The start address of the first or only register of the Select (can be decimal or hexadecimal). - **optionsmap** (**Required**, Map[str, int]): Provide a mapping from options (str) of @@ -38,7 +37,6 @@ Configuration variables: - **force_new_range** (*Optional*, boolean): If possible sensors with sequential addresses are grouped together and requested in one range. Setting this to ``true`` enforces the start of a new range at that address. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated every update interval to get the current option of the select. @@ -57,7 +55,7 @@ Configuration variables: - **write_lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated on every update of the Sensor, before the new value is written to the modbus registers. -- **use_write_multiple** (*Optional*, boolean): By default the modbus command *Function Code 6 (Preset Single Registers)* +- **use_write_multiple** (*Optional*, boolean): By default the modbus command *Function Code 6 (Preset Single Registers)* is used for setting the holding register if only one register is set. If your device only supports *Function Code 16 (Preset Multiple Registers)* set this option to ``true``. - **optimistic** (*Optional*, boolean): Whether to operate in optimistic mode - when in this mode, any command sent to the Modbus Select will immediately update the reported state. Defaults diff --git a/components/select/template.rst b/components/select/template.rst index 39f544a43..a349358f2 100644 --- a/components/select/template.rst +++ b/components/select/template.rst @@ -25,7 +25,6 @@ using :ref:`lambdas `. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the Select. - **options** (**Required**, list): The list of options this Select has. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated every update interval to get the current option of the select. @@ -42,7 +41,6 @@ Configuration variables: - **initial_option** (*Optional*, string): The option to set the option to on setup if not restored with ``restore_value``. Cannot be used with ``lambda``. Defaults to the first option in the ``options`` list. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Select `. .. note:: diff --git a/components/select/tuya.rst b/components/select/tuya.rst index 1b0b9d5e3..456d70b19 100644 --- a/components/select/tuya.rst +++ b/components/select/tuya.rst @@ -49,8 +49,6 @@ Based on this, you can create the select as follows: Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the switch. - **enum_datapoint** (**Required**, int): The enum datapoint id number for the select. - **options** (**Required**, Map[int, str]): Provide a mapping from values (int) of this Select to options (str) of the *enum_datapoint* and vice versa. All options and From 2d2971af576f0508f685fb9aca9617da5317c971 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:34:33 +1200 Subject: [PATCH 10/22] [number] Tidy up name/id (#4148) --- components/number/index.rst | 3 ++- components/number/modbus_controller.rst | 2 -- components/number/template.rst | 2 -- components/number/tuya.rst | 2 -- 4 files changed, 2 insertions(+), 7 deletions(-) diff --git a/components/number/index.rst b/components/number/index.rst index 82ba8e336..117c170e2 100644 --- a/components/number/index.rst +++ b/components/number/index.rst @@ -30,7 +30,8 @@ All numbers in ESPHome have a name and an optional icon. Configuration variables: -- **name** (**Required**, string): The name for the number. +- **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 for the number. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/number/modbus_controller.rst b/components/number/modbus_controller.rst index 3c5e2042b..f43b9c883 100644 --- a/components/number/modbus_controller.rst +++ b/components/number/modbus_controller.rst @@ -10,8 +10,6 @@ When the Number is updated a modbus write command is created sent to the device. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the sensor. - **address** (**Required**, int): start address of the first register in a range (can be decimal or hexadecimal). - **value_type** (**Required**): datatype of the modbus register data. The default data type for modbus is a 16 bit integer in big endian format (MSB first): diff --git a/components/number/template.rst b/components/number/template.rst index 13cbef2f7..62b52799e 100644 --- a/components/number/template.rst +++ b/components/number/template.rst @@ -22,7 +22,6 @@ using :ref:`lambdas `. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the number. - **min_value** (**Required**, float): The minimum value this number can be. - **max_value** (**Required**, float): The maximum value this number can be. - **step** (**Required**, float): The granularity with which the number can be set. @@ -41,7 +40,6 @@ Configuration variables: - **initial_value** (*Optional*, float): The value to set the state to on setup if not restored with ``restore_value``. Cannot be used with ``lambda``. Defaults to ``min_value``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Number `. ``number.set`` Action diff --git a/components/number/tuya.rst b/components/number/tuya.rst index 8db9bdf5c..bf05ac960 100644 --- a/components/number/tuya.rst +++ b/components/number/tuya.rst @@ -64,8 +64,6 @@ For instance, assume we have a pH sensor that reads from 0.00 to 15.00 with a sc Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the switch. - **number_datapoint** (**Required**, int): The datapoint id number of the number. - **min_value** (**Required**, float): The minimum value this number can be. - **max_value** (**Required**, float): The maximum value this number can be. From 5e53c6fed8b0bc6914644b095d2e134480c40d52 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:38:05 +1200 Subject: [PATCH 11/22] [text_sensor] Tidy up name/id (#4152) --- components/text_sensor/ble_client.rst | 1 - components/text_sensor/ble_scanner.rst | 3 +-- components/text_sensor/homeassistant.rst | 4 +--- components/text_sensor/index.rst | 3 ++- components/text_sensor/modbus_controller.rst | 4 +--- components/text_sensor/mqtt_subscribe.rst | 2 -- components/text_sensor/nextion.rst | 1 - components/text_sensor/template.rst | 2 -- components/text_sensor/tuya.rst | 2 -- components/text_sensor/version.rst | 4 +--- 10 files changed, 6 insertions(+), 20 deletions(-) diff --git a/components/text_sensor/ble_client.rst b/components/text_sensor/ble_client.rst index 1ea20be7c..2f45e799a 100644 --- a/components/text_sensor/ble_client.rst +++ b/components/text_sensor/ble_client.rst @@ -33,7 +33,6 @@ Configuration variables: - **service_uuid** (**Required**, UUID): UUID of the service on the device. - **characteristic_uuid** (**Required**, UUID): UUID of the service's characteristic to query. - **descriptor_uuid** (*Optional*, UUID): UUID of the characteristic's descriptor to query. -- **id** (*Optional*, :ref:`config-id`): The ID to use for code generation, and for reference by dependent components. - **notify** (*Optional*, boolean): Instruct the server to send notifications for this characteristic. Defaults to ``false``. - **update_interval** (*Optional*, :ref:`config-time`): The interval to poll the device. Defaults to ``60s``. diff --git a/components/text_sensor/ble_scanner.rst b/components/text_sensor/ble_scanner.rst index c577d4d08..142c3cf29 100644 --- a/components/text_sensor/ble_scanner.rst +++ b/components/text_sensor/ble_scanner.rst @@ -47,8 +47,7 @@ Example json log: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. -- All other options from :ref:`Text Sensor `. +- All options from :ref:`Text Sensor `. See Also -------- diff --git a/components/text_sensor/homeassistant.rst b/components/text_sensor/homeassistant.rst index 31f332f8e..f012ced2d 100644 --- a/components/text_sensor/homeassistant.rst +++ b/components/text_sensor/homeassistant.rst @@ -13,7 +13,7 @@ states from your Home Assistant instance using the :doc:`native API `. See Also diff --git a/components/text_sensor/index.rst b/components/text_sensor/index.rst index e6709e507..e94f1a1be 100644 --- a/components/text_sensor/index.rst +++ b/components/text_sensor/index.rst @@ -24,7 +24,8 @@ Base Text Sensor Configuration Configuration variables: -- **name** (**Required**, string): The name for the sensor. +- **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 for the sensor. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/text_sensor/modbus_controller.rst b/components/text_sensor/modbus_controller.rst index f949ac7f2..6e8685808 100644 --- a/components/text_sensor/modbus_controller.rst +++ b/components/text_sensor/modbus_controller.rst @@ -10,8 +10,6 @@ and requires :doc:`/components/modbus_controller` to be configured. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the sensor. - **register_type** (**Required**): type of the modbus register. - ``coil``: Coils are 1-bit registers (on/off values) that are used to control discrete outputs. They may be read and/or written. Modbus *Function Code 1 (Read Coil Status)* will be used. @@ -53,7 +51,7 @@ Configuration variables: - ``return ;`` the new value for the sensor. - ``return {};`` uses the parsed value for the state (same as ``return x;``). -- **offset** (*Optional*, int): Offset from start address in bytes (only required for uncommon response encodings). If more than one register is written in a command this value is used to find the start of this datapoint relative to start address. The component calculates the size of the range based on offset and size of the value type. The value for offset depends on the register type. +- **offset** (*Optional*, int): Offset from start address in bytes (only required for uncommon response encodings). If more than one register is written in a command this value is used to find the start of this datapoint relative to start address. The component calculates the size of the range based on offset and size of the value type. The value for offset depends on the register type. - All options from :ref:`Text Sensor `. Example: diff --git a/components/text_sensor/mqtt_subscribe.rst b/components/text_sensor/mqtt_subscribe.rst index 17a6d5966..d0a96574f 100644 --- a/components/text_sensor/mqtt_subscribe.rst +++ b/components/text_sensor/mqtt_subscribe.rst @@ -22,10 +22,8 @@ in its ``id(mysensor).state``. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the text sensor. - **topic** (**Required**, string): The MQTT topic to listen for string data. - **qos** (*Optional*, int): The MQTT QoS to subscribe with. Defaults to ``0``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Text Sensor `. Example Usage for Displays diff --git a/components/text_sensor/nextion.rst b/components/text_sensor/nextion.rst index 619ccb2e3..b50be7c73 100644 --- a/components/text_sensor/nextion.rst +++ b/components/text_sensor/nextion.rst @@ -32,7 +32,6 @@ See :doc:`/components/display/nextion` for setting up the display Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display. - **component_name** (*Optional*, string): The name of the Nextion component. - **update_interval** (*Optional*, :ref:`config-time`): The duration to update the sensor. If using a :ref:`nextion_custom_text_sensor_protocol` this should not be used diff --git a/components/text_sensor/template.rst b/components/text_sensor/template.rst index 5886e5dcf..abe085a80 100644 --- a/components/text_sensor/template.rst +++ b/components/text_sensor/template.rst @@ -28,12 +28,10 @@ Possible return values for the lambda: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the text sensor. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated every update interval to get the new value of the text sensor - **update_interval** (*Optional*, :ref:`config-time`): The interval to check the text sensor. Set to ``never`` to disable updates. Defaults to ``60s``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Text Sensor `. .. _text_sensor-template-publish_action: diff --git a/components/text_sensor/tuya.rst b/components/text_sensor/tuya.rst index 49c1a32ad..deed0760a 100644 --- a/components/text_sensor/tuya.rst +++ b/components/text_sensor/tuya.rst @@ -21,8 +21,6 @@ You can create the text sensor as follows: Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the sensor. - **sensor_datapoint** (**Required**, int): The datapoint id number of the sensor. - All other options from :ref:`Text Sensor `. diff --git a/components/text_sensor/version.rst b/components/text_sensor/version.rst index dcb78dfd1..6e6a7923a 100644 --- a/components/text_sensor/version.rst +++ b/components/text_sensor/version.rst @@ -21,15 +21,13 @@ was compiled against as a text sensor. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the text sensor. - **hide_timestamp** (*Optional*, boolean): Allows you to hide the compilation timestamp from the version string. Defaults to ``false``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Text Sensor `. Disabling the compilation timestamp: ------------------------------------ -.. code-block:: yaml +.. code-block:: yaml # Example configuration entry text_sensor: From f6b565de768b561135670b7396ed80da50002ced Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:38:20 +1200 Subject: [PATCH 12/22] [media_player] Tidy up name/id (#4147) --- components/media_player/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/components/media_player/index.rst b/components/media_player/index.rst index 01a33e595..f71f32be9 100644 --- a/components/media_player/index.rst +++ b/components/media_player/index.rst @@ -25,7 +25,8 @@ Base Media Player Configuration Configuration variables: -- **name** (**Required**, string): The name of the media player. +- **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 media player. At least one of **id** and **name** must be specified. .. note:: From 3b59f2c84795dccbb86fcb2da7a635bfd05a569a Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:38:52 +1200 Subject: [PATCH 13/22] [lock] Tidy up name/id (#4146) --- components/lock/index.rst | 3 ++- components/lock/output.rst | 2 -- components/lock/template.rst | 2 -- 3 files changed, 2 insertions(+), 5 deletions(-) diff --git a/components/lock/index.rst b/components/lock/index.rst index a42f88be4..f88c93978 100644 --- a/components/lock/index.rst +++ b/components/lock/index.rst @@ -21,7 +21,8 @@ Base Lock Configuration Configuration variables: -- **name** (**Required**, string): The name of the lock. +- **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 lock. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/lock/output.rst b/components/lock/output.rst index ef07f4518..127ad9a01 100644 --- a/components/lock/output.rst +++ b/components/lock/output.rst @@ -27,8 +27,6 @@ Configuration variables: ------------------------ - **output** (**Required**, :ref:`config-id`): The ID of the output component to use. -- **name** (**Required**, string): The name for the lock. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Lock `. See Also diff --git a/components/lock/template.rst b/components/lock/template.rst index e94a42ffd..feeff7fde 100644 --- a/components/lock/template.rst +++ b/components/lock/template.rst @@ -45,7 +45,6 @@ Possible return values for the optional lambda: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the lock. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated repeatedly to get the current state of the lock. - **lock_action** (*Optional*, :ref:`Action `): The action that should @@ -58,7 +57,6 @@ Configuration variables: - **assumed_state** (*Optional*, boolean): Whether the true state of the lock is not known. This will make the Home Assistant frontend show buttons for both LOCK and UNLOCK actions, instead of hiding one of them when the lock is LOCKED/UNLOCKED. Defaults to ``false``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Lock `. .. _lock-template-publish_action: From 391eeda9e384a7593b426614fd64d90a4dd3b070 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:41:14 +1200 Subject: [PATCH 14/22] [climate] Tidy up name/id (#4140) * [climate] Tidy up name/id * Fix paste mistake --- components/climate/anova.rst | 2 -- components/climate/bedjet.rst | 4 ---- components/climate/climate_ir.rst | 14 ++++++-------- components/climate/haier.rst | 2 -- components/climate/index.rst | 3 ++- components/climate/midea.rst | 14 +++----------- components/climate/pid.rst | 3 ++- components/climate/tuya.rst | 4 +--- 8 files changed, 14 insertions(+), 32 deletions(-) diff --git a/components/climate/anova.rst b/components/climate/anova.rst index fe0e4d465..2962f8a67 100644 --- a/components/climate/anova.rst +++ b/components/climate/anova.rst @@ -48,8 +48,6 @@ need to do conversion again within the frontend if you use Fahrenheit. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the climate device. - **ble_client_id** (**Required**, :ref:`config-id`): The ID of the BLE Client. - **unit_of_measurement** (**Required**, string): Units to use on the device display. 'c' or 'f'. - All other options from :ref:`Climate `. diff --git a/components/climate/bedjet.rst b/components/climate/bedjet.rst index d20c370e6..31b7e442c 100644 --- a/components/climate/bedjet.rst +++ b/components/climate/bedjet.rst @@ -109,8 +109,6 @@ setting the mode and target temperature. Configuration variables: ************************ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the climate device. - **bedjet_id** (**Required**, :ref:`config-id`): The ID of the Bedjet component. - **heat_mode** (*Optional*, string): The primary heating mode to use for ``HVACMode.HEAT``: @@ -148,8 +146,6 @@ When the BedJet is already on, turning the Fan component off will set the BedJet Configuration variables: ************************ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the fan device. - **bedjet_id** (**Required**, :ref:`config-id`): The ID of the Bedjet component. - Other options from :ref:`Fan `. diff --git a/components/climate/climate_ir.rst b/components/climate/climate_ir.rst index 4c54f97bb..aaf3cc23f 100644 --- a/components/climate/climate_ir.rst +++ b/components/climate/climate_ir.rst @@ -88,7 +88,6 @@ controller unit. Configuration Variables: ------------------------ -- **name** (**Required**, string): The name for the climate device. - **sensor** (*Optional*, :ref:`config-id`): The sensor that is used to measure the ambient temperature. This is only for reporting the current temperature in the frontend. - **supports_cool** (*Optional*, boolean): Enables setting cooling mode for this climate device. Defaults to ``true``. @@ -99,7 +98,6 @@ Configuration Variables: **Advanced Options** -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **transmitter_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the remote transmitter. **Specific configuration variables:** @@ -206,8 +204,8 @@ These air conditioners support two protocols: Midea and Coolix. Therefore, when - **set_fan_mode** (*Optional*, string): Select the fan modes desired or that are supported on your remote. Defaults to ``3levels`` - - Options are: ``3levels`` , ``4levels``, ``quiet_4levels``. - + - Options are: ``3levels`` , ``4levels``, ``quiet_4levels``. + - ``3levels``; Low [fan speed 1], Medium [2], High [3] - ``4levels``; Low [1], Middle [2], Medium [3], High [4] - ``quiet_4levels``; Low [1], Middle [2], Medium [3], High [4], Quiet [5] @@ -215,10 +213,10 @@ These air conditioners support two protocols: Midea and Coolix. Therefore, when - **supports_dry** (*Optional*, boolean): Enables setting dry mode for this unit. Defaults to ``false``. - **supports_fan_only** (*Optional*, boolean): Enables setting fan only mode for this unit. Confirm that mode is supported on your remote. Defaults to ``false``. -- **horizontal_default** (*Optional*, string): What to default to when the AC unit's horizontal direction is *not* set to swing. Defaults to ``middle``. +- **horizontal_default** (*Optional*, string): What to default to when the AC unit's horizontal direction is *not* set to swing. Defaults to ``middle``. - Options are: ``left``, ``middle-left``, ``middle``, ``middle-right``, ``right``, ``auto`` -- **vertical_default** (*Optional*, string): What to default to when the AC unit's vertical direction is *not* set to swing. Defaults to ``middle``. +- **vertical_default** (*Optional*, string): What to default to when the AC unit's vertical direction is *not* set to swing. Defaults to ``middle``. - Options are: ``down``, ``middle-down``, ``middle``, ``middle-up``, ``up``, ``auto`` @@ -339,13 +337,13 @@ Arduino-HeatpumpIR The ``heatpumpir`` platform supports dozens of manufacturers and hundreds of AC units by utilising the `Arduino-HeatpumpIR library `__. -This platform compiles only under ``arduino`` framework or LibreTiny, and should only be used if your AC unit is not supported by any of the other (native) platforms from above. No support can be provided for Arduino-HeatpumpIR, because it is a third party library. +This platform compiles only under ``arduino`` framework or LibreTiny, and should only be used if your AC unit is not supported by any of the other (native) platforms from above. No support can be provided for Arduino-HeatpumpIR, because it is a third party library. This platform utilises the library's generic one-size-fits-all API, which might not line up perfectly with all of the supported AC units. For example, some AC units have more fan speed options than what the generic API supports. Additional configuration must be specified for this platform: -- **protocol** (**Required**, string): Choose one of Arduino-HeatpumpIR's supported protcols: +- **protocol** (**Required**, string): Choose one of Arduino-HeatpumpIR's supported protcols: ``airway``, ``aux``, ``ballu``, ``bgh_aud``, ``carrier_mca``, ``carrier_nqv``, ``carrier_qlima_1``, ``carrier_qlima_1``, ``daikin``, ``daikin_arc417``, ``daikin_arc480``, ``electroluxyal``, ``fuego``, ``fujitsu_awyz``, ``gree``, ``greeyaa``, ``greeyac``, ``greeyan``, ``greeyap``, ``greeyt``, ``hisense_aud``, ``hitachi``, ``hyundai``, ``ivt``, ``midea``, ``mitsubishi_fa``, ``mitsubishi_fd``, diff --git a/components/climate/haier.rst b/components/climate/haier.rst index c14b14c6c..9369f191f 100644 --- a/components/climate/haier.rst +++ b/components/climate/haier.rst @@ -111,10 +111,8 @@ This component requires a :ref:`uart` to be setup. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **uart_id** (*Optional*, :ref:`config-id`): ID of the UART port to communicate with AC. - **protocol** (*Optional*, string): Defines communication protocol with AC. Possible values: ``hon`` or ``smartair2``. The default value is ``smartair2``. -- **name** (**Required**, string): The name of the climate device. - **wifi_signal** (*Optional*, boolean): If ``true`` - send wifi signal level to AC. - **answer_timeout** (*Optional*, :ref:`config-time`): Responce timeout. The default value is ``200ms``. - **alternative_swing_control** (*Optional*, boolean): (supported by smartAir2 only) If ``true`` - use alternative values to control swing mode. Use only if the original control method is not working for your AC. diff --git a/components/climate/index.rst b/components/climate/index.rst index 5385bfa3e..8badd6d9b 100644 --- a/components/climate/index.rst +++ b/components/climate/index.rst @@ -46,7 +46,8 @@ All climate platforms in ESPHome inherit from the climate configuration schema. Configuration variables: -- **name** (**Required**, string): The name of the climate device. +- **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 climate device. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/climate/midea.rst b/components/climate/midea.rst index cec59359c..659fddca9 100644 --- a/components/climate/midea.rst +++ b/components/climate/midea.rst @@ -67,10 +67,8 @@ The ``midea`` component creates a Midea air conditioner climate device. 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 :doc:`../uart` if you want to use multiple UART buses. -- **name** (**Required**, string): The name of the climate device. - **transmitter_id** (*Optional*, :ref:`config-id`): Defined and used automatically when using :doc:`../remote_transmitter` component for IR commands transmit. - **period** (*Optional*, :ref:`config-time`): Minimal period between requests to the appliance. Defaults to ``1s``. - **timeout** (*Optional*, :ref:`config-time`): Request response timeout until next request attempt. Defaults to ``2s``. @@ -86,21 +84,15 @@ Configuration variables: - **outdoor_temperature** (*Optional*): The information for the outdoor temperature sensor. - - **name** (**Required**, string): The name of the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **power_usage** (*Optional*): The information for the current power consumption sensor. - - **name** (**Required**, string): The name of the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - **humidity_setpoint** (*Optional*): The information for the humidity indoor sensor (experimental). - - **name** (**Required**, string): The name of the sensor. - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - All other options from :ref:`Sensor `. + - All options from :ref:`Sensor `. - All other options from :ref:`Climate `. Automations diff --git a/components/climate/pid.rst b/components/climate/pid.rst index c8bdad802..ec256623e 100644 --- a/components/climate/pid.rst +++ b/components/climate/pid.rst @@ -409,7 +409,6 @@ the calculated PID parameters to help finding good PID values. Configuration variables: -- **name** (**Required**, string): The name of the sensor - **type** (**Required**, string): The value to monitor. One of - ``RESULT`` - The resulting value (sum of P, I, and D terms). @@ -423,6 +422,8 @@ Configuration variables: - ``KI`` - The current factor for the integral term of the PID controller. - ``KD`` - The current factor for the differential term of the PID controller. +- All other options from :ref:`Sensor `. + Advanced options: - **climate_id** (*Optional*, :ref:`config-id`): The ID of the pid climate to get the values from. diff --git a/components/climate/tuya.rst b/components/climate/tuya.rst index c0bf5f855..707d27f43 100644 --- a/components/climate/tuya.rst +++ b/components/climate/tuya.rst @@ -60,14 +60,12 @@ Based on this, you can create the climate device as follows: eco: datapoint: 5 temperature: 28 - + Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the climate device. - **supports_heat** (*Optional*, boolean): Specifies if the device has a heating mode. Defaults to ``true``. - **supports_cool** (*Optional*, boolean): Specifies if the device has a cooling mode. Defaults to ``false``. - **switch_datapoint** (**Required**, int): The datapoint id number of the climate switch (device on/off). From 5e517bb13fc21a33a83fc1ccf80200996afb4484 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:46:33 +1200 Subject: [PATCH 15/22] [light] Tidy up name/id (#4145) * [light] Tidy up name/id * Update components/light/shelly_dimmer.rst --------- Co-authored-by: Keith Burzinski --- components/light/binary.rst | 7 +------ components/light/color_temperature.rst | 3 --- components/light/cwww.rst | 3 --- components/light/fastled.rst | 5 ----- components/light/hbridge.rst | 2 -- components/light/index.rst | 3 ++- components/light/monochromatic.rst | 3 --- components/light/neopixelbus.rst | 5 ----- components/light/partition.rst | 6 +----- components/light/rgb.rst | 3 --- components/light/rgbct.rst | 3 --- components/light/rgbw.rst | 3 --- components/light/rgbww.rst | 3 --- components/light/shelly_dimmer.rst | 5 +---- components/light/sonoff_d1.rst | 2 -- components/light/spi_led_strip.rst | 3 --- components/light/status_led.rst | 4 ---- components/light/tuya.rst | 2 -- 18 files changed, 5 insertions(+), 60 deletions(-) diff --git a/components/light/binary.rst b/components/light/binary.rst index 4a3bf44e5..08fe2f6c9 100644 --- a/components/light/binary.rst +++ b/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 ` 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 `. See Also diff --git a/components/light/color_temperature.rst b/components/light/color_temperature.rst index b66a94248..1f674d551 100644 --- a/components/light/color_temperature.rst +++ b/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 `__, or the lowest value when expressed in Kelvin. -- **effects** (*Optional*, list): A list of :ref:`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 `. See Also diff --git a/components/light/cwww.rst b/components/light/cwww.rst index 43127cbc4..467087c4b 100644 --- a/components/light/cwww.rst +++ b/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 `__ or Kelvin) @@ -44,8 +43,6 @@ Configuration variables: - **warm_white_color_temperature** (*Optional*, float): The color temperature (in `mireds `__ 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 ` to use for this light. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Light `. See Also diff --git a/components/light/fastled.rst b/components/light/fastled.rst index f1799fca0..cc68da4e8 100644 --- a/components/light/fastled.rst +++ b/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 ` to use for this light. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`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 ` to use for this light. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Light `. .. _fastled_spi-chipsets: diff --git a/components/light/hbridge.rst b/components/light/hbridge.rst index 07b8c23cc..5560c007c 100644 --- a/components/light/hbridge.rst +++ b/components/light/hbridge.rst @@ -34,8 +34,6 @@ control the colors in the :ref:`light control actions `, 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 `. diff --git a/components/light/index.rst b/components/light/index.rst index 60125554e..aaee49489 100644 --- a/components/light/index.rst +++ b/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:: diff --git a/components/light/monochromatic.rst b/components/light/monochromatic.rst index c24a9787a..164ff7f42 100644 --- a/components/light/monochromatic.rst +++ b/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 ` to use for this light. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Light `. See Also diff --git a/components/light/neopixelbus.rst b/components/light/neopixelbus.rst index 852978677..69cf51465 100644 --- a/components/light/neopixelbus.rst +++ b/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 ` 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 `. .. warning:: diff --git a/components/light/partition.rst b/components/light/partition.rst index a5544cb45..50778b13a 100644 --- a/components/light/partition.rst +++ b/components/light/partition.rst @@ -90,9 +90,8 @@ 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:* - **id** (**Required**, :ref:`config-id`): The ID of the addressable light to be controlled by this segment. @@ -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 ` to use for this light. - - All other options from :ref:`Light `. .. note:: diff --git a/components/light/rgb.rst b/components/light/rgb.rst index 2c1f4f837..bfa1b2b32 100644 --- a/components/light/rgb.rst +++ b/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 ` to use for this light. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Light `. See Also diff --git a/components/light/rgbct.rst b/components/light/rgbct.rst index 7e198bbb2..3447758ea 100644 --- a/components/light/rgbct.rst +++ b/components/light/rgbct.rst @@ -25,7 +25,6 @@ light from 5 :ref:`float output components ` (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 ` to use for this light. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Light `. See Also diff --git a/components/light/rgbw.rst b/components/light/rgbw.rst index ca089b07d..3cf45f830 100644 --- a/components/light/rgbw.rst +++ b/components/light/rgbw.rst @@ -64,15 +64,12 @@ the ``color_mode`` option of the :ref:`light control actions ` 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 `. See Also diff --git a/components/light/rgbww.rst b/components/light/rgbww.rst index 426e45f1b..c308860e2 100644 --- a/components/light/rgbww.rst +++ b/components/light/rgbww.rst @@ -69,7 +69,6 @@ the ``color_mode`` option of the :ref:`light control actions ` to use for this light. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Light `. See Also diff --git a/components/light/shelly_dimmer.rst b/components/light/shelly_dimmer.rst index d6f9b8c12..7b5899067 100644 --- a/components/light/shelly_dimmer.rst +++ b/components/light/shelly_dimmer.rst @@ -10,7 +10,6 @@ A detailed analysis of the Shelly Dimmer 2 hardware is given `here `_: ``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. @@ -91,7 +88,7 @@ Configuration variables: firmware: version: "51.6" #<-- set version here update: true - + There is no action required by the user to flash the STM32. There is no way to revert to stock firmware on the STM32 at the time of writing. - All other options from :ref:`Light `. diff --git a/components/light/sonoff_d1.rst b/components/light/sonoff_d1.rst index b2a17cba8..4882f6951 100644 --- a/components/light/sonoff_d1.rst +++ b/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 diff --git a/components/light/spi_led_strip.rst b/components/light/spi_led_strip.rst index 31b226e09..5626d18c3 100644 --- a/components/light/spi_led_strip.rst +++ b/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 ` 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 `. diff --git a/components/light/status_led.rst b/components/light/status_led.rst index 69b315b5f..1aa2b91c1 100644 --- a/components/light/status_led.rst +++ b/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 `): 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 ` to use for this light, though binary lights - only support very few of them. - All other options from :ref:`Light `. .. note:: diff --git a/components/light/tuya.rst b/components/light/tuya.rst index e0b74872a..e866828f8 100644 --- a/components/light/tuya.rst +++ b/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. From d24b5602bf306490ca85c3290d273e66e4913e42 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:48:08 +1200 Subject: [PATCH 16/22] [event] Tidy up name/id (#4143) * [event] Tidy up name/id * Fix spelling --------- Co-authored-by: Keith Burzinski --- components/event/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/event/index.rst b/components/event/index.rst index 3d5d222aa..b1cc7e4f2 100644 --- a/components/event/index.rst +++ b/components/event/index.rst @@ -48,8 +48,8 @@ Configuration variables: One of ``id`` or ``name`` is required. -- **id** (**Required**, :ref:`config-id`): Manually specify the ID used for code generation, allowing for further customization or interaction with this event within ESPHome scripts or lambda functions. -- **name** (**Required**, string): The name for the event. +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. At least one of **id** and **name** must be specified. +- **name** (*Optional*, string): The name for the event. At least one of **id** and **name** must be specified. .. note:: From f01798fede521bcf0f276530a03bb1e4eb8737eb Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:48:47 +1200 Subject: [PATCH 17/22] [fan] Tidy up name/id (#4144) --- components/fan/binary.rst | 3 --- components/fan/hbridge.rst | 2 -- components/fan/index.rst | 3 ++- components/fan/speed.rst | 2 -- components/fan/template.rst | 2 -- components/fan/tuya.rst | 2 -- 6 files changed, 2 insertions(+), 12 deletions(-) diff --git a/components/fan/binary.rst b/components/fan/binary.rst index c7328c5e7..69414e351 100644 --- a/components/fan/binary.rst +++ b/components/fan/binary.rst @@ -27,13 +27,10 @@ Configuration variables: - **output** (**Required**, :ref:`config-id`): The id of the binary output component to use for this fan. -- **name** (**Required**, string): The name for this fan. - **oscillation_output** (*Optional*, :ref:`config-id`): The id of the :ref:`output ` to use for the oscillation state of this fan. Default is empty. - **direction_output** (*Optional*, :ref:`config-id`): The id of the :ref:`output ` to use for the direction state of the fan. Default is empty. -- **id** (*Optional*, :ref:`config-id`): Manually specify - the ID used for code generation. - All other options from :ref:`Fan Component `. See Also diff --git a/components/fan/hbridge.rst b/components/fan/hbridge.rst index 7e4295f8c..120fcb173 100644 --- a/components/fan/hbridge.rst +++ b/components/fan/hbridge.rst @@ -46,8 +46,6 @@ Configuration variables: - **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. The value is used to calculate the percentages for each speed. E.g. ``2`` means that you have 50% and 100% while ``100`` will allow 1% increments in the output. Defaults to ``100``. -- **name** (**Required**, string): The name for this fan. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **preset_modes** (*Optional*): A list of preset modes for this fan. Preset modes can be used in automations (i.e. `on_preset_set`). - All other options from :ref:`Fan Component `. diff --git a/components/fan/index.rst b/components/fan/index.rst index 9e68a0d17..c0e34ef05 100644 --- a/components/fan/index.rst +++ b/components/fan/index.rst @@ -26,7 +26,8 @@ Base Fan Configuration Configuration variables: -- **name** (**Required**, string): The name of the fan. +- **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 fan. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/fan/speed.rst b/components/fan/speed.rst index e23f0b009..28af893b8 100644 --- a/components/fan/speed.rst +++ b/components/fan/speed.rst @@ -23,7 +23,6 @@ supports speed settings. Configuration variables: ------------------------ -- **name** (*Optional*, string): The name for this fan. - **output** (**Required**, :ref:`config-id`): The id of the :ref:`float output ` to use for this fan. - **oscillation_output** (*Optional*, :ref:`config-id`): The id of the :ref:`output ` to use for the oscillation state of this fan. Default is empty. @@ -32,7 +31,6 @@ Configuration variables: - **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. The value is used to calculate the percentages for each speed. E.g. ``2`` means that you have 50% and 100% while ``100`` will allow 1% increments in the output. Defaults to ``100``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **preset_modes** (*Optional*): A list of preset modes for this fan. Preset modes can be used in automations (i.e. `on_preset_set`). - All other options from :ref:`Fan Component `. diff --git a/components/fan/template.rst b/components/fan/template.rst index 75c36ce8e..19a9e04a5 100644 --- a/components/fan/template.rst +++ b/components/fan/template.rst @@ -25,8 +25,6 @@ The ``template`` fan platform lets you create a fan interface using only trigger Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (*Optional*, string): The name for this fan. - **has_direction** (*Optional*, boolean): Indicates if there should be a control for direction. Default is ``false``. - **has_oscillating** (*Optional*, boolean): Indicates if there should be a control for oscillating. Default is ``false``. - **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. Default is only on/off. diff --git a/components/fan/tuya.rst b/components/fan/tuya.rst index 8eb3136f4..7bfe09cbc 100644 --- a/components/fan/tuya.rst +++ b/components/fan/tuya.rst @@ -49,8 +49,6 @@ Based on this, you can create the fan as follows: Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the fan. - **speed_datapoint** (**Required**, int): The datapoint id number of the fan speed. - **switch_datapoint** (**Required**, int): The datapoint id number of the fan switch. - **oscillation_datapoint** (*Optional*, int): The datapoint id number of the oscillation From 9cb258b292a38d7598eb945c77c1033e4fba88dc Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:49:43 +1200 Subject: [PATCH 18/22] [datetime] Tidy up name/id (#4142) --- components/datetime/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/components/datetime/index.rst b/components/datetime/index.rst index 0580442d7..60ec0001b 100644 --- a/components/datetime/index.rst +++ b/components/datetime/index.rst @@ -29,7 +29,8 @@ All datetime in ESPHome have a name and an optional icon. Configuration variables: -- **name** (**Required**, string): The name for the datetime. +- **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 for the datetime. At least one of **id** and **name** must be specified. .. note:: From 52542f36080b40b146df8b7cd7634adc32c3911f Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:51:21 +1200 Subject: [PATCH 19/22] [cover] Tidy up name/id (#4141) --- components/cover/am43.rst | 2 - components/cover/current_based.rst | 2 - components/cover/endstop.rst | 2 - components/cover/feedback.rst | 67 ++++++++++++++---------------- components/cover/index.rst | 3 +- components/cover/template.rst | 2 - components/cover/time_based.rst | 18 ++++---- components/cover/tuya.rst | 2 - 8 files changed, 42 insertions(+), 56 deletions(-) diff --git a/components/cover/am43.rst b/components/cover/am43.rst index 227b1afd1..efef4b14b 100644 --- a/components/cover/am43.rst +++ b/components/cover/am43.rst @@ -53,13 +53,11 @@ To make use of the battery and light level sensors, see the Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the cover. - **ble_client_id** (**Required**, :ref:`config-id`): The id of the ``ble_client`` entry associated with the device. - **pin** (*Optional*, int): The pin for the device, as set in the app. The default is usually printed on the device. Defaults to ``8888``. - **invert_position** (*Optional*, boolean): Inverts the position value to and from the device. Set if ESPHome is swapping around the open/close state of the cover. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Cover `. diff --git a/components/cover/current_based.rst b/components/cover/current_based.rst index 48408fe03..440f82f00 100644 --- a/components/cover/current_based.rst +++ b/components/cover/current_based.rst @@ -62,7 +62,6 @@ operation circuit (typically caused by welded relays). Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the cover. - **open_sensor** (**Required**, :ref:`config-id`): The open current sensor. - **open_action** (**Required**, :ref:`Action `): The action that should be performed when the remote requests the cover to be opened. @@ -95,7 +94,6 @@ Configuration variables: - **malfunction_action** (*Optional*, :ref:`Action `): The action that should be performed when relay malfunction is detected. Malfunction may require device servicing. You can use this action to notify other systems about this situation -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Cover `. Use with Shelly 2.5 diff --git a/components/cover/endstop.rst b/components/cover/endstop.rst index 1637f8d72..a116f2f08 100644 --- a/components/cover/endstop.rst +++ b/components/cover/endstop.rst @@ -47,7 +47,6 @@ current position of the cover. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the cover. - **open_action** (**Required**, :ref:`Action `): The action that should be performed when the remote requests the cover to be opened. - **open_duration** (**Required**, :ref:`config-time`): The amount of time it takes the cover @@ -66,7 +65,6 @@ Configuration variables: be performed when the remote requests the cover to be closed or an endstop is reached. - **max_duration** (*Optional*, :ref:`config-time`): The maximum duration the cover should be opening or closing. Useful for protecting from dysfunctional endstops. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Cover `. See Also diff --git a/components/cover/feedback.rst b/components/cover/feedback.rst index 2f087be28..0c759eae9 100644 --- a/components/cover/feedback.rst +++ b/components/cover/feedback.rst @@ -4,8 +4,8 @@ Feedback Cover .. seo:: :description: Instructions for setting up feedback covers in ESPHome. -The ``feedback`` cover platform allows you to create covers with position control that -can optionally have feedback from sensors to detect the fully-open and fully-closed states (endstops), +The ``feedback`` cover platform allows you to create covers with position control that +can optionally have feedback from sensors to detect the fully-open and fully-closed states (endstops), and from sensors to detect actual movement (opening/closing). In all the cases the current position is approximated with the time the cover has been moving in a direction. @@ -54,11 +54,11 @@ Endstop Sensors *************** For cases where there are endstops at one or both ends of the cover to detect the fully-open and fully-closed states. -When any of these endstops are reached, an actual state is read and updated and the cover optionally +When any of these endstops are reached, an actual state is read and updated and the cover optionally stopped (via ``stop_action``). The state is not assumed. The extension also handles the case where the cover has builtin endstops, which stops the movement, independently to -the component's logic. In this case, when the cover is fully closed (either if timed based or sensor based) the +the component's logic. In this case, when the cover is fully closed (either if timed based or sensor based) the ``stop_action`` is not triggered. It is a drop-in replacement of :doc:`/components/cover/endstop`. @@ -71,9 +71,9 @@ as soon as an action is triggered) and can also react to commands issued to cove keep states in sync (useful for "smartization" of an existing cover). When there are no specific endstop sensors, and if the cover has builtin endstops and no external control logic, -these movement sensors can optionally be use to infer the endstop state. +these movement sensors can optionally be use to infer the endstop state. When the movement stops (with no stop action being requested) it is assumed that it was caused by -the builtin endstops, and so the close/open state (according to current direction) was reached. +the builtin endstops, and so the close/open state (according to current direction) was reached. This function is activated setting ``infer_endstop`` to True. It can be used to replace a :doc:`/components/cover/current_based`, with some modifications in the yaml. See :ref:`migrating_current_based` @@ -85,16 +85,13 @@ To protect the cover hardware from damage, some safety options are available: - *Max duration*, to protect from faulty endstops - *Direction change wait time*, like an interlock wait time, to protect motors from sudden direction changes -- *Obstacle sensors* and *rollback*, possibility to stop and optionally rollback the cover when some external sensors detects an obstacle +- *Obstacle sensors* and *rollback*, possibility to stop and optionally rollback the cover when some external sensors detects an obstacle (it might be a sensor for high current consumption or an infrared light detecting an obstruction in the path). Configuration variables ----------------------- -- **name** (**Required**, string): The name of the cover. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - - **stop_action** (**Required**, :ref:`Action `): The action that should be performed when the remote requests the cover to be closed or an endstop is reached. @@ -132,23 +129,23 @@ Additional options: detectors. In this configuration the ``stop_action`` is not performed when the open or close time is completed and if the cover is commanded to open or close the corresponding actions will be performed without checking current state. Defaults to ``false``. -- **infer_endstop_from_movement** (*Optional*, boolean): Whether to infer endstop state from the movement sensor. +- **infer_endstop_from_movement** (*Optional*, boolean): Whether to infer endstop state from the movement sensor. Requires movement sensors to be set, no endstop sensors and to have builtin endstops. Defaults to ``false``. - **assumed_state** (*Optional*, boolean): Whether the true state of the cover is not known. This will make the Home Assistant frontend show buttons for both OPEN and CLOSE actions, instead of hiding or disabling one of them. Defaults to ``true`` if no sensor is available to known the actual state of the cover. - **max_duration** (*Optional*, :ref:`config-time`): The maximum duration the cover should be opening - or closing. Useful for protecting from dysfunctional endstops. + or closing. Useful for protecting from dysfunctional endstops. Requires internal, builtin or inferred endstops. - **direction_change_wait_time** (*Optional*, :ref:`config-time`): Stops cover and forces a wait time between changes in direction, - and takes it into account when computing cover position (useful to protect motors). + and takes it into account when computing cover position (useful to protect motors). When this option is set (even at 0s) if an open/close action is invoked while the cover is moving in the opposite direction, - then and intermediate stop action will be invoked to generate the delay. -- **acceleration_wait_time** (*Optional*, :ref:`config-time`): Considers a wait time needed by the cover to actually - start moving after command is issued and takes it into account when computing cover position - (useful for heavy covers with large inertia). - Intended to not accumulate error when doing multiple partial open/close actions). + then and intermediate stop action will be invoked to generate the delay. +- **acceleration_wait_time** (*Optional*, :ref:`config-time`): Considers a wait time needed by the cover to actually + start moving after command is issued and takes it into account when computing cover position + (useful for heavy covers with large inertia). + Intended to not accumulate error when doing multiple partial open/close actions). The open/close duration includes one instance of this delay, as it is the total amount of time from issuing a command to reaching endstop. Defaults to ``0s``. @@ -175,13 +172,13 @@ Most options can be left untouched, but some modifications are needed: If there where any open/close obstacle current threshold defined, a separate binary sensor with that threshold should be defined. The option ``start_sensing_delay`` should be directly replaced by a ``delayed_off`` filter in the movement sensors, or alternatively - hysteresis options could be used to reduce the noise. + hysteresis options could be used to reduce the noise. 2. To have the very same behavior implicit in current based cover, you must always set ``has_built_in_endstop`` and ``infer_endstop_from_movement`` to True. .. code-block:: yaml - # Example original sensor configuration + # Example original sensor configuration cover: - platform: current_based name: "Current Based Cover" @@ -192,7 +189,7 @@ Most options can be left untouched, but some modifications are needed: start_sensing_delay: 0.8s # ...rest of options - # Example converted sensor configuration + # Example converted sensor configuration binary_sensor: - platform: analog_threshold id: open_binary_sensor @@ -216,43 +213,43 @@ Most options can be left untouched, but some modifications are needed: open_obstacle_sensor: open_obstacle_binary_sensor #... rest of options -3. Malfunction detection is not directly supported by Feedback Cover, as the malfunction was very narrowly defined to a specific use case - (while in other hardware configurations, the same situation is perfectly valid). +3. Malfunction detection is not directly supported by Feedback Cover, as the malfunction was very narrowly defined to a specific use case + (while in other hardware configurations, the same situation is perfectly valid). The malfunction alerted specifically when there was current in the opposite direction of the requested operation (possibly due to a relay welded). This detection can still be achieved by putting the logic directly in the switch, (or whatever needed according to your specific use case). .. code-block:: yaml - # Example original malfunction configuration + # Example original malfunction configuration cover: - platform: current_based - close_sensor: close_current + close_sensor: close_current close_action: - switch.turn_on: open_relay - open_sensor: open_current + open_sensor: open_current open_action: - - switch.turn_on: open_relay - + - switch.turn_on: open_relay + malfunction_detection: true malfunction_action: - - logger.log: "Malfunction detected. Relay welded." - #... rest of options + - logger.log: "Malfunction detected. Relay welded." + #... rest of options - # Example converted malfunction configuration + # Example converted malfunction configuration switch: - platform: gpio id: open_relay - #... rest of options + #... rest of options on_turn_off: - delay: 200ms #allow for switching time and any discharge - if: - condition: + condition: binary_sensor.is_on: open_binary_sensor - # alternative can check directly + # alternative can check directly # on sensor.in_range open_current then: - - logger.log: "Malfunction detected. Relay welded." + - logger.log: "Malfunction detected. Relay welded." diff --git a/components/cover/index.rst b/components/cover/index.rst index 28a5efc7f..3ac2e9b66 100644 --- a/components/cover/index.rst +++ b/components/cover/index.rst @@ -28,7 +28,8 @@ All cover config schemas inherit from this schema - you can set these keys for c Configuration variables: -- **name** (**Required**, string): The name for the cover. +- **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 for the cover. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/cover/template.rst b/components/cover/template.rst index 9d6b82692..908f860ac 100644 --- a/components/cover/template.rst +++ b/components/cover/template.rst @@ -43,7 +43,6 @@ Possible return values for the optional lambda: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the cover. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated repeatedly to get the current state of the cover. - **open_action** (*Optional*, :ref:`Action `): The action that should @@ -71,7 +70,6 @@ Configuration variables: be performed when the remote (like Home Assistant's frontend) requests the cover be set to a specific position. The desired position is available in the lambda in the ``pos`` variable. Useless if `has_position` is not set to ``true``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Cover `. .. _cover-template-publish_action: diff --git a/components/cover/time_based.rst b/components/cover/time_based.rst index d5888b923..41c84c84c 100644 --- a/components/cover/time_based.rst +++ b/components/cover/time_based.rst @@ -37,7 +37,6 @@ of the cover can be restored at node reboot. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the cover. - **open_action** (**Required**, :ref:`Action `): The action that should be performed when the remote requests the cover to be opened. - **open_duration** (**Required**, :ref:`config-time`): The amount of time it takes the cover @@ -53,17 +52,16 @@ Configuration variables: detectors. In this configuration the ``stop_action`` is not performed when the open or close time is completed and if the cover is commanded to open or close the corresponding actions will be performed without checking current state. Defaults to ``false``. -- **manual_control** (*Optional*, boolean): For covers with manual external controls. With this - configuration if the cover is commanded to open or close the corresponding actions will be - performed even if the current state fully open or fully closed matches desired state, then - ``stop_action`` will be called after the full duration of the action elapses. +- **manual_control** (*Optional*, boolean): For covers with manual external controls. With this + configuration if the cover is commanded to open or close the corresponding actions will be + performed even if the current state fully open or fully closed matches desired state, then + ``stop_action`` will be called after the full duration of the action elapses. The current state will then be relearned upon completion. - It's recommended to set ``assumed_state`` to true so the cover control button aren't disabled - in the interface. Defaults to ``false``. + It's recommended to set ``assumed_state`` to true so the cover control button aren't disabled + in the interface. Defaults to ``false``. - **assumed_state** (*Optional*, boolean): Whether the true state of the cover is not known. This will make the Home Assistant frontend show buttons for both OPEN and CLOSE actions, instead of hiding or disabling one of them. Defaults to ``true``. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Cover `. @@ -79,7 +77,7 @@ This can be handled at the **stop_action** by using the following lambda functio .. code-block:: yaml - stop_action: + stop_action: - lambda: !lambda |- if (id(cover).get_last_operation() == CoverOperation::COVER_OPERATION_OPENING) { // Cover is currently opening @@ -89,7 +87,7 @@ This can be handled at the **stop_action** by using the following lambda functio id(cover_button_up).press(); } -Be aware that ``get_last_operation`` will only return the last opening or closing operation, but not the last idle operation. +Be aware that ``get_last_operation`` will only return the last opening or closing operation, but not the last idle operation. This issue is tracked `here `_. See Also diff --git a/components/cover/tuya.rst b/components/cover/tuya.rst index 33f1fa479..2cb13faa8 100644 --- a/components/cover/tuya.rst +++ b/components/cover/tuya.rst @@ -31,8 +31,6 @@ Now you can create the cover. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the cover. - **control_datapoint** (*Optional*, int): The datapoint id number for sending control commands. - **position_datapoint** (**Required**, int): The datapoint id number of the cover position value. - **position_report_datapoint** (*Optional*, int): The datapoint id number of the cover position report value, if separate from position_datapoint. From 4b097030095bc2a45a7798e8f4e6bda7a93940b2 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:52:16 +1200 Subject: [PATCH 20/22] [button] Tidy up name/id (#4139) --- components/button/factory_reset.rst | 4 +--- components/button/index.rst | 3 ++- components/button/output.rst | 2 -- components/button/restart.rst | 4 +--- components/button/safe_mode.rst | 4 +--- components/button/shutdown.rst | 4 +--- components/button/template.rst | 4 +--- components/button/uart.rst | 2 -- components/button/wake_on_lan.rst | 2 -- 9 files changed, 7 insertions(+), 22 deletions(-) diff --git a/components/button/factory_reset.rst b/components/button/factory_reset.rst index 03e1bfe09..f8ed5a97a 100644 --- a/components/button/factory_reset.rst +++ b/components/button/factory_reset.rst @@ -35,9 +35,7 @@ After reboot all states, parameters and variables will be reinitialized with the Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the button. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Button `. +- All options from :ref:`Button `. See Also -------- diff --git a/components/button/index.rst b/components/button/index.rst index 0151b7c69..921d37848 100644 --- a/components/button/index.rst +++ b/components/button/index.rst @@ -40,7 +40,8 @@ All buttons in ESPHome have a name and an optional icon. Configuration variables: -- **name** (**Required**, string): The name for the button. +- **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 for the button. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/button/output.rst b/components/button/output.rst index d037730fc..e54d70462 100644 --- a/components/button/output.rst +++ b/components/button/output.rst @@ -29,8 +29,6 @@ momentarily set a GPIO pin using a button. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the button. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **output** (**Required**, :ref:`config-id`): The ID of the output component to use. - **duration** (**Required**, :ref:`config-time`): How long the output should be set when the button is pressed. - All other options from :ref:`Button `. diff --git a/components/button/restart.rst b/components/button/restart.rst index 03be784b7..0f6d44519 100644 --- a/components/button/restart.rst +++ b/components/button/restart.rst @@ -18,9 +18,7 @@ through Home Assistant. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the button. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Button `. +- All options from :ref:`Button `. See Also -------- diff --git a/components/button/safe_mode.rst b/components/button/safe_mode.rst index 45fe8534a..7342d08e2 100644 --- a/components/button/safe_mode.rst +++ b/components/button/safe_mode.rst @@ -24,9 +24,7 @@ This component requires :doc:`/components/safe_mode` to be configured. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the button. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Button `. +- All options from :ref:`Button `. See Also -------- diff --git a/components/button/shutdown.rst b/components/button/shutdown.rst index 68dadc518..c6d363b50 100644 --- a/components/button/shutdown.rst +++ b/components/button/shutdown.rst @@ -24,9 +24,7 @@ pressing the reset button or restarting the power supply. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the button. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Button `. +- All options from :ref:`Button `. See Also -------- diff --git a/components/button/template.rst b/components/button/template.rst index 11095ab82..cc8d3965a 100644 --- a/components/button/template.rst +++ b/components/button/template.rst @@ -20,9 +20,7 @@ it will automatically appear in Home Assistant as a button and can be controlled Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the switch. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Button `. +- All options from :ref:`Button `. See Also -------- diff --git a/components/button/uart.rst b/components/button/uart.rst index 565e42af2..174d7b827 100644 --- a/components/button/uart.rst +++ b/components/button/uart.rst @@ -22,8 +22,6 @@ The ``uart`` button platform allows you to send a pre-defined sequence of bytes Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (*Optional*, string): The name for the button. - **data** (**Required**, string or list of bytes): The data to send via UART. Either an ASCII string or a list of bytes. - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub. diff --git a/components/button/wake_on_lan.rst b/components/button/wake_on_lan.rst index 10b510201..b91e5f3ba 100644 --- a/components/button/wake_on_lan.rst +++ b/components/button/wake_on_lan.rst @@ -19,9 +19,7 @@ by specifying its MAC address. Configuration variables: ------------------------ -- **name** (**Required**, string): The name for the button. - **target_mac_address** (**Required**, MAC Address): The MAC Address of the target computer. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Button `. See Also From 0af60409292b8685fdac44f6443f96b5572bc6d2 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:53:49 +1200 Subject: [PATCH 21/22] [binary_sensor] Tidy up name/id (#4138) --- components/binary_sensor/analog_threshold.rst | 2 -- components/binary_sensor/ble_presence.rst | 3 --- components/binary_sensor/cap1188.rst | 2 -- components/binary_sensor/esp32_touch.rst | 2 -- components/binary_sensor/gpio.rst | 2 -- components/binary_sensor/homeassistant.rst | 2 -- components/binary_sensor/hydreon_rgxx.rst | 18 +++--------------- components/binary_sensor/index.rst | 3 ++- components/binary_sensor/modbus_controller.rst | 2 -- components/binary_sensor/mpr121.rst | 2 -- components/binary_sensor/nextion.rst | 1 - components/binary_sensor/pn532.rst | 2 -- components/binary_sensor/rc522.rst | 2 -- components/binary_sensor/rdm6300.rst | 2 -- components/binary_sensor/status.rst | 4 +--- components/binary_sensor/template.rst | 4 ---- components/binary_sensor/ttp229.rst | 4 ---- components/binary_sensor/tuya.rst | 2 -- 18 files changed, 6 insertions(+), 53 deletions(-) diff --git a/components/binary_sensor/analog_threshold.rst b/components/binary_sensor/analog_threshold.rst index 236eed00f..f006afdfc 100644 --- a/components/binary_sensor/analog_threshold.rst +++ b/components/binary_sensor/analog_threshold.rst @@ -36,8 +36,6 @@ a binary sensor. Configuration variables ----------------------- -- **name** (**Required**, string): The name of the binary sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **sensor_id** (**Required**, :ref:`config-id`): The ID of the source sensor. - **threshold** (**Required**, float or mapping): Configures the reference for comparison. Accepts either a shorthand float number that will be used as both upper/lower threshold, or a mapping to define different values for each (to diff --git a/components/binary_sensor/ble_presence.rst b/components/binary_sensor/ble_presence.rst index 412049a50..c8a5c6565 100644 --- a/components/binary_sensor/ble_presence.rst +++ b/components/binary_sensor/ble_presence.rst @@ -54,7 +54,6 @@ The ``ble_presence`` binary sensor platform lets you track the presence of a Blu Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the binary sensor. - **mac_address** (*Optional*, MAC Address): The MAC address to track for this binary sensor. Note that exactly one of ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid`` must be present. @@ -72,8 +71,6 @@ Configuration variables: same building. - **ibeacon_minor** (*Optional*, int): The iBeacon minor identifier of the beacon that needs to be tracked. Usually used to identify beacons within an iBeacon group. -- **id** (*Optional*, :ref:`config-id`): Manually specify - the ID used for code generation. - **min_rssi** (*Optional*, int): at which minimum RSSI level would the component report the device be present. - **timeout** (*Optional*, :ref:`config-time`): The delay after last detecting the device before publishing not present state. The default is 5 minutes. diff --git a/components/binary_sensor/cap1188.rst b/components/binary_sensor/cap1188.rst index 016720311..65f0608cc 100644 --- a/components/binary_sensor/cap1188.rst +++ b/components/binary_sensor/cap1188.rst @@ -68,9 +68,7 @@ binary sensors for each touch sensor. Configuration variables: -- **name** (*Optional*, string): The name for the binary sensor. - **cap1188_id** (*Optional*, :ref:`config-id`): The ID of the CAP1188 defined above. Useful for multiple CAP1188's on the I²C bus. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **channel** (**Required**, int): The channel number the CAP1188 the touchkey is connected to. - All other options from :ref:`Binary Sensor `. diff --git a/components/binary_sensor/esp32_touch.rst b/components/binary_sensor/esp32_touch.rst index 7c6bc25f3..72153999a 100644 --- a/components/binary_sensor/esp32_touch.rst +++ b/components/binary_sensor/esp32_touch.rst @@ -141,8 +141,6 @@ Configuration variables: events on. - **threshold** (**Required**, ``int``): The threshold to use to detect touch events. See :ref:`esp32-finding-thresholds` below for help determining this value. -- **name** (**Required**, string): The name of the binary sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **wakeup_threshold** (*Optional*, ``int``): The threshold to use to detect touch events to wake-up from deep sleep. See :ref:`esp32-finding-thresholds` below for help determining this value. Touch pad sensors that should trigger a wake-up from deep sleep must specify this value. The :ref:`deep_sleep-component` must also be configured to enable diff --git a/components/binary_sensor/gpio.rst b/components/binary_sensor/gpio.rst index 65aefcb12..465cddd28 100644 --- a/components/binary_sensor/gpio.rst +++ b/components/binary_sensor/gpio.rst @@ -27,8 +27,6 @@ Configuration variables: ------------------------ - **pin** (**Required**, :ref:`Pin Schema `): The pin to periodically check. -- **name** (**Required**, string): The name of the binary sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. Activating internal pullups diff --git a/components/binary_sensor/homeassistant.rst b/components/binary_sensor/homeassistant.rst index 2628c5d58..b822a075b 100644 --- a/components/binary_sensor/homeassistant.rst +++ b/components/binary_sensor/homeassistant.rst @@ -30,11 +30,9 @@ With Home Assistant 2021.6 or newer, entity state attributes can also be importe Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the binary sensor. - **entity_id** (**Required**, string): The entity ID to import from Home Assistant. - **attribute** (*Optional*, string): The name of the state attribute to import from the specified entity. The entity state is used when this option is omitted. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. See Also diff --git a/components/binary_sensor/hydreon_rgxx.rst b/components/binary_sensor/hydreon_rgxx.rst index 47a5b7dba..d49864221 100644 --- a/components/binary_sensor/hydreon_rgxx.rst +++ b/components/binary_sensor/hydreon_rgxx.rst @@ -34,27 +34,15 @@ Configuration variables: - **too_cold** (*Optional*): ``true`` if the sensor reports being too cold. Hydreon only mentions this feature for the RG-9. - - **name** (**Required**, string): The name for the sensor. - - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - - All other options from :ref:`Binary Sensor `. + - All options from :ref:`Binary Sensor `. - **lens_bad** (*Optional*): ``true`` if the sensor reports the lens being bad. - - **name** (**Required**, string): The name for the sensor. - - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - - All other options from :ref:`Binary Sensor `. + - All options from :ref:`Binary Sensor `. - **em_sat** (*Optional*): ``true`` if the sensor reports the Emitter being saturated. - - **name** (**Required**, string): The name for the sensor. - - - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - - - All other options from :ref:`Binary Sensor `. + - All options from :ref:`Binary Sensor `. See Also diff --git a/components/binary_sensor/index.rst b/components/binary_sensor/index.rst index fba4b9da6..949a2bf15 100644 --- a/components/binary_sensor/index.rst +++ b/components/binary_sensor/index.rst @@ -27,7 +27,8 @@ you can always override it. Configuration variables: -- **name** (**Required**, string): The name for the binary sensor. +- **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 for the binary sensor. At least one of **id** and **name** must be specified. .. note:: diff --git a/components/binary_sensor/modbus_controller.rst b/components/binary_sensor/modbus_controller.rst index 8e8ecea77..1ff315fe3 100644 --- a/components/binary_sensor/modbus_controller.rst +++ b/components/binary_sensor/modbus_controller.rst @@ -12,8 +12,6 @@ and requires :doc:`/components/modbus_controller` to be configured. Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the sensor. - **register_type** (**Required**): type of the modbus register. - ``coil``: Coils are 1-bit registers (ON/OFF values) that are used to control discrete outputs. Read and Write access. Modbus *Function Code 1 (Read Coil Status)* will be used. diff --git a/components/binary_sensor/mpr121.rst b/components/binary_sensor/mpr121.rst index 73fcd743b..4d41a2137 100644 --- a/components/binary_sensor/mpr121.rst +++ b/components/binary_sensor/mpr121.rst @@ -69,9 +69,7 @@ binary sensors for each touch sensor. Configuration variables: -- **name** (*Optional*, string): The name for the binary sensor. - **mpr121_id** (*Optional*, :ref:`config-id`): The ID of the MPR121 defined above. Useful for multiple MPR121's on the I²C bus -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - **channel** (**Required**, int): The channel number at the MPR121 the touchkey is connected to. - **touch_threshold** (*Optional*, int): A per-channel override of the global touch_threshold value. If not specified, uses the global value. - **release_threshold** (*Optional*, int): A per-channel override of the global release_threshold value. If not specified, uses the global value. diff --git a/components/binary_sensor/nextion.rst b/components/binary_sensor/nextion.rst index 9825c216f..2260ddb02 100644 --- a/components/binary_sensor/nextion.rst +++ b/components/binary_sensor/nextion.rst @@ -39,7 +39,6 @@ See :doc:`/components/display/nextion` for setting up the display Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the sensor. - **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display. - **component_name** (*Optional*, string): The name of the Nextion component. - **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considered to be **on** diff --git a/components/binary_sensor/pn532.rst b/components/binary_sensor/pn532.rst index fe161c46d..c2db142a9 100644 --- a/components/binary_sensor/pn532.rst +++ b/components/binary_sensor/pn532.rst @@ -208,8 +208,6 @@ Configuration variables: - **uid** (**Required**, string): The unique ID of the NFC/RFID tag. This is a hyphen-separated list of hexadecimal values. For example ``74-10-37-94``. -- **name** (**Required**, string): The name of the binary sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. .. _pn532-setting_up_tags: diff --git a/components/binary_sensor/rc522.rst b/components/binary_sensor/rc522.rst index 1c89732b1..837e797ca 100644 --- a/components/binary_sensor/rc522.rst +++ b/components/binary_sensor/rc522.rst @@ -189,8 +189,6 @@ Configuration variables: - **uid** (**Required**, string): The unique ID of the NFC/RFID tag. This is a hyphen-separated list of hexadecimal values. For example ``74-10-37-94``. -- **name** (**Required**, string): The name of the binary sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. .. _rc522-setting_up_tags: diff --git a/components/binary_sensor/rdm6300.rst b/components/binary_sensor/rdm6300.rst index 11b102e6f..901a5db17 100644 --- a/components/binary_sensor/rdm6300.rst +++ b/components/binary_sensor/rdm6300.rst @@ -107,8 +107,6 @@ Configuration variables: ************************ - **uid** (**Required**, int): The unique ID of the NFC/RFID tag. -- **name** (**Required**, string): The name of the binary sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. .. _rdm6300-setting_up_tags: diff --git a/components/binary_sensor/status.rst b/components/binary_sensor/status.rst index cdaac910a..b426031a1 100644 --- a/components/binary_sensor/status.rst +++ b/components/binary_sensor/status.rst @@ -22,9 +22,7 @@ for Home Assistant. Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the binary sensor. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- All other options from :ref:`Binary Sensor `. (Inverted mode is not supported) +- All options from :ref:`Binary Sensor `. (Inverted mode is not supported) See Also -------- diff --git a/components/binary_sensor/template.rst b/components/binary_sensor/template.rst index 85b70513d..c1c8e645b 100644 --- a/components/binary_sensor/template.rst +++ b/components/binary_sensor/template.rst @@ -36,12 +36,8 @@ Possible return values of the lambda: Configuration variables: ------------------------ -- **name** (**Required**, string): The name of the binary sensor. - **lambda** (*Optional*, :ref:`lambda `): Lambda to be evaluated repeatedly to get the current state of the binary sensor. -- **id** (*Optional*, - :ref:`config-id`): Manually specify - the ID used for code generation. - All other options from :ref:`Binary Sensor `. .. _binary_sensor-template-publish_action: diff --git a/components/binary_sensor/ttp229.rst b/components/binary_sensor/ttp229.rst index 6910db3b2..8fbf712fc 100644 --- a/components/binary_sensor/ttp229.rst +++ b/components/binary_sensor/ttp229.rst @@ -47,9 +47,7 @@ The configuration is made up of two parts: The central component, and individual Configuration variables: -- **name** (**Required**, string): The name of the binary sensor. - **channel** (**Required**, int): The channel number at the TTP229 the touchkey is connected to. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. ``ttp229_bsf`` Component @@ -85,9 +83,7 @@ Base Configuration: Configuration variables: -- **name** (**Required**, string): The name of the binary sensor. - **channel** (**Required**, int): The channel number at the TTP229 the touchkey is connected to. -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. - All other options from :ref:`Binary Sensor `. See Also diff --git a/components/binary_sensor/tuya.rst b/components/binary_sensor/tuya.rst index ab6489af2..30c362e69 100644 --- a/components/binary_sensor/tuya.rst +++ b/components/binary_sensor/tuya.rst @@ -20,8 +20,6 @@ You can create the binary sensor as follows: Configuration variables: ------------------------ -- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. -- **name** (**Required**, string): The name of the binary sensor. - **sensor_datapoint** (**Required**, int): The datapoint id number of the binary sensor. - All other options from :ref:`Binary Sensor `. From 84b7857577df89d5d1d957d9b5214df897b4f4d0 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 14 Aug 2024 14:54:45 +1200 Subject: [PATCH 22/22] [alarm_control_panel] Tidy up name/id (#4137) --- components/alarm_control_panel/index.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/components/alarm_control_panel/index.rst b/components/alarm_control_panel/index.rst index da0e8d8a8..57ab72b4f 100644 --- a/components/alarm_control_panel/index.rst +++ b/components/alarm_control_panel/index.rst @@ -19,7 +19,8 @@ Base Alarm Control Panel Configuration Configuration variables: -- **name** (**Required**, string): The name of the alarm control panel. +- **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 alarm control panel. At least one of **id** and **name** must be specified. .. note:: @@ -47,7 +48,7 @@ Configuration variables: - **on_ready** (*Optional*, :ref:`Action `): An automation to perform when the logical 'and' of all the zone sensors change state. See :ref:`alarm_control_panel_on_ready_trigger`. - **on_chime** (*Optional*, :ref:`Action `): An automation to perform - when a zone has been marked as chime in the configuration, and it changes from closed to open. + when a zone has been marked as chime in the configuration, and it changes from closed to open. See :ref:`alarm_control_panel_on_chime_trigger`. - If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting `.