mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-10 10:11:29 +01:00
Merge branch 'current' into next
This commit is contained in:
commit
ab3781ab3a
@ -41,3 +41,4 @@
|
|||||||
/cookbook/dual-r2-cover.html /cookbook/lambda_magic.html#one-button-cover-control 301
|
/cookbook/dual-r2-cover.html /cookbook/lambda_magic.html#one-button-cover-control 301
|
||||||
|
|
||||||
/ready-made/projects /projects/ 301
|
/ready-made/projects /projects/ 301
|
||||||
|
/components/images /components/image 301
|
||||||
|
@ -19,7 +19,8 @@ Base Alarm Control Panel Configuration
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
@ -47,7 +48,7 @@ Configuration variables:
|
|||||||
- **on_ready** (*Optional*, :ref:`Action <config-action>`): An automation to perform
|
- **on_ready** (*Optional*, :ref:`Action <config-action>`): An automation to perform
|
||||||
when the logical 'and' of all the zone sensors change state. See :ref:`alarm_control_panel_on_ready_trigger`.
|
when the logical 'and' of all the zone sensors change state. See :ref:`alarm_control_panel_on_ready_trigger`.
|
||||||
- **on_chime** (*Optional*, :ref:`Action <config-action>`): An automation to perform
|
- **on_chime** (*Optional*, :ref:`Action <config-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`.
|
See :ref:`alarm_control_panel_on_chime_trigger`.
|
||||||
- If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
|
- If MQTT enabled, all other options from :ref:`MQTT Component <config-mqtt-component>`.
|
||||||
- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
|
- If Webserver enabled, ``web_server_sorting_weight`` can be set. See :ref:`Webserver Entity Sorting <config-webserver-sorting>`.
|
||||||
|
@ -36,8 +36,6 @@ a binary sensor.
|
|||||||
Configuration variables
|
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.
|
- **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
|
- **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
|
float number that will be used as both upper/lower threshold, or a mapping to define different values for each (to
|
||||||
|
@ -54,7 +54,6 @@ The ``ble_presence`` binary sensor platform lets you track the presence of a Blu
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the binary sensor.
|
|
||||||
- **mac_address** (*Optional*, MAC Address): The MAC address to track for this
|
- **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``
|
binary sensor. Note that exactly one of ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid``
|
||||||
must be present.
|
must be present.
|
||||||
@ -72,8 +71,6 @@ Configuration variables:
|
|||||||
same building.
|
same building.
|
||||||
- **ibeacon_minor** (*Optional*, int): The iBeacon minor identifier of the beacon that needs
|
- **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.
|
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.
|
- **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.
|
- **timeout** (*Optional*, :ref:`config-time`): The delay after last detecting the device before publishing not present state.
|
||||||
The default is 5 minutes.
|
The default is 5 minutes.
|
||||||
|
@ -68,9 +68,7 @@ binary sensors for each touch sensor.
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **channel** (**Required**, int): The channel number the CAP1188 the touchkey is connected to.
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
|
@ -141,8 +141,6 @@ Configuration variables:
|
|||||||
events on.
|
events on.
|
||||||
- **threshold** (**Required**, ``int``): The threshold to use to detect touch events. See
|
- **threshold** (**Required**, ``int``): The threshold to use to detect touch events. See
|
||||||
:ref:`esp32-finding-thresholds` below for help determining this value.
|
: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.
|
- **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
|
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
|
wake-up from deep sleep must specify this value. The :ref:`deep_sleep-component` must also be configured to enable
|
||||||
|
@ -27,8 +27,6 @@ Configuration variables:
|
|||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The pin to periodically check.
|
- **pin** (**Required**, :ref:`Pin Schema <config-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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
Activating internal pullups
|
Activating internal pullups
|
||||||
|
@ -30,11 +30,9 @@ With Home Assistant 2021.6 or newer, entity state attributes can also be importe
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the binary sensor.
|
|
||||||
- **entity_id** (**Required**, string): The entity ID to import from Home Assistant.
|
- **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
|
- **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.
|
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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -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.
|
- **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.
|
- All options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
||||||
|
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
|
||||||
|
|
||||||
- **lens_bad** (*Optional*): ``true`` if the sensor reports the lens being bad.
|
- **lens_bad** (*Optional*): ``true`` if the sensor reports the lens being bad.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the sensor.
|
- All options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
||||||
|
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
|
||||||
|
|
||||||
- **em_sat** (*Optional*): ``true`` if the sensor reports the Emitter being saturated.
|
- **em_sat** (*Optional*): ``true`` if the sensor reports the Emitter being saturated.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the sensor.
|
- All options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
|
|
||||||
|
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
|
||||||
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -27,7 +27,8 @@ you can always override it.
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -12,8 +12,6 @@ and requires :doc:`/components/modbus_controller` to be configured.
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- ``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.
|
||||||
|
@ -69,9 +69,7 @@ binary sensors for each touch sensor.
|
|||||||
Configuration variables:
|
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
|
- **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.
|
- **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.
|
- **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.
|
- **release_threshold** (*Optional*, int): A per-channel override of the global release_threshold value. If not specified, uses the global value.
|
||||||
|
@ -39,7 +39,6 @@ See :doc:`/components/display/nextion` for setting up the display
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
|
||||||
- **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display.
|
- **nextion_id** (*Optional*, :ref:`config-id`): The ID of the Nextion display.
|
||||||
- **component_name** (*Optional*, string): The name of the Nextion component.
|
- **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**
|
- **variable_name** (*Optional*, string): The name of the Nextion variable. Any value over ``0`` is considered to be **on**
|
||||||
|
@ -208,8 +208,6 @@ Configuration variables:
|
|||||||
|
|
||||||
- **uid** (**Required**, string): The unique ID of the NFC/RFID tag. This is a hyphen-separated list
|
- **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``.
|
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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
.. _pn532-setting_up_tags:
|
.. _pn532-setting_up_tags:
|
||||||
|
@ -189,8 +189,6 @@ Configuration variables:
|
|||||||
|
|
||||||
- **uid** (**Required**, string): The unique ID of the NFC/RFID tag. This is a hyphen-separated list
|
- **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``.
|
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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
.. _rc522-setting_up_tags:
|
.. _rc522-setting_up_tags:
|
||||||
|
@ -107,8 +107,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **uid** (**Required**, int): The unique ID of the NFC/RFID tag.
|
- **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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
.. _rdm6300-setting_up_tags:
|
.. _rdm6300-setting_up_tags:
|
||||||
|
@ -22,9 +22,7 @@ for Home Assistant.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the binary sensor.
|
- All options from :ref:`Binary Sensor <config-binary_sensor>`. (Inverted mode is not supported)
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`. (Inverted mode is not supported)
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -36,12 +36,8 @@ Possible return values of the lambda:
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the binary sensor.
|
|
||||||
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
||||||
Lambda to be evaluated repeatedly to get the current state of the binary sensor.
|
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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
.. _binary_sensor-template-publish_action:
|
.. _binary_sensor-template-publish_action:
|
||||||
|
@ -47,9 +47,7 @@ The configuration is made up of two parts: The central component, and individual
|
|||||||
|
|
||||||
Configuration variables:
|
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.
|
- **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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
``ttp229_bsf`` Component
|
``ttp229_bsf`` Component
|
||||||
@ -85,9 +83,7 @@ Base Configuration:
|
|||||||
|
|
||||||
Configuration variables:
|
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.
|
- **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 <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -20,8 +20,6 @@ You can create the binary sensor 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 binary sensor.
|
|
||||||
- **sensor_datapoint** (**Required**, int): The datapoint id number of the binary sensor.
|
- **sensor_datapoint** (**Required**, int): The datapoint id number of the binary sensor.
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
|
@ -35,9 +35,7 @@ After reboot all states, parameters and variables will be reinitialized with the
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the button.
|
- All options from :ref:`Button <config-button>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Button <config-button>`.
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -40,7 +40,8 @@ All buttons in ESPHome have a name and an optional icon.
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -29,8 +29,6 @@ momentarily set a GPIO pin using a button.
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **duration** (**Required**, :ref:`config-time`): How long the output should be set when the button is pressed.
|
||||||
- All other options from :ref:`Button <config-button>`.
|
- All other options from :ref:`Button <config-button>`.
|
||||||
|
@ -18,9 +18,7 @@ through Home Assistant.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the button.
|
- All options from :ref:`Button <config-button>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Button <config-button>`.
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -24,9 +24,7 @@ This component requires :doc:`/components/safe_mode` to be configured.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the button.
|
- All options from :ref:`Button <config-button>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Button <config-button>`.
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -24,9 +24,7 @@ pressing the reset button or restarting the power supply.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the button.
|
- All options from :ref:`Button <config-button>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Button <config-button>`.
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -20,9 +20,7 @@ it will automatically appear in Home Assistant as a button and can be controlled
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the switch.
|
- All options from :ref:`Button <config-button>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Button <config-button>`.
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -22,8 +22,6 @@ The ``uart`` button platform allows you to send a pre-defined sequence of bytes
|
|||||||
Configuration variables:
|
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
|
- **data** (**Required**, string or list of bytes): The data to send via UART. Either an ASCII string
|
||||||
or a list of bytes.
|
or a list of bytes.
|
||||||
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.
|
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.
|
||||||
|
@ -19,9 +19,7 @@ by specifying its MAC address.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the button.
|
|
||||||
- **target_mac_address** (**Required**, MAC Address): The MAC Address of the target computer.
|
- **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 <config-button>`.
|
- All other options from :ref:`Button <config-button>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -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:**
|
||||||
@ -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``
|
- **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]
|
- ``3levels``; Low [fan speed 1], Medium [2], High [3]
|
||||||
- ``4levels``; Low [1], Middle [2], Medium [3], High [4]
|
- ``4levels``; Low [1], Middle [2], Medium [3], High [4]
|
||||||
- ``quiet_4levels``; Low [1], Middle [2], Medium [3], High [4], Quiet [5]
|
- ``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_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``.
|
- **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``
|
- 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``
|
- 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 <https://github.com/ToniA/arduino-heatpumpir>`__.
|
The ``heatpumpir`` platform supports dozens of manufacturers and hundreds of AC units by utilising the `Arduino-HeatpumpIR library <https://github.com/ToniA/arduino-heatpumpir>`__.
|
||||||
|
|
||||||
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.
|
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:
|
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``,
|
``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``,
|
``daikin_arc417``, ``daikin_arc480``, ``electroluxyal``, ``fuego``, ``fujitsu_awyz``, ``gree``, ``greeyaa``, ``greeyac``, ``greeyan``,
|
||||||
``greeyap``, ``greeyt``, ``hisense_aud``, ``hitachi``, ``hyundai``, ``ivt``, ``midea``, ``mitsubishi_fa``, ``mitsubishi_fd``,
|
``greeyap``, ``greeyt``, ``hisense_aud``, ``hitachi``, ``hyundai``, ``ivt``, ``midea``, ``mitsubishi_fa``, ``mitsubishi_fd``,
|
||||||
|
@ -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.
|
||||||
|
@ -60,14 +60,12 @@ Based on this, you can create the climate device as follows:
|
|||||||
eco:
|
eco:
|
||||||
datapoint: 5
|
datapoint: 5
|
||||||
temperature: 28
|
temperature: 28
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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).
|
||||||
|
@ -26,7 +26,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The binary sensor that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The binary sensor that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the binary sensor.
|
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
Copy Button
|
Copy Button
|
||||||
@ -44,7 +43,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The button that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The button that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the button.
|
|
||||||
- All other options from :ref:`Button <config-button>`.
|
- All other options from :ref:`Button <config-button>`.
|
||||||
|
|
||||||
Copy Cover
|
Copy Cover
|
||||||
@ -62,7 +60,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The cover that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The cover that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the cover.
|
|
||||||
- All other options from :ref:`Cover <config-cover>`.
|
- All other options from :ref:`Cover <config-cover>`.
|
||||||
|
|
||||||
Copy Fan
|
Copy Fan
|
||||||
@ -80,7 +77,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The fan that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The fan that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the fan.
|
|
||||||
- All other options from :ref:`Fan <config-fan>`.
|
- All other options from :ref:`Fan <config-fan>`.
|
||||||
|
|
||||||
Copy Lock
|
Copy Lock
|
||||||
@ -98,7 +94,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The lock that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The lock that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the lock.
|
|
||||||
- All other options from :ref:`Lock <config-lock>`.
|
- All other options from :ref:`Lock <config-lock>`.
|
||||||
|
|
||||||
Copy Number
|
Copy Number
|
||||||
@ -116,7 +111,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The number that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The number that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the number.
|
|
||||||
- All other options from :ref:`Number <config-number>`.
|
- All other options from :ref:`Number <config-number>`.
|
||||||
|
|
||||||
Copy Select
|
Copy Select
|
||||||
@ -134,7 +128,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The select that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The select that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the select.
|
|
||||||
- All other options from :ref:`Select <config-select>`.
|
- All other options from :ref:`Select <config-select>`.
|
||||||
|
|
||||||
.. _copy-sensor:
|
.. _copy-sensor:
|
||||||
@ -154,7 +147,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The sensor that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The sensor that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
Copy Switch
|
Copy Switch
|
||||||
@ -172,7 +164,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The switch that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The switch that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the switch.
|
|
||||||
- All other options from :ref:`Switch <config-switch>`.
|
- All other options from :ref:`Switch <config-switch>`.
|
||||||
|
|
||||||
Copy Text Sensor
|
Copy Text Sensor
|
||||||
@ -190,7 +181,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The text sensor that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The text sensor that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the text sensor.
|
|
||||||
- All other options from :ref:`Text Sensor <config-text_sensor>`.
|
- All other options from :ref:`Text Sensor <config-text_sensor>`.
|
||||||
|
|
||||||
Copy Text
|
Copy Text
|
||||||
@ -208,7 +198,6 @@ Configuration variables:
|
|||||||
************************
|
************************
|
||||||
|
|
||||||
- **source_id** (**Required**, :ref:`config-id`): The text that should be mirrored.
|
- **source_id** (**Required**, :ref:`config-id`): The text that should be mirrored.
|
||||||
- **name** (**Required**, string): The name of the number.
|
|
||||||
- All other options from :ref:`Text <config-text>`.
|
- All other options from :ref:`Text <config-text>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -53,13 +53,11 @@ To make use of the battery and light level sensors, see the
|
|||||||
Configuration variables:
|
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.
|
- **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
|
- **pin** (*Optional*, int): The pin for the device, as
|
||||||
set in the app. The default is usually printed on the
|
set in the app. The default is usually printed on the
|
||||||
device. Defaults to ``8888``.
|
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.
|
- **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 <config-cover>`.
|
- All other options from :ref:`Cover <config-cover>`.
|
||||||
|
|
||||||
|
|
||||||
|
@ -62,7 +62,6 @@ operation circuit (typically caused by welded relays).
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the cover.
|
|
||||||
- **open_sensor** (**Required**, :ref:`config-id`): The open current sensor.
|
- **open_sensor** (**Required**, :ref:`config-id`): The open current sensor.
|
||||||
- **open_action** (**Required**, :ref:`Action <config-action>`): The action that should
|
- **open_action** (**Required**, :ref:`Action <config-action>`): The action that should
|
||||||
be performed when the remote requests the cover to be opened.
|
be performed when the remote requests the cover to be opened.
|
||||||
@ -95,7 +94,6 @@ Configuration variables:
|
|||||||
- **malfunction_action** (*Optional*, :ref:`Action <config-action>`): The action that should
|
- **malfunction_action** (*Optional*, :ref:`Action <config-action>`): The action that should
|
||||||
be performed when relay malfunction is detected. Malfunction may require device servicing. You can use this action
|
be performed when relay malfunction is detected. Malfunction may require device servicing. You can use this action
|
||||||
to notify other systems about this situation
|
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 <config-cover>`.
|
- All other options from :ref:`Cover <config-cover>`.
|
||||||
|
|
||||||
Use with Shelly 2.5
|
Use with Shelly 2.5
|
||||||
|
@ -47,7 +47,6 @@ current position of the cover.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the cover.
|
|
||||||
- **open_action** (**Required**, :ref:`Action <config-action>`): The action that should
|
- **open_action** (**Required**, :ref:`Action <config-action>`): The action that should
|
||||||
be performed when the remote requests the cover to be opened.
|
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
|
- **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.
|
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
|
- **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.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Cover <config-cover>`.
|
- All other options from :ref:`Cover <config-cover>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -4,8 +4,8 @@ Feedback Cover
|
|||||||
.. seo::
|
.. seo::
|
||||||
:description: Instructions for setting up feedback covers in ESPHome.
|
:description: Instructions for setting up feedback covers in ESPHome.
|
||||||
|
|
||||||
The ``feedback`` cover platform allows you to create covers with position control that
|
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),
|
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
|
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.
|
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.
|
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.
|
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 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.
|
``stop_action`` is not triggered.
|
||||||
|
|
||||||
It is a drop-in replacement of :doc:`/components/cover/endstop`.
|
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).
|
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,
|
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
|
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.
|
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`
|
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
|
- *Max duration*, to protect from faulty endstops
|
||||||
- *Direction change wait time*, like an interlock wait time, to protect motors from sudden direction changes
|
- *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).
|
(it might be a sensor for high current consumption or an infrared light detecting an obstruction in the path).
|
||||||
|
|
||||||
|
|
||||||
Configuration variables
|
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 <config-action>`): The action that should
|
- **stop_action** (**Required**, :ref:`Action <config-action>`): The action that should
|
||||||
be performed when the remote requests the cover to be closed or an endstop is reached.
|
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
|
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
|
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``.
|
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``.
|
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.
|
- **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
|
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
|
of hiding or disabling one of them. Defaults to ``true`` if no sensor is available to known
|
||||||
the actual state of the cover.
|
the actual state of the cover.
|
||||||
- **max_duration** (*Optional*, :ref:`config-time`): The maximum duration the cover should be opening
|
- **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.
|
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,
|
- **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,
|
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.
|
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
|
- **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
|
start moving after command is issued and takes it into account when computing cover position
|
||||||
(useful for heavy covers with large inertia).
|
(useful for heavy covers with large inertia).
|
||||||
Intended to not accumulate error when doing multiple partial open/close actions).
|
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
|
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.
|
issuing a command to reaching endstop.
|
||||||
Defaults to ``0s``.
|
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.
|
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
|
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``
|
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.
|
to True.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
# Example original sensor configuration
|
# Example original sensor configuration
|
||||||
cover:
|
cover:
|
||||||
- platform: current_based
|
- platform: current_based
|
||||||
name: "Current Based Cover"
|
name: "Current Based Cover"
|
||||||
@ -192,7 +189,7 @@ Most options can be left untouched, but some modifications are needed:
|
|||||||
start_sensing_delay: 0.8s
|
start_sensing_delay: 0.8s
|
||||||
# ...rest of options
|
# ...rest of options
|
||||||
|
|
||||||
# Example converted sensor configuration
|
# Example converted sensor configuration
|
||||||
binary_sensor:
|
binary_sensor:
|
||||||
- platform: analog_threshold
|
- platform: analog_threshold
|
||||||
id: open_binary_sensor
|
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
|
open_obstacle_sensor: open_obstacle_binary_sensor
|
||||||
#... rest of options
|
#... 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
|
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).
|
(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).
|
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).
|
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
|
.. code-block:: yaml
|
||||||
|
|
||||||
# Example original malfunction configuration
|
# Example original malfunction configuration
|
||||||
cover:
|
cover:
|
||||||
- platform: current_based
|
- platform: current_based
|
||||||
close_sensor: close_current
|
close_sensor: close_current
|
||||||
close_action:
|
close_action:
|
||||||
- switch.turn_on: open_relay
|
- switch.turn_on: open_relay
|
||||||
open_sensor: open_current
|
open_sensor: open_current
|
||||||
open_action:
|
open_action:
|
||||||
- switch.turn_on: open_relay
|
- switch.turn_on: open_relay
|
||||||
|
|
||||||
malfunction_detection: true
|
malfunction_detection: true
|
||||||
malfunction_action:
|
malfunction_action:
|
||||||
- logger.log: "Malfunction detected. Relay welded."
|
- logger.log: "Malfunction detected. Relay welded."
|
||||||
#... rest of options
|
#... rest of options
|
||||||
|
|
||||||
# Example converted malfunction configuration
|
# Example converted malfunction configuration
|
||||||
switch:
|
switch:
|
||||||
- platform: gpio
|
- platform: gpio
|
||||||
id: open_relay
|
id: open_relay
|
||||||
#... rest of options
|
#... rest of options
|
||||||
on_turn_off:
|
on_turn_off:
|
||||||
- delay: 200ms #allow for switching time and any discharge
|
- delay: 200ms #allow for switching time and any discharge
|
||||||
- if:
|
- if:
|
||||||
condition:
|
condition:
|
||||||
binary_sensor.is_on: open_binary_sensor
|
binary_sensor.is_on: open_binary_sensor
|
||||||
# alternative can check directly
|
# alternative can check directly
|
||||||
# on sensor.in_range open_current
|
# on sensor.in_range open_current
|
||||||
then:
|
then:
|
||||||
- logger.log: "Malfunction detected. Relay welded."
|
- logger.log: "Malfunction detected. Relay welded."
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -28,7 +28,8 @@ All cover config schemas inherit from this schema - you can set these keys for c
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -43,7 +43,6 @@ Possible return values for the optional lambda:
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the cover.
|
|
||||||
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
||||||
Lambda to be evaluated repeatedly to get the current state of the cover.
|
Lambda to be evaluated repeatedly to get the current state of the cover.
|
||||||
- **open_action** (*Optional*, :ref:`Action <config-action>`): The action that should
|
- **open_action** (*Optional*, :ref:`Action <config-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
|
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.
|
position. The desired position is available in the lambda in the ``pos`` variable.
|
||||||
Useless if `has_position` is not set to ``true``.
|
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 <config-cover>`.
|
- All other options from :ref:`Cover <config-cover>`.
|
||||||
|
|
||||||
.. _cover-template-publish_action:
|
.. _cover-template-publish_action:
|
||||||
|
@ -37,7 +37,6 @@ of the cover can be restored at node reboot.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the cover.
|
|
||||||
- **open_action** (**Required**, :ref:`Action <config-action>`): The action that should
|
- **open_action** (**Required**, :ref:`Action <config-action>`): The action that should
|
||||||
be performed when the remote requests the cover to be opened.
|
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
|
- **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
|
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
|
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``.
|
will be performed without checking current state. Defaults to ``false``.
|
||||||
- **manual_control** (*Optional*, boolean): For covers with manual external controls. With this
|
- **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
|
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
|
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.
|
``stop_action`` will be called after the full duration of the action elapses.
|
||||||
The current state will then be relearned upon completion.
|
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
|
It's recommended to set ``assumed_state`` to true so the cover control button aren't disabled
|
||||||
in the interface. Defaults to ``false``.
|
in the interface. Defaults to ``false``.
|
||||||
- **assumed_state** (*Optional*, boolean): Whether the true state of the cover is not known.
|
- **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
|
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``.
|
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 <config-cover>`.
|
- All other options from :ref:`Cover <config-cover>`.
|
||||||
|
|
||||||
|
|
||||||
@ -79,7 +77,7 @@ This can be handled at the **stop_action** by using the following lambda functio
|
|||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
stop_action:
|
stop_action:
|
||||||
- lambda: !lambda |-
|
- lambda: !lambda |-
|
||||||
if (id(cover).get_last_operation() == CoverOperation::COVER_OPERATION_OPENING) {
|
if (id(cover).get_last_operation() == CoverOperation::COVER_OPERATION_OPENING) {
|
||||||
// Cover is currently 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();
|
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 <https://github.com/esphome/issues/issues/4252#issuecomment-2132727377>`_.
|
This issue is tracked `here <https://github.com/esphome/issues/issues/4252#issuecomment-2132727377>`_.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -31,8 +31,6 @@ Now you can create the cover.
|
|||||||
Configuration variables:
|
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.
|
- **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_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.
|
- **position_report_datapoint** (*Optional*, int): The datapoint id number of the cover position report value, if separate from position_datapoint.
|
||||||
|
@ -29,7 +29,8 @@ All datetime in ESPHome have a name and an optional icon.
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -48,8 +48,8 @@ Configuration variables:
|
|||||||
|
|
||||||
One of ``id`` or ``name`` is required.
|
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.
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. At least one of **id** and **name** must be specified.
|
||||||
- **name** (**Required**, string): The name for the event.
|
- **name** (*Optional*, string): The name for the event. At least one of **id** and **name** must be specified.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
@ -27,13 +27,10 @@ Configuration variables:
|
|||||||
|
|
||||||
- **output** (**Required**, :ref:`config-id`): The id of the
|
- **output** (**Required**, :ref:`config-id`): The id of the
|
||||||
binary output component to use for this fan.
|
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
|
- **oscillation_output** (*Optional*, :ref:`config-id`): The id of the
|
||||||
:ref:`output <output>` to use for the oscillation state of this fan. Default is empty.
|
:ref:`output <output>` to use for the oscillation state of this fan. Default is empty.
|
||||||
- **direction_output** (*Optional*, :ref:`config-id`): The id of the
|
- **direction_output** (*Optional*, :ref:`config-id`): The id of the
|
||||||
:ref:`output <output>` to use for the direction state of the fan. Default is empty.
|
:ref:`output <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 <config-fan>`.
|
- All other options from :ref:`Fan Component <config-fan>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -46,8 +46,6 @@ Configuration variables:
|
|||||||
- **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. The value is used
|
- **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``
|
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``.
|
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`).
|
- **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 <config-fan>`.
|
- All other options from :ref:`Fan Component <config-fan>`.
|
||||||
|
|
||||||
|
@ -26,7 +26,8 @@ Base Fan Configuration
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -23,7 +23,6 @@ supports speed settings.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (*Optional*, string): The name for this fan.
|
|
||||||
- **output** (**Required**, :ref:`config-id`): The id of the :ref:`float output <output>` to use for this fan.
|
- **output** (**Required**, :ref:`config-id`): The id of the :ref:`float output <output>` to use for this fan.
|
||||||
- **oscillation_output** (*Optional*, :ref:`config-id`): The id of the
|
- **oscillation_output** (*Optional*, :ref:`config-id`): The id of the
|
||||||
:ref:`output <output>` to use for the oscillation state of this fan. Default is empty.
|
:ref:`output <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
|
- **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``
|
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``.
|
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`).
|
- **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 <config-fan>`.
|
- All other options from :ref:`Fan Component <config-fan>`.
|
||||||
|
|
||||||
|
@ -25,8 +25,6 @@ The ``template`` fan platform lets you create a fan interface using only trigger
|
|||||||
Configuration variables:
|
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_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``.
|
- **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.
|
- **speed_count** (*Optional*, int): Set the number of supported discrete speed levels. Default is only on/off.
|
||||||
|
@ -49,8 +49,6 @@ Based on this, you can create the fan 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 fan.
|
|
||||||
- **speed_datapoint** (**Required**, int): The datapoint id number of the fan speed.
|
- **speed_datapoint** (**Required**, int): The datapoint id number of the fan speed.
|
||||||
- **switch_datapoint** (**Required**, int): The datapoint id number of the fan switch.
|
- **switch_datapoint** (**Required**, int): The datapoint id number of the fan switch.
|
||||||
- **oscillation_datapoint** (*Optional*, int): The datapoint id number of the oscillation
|
- **oscillation_datapoint** (*Optional*, int): The datapoint id number of the oscillation
|
||||||
|
@ -83,9 +83,7 @@ Binary Sensor
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the enrolling binary sensor.
|
- All options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
|
||||||
|
|
||||||
|
|
||||||
Sensor
|
Sensor
|
||||||
|
@ -49,39 +49,27 @@ Configuration variables:
|
|||||||
------------------------
|
------------------------
|
||||||
- **latitude** (*Optional*): Include the Latitude as a sensor
|
- **latitude** (*Optional*): Include the Latitude as a sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name to give the latitude 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>`.
|
|
||||||
|
|
||||||
- **longitude** (*Optional*): Include the Longitude as a sensor
|
- **longitude** (*Optional*): Include the Longitude as a sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name to give the longitude 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>`.
|
|
||||||
|
|
||||||
- **speed** (*Optional*): Include the measured speed as a sensor
|
- **speed** (*Optional*): Include the measured speed as a sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name to give the speed 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>`.
|
|
||||||
|
|
||||||
- **course** (*Optional*): Include the measured course as a sensor
|
- **course** (*Optional*): Include the measured course as a sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name to give the course 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>`.
|
|
||||||
|
|
||||||
- **altitude** (*Optional*): Include the measured altitude as a sensor
|
- **altitude** (*Optional*): Include the measured altitude as a sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name to give the altitude 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>`.
|
|
||||||
|
|
||||||
- **satellites** (*Optional*): Include the number of tracking satellites being used as a 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
|
- 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>`.
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -24,12 +24,7 @@ The ``binary`` light platform creates a simple ON/OFF-only light from a
|
|||||||
Configuration variables:
|
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.
|
||||||
- **output** (**Required**, :ref:`config-id`): The id of the
|
|
||||||
binary :ref:`output` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light, though binary lights
|
|
||||||
only support very few of them.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -23,7 +23,6 @@ and the other channel controls the brightness.
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **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
|
- **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
|
- **warm_white_color_temperature** (**Required**, float): The warmest color temperature supported by this light. This
|
||||||
is the highest value when expressed in `mireds <https://en.wikipedia.org/wiki/Mired>`__, or the lowest value when
|
is the highest value when expressed in `mireds <https://en.wikipedia.org/wiki/Mired>`__, or the lowest value when
|
||||||
expressed in Kelvin.
|
expressed in Kelvin.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -36,7 +36,6 @@ calculation assumes that both lights have the same illuminance, which might not
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **warm_white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the warm white channel.
|
||||||
- **cold_white_color_temperature** (*Optional*, float): The color temperature (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
|
- **cold_white_color_temperature** (*Optional*, float): The color temperature (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
|
||||||
@ -44,8 +43,6 @@ Configuration variables:
|
|||||||
- **warm_white_color_temperature** (*Optional*, float): The color temperature (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
|
- **warm_white_color_temperature** (*Optional*, float): The color temperature (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin)
|
||||||
of the warm white channel. Note that this option is required to control the mixing from Home Assistant.
|
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``.
|
- **constant_brightness** (*Optional*, boolean): When enabled, this will keep the overall brightness of the cold and warm white channels constant by limiting the combined output to 100% of a single channel. This reduces the possible overall brightness but is necessary for some power supplies that are not able to run both channels at full brightness at once. Defaults to ``false``.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -55,7 +55,6 @@ Clockless FastLED lights differ from the
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
************************
|
************************
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the light.
|
|
||||||
- **chipset** (**Required**, string): Set a chipset to use.
|
- **chipset** (**Required**, string): Set a chipset to use.
|
||||||
See :ref:`fastled_clockless-chipsets` for options.
|
See :ref:`fastled_clockless-chipsets` for options.
|
||||||
- **pin** (**Required**, :ref:`config-pin`): The pin for the data line of the FastLED light.
|
- **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`):
|
- **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
|
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.
|
16ms will limit the light to a refresh rate of about 60Hz. Defaults to the default value for the used chipset.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
.. _fastled_clockless-chipsets:
|
.. _fastled_clockless-chipsets:
|
||||||
@ -135,7 +132,6 @@ whereas the clockless lights only need a single pin.
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **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.
|
- **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
|
- **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.
|
have long cables or slow level-shifters.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
.. _fastled_spi-chipsets:
|
.. _fastled_spi-chipsets:
|
||||||
|
@ -34,8 +34,6 @@ control the colors in the :ref:`light control actions <light-turn_on_action>`, y
|
|||||||
Configuration variables:
|
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_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.
|
- **pin_b** (**Required**, :ref:`config-id`): The id of the second float :ref:`output` to use for this light.
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
@ -26,7 +26,8 @@ All light configuration schemas inherit these options.
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -30,10 +30,7 @@ The ``monochromatic`` light platform creates a simple brightness-only light from
|
|||||||
Configuration variables:
|
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.
|
- **output** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for this light.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -37,10 +37,7 @@ Configuration variables:
|
|||||||
|
|
||||||
**Base Options:**
|
**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.
|
- **num_leds** (**Required**, int): The number of LEDs attached.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
|
|
||||||
**Type Options:**
|
**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.
|
- **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.
|
- **data_pin** (**Required**, :ref:`config-pin`): The pin for the data line of the light, for two-wire lights.
|
||||||
|
|
||||||
**Advanced Options:**
|
|
||||||
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
@ -90,9 +90,8 @@ Joining multiple LED lights into one
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the light.
|
|
||||||
- **segments** (**Required**, list): A list of segments included in this partition.
|
- **segments** (**Required**, list): A list of segments included in this partition.
|
||||||
|
|
||||||
*For addressable segments:*
|
*For addressable segments:*
|
||||||
|
|
||||||
- **id** (**Required**, :ref:`config-id`): The ID of the addressable light to be controlled by this segment.
|
- **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.
|
- **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.
|
If an addressable light is specified, it will be treated as a single light in the partition.
|
||||||
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -60,12 +60,9 @@ perceived intensity of different colors will generally vary. This can be done by
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **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.
|
- **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -25,7 +25,6 @@ light from 5 :ref:`float output components <output>` (one for each channel).
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **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.
|
- **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.
|
expressed in Kelvin.
|
||||||
- **color_interlock** (*Optional*, boolean): When enabled, this will prevent white leds being on at the same
|
- **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``.
|
time as RGB leds. See :ref:`rgbw_color_interlock` for more information. Defaults to ``false``.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -64,15 +64,12 @@ the ``color_mode`` option of the :ref:`light control actions <light-turn_on_acti
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **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.
|
- **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel.
|
||||||
- **white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the white channel.
|
- **white** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the white channel.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **color_interlock** (*Optional*, boolean): When enabled, this will prevent white leds being on at the same
|
- **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``.
|
time as RGB leds. See :ref:`rgbw_color_interlock` for more information. Defaults to ``false``.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -69,7 +69,6 @@ the ``color_mode`` option of the :ref:`light control actions <light-turn_on_acti
|
|||||||
Configuration variables:
|
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.
|
- **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.
|
- **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.
|
- **blue** (**Required**, :ref:`config-id`): The id of the float :ref:`output` to use for the blue channel.
|
||||||
@ -89,8 +88,6 @@ Configuration variables:
|
|||||||
both channels at full brightness at once. Defaults to ``false``.
|
both channels at full brightness at once. Defaults to ``false``.
|
||||||
- **color_interlock** (*Optional*, boolean): When enabled, this will prevent white leds being on at the same
|
- **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``.
|
time as RGB leds. See :ref:`rgbw_color_interlock` for more information. Defaults to ``false``.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -10,7 +10,6 @@ A detailed analysis of the Shelly Dimmer 2 hardware is given `here <https://gith
|
|||||||
|
|
||||||
Warning!!! At the time of writing there seems to be no way to revert back to the "stock firmware", because there seems to be no way to revert to firmware of the STM32 co-processor.
|
Warning!!! At the time of writing there seems to be no way to revert back to the "stock firmware", because there seems to be no way to revert to firmware of the STM32 co-processor.
|
||||||
|
|
||||||
The
|
|
||||||
|
|
||||||
.. figure:: ../../images/shellydimmer2.jpg
|
.. figure:: ../../images/shellydimmer2.jpg
|
||||||
:align: center
|
:align: center
|
||||||
@ -49,7 +48,6 @@ An example of a configuration of this component:
|
|||||||
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 UART hub.
|
- **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the UART hub.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
@ -64,7 +62,6 @@ Configuration variables:
|
|||||||
baud_rate: 115200
|
baud_rate: 115200
|
||||||
|
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the light.
|
|
||||||
- **leading_edge** (*Optional*, boolean): `Dimming mode <https://en.wikipedia.org/wiki/Dimmer#Solid-state_dimmer>`_: ``true`` means leading edge, ``false`` is trailing edge. Defaults to ``false``.
|
- **leading_edge** (*Optional*, boolean): `Dimming mode <https://en.wikipedia.org/wiki/Dimmer#Solid-state_dimmer>`_: ``true`` means leading edge, ``false`` is trailing edge. Defaults to ``false``.
|
||||||
- **min_brightness** (*Optional*, int): Minimum brightness value on a scale from 0..1000, the default is 0.
|
- **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.
|
- **max_brightness** (*Optional*, int): Maximum brightness value on a scale from 0..1000, the default is 1000.
|
||||||
@ -91,7 +88,7 @@ Configuration variables:
|
|||||||
firmware:
|
firmware:
|
||||||
version: "51.6" #<-- set version here
|
version: "51.6" #<-- set version here
|
||||||
update: true
|
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.
|
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 <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
@ -94,8 +94,6 @@ This component is useless for devices other than Sonoff D1 dimmer.
|
|||||||
Configuration variables:
|
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
|
- **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
|
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
|
identify what to do with incoming UART commands. RF chip is known to catch random commands
|
||||||
|
@ -35,10 +35,7 @@ perceived intensity of different colors will generally vary. This can be done by
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the light.
|
|
||||||
- **num_leds** (*Optional*, int): The number of LEDs attached. The default is 1.
|
- **num_leds** (*Optional*, int): The number of LEDs attached. The default is 1.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- **data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz``, ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz`` (default), ``200kHz``, ``75kHz`` or ``1kHz``.
|
- **data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz``, ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz`` (default), ``200kHz``, ``75kHz`` or ``1kHz``.
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
|
@ -34,12 +34,8 @@ When the device is in OK state, the LED will be restored to the state of the ``b
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (*Optional*, string): The name of the light.
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- **pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The GPIO pin to operate the LED on.
|
- **pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The GPIO pin to operate the LED on.
|
||||||
- **output** (*Optional*, :ref:`config-id`): The id of the binary :ref:`output` to use for this light.
|
- **output** (*Optional*, :ref:`config-id`): The id of the binary :ref:`output` to use for this light.
|
||||||
- **effects** (*Optional*, list): A list of :ref:`light effects <light-effects>` to use for this light, though binary lights
|
|
||||||
only support very few of them.
|
|
||||||
- All other options from :ref:`Light <config-light>`.
|
- All other options from :ref:`Light <config-light>`.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -42,8 +42,6 @@ Now you can create the light.
|
|||||||
Configuration variables:
|
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.
|
- **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
|
- **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.
|
setting. If this is set then ESPHome will sync the **min_value** to the MCU on startup.
|
||||||
|
@ -21,7 +21,8 @@ Base Lock Configuration
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -27,8 +27,6 @@ Configuration variables:
|
|||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **output** (**Required**, :ref:`config-id`): The ID of the output component to use.
|
- **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 <config-lock>`.
|
- All other options from :ref:`Lock <config-lock>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -45,7 +45,6 @@ Possible return values for the optional lambda:
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the lock.
|
|
||||||
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
||||||
Lambda to be evaluated repeatedly to get the current state of the lock.
|
Lambda to be evaluated repeatedly to get the current state of the lock.
|
||||||
- **lock_action** (*Optional*, :ref:`Action <config-action>`): The action that should
|
- **lock_action** (*Optional*, :ref:`Action <config-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.
|
- **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
|
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``.
|
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 <config-lock>`.
|
- All other options from :ref:`Lock <config-lock>`.
|
||||||
|
|
||||||
.. _lock-template-publish_action:
|
.. _lock-template-publish_action:
|
||||||
|
@ -25,7 +25,8 @@ Base Media Player Configuration
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -44,7 +44,7 @@ Configuration variables:
|
|||||||
- **sample_rate** (*Optional*, positive integer): I2S sample rate. Defaults to ``16000``.
|
- **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
|
- **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.
|
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``.
|
- **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_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 <i2s_audio>` you wish to use for this microphone.
|
- **i2s_audio_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`I²S Audio <i2s_audio>` you wish to use for this microphone.
|
||||||
|
@ -30,7 +30,8 @@ All numbers in ESPHome have a name and an optional icon.
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -10,8 +10,6 @@ When the Number is updated a modbus write command is created sent to the device.
|
|||||||
Configuration variables:
|
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).
|
- **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):
|
- **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):
|
||||||
|
|
||||||
|
@ -22,7 +22,6 @@ using :ref:`lambdas <config-lambda>`.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the number.
|
|
||||||
- **min_value** (**Required**, float): The minimum value this number can be.
|
- **min_value** (**Required**, float): The minimum value this number can be.
|
||||||
- **max_value** (**Required**, float): The maximum 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.
|
- **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
|
- **initial_value** (*Optional*, float): The value to set the state to on setup if not
|
||||||
restored with ``restore_value``.
|
restored with ``restore_value``.
|
||||||
Cannot be used with ``lambda``. Defaults to ``min_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 <config-number>`.
|
- All other options from :ref:`Number <config-number>`.
|
||||||
|
|
||||||
``number.set`` Action
|
``number.set`` Action
|
||||||
|
@ -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:
|
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.
|
- **number_datapoint** (**Required**, int): The datapoint id number of the number.
|
||||||
- **min_value** (**Required**, float): The minimum value this number can be.
|
- **min_value** (**Required**, float): The minimum value this number can be.
|
||||||
- **max_value** (**Required**, float): The maximum value this number can be.
|
- **max_value** (**Required**, float): The maximum value this number can be.
|
||||||
|
@ -234,8 +234,6 @@ then immediately OFF.
|
|||||||
Configuration variables:
|
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
|
- **receiver_id** (*Optional*, :ref:`config-id`): The remote receiver to receive the
|
||||||
remote code with. Required if multiple receivers configured.
|
remote code with. Required if multiple receivers configured.
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
@ -30,7 +30,8 @@ All selects in ESPHome have a name and an optional icon.
|
|||||||
|
|
||||||
Configuration variables:
|
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::
|
.. note::
|
||||||
|
|
||||||
|
@ -10,7 +10,6 @@ registers.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the Select.
|
|
||||||
- **address** (**Required**, int): The start address of the first or only register
|
- **address** (**Required**, int): The start address of the first or only register
|
||||||
of the Select (can be decimal or hexadecimal).
|
of the Select (can be decimal or hexadecimal).
|
||||||
- **optionsmap** (**Required**, Map[str, int]): Provide a mapping from options (str) of
|
- **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
|
- **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
|
grouped together and requested in one range. Setting this to ``true`` enforces the start of a new
|
||||||
range at that address.
|
range at that address.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): Lambda to be evaluated every update interval
|
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): Lambda to be evaluated every update interval
|
||||||
to get the current option of the select.
|
to get the current option of the select.
|
||||||
|
|
||||||
@ -57,7 +55,7 @@ Configuration variables:
|
|||||||
|
|
||||||
- **write_lambda** (*Optional*, :ref:`lambda <config-lambda>`): Lambda to be evaluated on every update
|
- **write_lambda** (*Optional*, :ref:`lambda <config-lambda>`): Lambda to be evaluated on every update
|
||||||
of the Sensor, before the new value is written to the modbus registers.
|
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``.
|
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,
|
- **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
|
any command sent to the Modbus Select will immediately update the reported state. Defaults
|
||||||
|
@ -25,7 +25,6 @@ using :ref:`lambdas <config-lambda>`.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the Select.
|
|
||||||
- **options** (**Required**, list): The list of options this Select has.
|
- **options** (**Required**, list): The list of options this Select has.
|
||||||
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
||||||
Lambda to be evaluated every update interval to get the current option of the select.
|
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
|
- **initial_option** (*Optional*, string): The option to set the option to on setup if not
|
||||||
restored with ``restore_value``.
|
restored with ``restore_value``.
|
||||||
Cannot be used with ``lambda``. Defaults to the first option in the ``options`` list.
|
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 <config-select>`.
|
- All other options from :ref:`Select <config-select>`.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -49,8 +49,6 @@ Based on this, you can create the select 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 switch.
|
|
||||||
- **enum_datapoint** (**Required**, int): The enum datapoint id number for the select.
|
- **enum_datapoint** (**Required**, int): The enum datapoint id number for the select.
|
||||||
- **options** (**Required**, Map[int, str]): Provide a mapping from values (int) of
|
- **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
|
this Select to options (str) of the *enum_datapoint* and vice versa. All options and
|
||||||
|
@ -6,7 +6,7 @@ A01NYUB Waterproof Ultrasonic Sensor
|
|||||||
:image: a01nyub.jpg
|
:image: a01nyub.jpg
|
||||||
:keywords: ultrasonic, DFRobot, A01NYUB
|
: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 <https://wiki.dfrobot.com/A01NYUB%20Waterproof%20Ultrasonic%20Sensor%20SKU:%20SEN0313>`__)
|
(`datasheet <https://wiki.dfrobot.com/A01NYUB%20Waterproof%20Ultrasonic%20Sensor%20SKU:%20SEN0313>`__)
|
||||||
with ESPHome to measure distances. This sensor can measure
|
with ESPHome to measure distances. This sensor can measure
|
||||||
ranges between 28 centimeters and 750 centimeters with a resolution of 1 milimeter.
|
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:
|
sensor:
|
||||||
- platform: "a01nyub"
|
- platform: "a01nyub"
|
||||||
name: "Distance"
|
name: "Distance"
|
||||||
|
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
|
||||||
- **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus <uart>` you wish to use for this sensor.
|
- **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus <uart>` you wish to use for this sensor.
|
||||||
Use this if you want to use multiple UART buses at once.
|
Use this if you want to use multiple UART buses at once.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
@ -6,7 +6,7 @@ A02YYUW Waterproof Ultrasonic Sensor
|
|||||||
:image: a02yyuw.jpg
|
:image: a02yyuw.jpg
|
||||||
:keywords: ultrasonic, DFRobot, A02YYUW
|
: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 <https://wiki.dfrobot.com/_A02YYUW_Waterproof_Ultrasonic_Sensor_SKU_SEN0311>`__)
|
(`datasheet <https://wiki.dfrobot.com/_A02YYUW_Waterproof_Ultrasonic_Sensor_SKU_SEN0311>`__)
|
||||||
with ESPHome to measure distances. This sensor can measure
|
with ESPHome to measure distances. This sensor can measure
|
||||||
ranges between 3 centimeters and 450 centimeters with a resolution of 1 milimeter.
|
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:
|
sensor:
|
||||||
- platform: "a02yyuw"
|
- platform: "a02yyuw"
|
||||||
name: "Distance"
|
name: "Distance"
|
||||||
|
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
|
||||||
- **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus <uart>` you wish to use for this sensor.
|
- **uart_id** (*Optional*, :ref:`config-id`): The ID of the :ref:`UART bus <uart>` you wish to use for this sensor.
|
||||||
Use this if you want to use multiple UART buses at once.
|
Use this if you want to use multiple UART buses at once.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
@ -30,7 +30,6 @@ See the links at the bottom of the page for details on absolute humidity and the
|
|||||||
Configuration variables:
|
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.
|
- **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 %.
|
- **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).
|
- **equation** (*Optional*): The saturated vapor pressure equation to use (see below).
|
||||||
|
@ -31,14 +31,12 @@ Configuration variables:
|
|||||||
|
|
||||||
- **pin** (**Required**, :ref:`config-pin`): The pin to measure the voltage on.
|
- **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`.
|
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** (*Optional*): Only on ESP32. Specify the ADC
|
||||||
attenuation to use. See :ref:`adc-esp32_attenuation`. Defaults to ``0db``.
|
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``.
|
- **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``.
|
- **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
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval
|
||||||
to check the sensor. Defaults to ``60s``.
|
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 <config-sensor>`.
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
@ -88,17 +88,16 @@ Configuration variables:
|
|||||||
- **multiplexer** (**Required**): The multiplexer channel of this sensor. Effectively means between which pins you
|
- **multiplexer** (**Required**): The multiplexer channel of this sensor. Effectively means between which pins you
|
||||||
want to measure voltage.
|
want to measure voltage.
|
||||||
- **gain** (**Required**, float): The gain of this sensor.
|
- **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
|
- **ads1115_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the
|
||||||
:ref:`ADS1115 Hub <ads1115-component>` you want to use this sensor.
|
:ref:`ADS1115 Hub <ads1115-component>` you want to use this sensor.
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval
|
||||||
to check the sensor. Defaults to ``60s``.
|
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``.
|
- **resolution** (*Optional*, string): the resolution of this sensor. Defaults to ``16 bits``.
|
||||||
|
|
||||||
- ``16 bits``
|
- ``16 bits``
|
||||||
- ``12 bits``
|
- ``12 bits``
|
||||||
|
|
||||||
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
Multiplexer and Gain
|
Multiplexer and Gain
|
||||||
--------------------
|
--------------------
|
||||||
|
@ -47,15 +47,11 @@ Configuration variables:
|
|||||||
|
|
||||||
- **temperature** (**Required**): The information for the temperature sensor.
|
- **temperature** (**Required**): The information for the temperature sensor.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the temperature 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** (**Required**): The information for the humidity sensor
|
- **humidity** (**Required**): The information for the humidity sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the humidity 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>`.
|
|
||||||
|
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
|
||||||
|
|
||||||
|
@ -40,15 +40,11 @@ Configuration variables:
|
|||||||
|
|
||||||
- **temperature** (**Required**): The information for the temperature sensor.
|
- **temperature** (**Required**): The information for the temperature sensor.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the temperature 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** (**Required**): The information for the humidity sensor
|
- **humidity** (**Required**): The information for the humidity sensor
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the humidity 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>`.
|
|
||||||
|
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``.
|
||||||
|
|
||||||
|
@ -45,14 +45,11 @@ Configuration variables:
|
|||||||
- **ble_client_id** (**Required**, :ref:`config-id`): The id of the ``ble_client`` entry associated with the device.
|
- **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.
|
- **battery_level** (*Optional*): The information for the battery level sensor.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the battery level 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>`.
|
|
||||||
- **illuminance** (*Optional*): The information for the light level sensor.
|
- **illuminance** (*Optional*): The information for the light level sensor.
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the light level 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>`.
|
|
||||||
|
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||||
sensor. Defaults to ``60s``.
|
sensor. Defaults to ``60s``.
|
||||||
|
@ -69,7 +69,6 @@ measurements.
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the sensor.
|
|
||||||
- **type** (**Required**, string): The type of sensor measurement. One of
|
- **type** (**Required**, string): The type of sensor measurement. One of
|
||||||
|
|
||||||
- ``CLEAR``
|
- ``CLEAR``
|
||||||
@ -78,7 +77,6 @@ Configuration variables:
|
|||||||
- ``BLUE``
|
- ``BLUE``
|
||||||
- ``PROXIMITY``
|
- ``PROXIMITY``
|
||||||
|
|
||||||
- **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:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
Binary Sensor
|
Binary Sensor
|
||||||
@ -89,7 +87,6 @@ measurements.
|
|||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the binary sensor.
|
|
||||||
- **direction** (**Required**, string): The direction to measure. One of:
|
- **direction** (**Required**, string): The direction to measure. One of:
|
||||||
|
|
||||||
- ``UP``
|
- ``UP``
|
||||||
@ -97,7 +94,6 @@ Configuration variables:
|
|||||||
- ``LEFT``
|
- ``LEFT``
|
||||||
- ``RIGHT``
|
- ``RIGHT``
|
||||||
|
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
||||||
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
|
||||||
|
|
||||||
Troubleshooting:
|
Troubleshooting:
|
||||||
|
@ -42,24 +42,23 @@ Configuration variables
|
|||||||
- **mac_address** (**Required**): The MAC address of the device.
|
- **mac_address** (**Required**): The MAC address of the device.
|
||||||
- **temperature** (*Optional*): Air temperature in Celsius.
|
- **temperature** (*Optional*): Air temperature in Celsius.
|
||||||
|
|
||||||
- **name** (**Required**): Sensor name.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
- **humidity** (*Optional*): Relative air humidity in %.
|
- **humidity** (*Optional*): Relative air humidity in %.
|
||||||
|
|
||||||
- **name** (**Required**): Sensor name.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
- **moisture** (*Optional*): Soil moisture in %.
|
- **moisture** (*Optional*): Soil moisture in %.
|
||||||
|
|
||||||
- **name** (**Required**): Sensor name.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
- **battery_voltage** (*Optional*): Battery voltage in volts.
|
- **battery_voltage** (*Optional*): Battery voltage in volts.
|
||||||
|
|
||||||
- **name** (**Required**): Sensor name.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
- **illuminance** (*Optional*): Illuminance in lux.
|
- **illuminance** (*Optional*): Illuminance in lux.
|
||||||
|
|
||||||
- **name** (**Required**): Sensor name.
|
- All options from :ref:`Sensor <config-sensor>`.
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
--------
|
--------
|
||||||
|
@ -35,14 +35,11 @@ your configuration for this sensor to work.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name for the sensor.
|
|
||||||
- **address** (*Optional*, int): Manually specify the I²C address of 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,
|
Defaults to ``0x23`` (address if address pin is pulled low). If the address pin is pulled high,
|
||||||
the address is ``0x5C``.
|
the address is ``0x5C``.
|
||||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||||
sensor. Defaults to ``60s``.
|
sensor. Defaults to ``60s``.
|
||||||
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code
|
|
||||||
generation.
|
|
||||||
- All other options from :ref:`Sensor <config-sensor>`.
|
- All other options from :ref:`Sensor <config-sensor>`.
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -121,7 +121,6 @@ The maximum amount of observations/channels supported is 64.
|
|||||||
Configuration variables:
|
Configuration variables:
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
- **name** (**Required**, string): The name of the sensor.
|
|
||||||
- **type** (**Required**, string): The sensor type. Should be one of: ``BAYESIAN``, ``GROUP``, or ``SUM``.
|
- **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.
|
- **channels** (**Required for GROUP or SUM types**): A list of channels that are mapped to certain values.
|
||||||
|
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user