Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-09-28 04:17:47 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1305 from esphome/bump-1.20.0b1

Browse Source 
1.20.0b1
This commit is contained in:
Jesse Hills 2021-07-15 09:23:39 +12:00 committed by GitHub
commit 9301182f51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
29 changed files with 918 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxygen
View File

@ -38,7 +38,7 @@ PROJECT_NAME = "ESPHome"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 1.19.4
PROJECT_NUMBER = 1.20.0b1
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a

2
Makefile
View File

@ -1,5 +1,5 @@
ESPHOME_PATH = ../esphome
ESPHOME_REF = v1.19.4
ESPHOME_REF = v1.20.0b1
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png

BIN
_static/changelog-1.20.0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 34 KiB

2
_static/version
View File

@ -1 +1 @@
1.19.4
1.20.0b1

2
changelog/index.rst
View File

@ -2,7 +2,7 @@ Changelog
=========
.. redirect::
:url: /changelog/v1.19.0.html
:url: /changelog/v1.20.0.html
.. toctree::
:glob:

152
changelog/v1.20.0.rst Normal file
View File

@ -0,0 +1,152 @@
Changelog - Version 1.20.0 - 21st July 2021
===========================================
.. seo::
:description: Changelog for ESPHome version 1.20.0.
:image: /_static/changelog-1.20.0.png
:author: ESPHome
:author_twitter: @esphome_
.. imgtable::
:columns: 2
Number Core, components/number/index, folder-open.svg
Template Number, components/number/template, description.svg
Havells Inverter, components/sensor/havells_inverter, havellsgti5000d_s.jpg
Anova Cooker, components/climate/anova, anova.png
Write some more notes here....
Number Entities
---------------
Creating ``number`` entities in Home Assistant from ESPHome is now supported. This basically replaces
creating an ``input_number`` and then importing that sensor into ESPHome as a sensor with
``platform: homeassistant``. The state of the number can also be updated directly on the ESPHome device
and will be reflected in Home Assistant.
I would like to see what other platforms people can come up with for the number component,
I have a few ideas myself.
Light Changes
-------------
Unfortunately, some breaking changes had to be made:
- For addressable RGBW lights, the brightness now also applies to the white channel (this was already the case for
non-addressable RGBW lights). If you want to control only the brightness of the color channel, use the new ``color_brightness`` option.
- For RGBW lights, the white channel is no longer normalized by the color intensity in the ``light.turn_on`` and
``light.control`` actions. In previous versions, if the red value was set to 60% and the white value to 30%, this
would result in the white channel being at 50% brightness. Starting with this version, this will result in the
white channel being set to 30%, as expected.
Full list of changes
--------------------
New Features
^^^^^^^^^^^^
- Allow WiFi AP to use device name :esphomepr:`1990` by :ghuser:`jesserockz` (new-feature)
- Add Number entities (from Home Assistant) :esphomepr:`1971` by :ghuser:`jesserockz` (new-feature) (new-integration) (notable-change)
New Integrations
^^^^^^^^^^^^^^^^
- Climate component for Ballu air conditioners with remote model YKR-K/002E :esphomepr:`1939` by :ghuser:`bazuchan` (new-integration)
- Anova ble component :esphomepr:`1752` by :ghuser:`buxtronix` (new-integration)
- Add Number entities (from Home Assistant) :esphomepr:`1971` by :ghuser:`jesserockz` (new-feature) (new-integration) (notable-change)
- Added support for havells_solar sensor :esphomepr:`1988` by :ghuser:`sourabhjaiswal` (new-integration)
Breaking Changes
^^^^^^^^^^^^^^^^
- remote_receiver use config parent receiver for registering dumpers :esphomepr:`1980` by :ghuser:`jesserockz` (breaking-change)
- Change color model to fix white channel issues :esphomepr:`1895` by :ghuser:`oxan` (breaking-change)
- Remove a whole bunch of deprecated/removed stuff :esphomepr:`1981` by :ghuser:`jesserockz` (breaking-change)
- catch 0.0 in float set_level pre-adjustment :esphomepr:`2013` by :ghuser:`WeekendWarrior1` (breaking-change)
Notable Changes
^^^^^^^^^^^^^^^
- Add Number entities (from Home Assistant) :esphomepr:`1971` by :ghuser:`jesserockz` (new-feature) (new-integration) (notable-change)
All changes
^^^^^^^^^^^
- Update ambiguous command :esphomepr:`1889` by :ghuser:`jesserockz`
- Configure clang-format for consistent pointer alignment :esphomepr:`1890` by :ghuser:`OttoWinter`
- Activate some clang-tidy checks :esphomepr:`1884` by :ghuser:`OttoWinter`
- Avoid non-const globals and enable clang-tidy check :esphomepr:`1892` by :ghuser:`agners`
- Convert st7735.cpp to use Unix line separators :esphomepr:`1894` by :ghuser:`oxan`
- Split files in light component :esphomepr:`1893` by :ghuser:`oxan`
- Fix CI by avoiding non-const global :esphomepr:`1907` by :ghuser:`oxan`
- Adds support cpp to vscode :esphomepr:`1828` by :ghuser:`dentra`
- Support ESP8266 Arduino 3.0.0 :esphomepr:`1897` by :ghuser:`agners`
- Run script/setup in devcontainer instead of pip install :esphomepr:`1913` by :ghuser:`OttoWinter`
- Fix typo in test3.yaml :esphomepr:`1928` by :ghuser:`loongyh`
- Fix error print in script/helpers.py :esphomepr:`1935` by :ghuser:`agners`
- Add variable bit width for Samsung protocol :esphomepr:`1927` by :ghuser:`kbx81`
- Add data sizes to log message :esphomepr:`1938` by :ghuser:`jesserockz`
- Update generation script to add const :esphomepr:`1945` by :ghuser:`jesserockz`
- Bump dashboard to 20210621.0 :esphomepr:`1946` by :ghuser:`balloob`
- Improve DHT read timings :esphomepr:`1901` by :ghuser:`agners`
- More VSCode devcontainer improvements :esphomepr:`1934` by :ghuser:`agners`
- Validate color temperature values for RGBWW/CWWW lights :esphomepr:`1957` by :ghuser:`oxan`
- Fix on_multi_click min_length :esphomepr:`1960` by :ghuser:`jesserockz`
- Climate component for Ballu air conditioners with remote model YKR-K/002E :esphomepr:`1939` by :ghuser:`bazuchan` (new-integration)
- Simplify initializing glyph_data :esphomepr:`1970` by :ghuser:`gladhorn`
- Add device_class support for MQTT integration :esphomepr:`1832` by :ghuser:`definitio`
- Rename master branch to release :esphomepr:`1976` by :ghuser:`OttoWinter`
- Fix tuya fan speed send :esphomepr:`1978` by :ghuser:`trvrnrth`
- Time Based Cover: Fixed apparent race condition on ESP32 chips :esphomepr:`1984` by :ghuser:`pdoidge`
- Fix invalid escape sequences in regex (fix pytest warning) :esphomepr:`1814` by :ghuser:`oxan`
- Bump hypothesis from 5.21.0 to 5.49.0 :esphomepr:`1753` by :ghuser:`mweinelt`
- Bump pytest-mock from 3.5.1 to 3.6.1 :esphomepr:`1754` by :ghuser:`dependabot[bot]`
- hlw8012: fix constants for BL0937 :esphomepr:`1973` by :ghuser:`ianchi`
- Anova ble component :esphomepr:`1752` by :ghuser:`buxtronix` (new-integration)
- Add stepper.set_acceleration and stepper.set_deceleration to stepper component :esphomepr:`1977` by :ghuser:`WeekendWarrior1`
- remote_receiver use config parent receiver for registering dumpers :esphomepr:`1980` by :ghuser:`jesserockz` (breaking-change)
- Don't try compat parsing for "esphome version" :esphomepr:`1966` by :ghuser:`oxan`
- Change color model to fix white channel issues :esphomepr:`1895` by :ghuser:`oxan` (breaking-change)
- Allow WiFi AP to use device name :esphomepr:`1990` by :ghuser:`jesserockz` (new-feature)
- Support custom fan modes in mqtt_climate :esphomepr:`1989` by :ghuser:`mgorven`
- Bump protobuf from 3.17.0 to 3.17.3 :esphomepr:`1986` by :ghuser:`dependabot[bot]`
- Bump pytest-cov from 2.11.1 to 2.12.1 :esphomepr:`1855` by :ghuser:`dependabot[bot]`
- Bump pytest-asyncio from 0.14.0 to 0.15.1 :esphomepr:`1793` by :ghuser:`dependabot[bot]`
- Improve climate mode code docs :esphomepr:`1995` by :ghuser:`OttoWinter`
- Climate modes COOL and HEAT are auto modes :esphomepr:`1994` by :ghuser:`carstenschroeder`
- Add state callback to ota component :esphomepr:`1816` by :ghuser:`mmakaay`
- Fix deprecation message for old climate swing mode methods :esphomepr:`2003` by :ghuser:`oxan`
- Add Number entities (from Home Assistant) :esphomepr:`1971` by :ghuser:`jesserockz` (new-feature) (new-integration) (notable-change)
- Fixed lolin32 lite key :esphomepr:`2001` by :ghuser:`monkeyclass`
- Add support for IBS-TH1 External Sensor :esphomepr:`1983` by :ghuser:`MikkoTervala`
- Bang bang climate new mode meanings :esphomepr:`1996` by :ghuser:`OttoWinter`
- Sgp30 sensor improvements :esphomepr:`1510` by :ghuser:`huubeikens`
- Color brightness fixes :esphomepr:`2008` by :ghuser:`oxan`
- Bump black from 21.5b1 to 21.6b0 :esphomepr:`2011` by :ghuser:`dependabot[bot]`
- Added support for havells_solar sensor :esphomepr:`1988` by :ghuser:`sourabhjaiswal` (new-integration)
- Remove a whole bunch of deprecated/removed stuff :esphomepr:`1981` by :ghuser:`jesserockz` (breaking-change)
- catch 0.0 in float set_level pre-adjustment :esphomepr:`2013` by :ghuser:`WeekendWarrior1` (breaking-change)
- Introduce clamp as a template function :esphomepr:`1953` by :ghuser:`agners`
- [Teleinfo] do not stop parsing frame if there is only a CRC error on … :esphomepr:`1999` by :ghuser:`St4n`
Past Changelogs
---------------
.. toctree::
:maxdepth: 1
v1.19.0
v1.18.0
v1.17.0
v1.16.0
v1.15.0
v1.14.0
v1.13.0
v1.12.0
v1.11.0
v1.10.0
v1.9.0
v1.8.0
v1.7.0

