Merge branch 'current' into next
BIN
_static/made-for-esphome-black-on-transparent.png
Normal file
After Width: | Height: | Size: 19 KiB |
1
_static/made-for-esphome-black-on-transparent.svg
Normal file
After Width: | Height: | Size: 6.8 KiB |
BIN
_static/made-for-esphome-black-on-white.png
Normal file
After Width: | Height: | Size: 17 KiB |
1
_static/made-for-esphome-black-on-white.svg
Normal file
After Width: | Height: | Size: 7.1 KiB |
BIN
_static/made-for-esphome-white-on-black.png
Normal file
After Width: | Height: | Size: 17 KiB |
1
_static/made-for-esphome-white-on-black.svg
Normal file
After Width: | Height: | Size: 7.1 KiB |
BIN
_static/made-for-esphome-white-on-transparent.png
Normal file
After Width: | Height: | Size: 18 KiB |
1
_static/made-for-esphome-white-on-transparent.svg
Normal file
After Width: | Height: | Size: 6.8 KiB |
@ -109,6 +109,10 @@ Release 2021.8.1 - August 24
|
||||
- Fix template select lambda :esphomepr:`2198` by :ghuser:`ssieb`
|
||||
- Send Celsius temperature unit in MQTT discovery message :esphomepr:`1840` by :ghuser:`mtl010957`
|
||||
|
||||
Release 2021.8.2 - August 25
|
||||
----------------------------
|
||||
|
||||
- Revert "Light: include ON_OFF capability to BRIGHTNESS ColorMode" :esphomepr:`2202` by :ghuser:`jesserockz`
|
||||
|
||||
Full list of changes
|
||||
--------------------
|
||||
|
@ -108,7 +108,7 @@ Configuration variables:
|
||||
all other models.
|
||||
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
|
||||
See :ref:`display-engine` for more information.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``10s``, use ``never`` to only manually update the screen via ``component.update``.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``1s``, use ``never`` to only manually update the screen via ``component.update``.
|
||||
- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
|
||||
- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component <spi>` if you want
|
||||
to use multiple SPI buses.
|
||||
|
@ -31,8 +31,8 @@ Configuration variables:
|
||||
either ``ESP32`` or ``ESP8266``.
|
||||
- **board** (**Required**, string): The PlatformIO board ID that should
|
||||
be used. Choose the appropriate board from
|
||||
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif8266>` for the ESP8266, and
|
||||
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif32`> for the ESP32 (the icon
|
||||
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif8266>`__ for the ESP8266, and
|
||||
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif32>`__ for the ESP32 (the icon
|
||||
next to the name can be used to copy the board ID). *This only affects pin aliases and some internal settings*,
|
||||
if unsure choose a generic board from Espressif.
|
||||
|
||||
|
@ -1,19 +1,19 @@
|
||||
Status Led Light
|
||||
Status LED Light
|
||||
================
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up a Status Led shared also as binary ON/OFF light in ESPHome.
|
||||
:description: Instructions for setting up a Status LED shared also as binary ON/OFF light in ESPHome.
|
||||
:image: led-on.png
|
||||
|
||||
The ``status_led`` light platform allows to share a single led for indicating the status of
|
||||
The ``status_led`` light platform allows to share a single LED for indicating the status of
|
||||
the device (when on error/warning state) or as binary light (when on OK state).
|
||||
This is useful for devices with only one led available.
|
||||
This is useful for devices with only one LED available.
|
||||
|
||||
It provides the combined functionality of :doc:`status_led component </components/status_led>` and a
|
||||
:doc:`binary light component </components/light/binary>` over a single shared GPIO led.
|
||||
|
||||
When the device is on error/warning state, the function of ``status_led`` will take precedence and control the blinking of the led.
|
||||
When the device is in OK state, the led will be restored to the state of the ``binary light`` function and can be controlled as such.
|
||||
When the device is on error/warning state, the function of ``status_led`` will take precedence and control the blinking of the LED.
|
||||
When the device is in OK state, the LED will be restored to the state of the ``binary light`` function and can be controlled as such.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
|
@ -14,7 +14,7 @@ using :ref:`lambdas <config-lambda>`.
|
||||
number:
|
||||
- platform: template
|
||||
name: "Template number"
|
||||
update_interval: never
|
||||
optimistic: true
|
||||
min_value: 0
|
||||
max_value: 100
|
||||
step: 1
|
||||
@ -27,12 +27,12 @@ Configuration variables:
|
||||
- **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.
|
||||
Lambda to be evaluated every update interval to get the current 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. The new value is available to lambdas in the ``x`` variable.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||
number. Defaults to ``60s``.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval on which to update the number
|
||||
by executing the ``lambda``. 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.
|
||||
Cannot be used with ``lambda``. Defaults to ``false``.
|
||||
@ -45,9 +45,9 @@ Configuration variables:
|
||||
- All other options from :ref:`Number <config-number>`.
|
||||
|
||||
``number.set`` Action
|
||||
----------------------------------
|
||||
---------------------
|
||||
|
||||
You can also publish a state to a template number from elsewhere in your YAML file
|
||||
You can also set the number for the template number from elsewhere in your YAML file
|
||||
with the :ref:`number-set_action`.
|
||||
|
||||
See Also
|
||||
|
@ -60,46 +60,46 @@ Configuration variables:
|
||||
Automations:
|
||||
|
||||
- **on_jvc** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
JVC remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::JVCData`
|
||||
JVC remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::JVCData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_lg** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
LG remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::LGData`
|
||||
LG remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::LGData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_midea** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
Midea remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::MideaData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_nec** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
NEC remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::NECData`
|
||||
NEC remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::NECData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_sony** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
Sony remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::SonyData`
|
||||
Sony remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::SonyData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_toshiba_ac** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
Toshiba AC remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::ToshibaAcData`
|
||||
Toshiba AC remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::ToshibaAcData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_raw** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
raw remote code has been decoded. A variable ``x`` of type ``std::vector<int>``
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_rc5** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
RC5 remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::RC5Data`
|
||||
RC5 remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::RC5Data`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_rc_switch** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
RCSwitch RF code has been decoded. A variable ``x`` of type :apiclass:`remote_base::RCSwitchData`
|
||||
RCSwitch RF code has been decoded. A variable ``x`` of type :apistruct:`remote_base::RCSwitchData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_samsung** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
Samsung remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::SamsungData`
|
||||
Samsung remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::SamsungData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_samsung36** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
Samsung36 remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::Samsung36Data`
|
||||
is passed to the automation for use in lambdas.
|
||||
Samsung36 remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::Samsung36Data`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_panasonic** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
Panasonic remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::PanasonicData`
|
||||
Panasonic remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::PanasonicData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_pioneer** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
pioneer remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::PioneerData`
|
||||
pioneer remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::PioneerData`
|
||||
is passed to the automation for use in lambdas.
|
||||
- **on_dish** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a
|
||||
dish network remote code has been decoded. A variable ``x`` of type :apiclass:`remote_base::DishData`
|
||||
dish network remote code has been decoded. A variable ``x`` of type :apistruct:`remote_base::DishData`
|
||||
is passed to the automation for use in lambdas.
|
||||
Beware that Dish remotes use a different carrier frequency (57.6kHz) that many receiver hardware don't decode.
|
||||
|
||||
@ -197,8 +197,8 @@ Remote code selection (exactly one of these has to be included):
|
||||
- **dish**: Trigger on a decoded Dish Network remote code with the given data.
|
||||
Beware that Dish remotes use a different carrier frequency (57.6kHz) that many receiver hardware don't decode.
|
||||
|
||||
- **address** (*Optional*, int, 1-16): The number of the receiver to target. Defaults to ``1``.
|
||||
- **command** (**Required**, int, 0-63): The Dish command to listen for.
|
||||
- **address** (*Optional*, int, 1-16): The number of the receiver to target. Defaults to ``1``.
|
||||
- **command** (**Required**, int, 0-63): The Dish command to listen for.
|
||||
|
||||
- **rc_switch_raw**: Trigger on a decoded RC Switch raw remote code with the given data.
|
||||
|
||||
|
@ -2,10 +2,10 @@ Template Select
|
||||
===============
|
||||
|
||||
.. seo::
|
||||
:description: Instructions for setting up template selects with ESPHome.
|
||||
:description: Instructions for setting up Template Select(s) with ESPHome.
|
||||
:image: description.png
|
||||
|
||||
The ``template`` select platform allows you to create a select with templated values
|
||||
The ``template`` Select platform allows you to create a Select with templated values
|
||||
using :ref:`lambdas <config-lambda>`.
|
||||
|
||||
.. code-block:: yaml
|
||||
@ -14,7 +14,7 @@ using :ref:`lambdas <config-lambda>`.
|
||||
select:
|
||||
- platform: template
|
||||
name: "Template select"
|
||||
update_interval: never
|
||||
optimistic: true
|
||||
options:
|
||||
- one
|
||||
- two
|
||||
@ -25,16 +25,17 @@ using :ref:`lambdas <config-lambda>`.
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
||||
- **name** (**Required**, string): The name of the select.
|
||||
- **options** (**Required**, list): The list of options this select has.
|
||||
- **name** (**Required**, string): The name of the Select.
|
||||
- **options** (**Required**, list): The list of options this Select has.
|
||||
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
|
||||
Lambda to be evaluated every update interval to get the new option of the select.
|
||||
Lambda to be evaluated every update interval to get the current option of the select.
|
||||
- **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 select option.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
|
||||
select ``lambda``. Defaults to ``60s``.
|
||||
be performed when the remote (like Home Assistant's frontend) requests to set the Select option.
|
||||
The new option is available to lambdas in the ``x`` variable.
|
||||
- **update_interval** (*Optional*, :ref:`config-time`): The interval on which to update the select
|
||||
by executing the ``lambda``. Defaults to ``60s``.
|
||||
- **optimistic** (*Optional*, boolean): Whether to operate in optimistic mode - when in this mode,
|
||||
any command sent to the template select will immediately update the reported state.
|
||||
any command sent to the Template Select will immediately update the reported state.
|
||||
Cannot be used with ``lambda``. Defaults to ``false``.
|
||||
- **restore_value** (*Optional*, boolean): Saves and loads the state to RTC/Flash.
|
||||
Cannot be used with ``lambda``. Defaults to ``false``.
|
||||
@ -45,9 +46,9 @@ Configuration variables:
|
||||
- All other options from :ref:`Select <config-select>`.
|
||||
|
||||
``select.set`` Action
|
||||
----------------------------------
|
||||
---------------------
|
||||
|
||||
You can also set an option to a template select from elsewhere in your YAML file
|
||||
You can also set an option for the template select from elsewhere in your YAML file
|
||||
with the :ref:`select-set_action`.
|
||||
|
||||
See Also
|
||||
|
@ -7,7 +7,7 @@ ADE7953 Power Sensor
|
||||
|
||||
.. note::
|
||||
|
||||
This page is incomplete and could some work. If you want to contribute, please read the
|
||||
This page is incomplete and could use some work. If you want to contribute, please read the
|
||||
:doc:`contributing guide </guides/contributing>`. This page is missing:
|
||||
|
||||
- A complete configuration example for the Shelly 2.5
|
||||
|
@ -8,7 +8,7 @@ Peacefair PZEM-004T Energy Monitor
|
||||
|
||||
.. note::
|
||||
|
||||
This page is incomplete and could some work. If you want to contribute, please read the
|
||||
This page is incomplete and could use some work. If you want to contribute, please read the
|
||||
:doc:`contributing guide </guides/contributing>`. This page is missing:
|
||||
|
||||
- An image for the front page.
|
||||
|
@ -8,7 +8,7 @@ Peacefair PZEM-004T V3 Energy Monitor
|
||||
|
||||
.. note::
|
||||
|
||||
This page is incomplete and could some work. If you want to contribute, please read the
|
||||
This page is incomplete and could use some work. If you want to contribute, please read the
|
||||
:doc:`contributing guide </guides/contributing>`. This page is missing:
|
||||
|
||||
- Images/screenshots/example configs of this device being used in action.
|
||||
|
@ -7,7 +7,7 @@ Peacefair PZEM-00X DC Energy Monitor
|
||||
|
||||
.. note::
|
||||
|
||||
This page is incomplete and could some work. If you want to contribute, please read the
|
||||
This page is incomplete and could use some work. If you want to contribute, please read the
|
||||
:doc:`contributing guide </guides/contributing>`. This page is missing:
|
||||
|
||||
- Images/screenshots/example configs of this device being used in action.
|
||||
|
@ -23,7 +23,7 @@ the device. Specifically, it will:
|
||||
|
||||
.. note::
|
||||
|
||||
If your device has a single led that needs to be shared use :doc:`status_led light platform </components/light/status_led>` instead.
|
||||
If your device has a single LED that needs to be shared use :doc:`status_led light platform </components/light/status_led>` instead.
|
||||
|
||||
Configuration variables:
|
||||
------------------------
|
||||
|
64
guides/made_for_esphome.rst
Normal file
@ -0,0 +1,64 @@
|
||||
.. _made_for_esphome:
|
||||
|
||||
Made for ESPHome
|
||||
================
|
||||
|
||||
.. seo::
|
||||
:description: Information about the Made for ESPHome program
|
||||
:image: /_static/made-for-esphome-black-on-white.png
|
||||
|
||||
ESPHome has a great and active community that loves creating and sharing projects.
|
||||
You can apply for your project to get the Made for ESPHome stamp of approval.
|
||||
This ensures that your project is powered by ESPHome and guarantees a
|
||||
minimum level of customizability to users.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
Your product has to match the following requirements:
|
||||
- Your project is powered by ESPHome
|
||||
- Your ESPHome configuration is open source
|
||||
- Users should be able to apply updates if your project sells ready-made devices
|
||||
- Your product name cannot contain **ESPHome** except in the case of *ending with* **for ESPHome**
|
||||
|
||||
When your project matches all requirements of the Made for ESPHome program,
|
||||
you can apply for permission to carry the logo by emailing esphome@nabucasa.com
|
||||
|
||||
Logos
|
||||
-----
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<style>
|
||||
.transparent-background img {
|
||||
background: repeating-conic-gradient(#999 0% 25%, transparent 10% 50%) 50% / 10px 10px;
|
||||
}
|
||||
</style>
|
||||
|
||||
.. figure:: /_static/made-for-esphome-black-on-white.svg
|
||||
:align: center
|
||||
:width: 100%
|
||||
:class: transparent-background
|
||||
|
||||
Made with ESPHome black on white (`svg </_static/made-for-esphome-black-on-white.svg>`__, `png </_static/made-for-esphome-black-on-white.png>`__)
|
||||
|
||||
.. figure:: /_static/made-for-esphome-white-on-black.svg
|
||||
:align: center
|
||||
:width: 100%
|
||||
:class: transparent-background
|
||||
|
||||
Made with ESPHome white on black (`svg </_static/made-for-esphome-white-on-black.svg>`__, `png </_static/made-for-esphome-white-on-black.png>`__)
|
||||
|
||||
.. figure:: /_static/made-for-esphome-black-on-transparent.svg
|
||||
:align: center
|
||||
:width: 100%
|
||||
:class: transparent-background
|
||||
|
||||
Made with ESPHome black on transparent (`svg </_static/made-for-esphome-black-on-transparent.svg>`__, `png </_static/made-for-esphome-black-on-transparent.png>`__)
|
||||
|
||||
.. figure:: /_static/made-for-esphome-white-on-transparent.svg
|
||||
:align: center
|
||||
:width: 100%
|
||||
:class: transparent-background
|
||||
|
||||
Made with ESPHome white on transparent (`svg </_static/made-for-esphome-white-on-transparent.svg>`__, `png </_static/made-for-esphome-white-on-transparent.png>`__)
|
@ -557,6 +557,7 @@ Contributors
|
||||
- `Sascha (@Scarbous) <https://github.com/Scarbous>`__
|
||||
- `Nils Schulte (@Schnilz) <https://github.com/Schnilz>`__
|
||||
- `Ville Skyttä (@scop) <https://github.com/scop>`__
|
||||
- `Seganku (@seganku) <https://github.com/seganku>`__
|
||||
- `sekkr1 (@sekkr1) <https://github.com/sekkr1>`__
|
||||
- `SenexCrenshaw (@SenexCrenshaw) <https://github.com/SenexCrenshaw>`__
|
||||
- `Sergio (@sergio303) <https://github.com/sergio303>`__
|
||||
@ -578,6 +579,7 @@ Contributors
|
||||
- `Sourabh Jaiswal (@sourabhjaiswal) <https://github.com/sourabhjaiswal>`__
|
||||
- `Philip Allgaier (@spacegaier) <https://github.com/spacegaier>`__
|
||||
- `spattinson (@spattinson) <https://github.com/spattinson>`__
|
||||
- `Stephan Peijnik-Steinwender (@speijnik) <https://github.com/speijnik>`__
|
||||
- `spilin (@spilin) <https://github.com/spilin>`__
|
||||
- `square99 (@square99) <https://github.com/square99>`__
|
||||
- `Paul Krischer (@SqyD) <https://github.com/SqyD>`__
|
||||
@ -687,4 +689,4 @@ Contributors
|
||||
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||
|
||||
*This page was last updated August 24, 2021.*
|
||||
*This page was last updated August 25, 2021.*
|
||||
|