Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-04-18 20:46:33 +02:00
Code Issues Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Jesse Hills 2024-03-13 16:33:13 +13:00
commit 244ed32046
No known key found for this signature in database
GPG Key ID: BEAAE804EFD8E83A
7 changed files with 63 additions and 16 deletions

8
changelog/2024.2.0.rst
View File

@ -66,6 +66,14 @@ Release 2024.2.1 - February 26
- fix throttle average nan handling :esphomepr:`6275` by :ghuser:`ssieb`
- Fix thermostat supplemental actions :esphomepr:`6282` by :ghuser:`kbx81`
Release 2024.2.2 - March 6
--------------------------
- CSE7766: Fix energy calculation :esphomepr:`6286` by :ghuser:`puuu`
- handling with the negative temperature in the sensor tmp102 :esphomepr:`6316` by :ghuser:`FlyingFeng2021`
- fix tmp102 negative calculation :esphomepr:`6320` by :ghuser:`ssieb`
- auto load output for now :esphomepr:`6309` by :ghuser:`ssieb`
- Add wake word phrase to voice assistant start command :esphomepr:`6290` by :ghuser:`jesserockz`
Full list of changes
--------------------

28
components/deep_sleep.rst
View File

@ -87,6 +87,34 @@ when the deep sleep should start? There are three ways of handling this using th
then re-configure deep sleep to wake up on a LOW signal and vice versa. Useful in situations when you want to
use observe the state changes of a pin using deep sleep and the ON/OFF values last longer.
ESP32 Wakeup Cause
------------------
On the ESP32, the ``esp_sleep_get_wakeup_cause()`` function can be used to check which wakeup source has triggered
wakeup from sleep mode.
.. code-block:: yaml
sensor:
- platform: template
name: "Wakeup Cause"
accuracy_decimals: 0
lambda: return esp_sleep_get_wakeup_cause();
The following integers are the wakeup causes:
- **0** - ``ESP_SLEEP_WAKEUP_UNDEFINED``: In case of deep sleep, reset was not caused by exit from deep sleep
- **1** - ``ESP_SLEEP_WAKEUP_ALL``: Not a wakeup cause, used to disable all wakeup sources with esp_sleep_disable_wakeup_source
- **2** - ``ESP_SLEEP_WAKEUP_EXT0``: Wakeup caused by external signal using RTC_IO
- **3** - ``ESP_SLEEP_WAKEUP_EXT1``: Wakeup caused by external signal using RTC_CNTL
- **4** - ``ESP_SLEEP_WAKEUP_TIMER``: Wakeup caused by timer
- **5** - ``ESP_SLEEP_WAKEUP_TOUCHPAD``: Wakeup caused by touchpad
- **6** - ``ESP_SLEEP_WAKEUP_ULP``: Wakeup caused by ULP program
- **7** - ``ESP_SLEEP_WAKEUP_GPIO``: Wakeup caused by GPIO (light sleep only on ESP32, S2 and S3)
- **8** - ``ESP_SLEEP_WAKEUP_UART``: Wakeup caused by UART (light sleep only)
- **9** - ``ESP_SLEEP_WAKEUP_WIFI``: Wakeup caused by WIFI (light sleep only)
- **10** - ``ESP_SLEEP_WAKEUP_COCPU``: Wakeup caused by COCPU int
- **11** - ``ESP_SLEEP_WAKEUP_COCPU_TRAP_TRIG``: Wakeup caused by COCPU crash
- **12** - ``ESP_SLEEP_WAKEUP_BT``: Wakeup caused by BT (light sleep only)
.. _deep_sleep-enter_action:

16
components/display/ili9xxx.rst
View File