53
components/climate/anova.rst Normal file
View File

@ -0,0 +1,53 @@
Anova Cooker
=============
.. seo::
:description: Instructions for setting up an Anova sous-vide cooker.
:image: anova.png
The ``anova`` climate platform creates a climate device which can be used
to control a BLE Anova sous-vide stick. Whilst not strictly a climate
device, the concept of keeping something to a set temperature applies
equally here.
This component supports the following functionality:
- Turn the stick on or off
- Set the desired temperature
- Show the current temperature
The timer is not currently supported, you can use automations to achieve
similar functionality.
This platform uses the BLE peripheral on an ESP32, so you also need to enable
this component. Please see the BLE Client docs for how to discover the MAC
address of your Anova device.
You cannot use the Anova app over BLE whilst this component is connected, you
should disconnect it first. To setup a (dis-)connect switch, see :doc:`/components/switch/ble_client`.
.. code-block:: yaml
ble_client:
- mac_address: 11:22:33:aa:bb:cc
id: my_anova
climate:
- platform: anova
name: "My Anova stick"
ble_client_id: my_anova
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.
- All other options from :ref:`Climate <config-climate>`.
See Also
--------
- :doc:`/components/ble_client`
- :doc:`/components/climate/index`
- :apiref:`anova/anova.h`
- :ghedit:`Edit`

3
components/climate/ir_climate.rst
View File

@ -19,6 +19,8 @@ request so it will be added (see FAQ).
| Name | Platform name | Supports receiver |
| | | |
+=======================================+=====================+======================+
| Ballu | ``ballu`` | yes |
+---------------------------------------+---------------------+----------------------+
| Coolix | ``coolix`` | yes |
+---------------------------------------+---------------------+----------------------+
| Daikin | ``daikin`` | yes |
@ -157,6 +159,7 @@ See Also
- :doc:`/components/climate/index`
- :doc:`/components/remote_transmitter`
- :apiref:`ballu.h <ballu/ballu.h>`,
- :apiref:`coolix.h <coolix/coolix.h>`,
:apiref:`daikin.h <daikin/daikin.h>`
:apiref:`fujitsu_general.h <fujitsu_general/fujitsu_general.h>`,

1
components/index.rst
View File

@ -9,6 +9,7 @@ Components
cover/index
fan/index
light/index
number/index
output/index
sensor/index
switch/index

34
components/light/index.rst
View File

