mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-09-27 04:13:07 +02:00
Merge branch 'current' into next
This commit is contained in:
commit
39f7eec5d6
2
Makefile
2
Makefile
@ -1,5 +1,5 @@
|
|||||||
ESPHOME_PATH = ../esphome
|
ESPHOME_PATH = ../esphome
|
||||||
ESPHOME_REF = 2021.8.0
|
ESPHOME_REF = dev
|
||||||
|
|
||||||
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png
|
.PHONY: html html-strict cleanhtml deploy help webserver Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png
|
||||||
|
|
||||||
|
@ -98,6 +98,18 @@ need to downgrade the esphome version because a new version does not work the wa
|
|||||||
should be using the snapshot/backup feature built into Home Assistant Supervisor to rollback.
|
should be using the snapshot/backup feature built into Home Assistant Supervisor to rollback.
|
||||||
|
|
||||||
|
|
||||||
|
Release 2021.8.1 - August 24
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
- Fix pypi download url :esphomepr:`2177` by :ghuser:`jesserockz`
|
||||||
|
- Light: include ON_OFF capability to BRIGHTNESS ColorMode :esphomepr:`2186` by :ghuser:`puuu`
|
||||||
|
- Fix addressable light control without transitions & effects with transitions :esphomepr:`2187` by :ghuser:`oxan`
|
||||||
|
- mqtt_light: remove legacy API config that is not compatible with HA 2021.8 :esphomepr:`2183` by :ghuser:`puuu`
|
||||||
|
- Tuya fan component uses enum datapoint type for speed instead of integer :esphomepr:`2182` by :ghuser:`nuttytree`
|
||||||
|
- Fix template select lambda :esphomepr:`2198` by :ghuser:`ssieb`
|
||||||
|
- Send Celsius temperature unit in MQTT discovery message :esphomepr:`1840` by :ghuser:`mtl010957`
|
||||||
|
|
||||||
|
|
||||||
Full list of changes
|
Full list of changes
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
|
@ -78,7 +78,7 @@ Rendering Lambda
|
|||||||
With Nextion displays, a dedicated chip on the display itself does the whole rendering. ESPHome can only
|
With Nextion displays, a dedicated chip on the display itself does the whole rendering. ESPHome can only
|
||||||
send *instructions* to the display to tell it *how* to render something and *what* to render.
|
send *instructions* to the display to tell it *how* to render something and *what* to render.
|
||||||
|
|
||||||
First, you need to use the `Nextion Editor <https://nextion.itead.cc/resources/download/nextion-editor/>`__ to
|
First, you need to use the `Nextion Editor <https://nextion.tech/nextion-editor/>`__ to
|
||||||
create a display file and insert it using the SD card slot. Then, in the rendering ``lambda``, you can use the various API calls
|
create a display file and insert it using the SD card slot. Then, in the rendering ``lambda``, you can use the various API calls
|
||||||
to populate data on the display:
|
to populate data on the display:
|
||||||
|
|
||||||
|
@ -27,14 +27,14 @@ Configuration variables:
|
|||||||
- **name** (**Required**, string): This is the name of the node. It
|
- **name** (**Required**, string): This is the name of the node. It
|
||||||
should always be unique in your ESPHome network. May only contain lowercase
|
should always be unique in your ESPHome network. May only contain lowercase
|
||||||
characters, digits and hyphens. See :ref:`esphome-changing_node_name`.
|
characters, digits and hyphens. See :ref:`esphome-changing_node_name`.
|
||||||
- **platform** (**Required**, string): The platform your board is on,
|
- **platform** (**Required**, string): The platform your board is using,
|
||||||
either ``ESP32`` or ``ESP8266``. See :ref:`esphome-arduino_version`.
|
either ``ESP32`` or ``ESP8266``.
|
||||||
- **board** (**Required**, string): The board ESPHome should
|
- **board** (**Required**, string): The PlatformIO board ID that should
|
||||||
specify for PlatformIO. For the ESP32, choose the appropriate one
|
be used. Choose the appropriate board from
|
||||||
from `this list <http://docs.platformio.org/en/latest/platforms/espressif32.html#boards>`__
|
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif8266>` for the ESP8266, and
|
||||||
and use `this list <http://docs.platformio.org/en/latest/platforms/espressif8266.html#boards>`__
|
`this list <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif32`> for the ESP32 (the icon
|
||||||
for ESP8266-based boards. *This only affects pin aliases and some internal settings*, if unsure
|
next to the name can be used to copy the board ID). *This only affects pin aliases and some internal settings*,
|
||||||
choose the generic board option!
|
if unsure choose a generic board from Espressif.
|
||||||
|
|
||||||
Advanced options:
|
Advanced options:
|
||||||
|
|
||||||
@ -105,6 +105,8 @@ option you can tell ESPHome which Arduino framework to use for compiling.
|
|||||||
For the ESP8266, you currently can manually pin the Arduino version to these values (see the full
|
For the ESP8266, you currently can manually pin the Arduino version to these values (see the full
|
||||||
list of Arduino frameworks `here <https://github.com/esp8266/Arduino/releases>`__):
|
list of Arduino frameworks `here <https://github.com/esp8266/Arduino/releases>`__):
|
||||||
|
|
||||||
|
* `3.0.1 <https://github.com/esp8266/Arduino/releases/tag/3.0.1>`__ (not recommended yet)
|
||||||
|
* `3.0.0 <https://github.com/esp8266/Arduino/releases/tag/3.0.0>`__ (not recommended yet)
|
||||||
* `2.7.4 <https://github.com/esp8266/Arduino/releases/tag/2.7.4>`__ (default)
|
* `2.7.4 <https://github.com/esp8266/Arduino/releases/tag/2.7.4>`__ (default)
|
||||||
* `2.7.3 <https://github.com/esp8266/Arduino/releases/tag/2.7.3>`__
|
* `2.7.3 <https://github.com/esp8266/Arduino/releases/tag/2.7.3>`__
|
||||||
* `2.7.2 <https://github.com/esp8266/Arduino/releases/tag/2.7.2>`__
|
* `2.7.2 <https://github.com/esp8266/Arduino/releases/tag/2.7.2>`__
|
||||||
|
@ -4,10 +4,11 @@ Generic ESP32
|
|||||||
.. seo::
|
.. seo::
|
||||||
:description: Information about how to use generic ESP32 boards in ESPHome.
|
:description: Information about how to use generic ESP32 boards in ESPHome.
|
||||||
:image: esp32.png
|
:image: esp32.png
|
||||||
|
:keywords: ESP32
|
||||||
|
|
||||||
All ESP32-based devices are supported by ESPHome. Simply select ``ESP32`` when
|
All devices based on the original ESP32 are supported by ESPHome. Simply select ``ESP32`` when
|
||||||
the ESPHome wizard asks you for your platform and choose a board type
|
the ESPHome wizard asks you for your platform and choose a board type
|
||||||
from `this link <http://docs.platformio.org/en/latest/platforms/espressif32.html>`__ when the wizard
|
from `this link <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif32>`__ when the wizard
|
||||||
asks you for the board type.
|
asks you for the board type.
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
@ -18,6 +19,10 @@ asks you for the board type.
|
|||||||
platform: ESP32
|
platform: ESP32
|
||||||
board: <BOARD_TYPE>
|
board: <BOARD_TYPE>
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Support for the ESP32-S2 and ESP32-C3 is currently in development.
|
||||||
|
|
||||||
The ESP32 boards often use the internal GPIO pin numbering on the board, this means that
|
The ESP32 boards often use the internal GPIO pin numbering on the board, this means that
|
||||||
you don't have to worry about other kinds of pin numberings, yay!
|
you don't have to worry about other kinds of pin numberings, yay!
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@ Generic ESP8266
|
|||||||
|
|
||||||
All ESP8266-based devices are supported by ESPHome. Simply select ``ESP8266`` when
|
All ESP8266-based devices are supported by ESPHome. Simply select ``ESP8266`` when
|
||||||
the ESPHome wizard asks you for your platform and choose a board type
|
the ESPHome wizard asks you for your platform and choose a board type
|
||||||
from `this link <http://docs.platformio.org/en/latest/platforms/espressif8266.html>`__ when the wizard
|
from `this link <https://platformio.org/boards?count=1000&filter%5Bplatform%5D=espressif8266>`__ when the wizard
|
||||||
asks you for the board type.
|
asks you for the board type.
|
||||||
|
|
||||||
|
|
||||||
|
@ -43,10 +43,11 @@ In general, it is best to just use the ``D0``, ``D1``, ... pin numbering to avoi
|
|||||||
Note that in certain conditions you *can* use the pins marked as ``INTERNAL`` in above image.
|
Note that in certain conditions you *can* use the pins marked as ``INTERNAL`` in above image.
|
||||||
|
|
||||||
- ``D0`` also can be used to wake the device up from :doc:`deep sleep </components/deep_sleep>` if
|
- ``D0`` also can be used to wake the device up from :doc:`deep sleep </components/deep_sleep>` if
|
||||||
the pin is connected to the ``RESET`` pin. ``D0`` is additionally connected to the LED
|
the pin is connected to the ``RESET`` pin. On some boards ``D0`` is additionally connected to the LED
|
||||||
next to the UART chip, but in an inverted mode.
|
next to the UART chip, but in an inverted mode.
|
||||||
- ``D3``, ``D4`` and ``D8`` are used on startup to determine the boot mode, therefore these pins should
|
- ``D3``, ``D4`` and ``D8`` are used on startup to determine the boot mode, therefore these pins should
|
||||||
not be pulled low on startup. You can, however, still use them as output pins.
|
not be pulled low on startup. You can, however, still use them as output pins.
|
||||||
|
- ``D4`` additionally is connected to the blue LED next to the antenna, but in an inverted mode.
|
||||||
- ``A0``: This pin can be used as a normal GPIO pin (like ``D1`` etc) but additionally can measure
|
- ``A0``: This pin can be used as a normal GPIO pin (like ``D1`` etc) but additionally can measure
|
||||||
voltages from 0 to 1.0V using the :doc:`/components/sensor/adc`.
|
voltages from 0 to 1.0V using the :doc:`/components/sensor/adc`.
|
||||||
- ``VIN``: This board can be powered by an external power supply by using this pin. Supply a voltage depends on the board you use. Some boards support up to 12V, some up to 5V.
|
- ``VIN``: This board can be powered by an external power supply by using this pin. Supply a voltage depends on the board you use. Some boards support up to 12V, some up to 5V.
|
||||||
|
@ -15,10 +15,6 @@ and shipping from China takes a long time, I've only set up dedicated guides for
|
|||||||
name: <NAME_OF_NODE>
|
name: <NAME_OF_NODE>
|
||||||
platform: ESP8266
|
platform: ESP8266
|
||||||
board: esp8285
|
board: esp8285
|
||||||
arduino_version: 2.4.2
|
|
||||||
|
|
||||||
The selected board and arduino_version are required in v1.14.3 (and probably later), see
|
|
||||||
https://github.com/esphome/issues/issues/931 for details.
|
|
||||||
|
|
||||||
After that use the following list of pin to function mappings to set up your Sonoff device.
|
After that use the following list of pin to function mappings to set up your Sonoff device.
|
||||||
This list has been compiled from the Sonoff Tasmota pin source file which can be found here:
|
This list has been compiled from the Sonoff Tasmota pin source file which can be found here:
|
||||||
|
@ -55,7 +55,6 @@ exposes all of the basic functions.
|
|||||||
name: <NAME_OF_NODE>
|
name: <NAME_OF_NODE>
|
||||||
platform: ESP8266
|
platform: ESP8266
|
||||||
board: esp8285
|
board: esp8285
|
||||||
arduino_version: 2.4.2
|
|
||||||
|
|
||||||
wifi:
|
wifi:
|
||||||
ssid: <YOUR_SSID>
|
ssid: <YOUR_SSID>
|
||||||
|
@ -48,6 +48,7 @@ Blog Posts & Videos
|
|||||||
- `Baseboard (Line Voltage) Thermostat from Smart Switch <https://github.com/rjmurph2241/baseboard-heating-thermostat>`__ by :ghuser:`rjmurph2241`
|
- `Baseboard (Line Voltage) Thermostat from Smart Switch <https://github.com/rjmurph2241/baseboard-heating-thermostat>`__ by :ghuser:`rjmurph2241`
|
||||||
- `Office Doorbell <https://github.com/shish/esphome-projects/blob/master/office-doorbell.md>`__ by :ghuser:`shish`
|
- `Office Doorbell <https://github.com/shish/esphome-projects/blob/master/office-doorbell.md>`__ by :ghuser:`shish`
|
||||||
- `Display TM1637 with ESPHome and MQTT showing Youtube subscribers count and other info <https://youtu.be/27JZEky0h1Q>`__ by :ghuser:`electrofun-smart`
|
- `Display TM1637 with ESPHome and MQTT showing Youtube subscribers count and other info <https://youtu.be/27JZEky0h1Q>`__ by :ghuser:`electrofun-smart`
|
||||||
|
- `Automate your garage door with ESP8266 lysignal Yunshan 7v-30v <https://www.haade.fr/en/blog/home-automation-smarthome-jeedom-homeassistant/tutos-haade-lab/domotiser-sa-porte-de-garage-pour-5e/>`__ by :ghuser:`haade-administrator`
|
||||||
|
|
||||||
Custom Components & Code
|
Custom Components & Code
|
||||||
------------------------
|
------------------------
|
||||||
|
@ -82,6 +82,7 @@ Contributors
|
|||||||
- `Viktr (@BbIKTOP) <https://github.com/BbIKTOP>`__
|
- `Viktr (@BbIKTOP) <https://github.com/BbIKTOP>`__
|
||||||
- `J. Nick Koston (@bdraco) <https://github.com/bdraco>`__
|
- `J. Nick Koston (@bdraco) <https://github.com/bdraco>`__
|
||||||
- `Ben Suffolk (@bensuffolk) <https://github.com/bensuffolk>`__
|
- `Ben Suffolk (@bensuffolk) <https://github.com/bensuffolk>`__
|
||||||
|
- `Ivan Bessarabov (@bessarabov) <https://github.com/bessarabov>`__
|
||||||
- `Bierchermuesli (@Bierchermuesli) <https://github.com/Bierchermuesli>`__
|
- `Bierchermuesli (@Bierchermuesli) <https://github.com/Bierchermuesli>`__
|
||||||
- `JDavid (@blackhack) <https://github.com/blackhack>`__
|
- `JDavid (@blackhack) <https://github.com/blackhack>`__
|
||||||
- `Branimir Lambov (@blambov) <https://github.com/blambov>`__
|
- `Branimir Lambov (@blambov) <https://github.com/blambov>`__
|
||||||
@ -479,6 +480,7 @@ Contributors
|
|||||||
- `Derrick Lyndon Pallas (@pallas) <https://github.com/pallas>`__
|
- `Derrick Lyndon Pallas (@pallas) <https://github.com/pallas>`__
|
||||||
- `Panuruj Khambanonda (PK) (@panuruj) <https://github.com/panuruj>`__
|
- `Panuruj Khambanonda (PK) (@panuruj) <https://github.com/panuruj>`__
|
||||||
- `Pasi Suominen (@pasiz) <https://github.com/pasiz>`__
|
- `Pasi Suominen (@pasiz) <https://github.com/pasiz>`__
|
||||||
|
- `Patrick Felstead (@patfelst) <https://github.com/patfelst>`__
|
||||||
- `Paul Deen (@PaulAntonDeen) <https://github.com/PaulAntonDeen>`__
|
- `Paul Deen (@PaulAntonDeen) <https://github.com/PaulAntonDeen>`__
|
||||||
- `Paul Monigatti (@paulmonigatti) <https://github.com/paulmonigatti>`__
|
- `Paul Monigatti (@paulmonigatti) <https://github.com/paulmonigatti>`__
|
||||||
- `Paul Nicholls (@pauln) <https://github.com/pauln>`__
|
- `Paul Nicholls (@pauln) <https://github.com/pauln>`__
|
||||||
@ -685,4 +687,4 @@ Contributors
|
|||||||
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
- `ZTX18 (@ZTX18) <https://github.com/ZTX18>`__
|
||||||
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
|
||||||
|
|
||||||
*This page was last updated August 18, 2021.*
|
*This page was last updated August 24, 2021.*
|
||||||
|
@ -175,7 +175,7 @@ Air Quality
|
|||||||
SGP40, components/sensor/sgp40, sgp40.jpg, Volatile organics
|
SGP40, components/sensor/sgp40, sgp40.jpg, Volatile organics
|
||||||
SM300D2, components/sensor/sm300d2, sm300d2.jpg, Air quality
|
SM300D2, components/sensor/sm300d2, sm300d2.jpg, Air quality
|
||||||
SPS30, components/sensor/sps30, sps30.jpg, Particulate
|
SPS30, components/sensor/sps30, sps30.jpg, Particulate
|
||||||
T6613/15, components/sensor/t6615, t6615.png, C02
|
T6613/15, components/sensor/t6615, t6615.png, CO2
|
||||||
ZyAura, components/sensor/zyaura, zgm053.jpg, CO2 & Temperature & Humidity
|
ZyAura, components/sensor/zyaura, zgm053.jpg, CO2 & Temperature & Humidity
|
||||||
|
|
||||||
|
|
||||||
@ -497,7 +497,6 @@ Text Sensor Components
|
|||||||
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg
|
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg
|
||||||
Template Text Sensor, components/text_sensor/template, description.svg
|
Template Text Sensor, components/text_sensor/template, description.svg
|
||||||
Custom Text Sensor, components/text_sensor/custom, language-cpp.svg
|
Custom Text Sensor, components/text_sensor/custom, language-cpp.svg
|
||||||
Custom UART Text Sensor, components/text_sensor/uart, language-cpp.svg
|
|
||||||
Nextion Text Sensor, components/text_sensor/nextion, nextion.jpg
|
Nextion Text Sensor, components/text_sensor/nextion, nextion.jpg
|
||||||
|
|
||||||
Climate Components
|
Climate Components
|
||||||
|
Loading…
Reference in New Issue
Block a user