mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-27 17:37:45 +01:00
[climate] Tidy up name/id (#4140)
* [climate] Tidy up name/id * Fix paste mistake
This commit is contained in:
parent
3b59f2c847
commit
391eeda9e3
@ -48,8 +48,6 @@ need to do conversion again within the frontend if you use Fahrenheit.
|
|||||||
Configuration variables:
|
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.
|
- **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'.
|
- **unit_of_measurement** (**Required**, string): Units to use on the device display. 'c' or 'f'.
|
||||||
- All other options from :ref:`Climate <config-climate>`.
|
- All other options from :ref:`Climate <config-climate>`.
|
||||||
|
@ -109,8 +109,6 @@ setting the mode and target temperature.
|
|||||||
Configuration variables:
|
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.
|
- **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``:
|
- **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:
|
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.
|
- **bedjet_id** (**Required**, :ref:`config-id`): The ID of the Bedjet component.
|
||||||
- Other options from :ref:`Fan <config-fan>`.
|
- Other options from :ref:`Fan <config-fan>`.
|
||||||
|
|
||||||
|
@ -88,7 +88,6 @@ controller unit.
|
|||||||
Configuration Variables:
|
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
|
- **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.
|
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``.
|
- **supports_cool** (*Optional*, boolean): Enables setting cooling mode for this climate device. Defaults to ``true``.
|
||||||
@ -99,7 +98,6 @@ Configuration Variables:
|
|||||||
|
|
||||||
**Advanced Options**
|
**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.
|
- **transmitter_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the remote transmitter.
|
||||||
|
|
||||||
**Specific configuration variables:**
|
**Specific configuration variables:**
|
||||||
|
@ -111,10 +111,8 @@ This component requires a :ref:`uart` to be setup.
|
|||||||
Configuration variables:
|
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.
|
- **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``.
|
- **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.
|
- **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``.
|
- **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.
|
- **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.
|
||||||
|
@ -46,7 +46,8 @@ All climate platforms in ESPHome inherit from the climate configuration schema.
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -67,10 +67,8 @@ The ``midea`` component creates a Midea air conditioner climate device.
|
|||||||
Configuration variables:
|
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
|
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :doc:`../uart` if you want
|
||||||
to use multiple UART buses.
|
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.
|
- **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``.
|
- **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``.
|
- **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
|
- **outdoor_temperature** (*Optional*): The information for the outdoor temperature
|
||||||
sensor.
|
sensor.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
- **power_usage** (*Optional*): The information for the current power consumption
|
- **power_usage** (*Optional*): The information for the current power consumption
|
||||||
sensor.
|
sensor.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
- **humidity_setpoint** (*Optional*): The information for the humidity indoor
|
- **humidity_setpoint** (*Optional*): The information for the humidity indoor
|
||||||
sensor (experimental).
|
sensor (experimental).
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
- All other options from :ref:`Climate <config-climate>`.
|
- All other options from :ref:`Climate <config-climate>`.
|
||||||
|
|
||||||
Automations
|
Automations
|
||||||
|
@ -409,7 +409,6 @@ the calculated PID parameters to help finding good PID values.
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor
|
|
||||||
- **type** (**Required**, string): The value to monitor. One of
|
- **type** (**Required**, string): The value to monitor. One of
|
||||||
|
|
||||||
- ``RESULT`` - The resulting value (sum of P, I, and D terms).
|
- ``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.
|
- ``KI`` - The current factor for the integral term of the PID controller.
|
||||||
- ``KD`` - The current factor for the differential term of the PID controller.
|
- ``KD`` - The current factor for the differential term of the PID controller.
|
||||||
|
|
||||||
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
Advanced options:
|
Advanced options:
|
||||||
|
|
||||||
- **climate_id** (*Optional*, :ref:`config-id`): The ID of the pid climate to get the values from.
|
- **climate_id** (*Optional*, :ref:`config-id`): The ID of the pid climate to get the values from.
|
||||||
|
@ -66,8 +66,6 @@ Based on this, you can create the climate device as follows:
|
|||||||
Configuration variables:
|
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_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``.
|
- **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).
|
- **switch_datapoint** (**Required**, int): The datapoint id number of the climate switch (device on/off).
|
||||||
|
Loading…
Reference in New Issue
Block a user