@ -48,7 +48,7 @@ Configuration variables:
- **on_turn_off** (*Optional*, :ref:`Action <config-action>`): An automation to perform
when the light is turned off. See :ref:`light-on_turn_on_off_trigger`.
Additional Configuration variables for addressable lights:
Additional configuration variables for addressable lights:
- **color_correct** (*Optional*, list of float): Apply a color correction to each color channel.
This defines the maximum brightness of each channel. For example ``[100%, 50%, 100%]`` would set the
@ -129,15 +129,19 @@ Configuration variables:
- **transition_length** (*Optional*, :ref:`config-time`, :ref:`templatable <config-templatable>`): The length of the transition
if the light supports it.
- **brightness** (*Optional*, percentage, :ref:`templatable <config-templatable>`): The brightness of the light. Must be in range
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to not changing brightness.
``0%`` to ``100%`` or ``0.0`` to ``1.0``. This is a master brightness that applies to all channels (both color and white) of the
light. Defaults to not changing brightness.
- **color_brightness** (*Optional*, percentage, :ref:`templatable <config-templatable>`): The brightness of the color lights. Must
be in range ``0%`` to ``100%`` or ``0.0`` to ``1.0``. Useful to control brightness of colored and white lights separately for
RGBW lights. Defaults to not changing brightness.
- **red** (*Optional*, percentage, :ref:`templatable <config-templatable>`): The red channel of the light. Must be in range
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to not changing red.
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to not changing red channel.
- **green** (*Optional*, percentage, :ref:`templatable <config-templatable>`): The green channel of the light. Must be in range
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to not changing green channel.
- **blue** (*Optional*, percentage, :ref:`templatable <config-templatable>`): The blue channel of the light. Must be in range
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to not changing blue channel.
- **white** (*Optional*, percentage, :ref:`templatable <config-templatable>`): The white channel value of RGBW lights. Must be in range
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to not changing white value.
- **white** (*Optional*, percentage, :ref:`templatable <config-templatable>`): The brightness of the white lights. Must be in range
``0%`` to ``100%`` or ``0.0`` to ``1.0``. Defaults to not changing white channel.
- **color_temperature** (*Optional*, float, :ref:`templatable <config-templatable>`): The white color temperature value (in `mireds <https://en.wikipedia.org/wiki/Mired>`__ or Kelvin) for CWWW / RGBWW lights. Defaults to not changing the color temperature value.
- **flash_length** (*Optional*, :ref:`config-time`, :ref:`templatable <config-templatable>`): If set, will flash the given color
for this period of time and then go back to the previous state.
@ -163,7 +167,21 @@ Configuration variables:
The ``red``, ``green`` and ``blue`` values only control the color of the light, not its
brightness! If you assign ``50%`` to all RGB channels it will be interpreted as 100% on.
Only use ``brightness`` to control the brightness of the light.
Only use ``brightness`` or ``color_brightness`` to control the brightness of the light.
.. note::
The master brightness (``brightness``) and separate brightness controls for the color and
white channels (``color_brightness`` and ``white``) are multiplied together. Thus, this will
result in color at 40% brightness and white at 60% brightness:
.. code-block:: yaml
- light.turn_on:
id: light_1
brightness: 80%
color_brightness: 50%
white: 75%
.. _light-turn_off_action:
@ -295,13 +313,15 @@ Configuration variables:
- **range_to** (*Optional*, :ref:`templatable <config-templatable>`, int): The end of the
range of LEDs to control - this is a half-open interval. 0-based indexing.
Defaults to the end of the strip (``num_leds``).
- **color_brightness** (*Optional*, :ref:`templatable <config-templatable>`, percentage): The brightness to
set the color channel to.
- **red** (*Optional*, :ref:`templatable <config-templatable>`, percentage): The value to
set the red channel to.
- **green** (*Optional*, :ref:`templatable <config-templatable>`, percentage): The value to
set the green channel to.
- **blue** (*Optional*, :ref:`templatable <config-templatable>`, percentage): The value to
set the blue channel to.
- **white** (*Optional*, :ref:`templatable <config-templatable>`, percentage): The value to
- **white** (*Optional*, :ref:`templatable <config-templatable>`, percentage): The brightness to
set the white channel to.
.. _light-is_on_condition:

14
components/light/rgbw.rst
View File

@ -62,14 +62,14 @@ Configuration variables:
Color Interlock
***************
With some LED bulbs, setting the RGB channels to maximum whilst wanting a white light will have an undesired
hue affect. Additionally, the brightness command may not work as expected depending upon configuration,
leaving users to adjust the white component level separately. For these cases a new configration variable
has been added: color_interlock.
With some LED bulbs, it is not possible to enable the RGB leds at the same time as the white leds, or setting
the RGB channels to maximum whilst wanting a white light will have an undesired hue effect. For these cases a
configuration variable is available that prevents the RGB leds and white leds from being turned on at the same
time: ``color_interlock``.
Setting this variable to True will turn off RGB leds when white value is above 0 (or if they are to 255,255,255)
and turn off white leds if color is not set to 255,255,255. This also allows the brightness parameter to
control the intensity of the white leds.
Setting this variable to ``True`` will automatically turn off the RGB leds when the white value is non-zero, or
when the color is set to white (equal values for red, green and blue). When a different color is set, or the
color brightness is raised above 0%, the white leds are automatically turned off.
See Also
--------

188
components/number/index.rst Normal file
View File

@ -0,0 +1,188 @@
Number Component
================
.. seo::
:description: Instructions for setting up number components in ESPHome.
:image: folder-open.png
ESPHome has support for components to create a number entity. A number entity is
like a sensor that can read a value from a device, but is useful when that value
can be set by the user/frontend.
.. note::
Home Assistant Core 2021.7 or higher is required for ESPHome number entities to work.
.. _config-number:
Base Number Configuration
-------------------------
All numbers in ESPHome have a name and an optional icon.
.. code-block:: yaml
# Example number configuration
name: Livingroom Volume
# Optional variables:
icon: "mdi:volume-high"
Configuration variables:
- **name** (**Required**, string): The name for the number.
- **icon** (*Optional*, icon): Manually set the icon to use for the number in the frontend.
- **internal** (*Optional*, boolean): Mark this component as internal. Internal components will
not be exposed to the frontend (like Home Assistant). Only specifying an ``id`` without
a ``name`` will implicitly set this to true.
Automations:
- **on_value** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when a new value is published. See :ref:`number-on_value`.
- **on_value_range** (*Optional*, :ref:`Automation <automation>`): An automation to perform
when a published value transition from outside to a range to inside. See :ref:`number-on_value_range`.
MQTT Options:
- All other options from :ref:`MQTT Component <config-mqtt-component>`.
Number Automation
-----------------
You can access the most recent state of the number in :ref:`lambdas <config-lambda>` using
``id(number_id).state``.
.. _number-on_value:
``on_value``
************
This automation will be triggered when a new value is published. In :ref:`Lambdas <config-lambda>`
you can get the value from the trigger with ``x``.
.. code-block:: yaml
number:
- platform: template
# ...
on_value:
then:
- light.turn_on:
id: light_1
red: !lambda "return x/255;"
Configuration variables: See :ref:`Automation <automation>`.
.. _number-on_value_range:
``on_value_range``
******************
With this automation you can observe if a number value passes from outside
a defined range of values to inside a range.
This trigger will only trigger when the new value is inside the range and the previous value
was outside the range. On startup, the last state before reboot is restored and if the value crossed
the boundary during the boot process, the trigger is also executed.
Define the range with ``above`` and ``below``. If only one of them is defined, the interval is half-open.
So for example ``above: 5`` with no below would mean the range from 5 to positive infinity.
.. code-block:: yaml
number:
- platform: template
# ...
on_value_range:
above: 5
below: 10
then:
- switch.turn_on: relay_1
Configuration variables:
- **above** (*Optional*, float): The minimum for the trigger.
- **below** (*Optional*, float): The maximum for the trigger.
- See :ref:`Automation <automation>`.
.. _number-in_range_condition:
``number.in_range`` Condition
*****************************
This condition passes if the state of the given number is inside a range.
Define the range with ``above`` and ``below``. If only one of them is defined, the interval is half-open.
So for example ``above: 5`` with no below would mean the range from 5 to positive infinity.
.. code-block:: yaml
# in a trigger:
on_...:
if:
condition:
number.in_range:
id: my_number
above: 50.0
then:
- script.execute: my_script
Configuration variables:
- **above** (*Optional*, float): The minimum for the condition.
- **below** (*Optional*, float): The maximum for the condition.
.. _number-set_action:
``number.set`` Action
*********************
This is an :ref:`Action <config-action>` for setting a number state.
.. code-block:: yaml
- number.set:
id: my_number
value: 42
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the number to set.
- **value** (**Required**, float, :ref:`templatable <config-templatable>`):
The value to set the number to.
.. _number-lambda_calls:
lambda calls
************
From :ref:`lambdas <config-lambda>`, you can call several methods on all numbers to do some
advanced stuff (see the full API Reference for more info).
- ``make_call()``: Set the number value.
.. code-block:: cpp
// Within lambda, push a value of 42
auto call = id(my_number).make_call();
call.set_value(42);
call.perform();
- ``.state``: Retrieve the current value of the number. Is ``NAN`` if no value has been read or set.
.. code-block:: cpp
// For example, create a custom log message when a value is received:
ESP_LOGI("main", "Value of my number: %f", id(my_number).state);
See Also
--------
- :apiref:`number/number.h`
- :ghedit:`Edit`
.. toctree::
:maxdepth: 1
:glob:
*