@ -96,8 +96,6 @@ Configuration variables:
- **offset_width** (*Optional*, int): Specify an offset for the x-direction of the display, typically used when an LCD is smaller than the maximum supported by the driver chip. Default is 0
- **offset_height** (*Optional*, int): Specify an offset for the y-direction of the display. Default is 0.
- **data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz`` (default), ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz``, ``200kHz``, ``75kHz`` or ``1kHz``. If you have multiple ILI9xxx displays they must all use the same **data_rate**.
- **spi_mode** (*Optional*): Set the mode for the SPI interface to the display. Default is ``MODE0`` but some displays require ``MODE3``.
- **invert_colors** (*Optional*): With this boolean option you can invert the display colors. **Note** some of the displays have this option set automatically to true and can't be changed.
- **18bit_mode** (*Optional*): With this boolean option you can manual enable or disable the 18 bit color mode.
- **rotation** (*Optional*): Rotate the display presentation in software. Choose one of ``0°``, ``90°``, ``180°``, or ``270°``. This option cannot be used with ``transform``.
@ -107,14 +105,18 @@ Configuration variables:
- **mirror_x** (*Optional*, boolean): If true, mirror the x axis.
- **mirror_y** (*Optional*, boolean): If true, mirror the y axis.
**Note:** To rotate the display in hardware use one of the following combinations - with 90 and 270 rotations you
will also need to use `dimensions:` to swap the height and width (see example below.)
**Note:** The ``rotation`` variable will do a software based rotation. It is better to use the **transform** to rotate the display in hardware. Use one of the following combinations:
- 90 degrees - use ``swap_xy`` with ``mirror_x``
- 180 degrees - use ``mirror_x`` with ``mirror_y``
- 270 degrees - use ``swap_xy`` with ``mirror_y``
With 90 and 270 rotations you will also need to swap the **dimensions** ''height'' and ''width'' (see example below.
To modify the SPI setting see :ref:`SPI bus <spi>` . The default **data_rate** is set to ``40MHz`` and the **spi_mode** mode is ``MODE0`` but some displays require ``MODE3`` (*).
**Note:** The maximum achievable data rate will depend on the chip type (e.g. ESP32 vs ESP32-S3) the pins used (on ESP32 using the default SPI pins allows higher rates) and the connection type (on-board connections will support higher rates than long cables or DuPont wires.) If in doubt, start with a low speed and test higher rates to find what works. A MISO pin should preferably not be specified, as this will limit the maximum rate in some circumstances, and is not required if the SPI bus is used only for the display.
Configuration examples
**********************
@ -132,8 +134,6 @@ height 320 and width 480 into portrait. Note that the dimensions are those of th
width: 320
To utilize the color capabilities of this display module, you'll likely want to add a ``color:`` section to your
YAML configuration; please see :ref:`color <config-color>` for more detail on this configuration section.

4
components/display_menu/graphical_display_menu.rst
View File

@ -34,7 +34,7 @@ engine such as :doc:`E-Paper displays </components/display/waveshare_epaper>` or
display: my_display_component
on_redraw:
then:
component.update: my_dispay_component
component.update: my_display_component
active: false
mode: rotary
items:
@ -194,7 +194,7 @@ The below example is a more complete example showing how you might use a rotary
display: my_display_component
on_redraw:
then:
component.update: my_dispay_component
component.update: my_display_component
active: false
mode: rotary
items:

2
components/pca9554.rst
View File

@ -59,7 +59,7 @@ binary sensor or GPIO switch.
- platform: gpio
name: "PCF9554A Pin #0"
pin:
pca9554: pcf9554a_device
pca9554: pca9554a_device
# Use pin number 0
number: 0
# One of INPUT or OUTPUT

3
components/rp2040.rst
View File

@ -10,6 +10,9 @@ This component contains platform-specific options for the RP2040 platform.
.. note::
Support for all aspects of ESPHome on the RP2040 is still in development.
Only the original model of Raspberry Pi Pico W board is supported, which has the Cypress **CYW43455** chip providing wireless connectivity. It can be identified by a metallic shield encapsulating the radio circuitry. Pico W boards with radio module chips like ESP8285 or similar (labelled as ``RP2040 Pico W-2023`` etc.), are not supported.
Please search for or create an `issue <https://github.com/esphome/issues/issues/new?assignees=&labels=&template=bug_report.yml>`__ if you encounter an unknown problem.
.. code-block:: yaml

18
guides/supporters.rst
View File

@ -97,6 +97,7 @@ Contributors
- `Andrzej (@andriej) <https://github.com/andriej>`__
- `Andreas (@anduchs) <https://github.com/anduchs>`__
- `Andy2No (@Andy2No) <https://github.com/Andy2No>`__
- `Andy Barcinski (@andynumber2) <https://github.com/andynumber2>`__
- `AndyRPH (@AndyRPH) <https://github.com/AndyRPH>`__
- `Vegetto (@angelnu) <https://github.com/angelnu>`__
- `Sergey Anisimov (@anisimovsergey) <https://github.com/anisimovsergey>`__
@ -176,6 +177,7 @@ Contributors
- `Brandon (@bgulla) <https://github.com/bgulla>`__
- `Benedikt Hübschen (@bhuebschen) <https://github.com/bhuebschen>`__
- `Bierchermuesli (@Bierchermuesli) <https://github.com/Bierchermuesli>`__
- `BigBobbas (@BigBobbas) <https://github.com/BigBobbas>`__
- `bigwoof (@bigwoof) <https://github.com/bigwoof>`__
- `Bill Church (@billchurch) <https://github.com/billchurch>`__
- `bisbastuner (@bisbastuner) <https://github.com/bisbastuner>`__
@ -233,7 +235,6 @@ Contributors
- `carstenschroeder (@carstenschroeder) <https://github.com/carstenschroeder>`__
- `Christian Anders Schwarzgruber (@casch-at) <https://github.com/casch-at>`__
- `Valentin Ochs (@Cat-Ion) <https://github.com/Cat-Ion>`__
- `Stroe Andrei Catalin (@catalin2402) <https://github.com/catalin2402>`__
- `Carter Nelson (@caternuson) <https://github.com/caternuson>`__
- `cathelest (@cathelest) <https://github.com/cathelest>`__
- `Chris AtLee (@catlee) <https://github.com/catlee>`__
@ -289,6 +290,7 @@ Contributors
- `Cougar (@Cougar) <https://github.com/Cougar>`__
- `Connor Prussin (@cprussin) <https://github.com/cprussin>`__
- `cptquad (@cptquad) <https://github.com/cptquad>`__
- `CptSkippy (@cptskippy) <https://github.com/cptskippy>`__
- `Grant Le Roux (@cram42) <https://github.com/cram42>`__
- `Corey Rice (@crice009) <https://github.com/crice009>`__
- `crp500 (@crp500) <https://github.com/crp500>`__
@ -317,6 +319,7 @@ Contributors
- `Danilo Campos (@daniloc) <https://github.com/daniloc>`__
- `Daniel Martin Gonzalez (@danimart1991) <https://github.com/danimart1991>`__
- `danlimlu (@danlimlu) <https://github.com/danlimlu>`__
- `Dariusz Dalecki (@darianndd) <https://github.com/darianndd>`__
- `Chris (@darthsebulba04) <https://github.com/darthsebulba04>`__
- `Dan Gentry (@dashdrum) <https://github.com/dashdrum>`__
- `Aliasghar Dashkhaneh (@dashkhaneh) <https://github.com/dashkhaneh>`__
@ -392,8 +395,10 @@ Contributors
- `Artem Sheremet (@dotdoom) <https://github.com/dotdoom>`__
- `Robert Schütz (@dotlambda) <https://github.com/dotlambda>`__
- `Daniel Hyles (@DotNetDann) <https://github.com/DotNetDann>`__
- `dougiteixeira (@dougiteixeira) <https://github.com/dougiteixeira>`__
- `Dan Maloney (@dpsm64) <https://github.com/dpsm64>`__
- `dr-oblivium (@dr-oblivium) <https://github.com/dr-oblivium>`__
- `DrBlokmeister (@DrBlokmeister) <https://github.com/DrBlokmeister>`__
- `Jean Louis-Guerin (@DrCoolzic) <https://github.com/DrCoolzic>`__
- `Drew Perttula (@drewp) <https://github.com/drewp>`__
- `drmodding (@drmodding) <https://github.com/drmodding>`__
@ -481,6 +486,7 @@ Contributors
- `Felix Storm (@felixstorm) <https://github.com/felixstorm>`__
- `Christian Ferbar (@ferbar) <https://github.com/ferbar>`__
- `ferbulous (@ferbulous) <https://github.com/ferbulous>`__
- `Federico Ferretti (@ferrets6) <https://github.com/ferrets6>`__
- `FeuerSturm (@FeuerSturm) <https://github.com/FeuerSturm>`__
- `Florian Golemo (@fgolemo) <https://github.com/fgolemo>`__
- `Federico G. Schwindt (@fgsch) <https://github.com/fgsch>`__
@ -496,6 +502,7 @@ Contributors
- `Flaviu Tamas (@flaviut) <https://github.com/flaviut>`__
- `fluffymadness (@fluffymadness) <https://github.com/fluffymadness>`__
- `fluffymonster (@fluffymonster) <https://github.com/fluffymonster>`__
- `星野SKY (@FlyingFeng2021) <https://github.com/FlyingFeng2021>`__
- `flyize (@flyize) <https://github.com/flyize>`__
- `风飘雨 (@flyrainning) <https://github.com/flyrainning>`__
- `foltymat (@foltymat) <https://github.com/foltymat>`__
@ -543,7 +550,6 @@ Contributors
- `The Gitter Badger (@gitter-badger) <https://github.com/gitter-badger>`__
- `Frederik Gladhorn (@gladhorn) <https://github.com/gladhorn>`__
- `Guillermo Ruffino (@glmnet) <https://github.com/glmnet>`__
- `Giorgos Logiotatidis (@glogiotatidis) <https://github.com/glogiotatidis>`__
- `Germán Martín (@gmag11) <https://github.com/gmag11>`__
- `Germain Masse (@gmasse) <https://github.com/gmasse>`__
- `Garret Buell (@gmbuell) <https://github.com/gmbuell>`__
@ -583,7 +589,6 @@ Contributors
- `Ha Thach (@hathach) <https://github.com/hathach>`__
- `Cong Hoang Nguyen (@HcNguyen111) <https://github.com/HcNguyen111>`__
- `hcoohb (@hcoohb) <https://github.com/hcoohb>`__
- `Héctor Giménez (@hectorgimenez) <https://github.com/hectorgimenez>`__
- `hellotomtom (@hellotomtom) <https://github.com/hellotomtom>`__
- `Jimmy Hedman (@HeMan) <https://github.com/HeMan>`__
- `Hemi03 (@Hemi03) <https://github.com/Hemi03>`__
@ -717,6 +722,7 @@ Contributors
- `Ken Piper (@Kealper) <https://github.com/Kealper>`__
- `Kelvie Wong (@kelvie) <https://github.com/kelvie>`__
- `kernelpanic85 (@kernelpanic85) <https://github.com/kernelpanic85>`__
- `Kevin Reilly (@kevireilly) <https://github.com/kevireilly>`__
- `kevlar10 (@kevlar10) <https://github.com/kevlar10>`__
- `kfulko (@kfulko) <https://github.com/kfulko>`__
- `Kai Gerken (@KG3RK3N) <https://github.com/KG3RK3N>`__
@ -931,7 +937,6 @@ Contributors
- `nmeachen (@nmeachen) <https://github.com/nmeachen>`__
- `Álvaro Fernández Rojas (@Noltari) <https://github.com/Noltari>`__
- `Łukasz Śliwiński (@nonameplum) <https://github.com/nonameplum>`__
- `Greg Johnson (@notgwj) <https://github.com/notgwj>`__
- `JJ (@notjj) <https://github.com/notjj>`__
- `Geoffrey Mayo (@notmayo) <https://github.com/notmayo>`__
- `nouser2013 (@nouser2013) <https://github.com/nouser2013>`__
@ -1107,6 +1112,7 @@ Contributors
- `Nils Schulte (@Schnilz) <https://github.com/Schnilz>`__
- `Wolle (@schreibfaul1) <https://github.com/schreibfaul1>`__
- `Ville Skyttä (@scop) <https://github.com/scop>`__
- `Dan (@ScrewLooseDan) <https://github.com/ScrewLooseDan>`__
- `Sean True (@seantrue) <https://github.com/seantrue>`__
- `Sebastian Rasor (@sebastianrasor) <https://github.com/sebastianrasor>`__
- `sebcaps (@sebcaps) <https://github.com/sebcaps>`__
@ -1258,6 +1264,7 @@ Contributors
- `Simon Hulme (@uberjew666) <https://github.com/uberjew666>`__
- `Ubi de Feo (@ubidefeo) <https://github.com/ubidefeo>`__
- `ulic75 (@ulic75) <https://github.com/ulic75>`__
- `Sever Sudakov (@UltimosHomo) <https://github.com/UltimosHomo>`__
- `unhold (@unhold) <https://github.com/unhold>`__
- `Aaron Mildenstein (@untergeek) <https://github.com/untergeek>`__
- `uPesy Electronics (@uPesy) <https://github.com/uPesy>`__
@ -1287,6 +1294,7 @@ Contributors
- `WeekendWarrior1 (@WeekendWarrior1) <https://github.com/WeekendWarrior1>`__
- `Thomas Aldrian (@Weissnix4711) <https://github.com/Weissnix4711>`__
- `Andrew Garrett (@werdnum) <https://github.com/werdnum>`__
- `Alexander Puzynia (@werwolfby) <https://github.com/werwolfby>`__
- `whimsee (@whimsee) <https://github.com/whimsee>`__
- `wifwucite (@wifwucite) <https://github.com/wifwucite>`__
- `wilberforce (@wilberforce) <https://github.com/wilberforce>`__
@ -1323,4 +1331,4 @@ Contributors
- `Zsolt Zsiros (@ZsZs73) <https://github.com/ZsZs73>`__
- `Christian Zufferey (@zuzu59) <https://github.com/zuzu59>`__
*This page was last updated February 26, 2024.*
*This page was last updated March 6, 2024.*