52
components/number/template.rst Normal file
View File

@ -0,0 +1,52 @@
Template Number
===============
.. seo::
:description: Instructions for setting up template numbers with ESPHome.
:image: description.png
The ``template`` number platform allows you to create a number with templated values
using :ref:`lambdas <config-lambda>`.
.. code-block:: yaml
# Example configuration entry
number:
- platform: template
name: "Template number"
update_interval: never
min_value: 0
max_value: 100
step: 1
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the number.
- **min_value** (**Required**, float): The minimum value this number can be.
- **max_value** (**Required**, float): The maximum value this number can be.
- **step** (**Required**, float): The granularity with which the number can be set.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
Lambda to be evaluated every update interval to get the new value of the number.
- **set_action** (*Optional*, :ref:`Action <config-action>`): The action that should
be performed when the remote (like Home Assistant's frontend) requests to set the number value.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
number. Defaults to ``60s``.
- **optimistic** (*Optional*, boolean): Whether to operate in optimistic mode - when in this mode,
any command sent to the template number will immediately update the reported state.
Defaults to ``false``.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-number>`.
``number.set`` Action
----------------------------------
You can also publish a state to a template number from elsewhere in your YAML file
with the :ref:`number-set_action`.
See Also
--------
- :ref:`automation`
- :apiref:`template/number/template_number.h`
- :ghedit:`Edit`

124
components/ota.rst
View File

@ -36,6 +36,16 @@ Configuration variables:
- **reboot_timeout** (*Optional*, :ref:`time <config-time>`): The amount of time to wait before rebooting when in
safe mode. Defaults to ``5min``.
- **num_attempts** (*Optional*, int): The number of attempts to wait before entering safe mode. Defaults to ``10``.
- **on_begin** (*Optional*, :ref:`Automation<automation>`): An action to be
performed when an OTA update is started. See :ref:`ota-on_begin`.
- **on_progress** (*Optional*, :ref:`Automation<automation>`): An action to be
performed (multiple times) during an OTA update. See :ref:`ota-on_progress`.
- **on_end** (*Optional*, :ref:`Automation<automation>`): An action to be
performed after a successful OTA update. See :ref:`ota-on_end`.
- **on_error** (*Optional*, :ref:`Automation<automation>`): An action to be
performed after a failed OTA update. See :ref:`ota-on_error`.
- **on_state_change** (*Optional*, :ref:`Automation<automation>`): An action to be
performed when an OTA update state change happens. See :ref:`ota-on_state_change`.
.. note::
@ -46,6 +56,120 @@ Configuration variables:
very likely that power-cycling the ESP module is required once after
the serial upload.
OTA Automation
--------------
The OTA component provides various automations that can be used to provide feedback
during an OTA update. There are a few things to consider when making use of the
provided automation triggers:
- An OTA update blocks the main loop during its operation. This means that you
won't be able to represent state changes using components that update their
output only from within their ``loop()`` method. Explained differently: if you
try to display the OTA progress using component X, but the update only appears
after the OTA update finished, then component X cannot be used for providing
OTA update feedback.
- Make sure that your automation actions do not take too much time, to prevent
them from blocking the OTA update code for too long.
.. _ota-on_begin:
``on_begin``
************
This automation will be triggered when an OTA update is started.
.. code-block:: yaml
ota:
on_begin:
then:
- logger.log: "OTA start"
.. _ota-on_progress:
``on_progress``
***************
Using this automation, it is possible to report on the OTA update progress.
It will be triggered multiple times during the OTA update. You can get the actual
progress percentage (a value between 0 and 100) from the trigger with variable ``x``.
.. code-block:: yaml
ota:
on_progress:
then:
- logger.log:
format: "OTA progress %0.1f%%"
args: ["x"]
.. _ota-on_end:
``on_end``
**********
This automation will be triggered when an OTA update has completed sucessfully,
right before the device is rebooted.
Because the update has completed, you can safely use an automation action that
takes some time to complete. This can for example be useful if you want to flash
a LED or so, in which case a pause would be required to make the LED light up
for long enough, before the reboot turns it off.
.. code-block:: yaml
ota:
on_end:
then:
- logger.log: "OTA end"
.. _ota-on_error:
``on_error``
************
This automation will be triggered when an OTA update has failed. You can get
the internal error code with variable ``x``.
Just like for :ref:`ota-on_end`, you can safely use an automation that
takes some time to complete, because the OTA update is no longer busy.
.. code-block:: yaml
ota:
on_error:
then:
- logger.log:
format: "OTA update error %d"
args: ["x"]
.. _ota-on_state_change:
``on_state_change``
*******************
This automation will be triggered on every state change. You can get the actual
state with variable ``state``, which will contain one of values for the OTAState
enum. These values are:
- ``ota::OTA_STARTED``
- ``ota::OTA_IN_PROGRESS`` (will be called multiple times during the update)
- ``ota::OTA_COMPLETED``
- ``ota::OTA_ERROR``
.. code-block:: yaml
ota:
on_state_change:
then:
- if:
condition:
lambda: return state == ota::OTA_STARTED
then:
- logger.log: "OTA start"
Updating the password:
----------------------

1
components/remote_receiver.rst
View File

@ -156,6 +156,7 @@ Remote code selection (exactly one of these has to be included):
- **samsung**: Trigger on a decoded Samsung remote code with the given data.
- **data** (**Required**, int): The data to trigger on, see dumper output for more info.
- **nbits** (*Optional*, int): The number of bits of the remote code. Defaults to ``32``.
- **samsung36**: Trigger on a decoded Samsung36 remote code with the given data.

7
components/remote_transmitter.rst
View File

@ -197,22 +197,29 @@ Configuration variables:
**********************************************
This :ref:`action <config-action>` sends a Samsung infrared remote code to a remote transmitter.
It transmits codes up to 64 bits in length in a single packet.
.. code-block:: yaml
on_...:
- remote_transmitter.transmit_samsung:
data: 0x1FEF05E4
# additional example for 48-bit codes:
- remote_transmitter.transmit_samsung:
data: 0xB946F50A09F6
nbits: 48
Configuration variables:
- **data** (**Required**, int): The data to send, see dumper output for more details.
- **nbits** (*Optional*, int): The number of bits to send. Defaults to ``32``.
- All other options from :ref:`remote_transmitter-transmit_action`.
``remote_transmitter.transmit_samsung36`` Action
************************************************
This :ref:`action <config-action>` sends a Samsung36 infrared remote code to a remote transmitter.
It transmits the ``address`` and ``command`` in two packets separated by a "space".
.. code-block:: yaml

184
components/sensor/havells_inverter.rst Normal file
View File

@ -0,0 +1,184 @@
Havells Inverter
================
.. seo::
:description: Instructions for setting up Havells inverter reading on modbus.
:image: images/havellsgti5000d.jpg
:keywords: Havells Enviro, Havells GTI
The ``Havells Inverter`` sensor platform allows you to use Havells inverter data reading on modbus
(`website <https://www.havells.com/en/consumer/solar/solar-on-grid-inverter-and-solutions/solar-on-grid-inverter.html>`__)
with ESPHome.
.. figure:: images/havellsgti5000d.jpg
:align: center
:width: 50.0%
Havells On Grid Solar Inverter.
The communication with this integration is done over a :ref:`UART bus <uart>` using :ref:`Modbus <modbus>`.
You must therefore have a ``uart:`` entry in your configuration with both the TX and RX pins set
to some pins on your board and the baud rate set to 9600.
.. code-block:: yaml
# Example configuration entry
uart:
- id: uart1
baud_rate: 9600
tx_pin: GPIO1
rx_pin: GPIO3
modbus:
uart_id: uart1
flow_control_pin: GPIO4
sensor:
- platform: havells_solar
update_interval: 60s
phase_a:
voltage:
name: "HAVELLS Phase A Voltage"
current:
name: "HAVELLS Phase A Current"
phase_b:
voltage:
name: "HAVELLS Voltage Phase B"
current:
name: "HAVELLS Current Phase B"
phase_c:
voltage:
name: "HAVELLS Voltage Phase C"
current:
name: "HAVELLS Current Phase C"
pv1:
voltage:
name: "HAVELLS PV1 Voltage"
current:
name: "HAVELLS PV1 Current"
active_power:
name: "HAVELLS PV1 Active Power"
voltage_sampled_by_secondary_cpu:
name: "HAVELLS PV1 Voltage Sampled By Slave CPU"
insulation_of_p_to_ground:
name: "HAVELLS PV1 Insulation Of +VE To Ground"
pv2:
voltage:
name: "HAVELLS PV2 Voltage"
current:
name: "HAVELLS PV2 Current"
active_power:
name: "HAVELLS PV2 Active Power"
voltage_sampled_by_secondary_cpu:
name: "HAVELLS PV2 Voltage Sampled By Slave CPU"
insulation_of_p_to_ground:
name: "HAVELLS PV2 Insulation Of +VE To Ground"
active_power:
name: "HAVELLS Active Power"
reactive_power:
name: "HAVELLS Reactive Power"
frequency:
name: "HAVELLS Frequency"
energy_production_day:
name: "HAVELLS Today's Generation"
total_energy_production:
name: "HAVELLS Total Energy Production"
total_generation_time:
name: "HAVELLS Total Generation Time"
today_generation_time:
name: "HAVELLS Today Generation Time"
inverter_module_temp:
name: "HAVELLS Inverter Module Temp"
inverter_inner_temp:
name: "HAVELLS Inverter Inner Temp"
inverter_bus_voltage:
name: "HAVELLS Inverter BUS Voltage"
insulation_of_pv_n_to_ground:
name: "HAVELLS Insulation Of PV- To Ground"
gfci_value:
name: "HAVELLS GFCI Value"
dci_of_r:
name: "HAVELLS DCI Of R"
dci_of_s:
name: "HAVELLS DCI Of S"
dci_of_t:
name: "HAVELLS DCI Of T"
Configuration variables:
------------------------
- **phase_a** (*Optional*): The group of exposed sensors for Phase A/1.
- **current** (*Optional*): Use the current value of the sensor in amperes. All options from
:ref:`Sensor <config-sensor>`.
- **voltage** (*Optional*): Use the voltage value of the sensor in volts.
All options from :ref:`Sensor <config-sensor>`.
- **phase_b** (*Optional*): The group of exposed sensors for Phase B/2 on applicable inverters.
- All options from **phase_a**
- **phase_c** (*Optional*): The group of exposed sensors for Phase C/3 on applicable inverters.
- All options from **phase_a**
- **pv1** (*Optional*): The group of exposed sensors for Photo Voltaic 1.
- **current** (*Optional*): Use the current value of the sensor in amperes. All options from
:ref:`Sensor <config-sensor>`.
- **voltage** (*Optional*): Use the voltage value of the sensor in volts.
All options from :ref:`Sensor <config-sensor>`.
- **active_power** (*Optional*): Use the (active) power value of the sensor in watts. All options
from :ref:`Sensor <config-sensor>`.
- **voltage_sampled_by_secondary_cpu** (*Optional*): Use the photo voltiac's voltage sampled by
slave CPU value of the sensor in volts. All options from :ref:`Sensor <config-sensor>`.
- **insulation_of_p_to_ground** (*Optional*): Use the insulation of photo voltiac's +ve terminal to
ground value of the sensor in kilo ohms. All options from :ref:`Sensor <config-sensor>`.
- **pv2** (*Optional*): The group of exposed sensors for Photo Voltaic 2.
- All options from **pv1**
- **active_power** (*Optional*): Use the (active) power value of the sensor in watts. All options
from :ref:`Sensor <config-sensor>`.
- **reactive_power** (*Optional*): Use the reactive power value of the sensor in VAR. All
options from :ref:`Sensor <config-sensor>`.
- **frequency** (*Optional*): Use the frequency value of the sensor in hertz.
All options from :ref:`Sensor <config-sensor>`.
- **energy_production_day** (*Optional*): Use the export active energy value for same day of the
sensor in kilo watt hours. All options from :ref:`Sensor <config-sensor>`.
- **total_energy_production** (*Optional*): Use the total exported energy value of the sensor in
kilo watt hours. All options from :ref:`Sensor <config-sensor>`.
- **total_generation_time** (*Optional*): Use the total generation time value of the sensor in
hours. All options from :ref:`Sensor <config-sensor>`.
- **today_generation_time** (*Optional*): Use the day generation time value for same day of the
sensor in minutes. All options from :ref:`Sensor <config-sensor>`.
- **inverter_module_temp** (*Optional*): Use the inverter module temperature value of the sensor in
degree celcius. All options from :ref:`Sensor <config-sensor>`.
- **inverter_inner_temp** (*Optional*): Use the inverter inner temperature value of the sensor in
degree celcius. All options from :ref:`Sensor <config-sensor>`.
- **inverter_bus_voltage** (*Optional*): Use the inverter bus voltage value of the sensor in volts.
All options from :ref:`Sensor <config-sensor>`.
- **insulation_of_pv_n_to_ground** (*Optional*): Use the insulation of photo voltiacs's
-ve terminal to ground value of the sensor in kilo ohms. All options from :ref:`Sensor <config-sensor>`.
- **gfci_value** (*Optional*): Use the GFCI value of the sensor.
All options from :ref:`Sensor <config-sensor>`.
- **dci_of_r** (*Optional*): Use the DCI of R value of the sensor.
All options from :ref:`Sensor <config-sensor>`.
- **dci_of_s** (*Optional*): Use the DCI of S value of the sensor.
All options from :ref:`Sensor <config-sensor>`.
- **dci_of_t** (*Optional*): Use the DCI of T value of the sensor.
All options from :ref:`Sensor <config-sensor>`.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.
- **address** (*Optional*, int): The address of the sensor if multiple sensors are attached to
the same UART bus. You will need to set the address of each device manually. Defaults to ``1``.
See Also
--------
- :ref:`sensor-filters`
- :ghedit:`Edit`

3
components/sensor/hlw8012.rst
View File

@ -67,6 +67,9 @@ Advanced Options:
Defaults to the Sonoff POW's value ``0.001 ohm``.
- **voltage_divider** (*Optional*, float): The value of the voltage divider on the board as ``(R_upstream + R_downstream) / R_downstream``.
Defaults to the Sonoff POW's value ``2351``.
- **model** (*Optional*, string): The sensor model on the board, to set internal constant factors to convert pulses to measurements.
Possible values are ``HLW8012``, ``CSE7759``, ``BL0937``. Defaults to ``HLW8012``.
CSE7759 uses same constants and it also works with default. Must be set for BL0937 to be able to calibrate all three measurements at the same time.
- **change_mode_every** (*Optional*, int): After how many updates to cycle between the current/voltage measurement mode.
Note that the first value after switching is discarded because it is often inaccurate. Defaults to ``8``.
- **initial_mode** (*Optional*, string): The initial measurement mode. Defaults to ``VOLTAGE``.

BIN
components/sensor/images/havellsgti5000d.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

41
components/sensor/inkbird_ibsth1_mini.rst
View File

@ -1,16 +1,21 @@
Inkbird IBS-TH1 Mini BLE Sensor
===============================
Inkbird IBS-TH1 and IBS-TH1 Mini BLE Sensor
===========================================
.. seo::
:description: Instructions for setting up Inkbird IBS-TH1 Mini Bluetooth-based temperature and humidity sensors in ESPHome.
:description: Instructions for setting up Inkbird IBS-TH1 Bluetooth-based temperature and humidity sensors in ESPHome.
:image: inkbird_isbth1_mini.jpg
:keywords: Inkbird, BLE, Bluetooth, IBS-TH1
The ``inkbird_ibsth1_mini`` sensor platform lets you track the output of Inkbird IBS-TH1 Mini Bluetooth
The ``inkbird_ibsth1_mini`` sensor platform lets you track the output of Inkbird IBS-TH1 and IBS-TH1 Mini Bluetooth
Low Energy devices using the :doc:`/components/esp32_ble_tracker`. This component will track the
temperature, humidity and the battery level of the IBS-TH1 Mini device every time the
temperature, external temperature (non mini only), humidity and the battery level of the IBS-TH1 device every time the
sensor sends out a BLE broadcast. Note that contrary to other implementations, ESPHome can track as
many IBS-TH1 Mini devices at once as you want.
many IBS-TH1 devices at once as you want.
.. note::
If an external temperature sensor is connected to the IBS-TH1, measurement from the internal sensor is not sent.
Only one sensor will work at a time.
.. figure:: images/inkbird_isbth1_mini-full.jpg
:align: center
@ -31,22 +36,30 @@ many IBS-TH1 Mini devices at once as you want.
- platform: inkbird_ibsth1_mini
mac_address: 38:81:D7:0A:9C:11
temperature:
name: "Inkbird IBS-TH1 Mini Temperature"
name: "Inkbird IBS-TH1 Temperature"
external_temperature:
name: "Inkburd IBS-TH1 External Temperature"
humidity:
name: "Inkbird IBS-TH1 Mini Humidity"
name: "Inkbird IBS-TH1 Humidity"
battery_level:
name: "Inkbird IBS-TH1 Mini Battery Level"
name: "Inkbird IBS-TH1 Battery Level"
Configuration variables:
------------------------
- **mac_address** (**Required**, MAC Address): The MAC address of the Inkbird IBS-TH1 Mini device.
- **mac_address** (**Required**, MAC Address): The MAC address of the Inkbird IBS-TH1 device.
- **temperature** (*Optional*): The information for the temperature sensor.
- **name** (**Required**, string): The name for the temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **external_temperature** (*Optional*): The information for the external temperature sensor.
- **name** (**Required**, string): The name for the external temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (*Optional*): The information for the humidity sensor
- **name** (**Required**, string): The name for the humidity sensor.
@ -63,7 +76,7 @@ Configuration variables:
Setting Up Devices
------------------
To set up Inkbird IBS-TH1 Mini devices you first need to find their MAC Address so that ESPHome can
To set up Inkbird IBS-TH1 devices you first need to find their MAC Address so that ESPHome can
identify them. So first, create a simple configuration without any ``inkbird_ibsth1_mini`` entries
like so:
@ -71,7 +84,7 @@ like so:
esp32_ble_tracker:
After uploading the ESP32 will immediately try to scan for BLE devices such as the Inkbird IBS-TH1 Mini.
After uploading the ESP32 will immediately try to scan for BLE devices such as the Inkbird IBS-TH1.
When it detects these sensors, it will automatically parse the BLE message print a
message like this one:
@ -82,7 +95,7 @@ message like this one:
[13:36:43][D][esp32_ble_tracker:567]: Name: 'sps'
Note that it can sometimes take some time for the first BLE broadcast to be received. Please note that address type
should say 'PUBLIC' and the device name should be 'sps', this is how you find the Inkbird IBS-TH1 Mini among all the
should say 'PUBLIC' and the device name should be 'sps', this is how you find the Inkbird IBS-TH1 among all the
other devices.
Then just copy the address (``38:81:D7:0A:9C:11``) into a new ``sensor.inkbird_ibsth1_mini`` platform
@ -90,7 +103,7 @@ entry like in the configuration example at the top.
.. note::
The ESPHome Inkbird IBS-TH1 Mini integration listens passively to packets the device sends by itself.
The ESPHome Inkbird IBS-TH1 integration listens passively to packets the device sends by itself.
ESPHome therefore has no impact on the battery life of the device.
See Also

47
components/sensor/sgp30.rst
View File

@ -24,8 +24,9 @@ The :ref:`I²C Bus <i2c>` is required to be set up in your configuration for thi
tvoc:
name: "Workshop TVOC"
accuracy_decimals: 1
store_baseline: yes
address: 0x58
update_interval: 5s
update_interval: 1s
Configuration variables:
------------------------
@ -42,19 +43,34 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **store_baseline** (*Optional*, boolean): Store the sensor baselines persistently when calculated or updated.
Defaults to yes.
- **address** (*Optional*, int): Manually specify the I²C address of the sensor.
Defaults to ``0x58``.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
sensor. Defaults to ``60s``.
sensor. Defaults to ``1s``.
Advanced:
- **baseline** (*Optional*): The block containing baselines for calibration purposes. See :ref:`sgp30-calibrating` for more info.
- **eco2_baseline** (**Required**, int): The eCO2 baseline for calibration purposes.
- **eco2_baseline** (**Required**, int): The eCO2 baseline for calibration purposes. After OTA, this value is used to calibrate the sensor.
- **tvoc_baseline** (**Required**, int): The TVOC baseline for calibration purposes.
- **tvoc_baseline** (**Required**, int): The TVOC baseline for calibration purposes. After OTA, this value is used to calibrate the sensor.
- **eco2_baseline** (*Optional*): The information for the CO₂eq. sensor baseline value. Baseline value is published in decimals.
- **name** (**Required**, string): The name for the CO₂eq baseline value sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **tvoc_baseline** (*Optional*): The information for the TVOC baseline value sensor. Baseline value is published in in decimals.
- **name** (**Required**, string): The name for the TVOC baseline value sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **compensation** (*Optional*): The block containing sensors used for compensation.
@ -69,15 +85,21 @@ Advanced:
Calibrating Baseline
--------------------
The SGP30 sensor will re-calibrate its baseline each time it is powered on. During the first power-up this can take up to 12 hours.
The SGP30 sensor will re-calibrate its baseline each time it is powered on. During the first power-up this will take up to 12 hours.
Exposing to outside air for at least 10 minutes cumulative time is advised during the calibration period.
For best performance and faster startup times, the current **baseline** needs to be persistently stored on the device before shutting it down and set again accordingly after boot up
that also means that if the sensor reboots at a time when the air is less clean than normal,
the values will have a constant offset and cannot be compared to the values before the last
boot.
For best performance and faster startup times, the current **baseline** needs to be persistently stored on the device before shutting it down and set again accordingly after boot up.
It implies that if the sensor reboots at a time when the air is less clean than normal, the values will have a constant offset and cannot be compared to the values before the last boot.
To do this, let the sensor boot up with no baseline set and let the sensor calibrate itself. After around 12 hours you can then view the remote logs on the ESP. The next
time the sensor is read out, you will see a log message with something like ``Current eCO2 baseline: 0x86C5, TVOC baseline: 0x8B38``.
Using the **store_baseline** option will automatically store the baseline values after calibration or when it is updated during operation. When booting up, the stored values will then be
(re)applied in the sensor. Stored baselines are cleared after OTA.
Another method is to manually specify the baseline values in the configuration file. To do this, let the sensor boot up with no baseline set and let the sensor calibrate itself.
After around 12 hours you can then view the remote logs on the ESP. The nexttime the sensor is read out, you will see a log message with something like
``Current eCO2 baseline: 0x86C5, TVOC baseline: 0x8B38``.
Another way to obtain the baseline values is to configure the eco2 and TVOC baseline value sensors. Values will be published to your Home Automation system.
Convert the decimal value to hex value before use (e.g. 37577 --> 0x92C9)
Now set the baseline property in your configuration file like so with the value you got
via the logs:
@ -94,8 +116,7 @@ via the logs:
The next time you upload the code, the SGP30 will be continue its operation with this baseline and you will get consistent values.
Please note that Sensirion recommends that after around 7 days, the baseline will need to be
re-calibrated because the internal sensor has a slight value drift over time.
Please note while the sensor is off, baseline values are valid for a maximum of seven days.
See Also
--------

17
components/wifi.rst
View File

@ -51,7 +51,8 @@ Configuration variables:
- **ap** (*Optional*): Enable an access point mode on the node.
- **ssid** (**Required**, string): The name of the access point to create.
- **ssid** (*Optional*, string): The name of the access point to create. Leave empty to use
the device name.
- **password** (*Optional*, string): The password for the access point. Leave empty for
no password.
- **channel** (*Optional*, int): The channel the AP should operate on from 1 to 14.
@ -95,6 +96,20 @@ to the WiFi router can be made.
ssid: "Livingroom Fallback Hotspot"
password: "W1PBGyrokfLz"
You can also create a simple ``ap`` config which will set up the access point to have the
devices name as the ssid with no password.
.. code-block:: yaml
wifi:
ap: {}
# or if you still want the ap to have a password
wifi:
ap:
password: "W1PBGyrokfLz"
.. _wifi-manual_ip:
Manual IPs

4
conf.py
View File

@ -67,9 +67,9 @@ author = "Otto Winter"
# built documents.
#
# The short X.Y version.
version = "1.19"
version = "1.20"
# The full version, including alpha/beta/rc tags.
release = "1.19.4"
release = "1.20.0b1"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

6
guides/automations.rst
View File

@ -334,6 +334,9 @@ All Triggers
- :ref:`switch.on_turn_on/off <switch-on_turn_on_off_trigger>`
- :ref:`sim800l.on_sms_received <sim800l-on_sms_received>`
- :ref:`rf_bridge.on_code_received <rf_bridge-on_code_received>`
- :ref:`ota.on_begin <ota-on_begin>` / :ref:`ota.on_progress <ota-on_progress>` /
:ref:`ota.on_end <ota-on_end>` / :ref:`ota.on_error <ota-on_error>` /
:ref:`ota.on_state_change <ota-on_state_change>`
All Actions
-----------
@ -376,6 +379,7 @@ All Actions
- :ref:`rf_bridge.learn <rf_bridge-learn_action>`
- :ref:`ds1307.read_time <ds1307-read_time_action>` / :ref:`ds1307.write_time <ds1307-write_time_action>`
- :ref:`cs5460a.restart <cs5460a-restart_action>`
- :ref:`number.set <number-set_action>`
.. _config-condition:
@ -396,6 +400,7 @@ All Conditions
- :ref:`text_sensor.state <text_sensor-state_condition>`
- :ref:`light.is_on <light-is_on_condition>` / :ref:`light.is_off <light-is_off_condition>`
- :ref:`display.is_displaying_page <display-is_displaying_page-condition>`
- :ref:`number.in_range <number-in_range_condition>`
All Lambda Calls
----------------
@ -407,6 +412,7 @@ All Lambda Calls
- :ref:`Cover <cover-lambda_calls>`
- :ref:`Text Sensor <text_sensor-lambda_calls>`
- :ref:`Stepper <stepper-lambda_calls>`
- :ref:`Number <number-lambda_calls>`
.. _delay_action:

2
guides/getting_started_hassio.rst
View File

@ -46,7 +46,7 @@ The wizard will guide you through creating your first configuration and, dependi
If you use `Microsoft Edge <https://www.microsoft.com/edge>`_ or `Google Chrome <https://www.google.com/chrome>`_, you will be able to install the initial configuration by connecting your ESP device to the computer that you're using to view the ESPHome Dashboard.
*You need to access the ESPHome Dashboard over HTTPS for this to work. This is a requirement of browsers to access your ESP device to ensure that we write the correct data.*
If you use another browser, you will have to connect the ESP devices to the machine running the ESPHome Dashboard and Home Assistant.
If the serial port is not showing up, you might not have the required drivers installed. These drivers work for most ESP devices:

17
guides/supporters.rst
View File

@ -70,6 +70,7 @@ Contributors
- `Paulus Schoutsen (@balloob) <https://github.com/balloob>`__
- `Andrew Zaborowski (@balrog-kun) <https://github.com/balrog-kun>`__
- `Rutger Nijhuis (@BananaPukeh) <https://github.com/BananaPukeh>`__
- `bazuchan (@bazuchan) <https://github.com/bazuchan>`__
- `J. Nick Koston (@bdraco) <https://github.com/bdraco>`__
- `Ben Suffolk (@bensuffolk) <https://github.com/bensuffolk>`__
- `Bierchermuesli (@Bierchermuesli) <https://github.com/Bierchermuesli>`__
@ -89,6 +90,7 @@ Contributors
- `bwente (@bwente) <https://github.com/bwente>`__
- `Carlos Gustavo Sarmiento (@carlos-sarmiento) <https://github.com/carlos-sarmiento>`__
- `Carlos Garcia Saura (@CarlosGS) <https://github.com/CarlosGS>`__
- `carstenschroeder (@carstenschroeder) <https://github.com/carstenschroeder>`__
- `cbialobos (@cbialobos) <https://github.com/cbialobos>`__
- `Ciprian Constantinescu (@cciprian5) <https://github.com/cciprian5>`__
- `Marco (@cdrfun) <https://github.com/cdrfun>`__
@ -127,6 +129,7 @@ Contributors
- `dckiller51 (@dckiller51) <https://github.com/dckiller51>`__
- `Debashish Sahu (@debsahu) <https://github.com/debsahu>`__
- `declanshanaghy (@declanshanaghy) <https://github.com/declanshanaghy>`__
- `definitio (@definitio) <https://github.com/definitio>`__
- `deftdawg (@deftdawg) <https://github.com/deftdawg>`__
- `Christiaan Blom (@Deinara) <https://github.com/Deinara>`__
- `Rsan (@deltazerorsan) <https://github.com/deltazerorsan>`__
@ -223,6 +226,7 @@ Contributors
- `Guyohms (@Guyohms) <https://github.com/Guyohms>`__
- `h0-- (@h0--) <https://github.com/h0-->`__
- `haade (@haade-administrator) <https://github.com/haade-administrator>`__
- `Peter van Dijk (@Habbie) <https://github.com/Habbie>`__
- `Boris Hajduk (@hajdbo) <https://github.com/hajdbo>`__
- `Gavin Mogan (@halkeye) <https://github.com/halkeye>`__
- `Charles Thompson (@haryadoon) <https://github.com/haryadoon>`__
@ -232,6 +236,7 @@ Contributors
- `HepoH3 (@HepoH3) <https://github.com/HepoH3>`__
- `Hamish Moffatt (@hmoffatt) <https://github.com/hmoffatt>`__
- `MoA (@honomoa) <https://github.com/honomoa>`__
- `Huub Eikens (@huubeikens) <https://github.com/huubeikens>`__
- `Petr Urbánek (@HyperReap) <https://github.com/HyperReap>`__
- `Adrián Panella (@ianchi) <https://github.com/ianchi>`__
- `Ian Leeder (@ianleeder) <https://github.com/ianleeder>`__
@ -292,6 +297,7 @@ Contributors
- `Klarstein (@Klarstein) <https://github.com/Klarstein>`__
- `klenaers (@klenaers) <https://github.com/klenaers>`__
- `Kevin Lewis (@kll) <https://github.com/kll>`__
- `Koen Vervloesem (@koenvervloesem) <https://github.com/koenvervloesem>`__
- `korellas (@korellas) <https://github.com/korellas>`__
- `Kevin Pelzel (@kpelzel) <https://github.com/kpelzel>`__
- `Karl Q. (@kquinsland) <https://github.com/kquinsland>`__
@ -330,6 +336,7 @@ Contributors
- `Major Péter (@majorpeter) <https://github.com/majorpeter>`__
- `Manuel Díez (@manutenfruits) <https://github.com/manutenfruits>`__
- `Marcel van der Veldt (@marcelveldt) <https://github.com/marcelveldt>`__
- `Marc (@MarcHagen) <https://github.com/MarcHagen>`__
- `Marc Teale (@marcteale) <https://github.com/marcteale>`__
- `marecabo (@marecabo) <https://github.com/marecabo>`__
- `Marvin Gaube (@margau) <https://github.com/margau>`__
@ -351,9 +358,11 @@ Contributors
- `MeIchthys (@meichthys) <https://github.com/meichthys>`__
- `meijerwynand (@meijerwynand) <https://github.com/meijerwynand>`__
- `Marco (@Melkor82) <https://github.com/Melkor82>`__
- `Michael Gorven (@mgorven) <https://github.com/mgorven>`__
- `mhentschke (@mhentschke) <https://github.com/mhentschke>`__
- `micw (@micw) <https://github.com/micw>`__
- `Pauline Middelink (@middelink) <https://github.com/middelink>`__
- `Mikko Tervala (@MikkoTervala) <https://github.com/MikkoTervala>`__
- `mikosoft83 (@mikosoft83) <https://github.com/mikosoft83>`__
- `Minideezel (@minideezel) <https://github.com/minideezel>`__
- `mipa87 (@mipa87) <https://github.com/mipa87>`__
@ -367,6 +376,7 @@ Contributors
- `mnaz (@mnaz) <https://github.com/mnaz>`__
- `Michael Nieß (@mniess) <https://github.com/mniess>`__
- `Matt N. (@mnoorenberghe) <https://github.com/mnoorenberghe>`__
- `monkeyclass (@monkeyclass) <https://github.com/monkeyclass>`__
- `Moritz Glöckl (@moritzgloeckl) <https://github.com/moritzgloeckl>`__
- `Matthew Pettitt (@mpettitt) <https://github.com/mpettitt>`__
- `Ryan Matthews (@mrrsm) <https://github.com/mrrsm>`__
@ -374,6 +384,7 @@ Contributors
- `mtl010957 (@mtl010957) <https://github.com/mtl010957>`__
- `Murilo (@murilobaliego) <https://github.com/murilobaliego>`__
- `Michiel van Turnhout (@mvturnho) <https://github.com/mvturnho>`__
- `Martin Weinelt (@mweinelt) <https://github.com/mweinelt>`__
- `Mynasru (@Mynasru) <https://github.com/Mynasru>`__
- `Niels Ulrik Andersen (@myplacedk) <https://github.com/myplacedk>`__
- `Kevin Uhlir (@n0bel) <https://github.com/n0bel>`__
@ -414,6 +425,7 @@ Contributors
- `Paul Deen (@PaulAntonDeen) <https://github.com/PaulAntonDeen>`__
- `Paul Nicholls (@pauln) <https://github.com/pauln>`__
- `Bartłomiej Biernacki (@pax0r) <https://github.com/pax0r>`__
- `Paul Doidge (@pdoidge) <https://github.com/pdoidge>`__
- `peq123 (@peq123) <https://github.com/peq123>`__
- `per1234 (@per1234) <https://github.com/per1234>`__
- `perjury (@perjury) <https://github.com/perjury>`__
@ -433,6 +445,7 @@ Contributors
- `Peter Tatrai (@ptatrai) <https://github.com/ptatrai>`__
- `Leandro Puerari (@puerari) <https://github.com/puerari>`__
- `puuu (@puuu) <https://github.com/puuu>`__
- `Karol Zlot (@qqgg231) <https://github.com/qqgg231>`__
- `Tommy Jonsson (@quazzie) <https://github.com/quazzie>`__
- `Quinn Hosler (@quinnhosler) <https://github.com/quinnhosler>`__
- `r-jordan (@r-jordan) <https://github.com/r-jordan>`__
@ -493,6 +506,7 @@ Contributors
- `Stephen Tierney (@sjtrny) <https://github.com/sjtrny>`__
- `Niklas Wagner (@Skaronator) <https://github.com/Skaronator>`__
- `Luca Zimmermann (@soundstorm) <https://github.com/soundstorm>`__
- `Sourabh Jaiswal (@sourabhjaiswal) <https://github.com/sourabhjaiswal>`__
- `Philip Allgaier (@spacegaier) <https://github.com/spacegaier>`__
- `spattinson (@spattinson) <https://github.com/spattinson>`__
- `spilin (@spilin) <https://github.com/spilin>`__
@ -501,6 +515,7 @@ Contributors
- `sredfern (@sredfern) <https://github.com/sredfern>`__
- `srg74 (@srg74) <https://github.com/srg74>`__
- `Samuel Sieb (@ssieb) <https://github.com/ssieb>`__
- `St4n (@St4n) <https://github.com/St4n>`__
- `starwolf73 (@starwolf73) <https://github.com/starwolf73>`__
- `Steve Baxter (@stevebaxter) <https://github.com/stevebaxter>`__
- `stubs12 (@stubs12) <https://github.com/stubs12>`__
@ -592,4 +607,4 @@ Contributors
- `San (@zhujunsan) <https://github.com/zhujunsan>`__
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
*This page was last updated June 24, 2021.*
*This page was last updated July 15, 2021.*

BIN
images/anova.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.0 KiB

BIN
images/havellsgti5000d_s.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

10
index.rst
View File

@ -169,6 +169,7 @@ Sensor Components
Duty Cycle, components/sensor/duty_cycle, percent.svg
ESP32 Hall Sensor, components/sensor/esp32_hall, magnet.svg
EZO sensor circuits, components/sensor/ezo, ezo-ph-circuit.png
Havells Inverter, components/sensor/havells_inverter, havellsgti5000d_s.jpg
HDC1080, components/sensor/hdc1080, hdc1080.jpg
HLW8012, components/sensor/hlw8012, hlw8012.svg
HMC5883L, components/sensor/hmc5883l, hmc5883l.jpg
@ -398,6 +399,15 @@ Climate Components
IR Remote Climate, components/climate/ir_climate, air-conditioner-ir.svg
Tuya Climate, components/climate/tuya, tuya.png
Midea Air Conditioner, components/climate/midea_ac, midea.svg
Anova Cooker, components/climate/anova, anova.png
Number Components
-----------------
.. imgtable::
Number Core, components/number/index, folder-open.svg
Template Number, components/number/template, description.svg
Misc Components
---------------