View Changelog
diff --git a/changelog/2023.12.0.rst b/changelog/2023.12.0.rst
new file mode 100644
index 000000000..499288e89
--- /dev/null
+++ b/changelog/2023.12.0.rst
@@ -0,0 +1,361 @@
+ESPHome 2023.12.0 - 20th December 2023
+======================================
+
+.. seo::
+ :description: Changelog for ESPHome 2023.12.0.
+ :image: /_static/changelog-2023.12.0.png
+ :author: Jesse Hills
+ :author_twitter: @jesserockz
+
+.. imgtable::
+ :columns: 3
+
+ ENS160, components/sensor/ens160, ens160.jpg, CO2 & Air Quality
+ GT911, components/touchscreen/gt911, esp32_s3_box_3.png
+ Pylontech Batteries, components/pylontech, pylontech.jpg
+ HE60R Cover, components/cover/he60r, he60r.jpg
+ Graphical Display Menu, components/display_menu/graphical_display_menu, graphical_display_menu.png
+ FT63X6, components/touchscreen/ft63x6, wt32-sc01.png
+ A02YYUW, components/sensor/a02yyuw, a02yyuw.jpg
+ PN7150, components/binary_sensor/pn7150, pn7150.jpg
+ PN716X, components/binary_sensor/pn7160, pn716x.jpg
+
+Graphical Menu
+--------------
+
+Following on from the previous :doc:`/components/display_menu/lcd_menu` that was only for LCD displays,
+there is now a new :doc:`/components/display_menu/graphical_display_menu` that can be used with any
+graphical/pixel based display.
+
+Pin Reuse validation
+--------------------
+
+There is a new validation performed on configurations to ensure that pins are not reused unintentionally.
+This is a common source of issues and generally a pin does not need to be reused across multiple components
+in a single configuration. Pins should only be reused in a very limited set of circumstances and seeing the
+error will generally mean that you need to reorganise your configuration to not reuse the pins.
+The error can be bypassed by specifically adding another config item to all of the
+duplicate pin definitions. See the :ref:`config-pin_schema` for details.
+
+Touchscreen internal changes
+----------------------------
+
+The touchscreen compoenent code has had a big overhaul which breaks any external components or open PRs for
+new touchscreens. See :esphomepr:`4596` for details if this affects you.
+
+MCP3008 breaking changes
+------------------------
+
+The MCP3008 has has a restructure of the code and at the same time the default update interval has been changed to 60 seconds,
+the units, device class and state class default have also been set to sane defaults expected for a voltage sensor.
+
+Release 2023.12.1 - December 21
+-------------------------------
+
+- Fix replaced - in allowed characters during object_id sanitizing :esphomepr:`5983` by :ghuser:`jesserockz`
+
+Release 2023.12.2 - December 22
+-------------------------------
+
+- ESP32-S3 and ESP-IDF don't play well with USB_CDC and need USB_SERIAL_JTAG :esphomepr:`5929` by :ghuser:`clydebarrow`
+- Update libtiff6 :esphomepr:`5985` by :ghuser:`cvandesande`
+- Override GPIOs 12 and 13 on the airm2m (LuatOS) board :esphomepr:`5982` by :ghuser:`davidmonro`
+- Add workaround for crash in Arduino 2.0.9 when CDC is configured :esphomepr:`5987` by :ghuser:`kbx81`
+- web_server.py: return empty content when file doesn't exist :esphomepr:`5980` by :ghuser:`jessicah`
+
+Release 2023.12.3 - December 22
+-------------------------------
+
+- Fix unexpected disconnects when outgoing buffer is full during keepalive :esphomepr:`5988` by :ghuser:`bdraco`
+- Regenerate api_pb2 after manual changes were added incorrectly in #5732 :esphomepr:`5990` by :ghuser:`jesserockz`
+- Improved sensor readings in htu21d component. :esphomepr:`5839` by :ghuser:`matzman666`
+- Fix dashboard logs when api is disabled and using MQTT :esphomepr:`5992` by :ghuser:`bdraco`
+- Fix broken configs with non-existent components :esphomepr:`5993` by :ghuser:`jesserockz`
+
+Release 2023.12.4 - December 25
+-------------------------------
+
+- dashboard: Only ping when polling is active :esphomepr:`6001` by :ghuser:`bdraco`
+- tt21100: restore init read :esphomepr:`6008` by :ghuser:`nielsnl68`
+- dashboard: Fix file writes on Windows :esphomepr:`6013` by :ghuser:`bdraco`
+- Display: fix class inherence in Python script :esphomepr:`6009` by :ghuser:`nielsnl68`
+
+Release 2023.12.5 - December 25
+-------------------------------
+
+- Fix docker builds :esphomepr:`6012` by :ghuser:`bdraco`
+
+Release 2023.12.6 - January 15
+------------------------------
+
+- Fix device not requesting Home Assistant time at the update interval :esphomepr:`6022` by :ghuser:`bdraco`
+- fix compilation error for libretiny :esphomepr:`6064` by :ghuser:`tomaszduda23`
+- pylontech: Fix parsing error with US2000 :esphomepr:`6061` by :ghuser:`functionpointer`
+- Support full (>460 char) dumps of Pronto IR commands :esphomepr:`6040` by :ghuser:`rpaskowitz`
+- ESP32-C3 USB_CDC fixes :esphomepr:`6069` by :ghuser:`kbx81`
+- Improv Serial -- don't wait for incoming bytes :esphomepr:`6089` by :ghuser:`kbx81`
+- add STATE_CLASS_TOTAL_INCREASING to bl0940 and bl0942 :esphomepr:`6090` by :ghuser:`tomaszduda23`
+- Fallback to pure-python loader for better error when YAML loading fails :esphomepr:`6081` by :ghuser:`bdraco`
+
+Release 2023.12.7 - January 17
+------------------------------
+
+- Fix RMT timing clock base :esphomepr:`6101` by :ghuser:`majkrzak`
+- Create RingBuffer for VoiceAssistant :esphomepr:`6102` by :ghuser:`jesserockz`
+- Inkplate6: Fix crash with initial set of greyscale :esphomepr:`6038` by :ghuser:`clydebarrow`
+
+Release 2023.12.8 - January 19
+------------------------------
+
+- Let show_*_page actions depend on "Display" :esphomepr:`6092` by :ghuser:`guillempages`
+- Fix some Voice Assistant bugs :esphomepr:`6121` by :ghuser:`jesserockz`
+
+Release 2023.12.9 - January 22
+------------------------------
+
+- fix sen5x negative temperature :esphomepr:`6082` by :ghuser:`ssieb`
+- negative values for all DHT22 variants :esphomepr:`6074` by :ghuser:`ssieb`
+- fix negative temperature for pmsx003 :esphomepr:`6083` by :ghuser:`ssieb`
+- fix: negative temperatures on PMS5003T sensors :esphomepr:`6100` by :ghuser:`aschmitz`
+
+Full list of changes
+--------------------
+
+New Components
+^^^^^^^^^^^^^^
+
+- Add ENS160 Sensor :esphomepr:`4243` by :ghuser:`vincentscode` (new-integration)
+- Create GT911 Touchscreen component :esphomepr:`4027` by :ghuser:`jesserockz` (new-integration)
+- Pylontech integration (solar battery bank) :esphomepr:`4688` by :ghuser:`functionpointer` (new-integration)
+- Add Chamberlain/HomEntry HE60R garage door opener :esphomepr:`5834` by :ghuser:`clydebarrow` (new-integration)
+- Add graphical display menu :esphomepr:`4105` by :ghuser:`MrMDavidson` (new-integration)
+- Updating the touchscreen interface structure :esphomepr:`4596` by :ghuser:`nielsnl68` (new-integration) (breaking-change)
+- Added the A02YYUW distance sensor :esphomepr:`5729` by :ghuser:`TH-Braemer` (new-integration)
+- Add support for PN7160 :esphomepr:`5486` by :ghuser:`kbx81` (new-integration)
+- Add support for PN7150 :esphomepr:`5487` by :ghuser:`kbx81` (new-integration)
+
+Breaking Changes
+^^^^^^^^^^^^^^^^
+
+- Add proper support for SH1107 to SSD1306 component :esphomepr:`5166` by :ghuser:`nikitakuklev` (breaking-change)
+- sen5x fix temperature compensation and gas tuning :esphomepr:`4901` by :ghuser:`matt7aylor` (breaking-change)
+- Ensure names containing characters other than `a-z` `A-Z` `0-9` or `_` are unique :esphomepr:`5810` by :ghuser:`bdraco` (breaking-change)
+- mcp3008: Tidy up and fix auto load bug :esphomepr:`5842` by :ghuser:`jesserockz` (breaking-change)
+- Nextion colors parameters :esphomepr:`5699` by :ghuser:`edwardtfn` (breaking-change)
+- Checks for pins used in multiple places :esphomepr:`5666` by :ghuser:`clydebarrow` (breaking-change)
+- Updating the touchscreen interface structure :esphomepr:`4596` by :ghuser:`nielsnl68` (new-integration) (breaking-change)
+
+Beta Changes
+^^^^^^^^^^^^
+
+- Allow use of CDC/JTAG loggers on esp32 variants with Arduino :esphomepr:`4658` by :ghuser:`jesserockz`
+- [Logger] ESP32 S3 serial logger :esphomepr:`4853` by :ghuser:`Fabian-Schmidt`
+- Support toggle action for template cover :esphomepr:`5917` by :ghuser:`jochenvg`
+- Fix SplitDefault with variants :esphomepr:`5928` by :ghuser:`jesserockz`
+- Update ENS160 TVOC device_class and AQI units to match required by HA :esphomepr:`5939` by :ghuser:`mrtoy-me`
+- Bump zeroconf from 0.128.4 to 0.130.0 :esphomepr:`5950` by :ghuser:`dependabot[bot]`
+- UARTComponent inline doc :esphomepr:`5930` by :ghuser:`edwardtfn`
+- Fix - Tuya Fan - Allow integer speed datapoint :esphomepr:`5948` by :ghuser:`cram42`
+- i2s_audio: Set player_task's prio to 1 :esphomepr:`5945` by :ghuser:`gaaf`
+- esp32_camera: Set framebuffer task prio to 1 :esphomepr:`5943` by :ghuser:`gaaf`
+- web_server_idf: fix call with hardcoded http code :esphomepr:`5942` by :ghuser:`dentra`
+- Revert pure virtual functions in UART component from #5920 :esphomepr:`5932` by :ghuser:`DrCoolzic`
+- Use the correct UART/`Serial` when CDC is enabled :esphomepr:`5957` by :ghuser:`kbx81`
+- rename ``set_raw_touch_position_`` to ``add_raw_touch_position_`` :esphomepr:`5962` by :ghuser:`nielsnl68`
+- Fix build issue with UART component when building with Arduino and CDC :esphomepr:`5964` by :ghuser:`kbx81`
+- Fix ``I2CBus::write()`` bug and add i2c documentation :esphomepr:`5947` by :ghuser:`DrCoolzic`
+- Add deep sleep between updates for waveshare epaper 1.54in and 1.54inv2 :esphomepr:`5961` by :ghuser:`mathieu-mp`
+- Speed up writing protobuf strings/bytes :esphomepr:`5828` by :ghuser:`bdraco`
+- Bump aioesphomeapi to 21.0.1 :esphomepr:`5969` by :ghuser:`bdraco`
+- image: allow the image to by auto-loaded by animation :esphomepr:`5139` by :ghuser:`ayufan`
+- Fix pin reuse error with pin expanders :esphomepr:`5973` by :ghuser:`jesserockz`
+
+All changes
+^^^^^^^^^^^
+
+- Nextion support to ``esp-idf`` :esphomepr:`5667` by :ghuser:`edwardtfn`
+- fix pin range for xl9535 :esphomepr:`5722` by :ghuser:`ssieb`
+- Bump black from 23.10.1 to 23.11.0 :esphomepr:`5702` by :ghuser:`dependabot[bot]`
+- Speed up YAML by using YAML C loader when available :esphomepr:`5721` by :ghuser:`bdraco`
+- Bump Arduino Pico Framework to 3.6.0 and Platform to 1.10.0 :esphomepr:`5731` by :ghuser:`HeMan`
+- Correct url for Arduino platform :esphomepr:`5744` by :ghuser:`HeMan`
+- remote_base: added helper class and schemas :esphomepr:`5169` by :ghuser:`dudanov`
+- Bump zeroconf from 0.123.0 to 0.126.0 :esphomepr:`5748` by :ghuser:`dependabot[bot]`
+- Make precommit checks happy :esphomepr:`5751` by :ghuser:`HeMan`
+- dashboard: Use mdns cache when available if device connection is OTA :esphomepr:`5724` by :ghuser:`bdraco`
+- Speed up OTAs :esphomepr:`5720` by :ghuser:`bdraco`
+- dashboard: convert ping thread to use asyncio :esphomepr:`5749` by :ghuser:`bdraco`
+- dashboard: Break apart dashboard into separate modules :esphomepr:`5764` by :ghuser:`bdraco`
+- dashboard: split dashboard web server code into its own module :esphomepr:`5770` by :ghuser:`bdraco`
+- Bump zeroconf from 0.126.0 to 0.127.0 :esphomepr:`5768` by :ghuser:`dependabot[bot]`
+- dashboard: fix subprocesses blocking the event loop :esphomepr:`5772` by :ghuser:`bdraco`
+- dashboard: use fastest available yaml loader in the dashboard :esphomepr:`5771` by :ghuser:`bdraco`
+- dashboard: Centralize dashboard entries into DashboardEntries class :esphomepr:`5774` by :ghuser:`bdraco`
+- Pass the name to the log runner when available :esphomepr:`5759` by :ghuser:`bdraco`
+- Add proper support for SH1107 to SSD1306 component :esphomepr:`5166` by :ghuser:`nikitakuklev` (breaking-change)
+- Split release workflow jobs per system arch :esphomepr:`5723` by :ghuser:`jesserockz`
+- Bump aioesphomeapi to 18.5.3 :esphomepr:`5785` by :ghuser:`bdraco`
+- Refactor log api client to let aioesphomeapi manage zeroconf :esphomepr:`5783` by :ghuser:`bdraco`
+- dashboard: Add support for firing events :esphomepr:`5775` by :ghuser:`bdraco`
+- dashboard: Ensure disk I/O happens in the executor :esphomepr:`5789` by :ghuser:`bdraco`
+- dashboard: Add lookup by name to entries :esphomepr:`5790` by :ghuser:`bdraco`
+- Refactor StorageJSON to keep loaded_integrations a set until its converted to JSON :esphomepr:`5793` by :ghuser:`bdraco`
+- wifi: Don't build SoftAP/DHCPS support unless 'ap' is in config. :esphomepr:`5649` by :ghuser:`kpfleming`
+- ssd1306: handle V_COM differently for SH1106 :esphomepr:`5796` by :ghuser:`papillon81`
+- Bump aioesphomeapi from 18.5.3 to 18.5.5 :esphomepr:`5804` by :ghuser:`dependabot[bot]`
+- dashboard: Fix online status when api is disabled :esphomepr:`5792` by :ghuser:`bdraco`
+- Haier component updated to support new protocol variations :esphomepr:`5713` by :ghuser:`paveldn`
+- sen5x fix temperature compensation and gas tuning :esphomepr:`4901` by :ghuser:`matt7aylor` (breaking-change)
+- Add startup_delay to interval. :esphomepr:`5327` by :ghuser:`clydebarrow`
+- Pillow: bump to 10.1.0 :esphomepr:`5815` by :ghuser:`hostcc`
+- dashboard: set nodelay on the websocket to avoid a delay seeing log messages :esphomepr:`5802` by :ghuser:`bdraco`
+- Bump aioesphomeapi from 18.5.5 to 18.5.7 :esphomepr:`5822` by :ghuser:`dependabot[bot]`
+- Ensure names containing characters other than `a-z` `A-Z` `0-9` or `_` are unique :esphomepr:`5810` by :ghuser:`bdraco` (breaking-change)
+- Add ENS160 Sensor :esphomepr:`4243` by :ghuser:`vincentscode` (new-integration)
+- Bump actions/github-script from 6.4.1 to 7.0.1 :esphomepr:`5803` by :ghuser:`dependabot[bot]`
+- Run all tests when local testing. :esphomepr:`5717` by :ghuser:`Fabian-Schmidt`
+- Bump aioesphomeapi from 18.5.7 to 18.5.9 :esphomepr:`5830` by :ghuser:`dependabot[bot]`
+- Allow split uart pin inversion for ESP-IDF :esphomepr:`5831` by :ghuser:`clydebarrow`
+- Add ``is_detected()`` for Nextion displays :esphomepr:`5825` by :ghuser:`edwardtfn`
+- Pull PollingComponent up from individual display drivers to Display. :esphomepr:`5444` by :ghuser:`clydebarrow`
+- Implement variable length single word SPI writes. :esphomepr:`5678` by :ghuser:`clydebarrow`
+- Add 'enable_on_boot' feature to power_supply :esphomepr:`5826` by :ghuser:`clydebarrow`
+- mcp3008: Tidy up and fix auto load bug :esphomepr:`5842` by :ghuser:`jesserockz` (breaking-change)
+- Create GT911 Touchscreen component :esphomepr:`4027` by :ghuser:`jesserockz` (new-integration)
+- Bump aioesphomeapi from 18.5.9 to 19.1.2 :esphomepr:`5844` by :ghuser:`dependabot[bot]`
+- Nextion - Standardizing log messages :esphomepr:`5837` by :ghuser:`edwardtfn`
+- dashboard: Small cleanups to dashboard :esphomepr:`5841` by :ghuser:`bdraco`
+- Pylontech integration (solar battery bank) :esphomepr:`4688` by :ghuser:`functionpointer` (new-integration)
+- Implement deep sleep and clear screen on Waveshare 7.5in B V3 :esphomepr:`5239` by :ghuser:`lucasprim`
+- Fix ESP-IDF uart initialisation sequence to match Espressif docs. :esphomepr:`5838` by :ghuser:`clydebarrow`
+- Nextion - Align strings on ``dump_config`` :esphomepr:`5824` by :ghuser:`edwardtfn`
+- Speed up (and fix) ili9xxx display component. :esphomepr:`5406` by :ghuser:`clydebarrow`
+- Fix regex for 'byte' custom CI check :esphomepr:`5851` by :ghuser:`jesserockz`
+- Pass through additional arguments to create number :esphomepr:`5849` by :ghuser:`clydebarrow`
+- Nextion ``on_touch`` trigger :esphomepr:`5833` by :ghuser:`edwardtfn`
+- Nextion colors parameters :esphomepr:`5699` by :ghuser:`edwardtfn` (breaking-change)
+- dashboard: fix supervisor auth doing I/O in the event loop :esphomepr:`5807` by :ghuser:`bdraco`
+- Improve reliability of Nextion TFT uploads (Arduino) :esphomepr:`5683` by :ghuser:`edwardtfn`
+- Add Pro Check Universal sensor support. :esphomepr:`5798` by :ghuser:`spbrogan`
+- Bump aioesphomeapi from 19.1.2 to 19.1.7 :esphomepr:`5859` by :ghuser:`dependabot[bot]`
+- Pn532 non blocking scan :esphomepr:`5191` by :ghuser:`sharkydog`
+- Add Chamberlain/HomEntry HE60R garage door opener :esphomepr:`5834` by :ghuser:`clydebarrow` (new-integration)
+- Bump aioesphomeapi from 19.1.7 to 19.2.1 :esphomepr:`5863` by :ghuser:`dependabot[bot]`
+- Bump tornado from 6.3.3 to 6.4 :esphomepr:`5862` by :ghuser:`dependabot[bot]`
+- add missing ifdef to pvvx_mithermometer :esphomepr:`5880` by :ghuser:`ssieb`
+- Fix un-initialized version string :esphomepr:`5865` by :ghuser:`descipher`
+- fix a01nyub data reading :esphomepr:`5882` by :ghuser:`ssieb`
+- Bump pytest-asyncio from 0.21.1 to 0.23.2 :esphomepr:`5888` by :ghuser:`dependabot[bot]`
+- Bump zeroconf from 0.127.0 to 0.128.0 :esphomepr:`5889` by :ghuser:`dependabot[bot]`
+- Bump pylint from 2.17.6 to 3.0.2 :esphomepr:`5592` by :ghuser:`dependabot[bot]`
+- Bump voluptuous from 0.13.1 to 0.14.1 :esphomepr:`5784` by :ghuser:`dependabot[bot]`
+- Security improvement: Support wifi ap_timeout=0s (disable) :esphomepr:`5887` by :ghuser:`fornellas`
+- Suppress full config output of "esphome config" when -q option is used. :esphomepr:`5852` by :ghuser:`clydebarrow`
+- Checks for pins used in multiple places :esphomepr:`5666` by :ghuser:`clydebarrow` (breaking-change)
+- Nextion support to idf with `cinttypes` :esphomepr:`5876` by :ghuser:`edwardtfn`
+- Fix test4.yaml after #5666 :esphomepr:`5890` by :ghuser:`kbx81`
+- Fix template text component length check :esphomepr:`5881` by :ghuser:`fornellas`
+- RC522 - Fix error counter error :esphomepr:`5873` by :ghuser:`kbx81`
+- feat(packages): support removing components :esphomepr:`5821` by :ghuser:`TMaYaD`
+- dashboard: Add some basic tests for the dashboard :esphomepr:`5870` by :ghuser:`bdraco`
+- Nextion exit reparse mode on startup :esphomepr:`5868` by :ghuser:`edwardtfn`
+- Bump aioesphomeapi from 19.2.1 to 19.3.0 :esphomepr:`5895` by :ghuser:`dependabot[bot]`
+- Add framework info to Nextion log tags :esphomepr:`5864` by :ghuser:`edwardtfn`
+- Handle case where using enetity level name: None with MQTT :esphomepr:`5897` by :ghuser:`mtl010957`
+- Bump actions/setup-python from 4.7.1 to 5.0.0 :esphomepr:`5896` by :ghuser:`dependabot[bot]`
+- Bump zeroconf from 0.128.0 to 0.128.4 :esphomepr:`5906` by :ghuser:`dependabot[bot]`
+- Fix 18 bit displays. :esphomepr:`5908` by :ghuser:`clydebarrow`
+- fix RGBW Mode on RP2040 :esphomepr:`5907` by :ghuser:`firegore`
+- Add graphical display menu :esphomepr:`4105` by :ghuser:`MrMDavidson` (new-integration)
+- Added on_image callback to ESP32 Cam :esphomepr:`4860` by :ghuser:`freekode`
+- Bump actions/stale from 8.0.0 to 9.0.0 :esphomepr:`5899` by :ghuser:`dependabot[bot]`
+- Bump pylint from 3.0.2 to 3.0.3 :esphomepr:`5905` by :ghuser:`dependabot[bot]`
+- Bump frenck/action-yamllint from 1.4.1 to 1.4.2 :esphomepr:`5716` by :ghuser:`dependabot[bot]`
+- Bump dessant/lock-threads from 4.0.1 to 5.0.1 :esphomepr:`5820` by :ghuser:`dependabot[bot]`
+- Add support for fan preset modes :esphomepr:`5694` by :ghuser:`mill1000`
+- Fix uninitialized climate target temperature :esphomepr:`5795` by :ghuser:`ckoca`
+- Bump aioesphomeapi from 19.3.0 to 20.0.0 :esphomepr:`5911` by :ghuser:`dependabot[bot]`
+- Bump black from 23.11.0 to 23.12.0 :esphomepr:`5912` by :ghuser:`dependabot[bot]`
+- Updating the touchscreen interface structure :esphomepr:`4596` by :ghuser:`nielsnl68` (new-integration) (breaking-change)
+- Added the A02YYUW distance sensor :esphomepr:`5729` by :ghuser:`TH-Braemer` (new-integration)
+- Fix AHT10 / AHT20 communication :esphomepr:`5198` by :ghuser:`flaminggoat`
+- Fix crash when handling pin_check error :esphomepr:`5915` by :ghuser:`clydebarrow`
+- Bump aioesphomeapi to 20.1.0 :esphomepr:`5914` by :ghuser:`bdraco`
+- Remove setpoint-change from error when calculating derivative in pid controller :esphomepr:`4737` by :ghuser:`Newspaperman57`
+- ir_transmitter: add support for repeated commands in NEC protocol :esphomepr:`4995` by :ghuser:`ngilles`
+- BP1658CJ - Fix timing for all platforms, now consistent with other drivers :esphomepr:`5799` by :ghuser:`Cossid`
+- Add humidity support to climate :esphomepr:`5732` by :ghuser:`kroimon`
+- Remove lingering note :esphomepr:`5916` by :ghuser:`jesserockz`
+- Fix typo added in esp32 post_build filename :esphomepr:`5918` by :ghuser:`jesserockz`
+- Copy esp32 custom partition files to build folder :esphomepr:`5919` by :ghuser:`jesserockz`
+- UART change at runtime :esphomepr:`5909` by :ghuser:`edwardtfn`
+- Bump aioesphomeapi from 20.1.0 to 21.0.0 :esphomepr:`5922` by :ghuser:`dependabot[bot]`
+- Fix the initial run of lambda light effects :esphomepr:`5921` by :ghuser:`smithjacobj`
+- Exposes ``load_settings`` to `UARTComponent` class :esphomepr:`5920` by :ghuser:`edwardtfn`
+- Add support for PN7160 :esphomepr:`5486` by :ghuser:`kbx81` (new-integration)
+- Add support for PN7150 :esphomepr:`5487` by :ghuser:`kbx81` (new-integration)
+- Allow use of CDC/JTAG loggers on esp32 variants with Arduino :esphomepr:`4658` by :ghuser:`jesserockz`
+- [Logger] ESP32 S3 serial logger :esphomepr:`4853` by :ghuser:`Fabian-Schmidt`
+- Support toggle action for template cover :esphomepr:`5917` by :ghuser:`jochenvg`
+- Fix SplitDefault with variants :esphomepr:`5928` by :ghuser:`jesserockz`
+- Update ENS160 TVOC device_class and AQI units to match required by HA :esphomepr:`5939` by :ghuser:`mrtoy-me`
+- Bump zeroconf from 0.128.4 to 0.130.0 :esphomepr:`5950` by :ghuser:`dependabot[bot]`
+- UARTComponent inline doc :esphomepr:`5930` by :ghuser:`edwardtfn`
+- Fix - Tuya Fan - Allow integer speed datapoint :esphomepr:`5948` by :ghuser:`cram42`
+- i2s_audio: Set player_task's prio to 1 :esphomepr:`5945` by :ghuser:`gaaf`
+- esp32_camera: Set framebuffer task prio to 1 :esphomepr:`5943` by :ghuser:`gaaf`
+- web_server_idf: fix call with hardcoded http code :esphomepr:`5942` by :ghuser:`dentra`
+- Revert pure virtual functions in UART component from #5920 :esphomepr:`5932` by :ghuser:`DrCoolzic`
+- Use the correct UART/`Serial` when CDC is enabled :esphomepr:`5957` by :ghuser:`kbx81`
+- rename ``set_raw_touch_position_`` to ``add_raw_touch_position_`` :esphomepr:`5962` by :ghuser:`nielsnl68`
+- Fix build issue with UART component when building with Arduino and CDC :esphomepr:`5964` by :ghuser:`kbx81`
+- Fix I2CBus::write() bug and add i2c documentation :esphomepr:`5947` by :ghuser:`DrCoolzic`
+- Add deep sleep between updates for waveshare epaper 1.54in and 1.54inv2 :esphomepr:`5961` by :ghuser:`mathieu-mp`
+- Speed up writing protobuf strings/bytes :esphomepr:`5828` by :ghuser:`bdraco`
+- Bump aioesphomeapi to 21.0.1 :esphomepr:`5969` by :ghuser:`bdraco`
+- image: allow the image to by auto-loaded by animation :esphomepr:`5139` by :ghuser:`ayufan`
+- Fix pin reuse error with pin expanders :esphomepr:`5973` by :ghuser:`jesserockz`
+
+Past Changelogs
+---------------
+
+- :doc:`2023.11.0`
+- :doc:`2023.10.0`
+- :doc:`2023.9.0`
+- :doc:`2023.8.0`
+- :doc:`2023.7.0`
+- :doc:`2023.6.0`
+- :doc:`2023.5.0`
+- :doc:`2023.4.0`
+- :doc:`2023.3.0`
+- :doc:`2023.2.0`
+- :doc:`2022.12.0`
+- :doc:`2022.11.0`
+- :doc:`2022.10.0`
+- :doc:`2022.9.0`
+- :doc:`2022.8.0`
+- :doc:`2022.6.0`
+- :doc:`2022.5.0`
+- :doc:`2022.4.0`
+- :doc:`2022.3.0`
+- :doc:`2022.2.0`
+- :doc:`2022.1.0`
+- :doc:`2021.12.0`
+- :doc:`2021.11.0`
+- :doc:`2021.10.0`
+- :doc:`2021.9.0`
+- :doc:`2021.8.0`
+- :doc:`v1.20.0`
+- :doc:`v1.19.0`
+- :doc:`v1.18.0`
+- :doc:`v1.17.0`
+- :doc:`v1.16.0`
+- :doc:`v1.15.0`
+- :doc:`v1.14.0`
+- :doc:`v1.13.0`
+- :doc:`v1.12.0`
+- :doc:`v1.11.0`
+- :doc:`v1.10.0`
+- :doc:`v1.9.0`
+- :doc:`v1.8.0`
+- :doc:`v1.7.0`
diff --git a/changelog/2024.2.0.rst b/changelog/2024.2.0.rst
new file mode 100644
index 000000000..08dc4c488
--- /dev/null
+++ b/changelog/2024.2.0.rst
@@ -0,0 +1,281 @@
+ESPHome 2024.2.0 - 21st February 2024
+=====================================
+
+.. seo::
+ :description: Changelog for ESPHome 2024.2.0.
+ :image: /_static/changelog-2024.2.0.png
+ :author: Jesse Hills
+ :author_twitter: @jesserockz
+
+.. imgtable::
+ :columns: 4
+
+ micro Wake Word, components/micro_wake_word, voice-assistant.svg, dark-invert
+ AS5600, components/sensor/as5600, as5600.jpg
+ ST7567, components/display/st7567, st7567.jpg
+ BME280 SPI, components/sensor/bme280, bme280.jpg
+ VEML3235, components/sensor/veml3235, veml3235.jpg
+ Honeywell HIH I2C, components/sensor/honeywell_hih_i2c, honeywellhih.jpg
+ Combination, components/sensor/combination, function.svg, dark-invert
+
+micro Wake Word
+---------------
+
+ESPHome implements an on-device wake word detection framework from `microWakeWord `__.
+See the :doc:`component documentation ` for details on how to use it.
+
+Check out the live stream replay below for more details about how it works and came to be.
+
+.. raw:: html
+
+
+
+
+BME280 changes
+--------------
+
+:ghuser:`apbodrov` has added support for the BME280 sensor over SPI. This change is a breaking change for any existing configurations using
+the BME280 over I2C as the platform name has been changed from ``bme280`` to ``bme280_i2c``. There are no other configuration changes required
+to continue using the BME280 over I2C. See the :doc:`component documentation ` for the latest configuration variables.
+
+
+CSE7766 changes
+---------------
+
+:ghuser:`ssieb` has changed the CSE7766 sensor from appearing to be a polling component.
+It has a high update rate, so if you don't want to send a lot of data to HA, you can
+add the :ref:`throttle_average ` filter
+with the time period you were using for the update interval (the default is 60s) to each
+sensor. The example in the sensor doc page has been updated to show this.
+
+
+Release 2024.2.1 - February 26
+------------------------------
+
+- Add missing timeout to "async_request" :esphomepr:`6267` by :ghuser:`jesserockz`
+- Bump zeroconf timeout to 3000 :esphomepr:`6270` by :ghuser:`jesserockz`
+- web_server: Add a position property for cover entities that have the supports position trait :esphomepr:`6269` by :ghuser:`DanielBaulig`
+- allow multiple emc2101 :esphomepr:`6272` by :ghuser:`ssieb`
+- Fix RP2040 SPI pin validation :esphomepr:`6277` by :ghuser:`kbx81`
+- dashboard: move storage json update to a background task in edit save :esphomepr:`6280` by :ghuser:`bdraco`
+- make output optional for speed fan :esphomepr:`6274` by :ghuser:`ssieb`
+- 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
+--------------------
+
+New Components
+^^^^^^^^^^^^^^
+
+- feat: add AS5600 component/sensor :esphomepr:`5174` by :ghuser:`ammmze` (new-integration)
+- Support for ST7567 display 128x64 (I2C, SPI) :esphomepr:`5952` by :ghuser:`latonita` (new-integration)
+- BME280 SPI :esphomepr:`5538` by :ghuser:`apbodrov` (new-integration) (breaking-change)
+- Add support for VEML3235 lux sensor :esphomepr:`5959` by :ghuser:`kbx81` (new-integration)
+- Add support of Honeywell HumidIcon (I2C HIH series) Temperature & Humidity sensor :esphomepr:`5730` by :ghuser:`Benichou34` (new-integration)
+- Add combination sensor and remove absorbed kalman_combinator component :esphomepr:`5438` by :ghuser:`kahrendt` (new-integration) (breaking-change)
+- Add micro_wake_word component :esphomepr:`6136` by :ghuser:`kahrendt` (new-integration)
+
+Breaking Changes
+^^^^^^^^^^^^^^^^
+
+- PMSx003 add relevant device and state classes to default config :esphomepr:`5633` by :ghuser:`wheimbigner` (breaking-change)
+- BME280 SPI :esphomepr:`5538` by :ghuser:`apbodrov` (new-integration) (breaking-change)
+- convert cse7766 to non-polling :esphomepr:`6095` by :ghuser:`ssieb` (breaking-change)
+- Add combination sensor and remove absorbed kalman_combinator component :esphomepr:`5438` by :ghuser:`kahrendt` (new-integration) (breaking-change)
+
+Beta Changes
+^^^^^^^^^^^^
+
+- AUTO_LOAD ``sensor`` for ``shelly_dimmer`` :esphomepr:`6223` by :ghuser:`kbx81`
+- Add more debugging logs to microWakeWord :esphomepr:`6238` by :ghuser:`kahrendt`
+- Fix to RF receiver for Drayton Digistat heating controller :esphomepr:`6235` by :ghuser:`marshn`
+- WRGB Use correct multiplier :esphomepr:`6237` by :ghuser:`mhetzi`
+- Add optional minimum esphome version to microWakeWord manifest :esphomepr:`6240` by :ghuser:`jesserockz`
+- Fix xl9535 pin reads :esphomepr:`6242` by :ghuser:`jesserockz`
+- hold interrupt disable for dallas one-wire :esphomepr:`6244` by :ghuser:`ssieb`
+- Fix tm1651 enum :esphomepr:`6248` by :ghuser:`kbx81`
+- Clear UART read buffer before sending next command :esphomepr:`6200` by :ghuser:`fototakas`
+- Voice Assistant: add on_idle trigger and fix nevermind :esphomepr:`6141` by :ghuser:`synesthesiam`
+- Tuya Fan component fix to handle enum datapoint type :esphomepr:`6135` by :ghuser:`sibowler`
+
+All changes
+^^^^^^^^^^^
+
+- Bump esptool from 4.6.2 to 4.7.0 :esphomepr:`5935` by :ghuser:`dependabot[bot]`
+- Bump actions/download-artifact from 3.0.2 to 4.0.0 :esphomepr:`5936` by :ghuser:`dependabot[bot]`
+- Bump build-image action versions :esphomepr:`5954` by :ghuser:`jesserockz`
+- Revert "Bump build-image action versions" :esphomepr:`5955` by :ghuser:`jesserockz`
+- Revert "Bump actions/download-artifact from 3.0.2 to 4.0.0" :esphomepr:`5956` by :ghuser:`jesserockz`
+- Bump zeroconf from 0.130.0 to 0.131.0 :esphomepr:`5967` by :ghuser:`dependabot[bot]`
+- Add ability to lock to set mode :esphomepr:`5924` by :ghuser:`ysmilda`
+- feat: add AS5600 component/sensor :esphomepr:`5174` by :ghuser:`ammmze` (new-integration)
+- Add default substitutions for package includes :esphomepr:`5752` by :ghuser:`mknjc`
+- Add gradient option to addressable color wipe effect :esphomepr:`5689` by :ghuser:`lifeisafractal`
+- Added alarm processing for Haier component (hOn protocol) :esphomepr:`5965` by :ghuser:`paveldn`
+- Allow haier remote protocol to use lambdas :esphomepr:`5898` by :ghuser:`catlee`
+- PMSx003 add relevant device and state classes to default config :esphomepr:`5633` by :ghuser:`wheimbigner` (breaking-change)
+- Add waveshare 2.7in V2 model :esphomepr:`5903` by :ghuser:`gumulka`
+- Add support for waveshare 2.9in B V3 version :esphomepr:`5902` by :ghuser:`gumulka`
+- Fix pin reuse in test1 :esphomepr:`5978` by :ghuser:`jesserockz`
+- Add Waveshare 1.47in 172x320 to ST7789v component :esphomepr:`5884` by :ghuser:`mrtoy-me`
+- (fingerprint_grow) Added on_finger_scan_invalid automation. :esphomepr:`5885` by :ghuser:`RubenNL`
+- Alarm panel: Add changes to support enhanced features :esphomepr:`5671` by :ghuser:`hwstar`
+- support default pins for adafruit esp32 feather v2 :esphomepr:`5482` by :ghuser:`sbrudenell`
+- Bug: Unwanted change resistance in x9c component :esphomepr:`5483` by :ghuser:`fizista`
+- Improvements to RF receiver for Drayton Digistat heating controller :esphomepr:`5504` by :ghuser:`marshn`
+- Reduce memory usage with StringRef in MQTT Components :esphomepr:`5719` by :ghuser:`kahrendt`
+- Nextion allow underscore on names :esphomepr:`5979` by :ghuser:`edwardtfn`
+- Add Keeloq RF protocol :esphomepr:`5511` by :ghuser:`marshn`
+- Add a Binary Sensor Filter for state settling :esphomepr:`5900` by :ghuser:`cottsay`
+- Lint the script folder files :esphomepr:`5991` by :ghuser:`jesserockz`
+- web_server support for home assistant like styling :esphomepr:`5854` by :ghuser:`afarago`
+- [Touchscreen] Add expire of touch record. :esphomepr:`5986` by :ghuser:`Fabian-Schmidt`
+- Support for ST7567 display 128x64 (I2C, SPI) :esphomepr:`5952` by :ghuser:`latonita` (new-integration)
+- Add constants used by multiple display drivers to global const.py :esphomepr:`6033` by :ghuser:`clydebarrow`
+- Nextion queue size :esphomepr:`6029` by :ghuser:`edwardtfn`
+- Ble client additions and fixes :esphomepr:`5277` by :ghuser:`clydebarrow`
+- HaierProtocol library updated to 0.9.25 to fix the answer_timeout bug :esphomepr:`6015` by :ghuser:`paveldn`
+- GT911 touchscreen: Fix bug causing touch button release to fail :esphomepr:`6042` by :ghuser:`clydebarrow`
+- Display: Introduce `draw_pixels_at()` method for fast block display rendering :esphomepr:`6034` by :ghuser:`clydebarrow`
+- clang-format and clang-tidy scripts: More robust algorithm to find correct executable :esphomepr:`6041` by :ghuser:`clydebarrow`
+- Don't crash with invalid adc pin :esphomepr:`6059` by :ghuser:`ssieb`
+- Add questionmark to default glyphs. :esphomepr:`6053` by :ghuser:`RubenNL`
+- pylontech: fix voltage_low and voltage_high wrong unit :esphomepr:`6060` by :ghuser:`functionpointer`
+- Bump flake8 from 6.1.0 to 7.0.0 :esphomepr:`6058` by :ghuser:`dependabot[bot]`
+- Nextion enable upload from https when using esp-idf :esphomepr:`6051` by :ghuser:`edwardtfn`
+- Extends UART change at runtime to ESP8266 :esphomepr:`6019` by :ghuser:`edwardtfn`
+- Nextion draw QR code at runtime :esphomepr:`6027` by :ghuser:`edwardtfn`
+- Extend i2s config options :esphomepr:`6056` by :ghuser:`Hadatko`
+- Add getter for image data_start :esphomepr:`6036` by :ghuser:`clydebarrow`
+- Bump hypothesis to 6.92.1 :esphomepr:`6011` by :ghuser:`bdraco`
+- Bump recommended ESP32 IDF to 4.4.6 :esphomepr:`6048` by :ghuser:`bdraco`
+- Bump pytest from 7.4.3 to 7.4.4 :esphomepr:`6046` by :ghuser:`dependabot[bot]`
+- dashboard: refactor ping implementation to be more efficient :esphomepr:`6002` by :ghuser:`bdraco`
+- Bump pytest-asyncio from 0.23.2 to 0.23.3 :esphomepr:`6047` by :ghuser:`dependabot[bot]`
+- Bump black from 23.12.0 to 23.12.1 :esphomepr:`6018` by :ghuser:`dependabot[bot]`
+- Run python tests on windows and macos :esphomepr:`6010` by :ghuser:`bdraco`
+- BME280 SPI :esphomepr:`5538` by :ghuser:`apbodrov` (new-integration) (breaking-change)
+- Actions to enable and disable WireGuard connection :esphomepr:`5690` by :ghuser:`droscy`
+- hydreon_rgxx - fix missing cg.add(var.set_model(...)) :esphomepr:`6065` by :ghuser:`mrtoy-me`
+- Bump pillow to 10.2.0. :esphomepr:`6091` by :ghuser:`pfrenssen`
+- convert cse7766 to non-polling :esphomepr:`6095` by :ghuser:`ssieb` (breaking-change)
+- Use touch state from ft63x6 driver. :esphomepr:`6055` by :ghuser:`nielsnl68`
+- update script/setup so it works fine on windows :esphomepr:`6087` by :ghuser:`nielsnl68`
+- add Pico-ResTouch-LCD-3.5 :esphomepr:`6078` by :ghuser:`nielsnl68`
+- Revert "add Pico-ResTouch-LCD-3.5" :esphomepr:`6098` by :ghuser:`nielsnl68`
+- Add triangle shapes to display component :esphomepr:`6096` by :ghuser:`mathieu-mp`
+- Fingerprint_grow: Trigger on finger scan start and on finger scan misplaced :esphomepr:`6003` by :ghuser:`alexborro`
+- Add continuous option to the graph :esphomepr:`6093` by :ghuser:`ssieb`
+- Add NFC binary sensor platform :esphomepr:`6068` by :ghuser:`kbx81`
+- Socket: Add recvfrom method to receive UDP with source address. :esphomepr:`6103` by :ghuser:`clydebarrow`
+- Add support for VEML3235 lux sensor :esphomepr:`5959` by :ghuser:`kbx81` (new-integration)
+- CV: tidy up Schema wrapper :esphomepr:`6105` by :ghuser:`jesserockz`
+- Add support X.509 client certificates for MQTT. :esphomepr:`5778` by :ghuser:`h2zero`
+- Fix color observation for triangle outline in display component :esphomepr:`6107` by :ghuser:`mathieu-mp`
+- Add support of Honeywell HumidIcon (I2C HIH series) Temperature & Humidity sensor :esphomepr:`5730` by :ghuser:`Benichou34` (new-integration)
+- Proposal: Test yaml for each component :esphomepr:`5398` by :ghuser:`Fabian-Schmidt`
+- WiFi fast_connect: save/load BSSID and channel for faster connect from sleep :esphomepr:`5931` by :ghuser:`rguca`
+- Fixes Waveshare 7.5in B V2 and V3 :esphomepr:`6079` by :ghuser:`Pofilo`
+- Add combination sensor and remove absorbed kalman_combinator component :esphomepr:`5438` by :ghuser:`kahrendt` (new-integration) (breaking-change)
+- Bump platformio from 6.1.11 to 6.1.13 :esphomepr:`6086` by :ghuser:`dependabot[bot]`
+- Bump actions/cache from 3.3.2 to 4.0.0 :esphomepr:`6110` by :ghuser:`dependabot[bot]`
+- Enable networking and some other components on host platform :esphomepr:`6114` by :ghuser:`clydebarrow`
+- Fix time component for host platform :esphomepr:`6118` by :ghuser:`clydebarrow`
+- Add quad spi features :esphomepr:`5925` by :ghuser:`clydebarrow`
+- add AM2120 device type :esphomepr:`6115` by :ghuser:`alexbuit`
+- Add support for Waveshare EPD 2.13" V3 :esphomepr:`5363` by :ghuser:`clydebarrow`
+- OTA 2 which confirm each written chunk :esphomepr:`6066` by :ghuser:`tomaszduda23`
+- Remove optional<> for pointer types :esphomepr:`6120` by :ghuser:`kroimon`
+- Improve temperature precision in BME280 and BMP280 :esphomepr:`6124` by :ghuser:`jxl77`
+- Nextion TFT upload IDF memory optimization :esphomepr:`6128` by :ghuser:`edwardtfn`
+- Add support for Pico-ResTouch-LCD-3.5 to ili9xxx driver :esphomepr:`6129` by :ghuser:`clydebarrow`
+- Ensure filename is shown when YAML raises an error :esphomepr:`6139` by :ghuser:`bdraco`
+- ILI9XXX: Restore offset usage in set_addr_window :esphomepr:`6147` by :ghuser:`clydebarrow`
+- Minimum 1 for full_update_every to prevent IntegerDivideByZero. :esphomepr:`6150` by :ghuser:`RubenNL`
+- Support tri-color waveshare eink displays 2.7inch B and B V2 :esphomepr:`4238` by :ghuser:`rnauber`
+- Synchronise Device Classes from Home Assistant :esphomepr:`6158` by :ghuser:`esphomebot`
+- dfrobot_sen0395: Use setLatency instead of outputLatency :esphomepr:`5665` by :ghuser:`jfroy`
+- Add some components to the new testing framework (A part 1) :esphomepr:`6142` by :ghuser:`kbx81`
+- WRGB or RGBW? WS2814 :esphomepr:`6164` by :ghuser:`mhetzi`
+- Add some components to the new testing framework (A part 2) :esphomepr:`6162` by :ghuser:`kbx81`
+- Bump aioesphomeapi to 21.0.2 :esphomepr:`6188` by :ghuser:`bdraco`
+- Add some components to the new testing framework (B) :esphomepr:`6173` by :ghuser:`kbx81`
+- Add "transformer_active" flag for use in effects. :esphomepr:`6157` by :ghuser:`TikiBill`
+- CSE7766: fix power and current measurements at low loads :esphomepr:`6180` by :ghuser:`twasilczyk`
+- host platform: improvements and bugfixes :esphomepr:`6137` by :ghuser:`clydebarrow`
+- WLED Sync fix and BK72XX support :esphomepr:`6190` by :ghuser:`ChuckMash`
+- Add missing vector.h for lightwaverf :esphomepr:`6196` by :ghuser:`kbx81`
+- Add some components to the new testing framework (C) :esphomepr:`6174` by :ghuser:`kbx81`
+- update docstrings in cpp_generator.py :esphomepr:`6212` by :ghuser:`nielsnl68`
+- Fixed group mask logic for WLED Sync fix :esphomepr:`6193` by :ghuser:`ChuckMash`
+- Add micro_wake_word component :esphomepr:`6136` by :ghuser:`kahrendt` (new-integration)
+- AUTO_LOAD ``sensor`` for ``shelly_dimmer`` :esphomepr:`6223` by :ghuser:`kbx81`
+- Add more debugging logs to microWakeWord :esphomepr:`6238` by :ghuser:`kahrendt`
+- Fix to RF receiver for Drayton Digistat heating controller :esphomepr:`6235` by :ghuser:`marshn`
+- WRGB Use correct multiplier :esphomepr:`6237` by :ghuser:`mhetzi`
+- Add optional minimum esphome version to microWakeWord manifest :esphomepr:`6240` by :ghuser:`jesserockz`
+- Fix xl9535 pin reads :esphomepr:`6242` by :ghuser:`jesserockz`
+- hold interrupt disable for dallas one-wire :esphomepr:`6244` by :ghuser:`ssieb`
+- Fix tm1651 enum :esphomepr:`6248` by :ghuser:`kbx81`
+- Clear UART read buffer before sending next command :esphomepr:`6200` by :ghuser:`fototakas`
+- Voice Assistant: add on_idle trigger and fix nevermind :esphomepr:`6141` by :ghuser:`synesthesiam`
+- Tuya Fan component fix to handle enum datapoint type :esphomepr:`6135` by :ghuser:`sibowler`
+
+Past Changelogs
+---------------
+
+- :doc:`2023.12.0`
+- :doc:`2023.11.0`
+- :doc:`2023.10.0`
+- :doc:`2023.9.0`
+- :doc:`2023.8.0`
+- :doc:`2023.7.0`
+- :doc:`2023.6.0`
+- :doc:`2023.5.0`
+- :doc:`2023.4.0`
+- :doc:`2023.3.0`
+- :doc:`2023.2.0`
+- :doc:`2022.12.0`
+- :doc:`2022.11.0`
+- :doc:`2022.10.0`
+- :doc:`2022.9.0`
+- :doc:`2022.8.0`
+- :doc:`2022.6.0`
+- :doc:`2022.5.0`
+- :doc:`2022.4.0`
+- :doc:`2022.3.0`
+- :doc:`2022.2.0`
+- :doc:`2022.1.0`
+- :doc:`2021.12.0`
+- :doc:`2021.11.0`
+- :doc:`2021.10.0`
+- :doc:`2021.9.0`
+- :doc:`2021.8.0`
+- :doc:`v1.20.0`
+- :doc:`v1.19.0`
+- :doc:`v1.18.0`
+- :doc:`v1.17.0`
+- :doc:`v1.16.0`
+- :doc:`v1.15.0`
+- :doc:`v1.14.0`
+- :doc:`v1.13.0`
+- :doc:`v1.12.0`
+- :doc:`v1.11.0`
+- :doc:`v1.10.0`
+- :doc:`v1.9.0`
+- :doc:`v1.8.0`
+- :doc:`v1.7.0`
diff --git a/changelog/2024.3.0.rst b/changelog/2024.3.0.rst
new file mode 100644
index 000000000..570b004a4
--- /dev/null
+++ b/changelog/2024.3.0.rst
@@ -0,0 +1,311 @@
+ESPHome 2024.3.0 - 20th March 2024
+==================================
+
+.. seo::
+ :description: Changelog for ESPHome 2024.3.0.
+ :image: /_static/changelog-2024.3.0.png
+ :author: Jesse Hills
+ :author_twitter: @jesserockz
+
+.. imgtable::
+ :columns: 5
+
+ Datetime Core, components/datetime/index, clock-outline.svg, dark-invert
+ Template Datetime, components/datetime/template, description.svg, dark-invert
+
+ AM2315C, components/sensor/am2315c, am2315c.jpg
+ HTU31D, components/sensor/htu31d, htu31d.jpg,
+ MS8607, components/sensor/ms8607, ms8607.jpg
+
+ AGS10, components/sensor/ags10, ags10.jpg
+ VEML6030, components/sensor/veml7700, veml6030.jpg
+ VEML7700, components/sensor/veml7700, veml7700.jpg
+
+ MR24HPC1 mmWave, components/seeed_mr24hpc1, seeed-mr24hpc1.jpg
+
+ ADS1118, components/sensor/ads1118, ads1118.jpg
+
+ CST816, components/touchscreen/cst816, cst816.jpg
+ CST226, components/touchscreen/cst226, t4-s3.jpg
+
+ RPI_DPI_RGB, components/display/rpi_dpi_rgb, waveshare_touch-s3.jpg
+ Quad SPI AMOLED, components/display/qspi_amoled, t4-s3.jpg
+ ST7701S, components/display/st7701s, indicator.jpg
+
+ ADE7880, components/sensor/ade7880, ade7880.svg
+ Emmeti, components/climate/climate_ir, air-conditioner-ir.svg, dark-invert
+ Uponor Smatrix, components/uponor_smatrix, uponor.svg
+ Kamstrup KMP, components/sensor/kamstrup_kmp, kamstrup_kmp.jpg
+ Template Fan, components/fan/template, description.svg, dark-invert
+
+
+Dates
+-----
+
+ESPHome now has support for ``date`` entities that can be set from the frontend (like Home Assistant) for you to check against and execute
+automations in the future.
+
+ESPHome Dates require Home Assistant 2024.4 or later.
+
+
+IPv6
+----
+
+ESPHome is now prepared for the future! The future that is the old IPv6 that is.
+Dualstack is added and it could now have up to 5 ip addresses of any type, and communication with Home assistant,
+MQTT and NTP works with IPv6. ESPHome still depends on IPv4, but the crystal ball shows sign of IPv6-only networks.
+
+If you are building an :doc:`/components/external_components` or you use
+``network::get_ip_address()``, ``wifi::global_wifi_component->get_ip_address()`` or ``ethernet::global_eth_component->get_ip_address()``,
+these functions have been renamed to ``::get_ip_addresses()`` respectively and now return a list of all IP addresses.
+
+
+Release 2024.3.1 - March 27
+---------------------------
+
+- AHT10: Fix bug :esphomepr:`6409` by :ghuser:`clydebarrow`
+- microWakeWord: Fix model path joining :esphomepr:`6426` by :ghuser:`ebw44`
+- Don't compile strptime unless its required :esphomepr:`6424` by :ghuser:`gabest11`
+- Fix editor live validation :esphomepr:`6431` by :ghuser:`bdraco`
+
+Release 2024.3.2 - April 4
+--------------------------
+
+- Fix logger compile error on ESP32-C6 :esphomepr:`6323` by :ghuser:`DAVe3283`
+- Add missing ethernet types :esphomepr:`6444` by :ghuser:`ssieb`
+- fix: changing the content source when playing is paused blocks the player :esphomepr:`6454` by :ghuser:`NewoPL`
+
+Thank you for your support
+--------------------------
+
+We would like to thank all Home Assistant Cloud subscribers for their support. It allows `Nabu Casa ` - Experiencing problems flashing esphomelib firmwares using esphomeyaml?
+* ``esphomeflasher`` - Experiencing problems flashing esphomelib firmwares using esphomeyaml?
No problem, esphomeflasher is a tool designed to make that super easy. Just let esphomeyaml generate the binary and flash
from your PC.
* :doc:`Over-the-Air Updates ` have been completely re-written to make them a lot more
@@ -76,7 +76,7 @@ New Features
- esphomelib now has a new tool: `esphomeflasher `__ to simplify
flashing on Windows/MacOS machines **without having to install esphomeyaml**. So if esphomeyaml for some reason
- can't find your USB port, you now can use the esphomeflasher app. See :ref:`esphome-flasher`.
+ can't find your USB port, you now can use the esphomeflasher app. See ``esphomeflasher``.
- ESP8266s now save the states of lights/switches/... internally and restores them on boot.
Additionally, esphomelib can now operate in fully offline mode if your WiFi network goes down
diff --git a/components/alarm_control_panel/index.rst b/components/alarm_control_panel/index.rst
index 24610ace1..af178a8b1 100644
--- a/components/alarm_control_panel/index.rst
+++ b/components/alarm_control_panel/index.rst
@@ -44,6 +44,11 @@ Configuration variables:
when the alarm state changes to ``disarmed``. See :ref:`alarm_control_panel_on_disarmed_trigger`.
- **on_cleared** (*Optional*, :ref:`Action `): An automation to perform
when the alarm clears. See :ref:`alarm_control_panel_on_cleared_trigger`.
+- **on_ready** (*Optional*, :ref:`Action `): An automation to perform
+ when the logical 'and' of all the zone sensors change state. See :ref:`alarm_control_panel_on_ready_trigger`.
+- **on_chime** (*Optional*, :ref:`Action `): An automation to perform
+ when a zone has been marked as chime in the configuration, and it changes from closed to open.
+ See :ref:`alarm_control_panel_on_chime_trigger`.
Automation:
@@ -184,6 +189,39 @@ This trigger is activated when the alarm changes from to disarmed.
then:
- logger.log: "Alarm Disarmed!"
+.. _alarm_control_panel_on_ready_trigger:
+
+``on_ready`` Trigger
+********************
+
+This trigger is activated when the logical 'and' of all the alarm sensors change state. This is useful for implementing "alarm ready" LEDs.
+Once this trigger is called, you can get the ready state by calling get_all_sensors_ready() in a lambda block.
+
+.. code-block:: yaml
+
+ alarm_control_panel:
+ # ...
+ on_disarmed:
+ then:
+ - lambda: !lambda |-
+ ESP_LOGI("AlarmPanel", "Sensor ready change to: %s", ((id(acp1).get_all_sensors_ready()) ? (const char *) "True" : (const char *) "False"));
+
+.. _alarm_control_panel_on_chime_trigger:
+
+``on_chime`` Trigger
+********************
+
+This trigger is activated when a zone sensor marked with chime:true changes from closed to open. This is useful for implementing keypad chimes when a zone
+opens.
+
+.. code-block:: yaml
+
+ alarm_control_panel:
+ # ...
+ on_chime:
+ then:
+ - logger.log: "Alarm Chime!"
+
.. _alarm_control_panel_arm_away_action:
``arm_away`` Action
@@ -296,6 +334,7 @@ From :ref:`lambdas `, you can call the following methods:
- ``arm_home(code)``
- ``arm_night(code)``
- ``disarm(code)``
+- ``get_all_sensors_ready()``
.. code-block:: cpp
@@ -303,6 +342,7 @@ From :ref:`lambdas `, you can call the following methods:
id(acp1).arm_home();
id(acp1).arm_night();
id(acp1).disarm(std::string("1234"));
+ bool all_sensors_ready = id(acp1).get_all_sensors_ready();
Platforms
diff --git a/components/alarm_control_panel/template.rst b/components/alarm_control_panel/template.rst
index 71d214d46..35f80ad5c 100644
--- a/components/alarm_control_panel/template.rst
+++ b/components/alarm_control_panel/template.rst
@@ -27,8 +27,8 @@ Configuration variables:
- **codes** (*Optional*, list of string): A list of codes for disarming the alarm, if *requires_code_to_arm* set to true then for arming the alarm too.
- **requires_code_to_arm** (*Optional*, boolean): Code required for arming the alarm, *codes* must be provided.
- **arming_away_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to away mode. Defaults to ``0s``.
-- **arming_home_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to home mode.
-- **arming_night_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to night mode.
+- **arming_home_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to home mode.
+- **arming_night_time** (*Optional*, :ref:`config-time`): The exit delay before the alarm is armed to night mode.
- **pending_time** (*Optional*, :ref:`config-time`): The entry delay before the alarm is triggered. Defaults to ``0s``.
- **trigger_time** (*Optional*, :ref:`config-time`): The time after a triggered alarm before resetting to previous state if the sensors are cleared/off. Defaults to ``0s``.
- **binary_sensors** (*Optional*, *list*): A list of binary sensors the panel should use. Each consists of:
@@ -36,6 +36,8 @@ Configuration variables:
- **input** (**Required**, string): The id of the binary sensor component
- **bypass_armed_home** (*Optional*, boolean): This binary sensor will not trigger the alarm when in ``armed_home`` state.
- **bypass_armed_night** (*Optional*, boolean): This binary sensor will not trigger the alarm when in ``armed_night`` state.
+ - **trigger_mode** (*Optional*, string): Sets the trigger mode for this sensor. One of ``delayed``, ``instant``, or ``delayed_follower``. (``delayed`` is the default if not specified)
+ - **chime** (*Optional*, boolean): When set ``true``, the chime callback will be called whenever the sensor goes from closed to open. (``false`` is the default if not specified)
- **restore_mode** (*Optional*, enum):
@@ -46,9 +48,33 @@ Configuration variables:
.. note::
- If ``binary_sensors`` is ommited then you're expected to trigger the alarm using
+ If ``binary_sensors`` is omitted then you're expected to trigger the alarm using
:ref:`alarm_control_panel_pending_action` or :ref:`alarm_control_panel_triggered_action`.
+.. _template_alarm_control_panel-trigger_modes:
+
+Trigger Modes
+-------------
+
+Each binary sensor "zone" supports 3 trigger modes. The 3 trigger modes are:
+
+- delayed
+- instant
+- delayed_follower
+
+The ``delayed`` trigger mode is typically specified for exterior doors where entry is required to access an alarm keypad or other arm/disarm method. If the alarm panel is armed, and a zone set to ``delayed`` is "faulted" (i.e. the zone state is ``true``) the alarm state will change from the ``armed`` state to the ``pending`` state. During the ``pending`` state, the user has a preset time to disarm the alarm before it changes to the ``triggered`` state. This is the default trigger mode if not specified.
+
+The ``instant`` trigger mode is typically used for exterior zones (e.g. windows, and glass break detectors). If the alarm control panel is armed, a fault on this type of zone will cause the alarm to go from the ``armed`` state directly to the ``triggered`` state.
+
+The ``delayed_follower`` trigger mode is typically specifed for interior passive infared (PIR) or microwave sensors. One of two things happen when a ``delayed_follower`` zone is faulted:
+
+1. When the alarm panel is in the armed state, a fault on a zone with ``delayed_follower`` specified will cause the alarm control panel to go directly to the ``triggered`` state.
+
+2. When the alarm panel is in the pending state, a fault on a zone with ``delayed_follower`` specified will remain in the ``pending`` state.
+
+The ``delayed_follower`` trigger mode offers better protection if someone enters a premises via an unprotected window or door. If there is a PIR guarding the main hallway, it will cause an instant trigger of the alarm panel as someone
+entered the premises in a unusual manner. Likewise, if someone enters the premises though a door set to the ``delayed`` trigger mode, and then triggers the PIR, the alarm will stay in the ``pending`` state until either they disarm the alarm, or
+the pending timer expires.
.. _template_alarm_control_panel-state_flow:
@@ -63,18 +89,29 @@ State Flow:
3. When the alarm is tripped by a sensor state changing to ``on`` or ``alarm_control_panel_pending_action`` invoked
- a. ``pending_time`` greater than 0 the state is ``PENDING``
- b. ``pending_time`` is 0 or after the ``pending_time`` delay the state is ``TRIGGERED``
+ 1. If trigger_mode is set to ``delayed``:
+
+ 1. ``pending_time`` greater than 0 the state is ``PENDING``
+ 2. ``pending_time`` is 0 or after the ``pending_time`` delay the state is ``TRIGGERED``
+
+ 2. If trigger_mode is set to ``instant``:
+
+ 1. The state is set to ``TRIGGERED``
+
+ 3. If the trigger_mode is set to ``interior_follower``:
+
+ 1. If the current state is ``ARMED_...`` the state will be set to ``TRIGGERED``
+ 2. If the current state is ``PENDING`` then nothing will happen and it will stay in the ``PENDING`` state.
4. If ``trigger_time`` greater than 0 and no sensors are ``on`` after ``trigger_time`` delay
the state returns to ``ARM_...``
.. note::
- Although the interface supports all arming modes only ``away`` and ``home`` have been implemented for now.
+ Although the interface supports all arming modes only ``away``, ``home`` and ``night`` have been implemented for now.
``arm_...`` is for either ``arm_away`` or ``arm_home``
- ``arming_..._time`` is for either ``arming_away_time`` or ``arming_home_time``
- ``ARMED_...`` is for either ``ARMED_AWAY`` or ``ARMED_HOME``
+ ``arming_..._time`` is for either ``arming_away_time``, ``arming_home_time``, or ``arming_night_time``
+ ``ARMED_...`` is for either ``ARMED_AWAY``, ``ARMED_HOME``, or ``ARMED_NIGHT``
Example:
@@ -95,8 +132,16 @@ Example:
trigger_time: 5min
binary_sensors:
- input: zone_1
+ chime: true
+ trigger_mode: delayed
- input: zone_2
+ chime: true
+ trigger_mode: delayed
+ - input: zone_3
bypass_armed_home: true
+ trigger_mode: delayed_follower
+ - input: zone_4
+ trigger_mode: instant
- input: ha_test
on_state:
then:
@@ -108,6 +153,15 @@ Example:
on_cleared:
then:
- switch.turn_off: siren
+ on_ready:
+ then:
+ - lambda: !lambda |-
+ ESP_LOGD("TEST", "Sensor ready change to: %s",
+ (id(acp1).get_all_sensors_ready())) ? (const char *) "True" : (const char *) "False");
+ on_chime:
+ then:
+ - lambda: !lambda |-
+ ESP_LOGD("TEST", "Zone with chime mode set opened");
binary_sensor:
- platform: gpio
@@ -115,20 +169,36 @@ Example:
name: Zone 1
device_class: door
pin:
- number: D1
+ number: GPIOXX
mode: INPUT_PULLUP
inverted: True
- platform: gpio
id: zone_2
name: Zone 2
+ device_class: door
+ pin:
+ number: GPIOXX
+ mode: INPUT_PULLUP
+ inverted: True
+ - platform: gpio
+ id: zone_3
+ name: Zone 3
device_class: motion
pin:
- number: D2
+ number: GPIOXX
+ mode: INPUT_PULLUP
+ inverted: True
+ - platform: gpio
+ id: zone_4
+ name: Zone 4
+ device_class: door
+ pin:
+ number: GPIOXX
mode: INPUT_PULLUP
inverted: True
- platform: homeassistant
id: ha_test
- name: Zone 3
+ name: HA Test
entity_id: input_boolean.test_switch
switch:
@@ -136,7 +206,7 @@ Example:
id: siren
name: Siren
icon: mdi:alarm-bell
- pin: D7
+ pin: GPIOXX
See Also
diff --git a/components/api.rst b/components/api.rst
index cb1a48116..a6386a845 100644
--- a/components/api.rst
+++ b/components/api.rst
@@ -75,20 +75,35 @@ Configuration variables:
.. _api-actions:
-.. note::
-
- Before a newly added ESPHome device can interact with the Home Assistant API it needs to be allowed to communicate
- with it. This setting can be found in the ESPHome integration (NOT in the Add-On) by clicking "CONFIGURE" for
- that device and enabling the "Allow device to make service calls" option.
-
Actions
-------
+Before using any of the actions below, you'll need to tell Home Assistant to allow your device to
+make service calls.
+
+Open the ESPHome integration page on your Home Assistant instance:
+
+.. raw:: html
+
+ 
+
+Then:
+
+#. Fnd your device in the device list
+#. Click the "configure" button next to it
+#. Check the "Allow the device to make Home Assistant service calls" box
+#. Then click "submit".
+
.. _api-homeassistant_event_action:
``homeassistant.event`` Action
******************************
+.. note::
+
+ Be sure to :ref:`follow the instructions above ` to tell Home Assistant to allow
+ your device to make service calls.
+
When using the native API with Home Assistant, you can create events in the Home Assistant event bus
straight from ESPHome :ref:`Automations `.
@@ -117,6 +132,11 @@ Configuration variables:
``homeassistant.service`` Action
********************************
+.. note::
+
+ Be sure to :ref:`follow the instructions above ` to tell Home Assistant to allow
+ your device to make service calls.
+
When using the native API with Home Assistant, you can create Home Assistant service
calls straight from ESPHome :ref:`Automations `.
@@ -189,6 +209,11 @@ Then, in ESPHome:
``homeassistant.tag_scanned`` Action
************************************
+.. note::
+
+ Be sure to :ref:`follow the instructions above ` to tell Home Assistant to allow
+ your device to make service calls.
+
When using the native API with Home Assistant, you can push tag_scanned to Home Assistant
straight from ESPHome :ref:`Automations `.
diff --git a/components/at581x.rst b/components/at581x.rst
new file mode 100644
index 000000000..9513112a2
--- /dev/null
+++ b/components/at581x.rst
@@ -0,0 +1,183 @@
+AirTouch AT581x Radar
+=====================
+
+.. seo::
+ :description: Instructions for setting up AirTouch AT581x Radar
+ :image: at581x.png
+ :keywords: radar
+
+The `AirTouch AT581x radar `__
+(aka ``AT581x``) is a familly of 5.8GHz radar which can be used for human presence detection. It can detect tiny movements
+and compared to a PIR sensor **it can detect presence continuously**. This can be useful, for example, to turn
+the lights on when you enter a room, keep them on as long as you are there (without waving your hands at the
+sensor) and turn them off almost immediately after you leave the room.
+
+They are ultra-low power (as low as 40µA of current consumption) and are extremely simple to use, yet can be setup by I2C.
+It's installed in many low cost appliance, like the ESP32S3-BOX-3, and can be found by many different manufacturer or reference,
+like the MoreSense MS58-3909S68U4.
+
+It is possible to use this sensor with only a single GPIO pin; however, if you wish to change its settings,
+a :doc:`/components/i2c` component (and its requisite GPIO pins) is required in your device's configuration.
+
+.. figure:: ../images/at581x.png
+ :align: center
+ :width: 75%
+
+ AirTouch AT581x Radar / presence detection sensor
+
+.. code-block:: yaml
+
+ # Example configuration entry
+ at581x:
+ id: "Radar"
+ i2c_id: bus_a
+
+.. _at581x-component:
+
+Component/Hub
+-------------
+
+You need to have the hub component (``at581x:`` entry) defined to be able to change the sensor's
+settings, get it listed as an motion entity or being able to turn on/off the radio frequency emmission.
+A :doc:`/components/binary_sensor/gpio` alone could be sufficient if you only want
+to determine presence/occupancy. When you define ``at581x:`` you'll need to have a ``i2c:`` entry in
+your configuration with both the SDA and SCL pins defined.
+
+Multiple instances of this component may be defined if multiple :doc:`/components/i2c` components are available:
+
+.. code-block:: yaml
+
+ at581x:
+ - id: mmWave_1
+ i2c_id: bus_a
+ address: 0x28
+ - id: mmWave_2
+ i2c_id: bus_a
+ address: 0x29
+ ...
+
+Configuration variables:
+************************
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. Necessary if you want
+ to define multiple instances of this component.
+- **i2c_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :doc:`/components/i2c` if you want
+ to use multiple I2C buses.
+
+.. _at581x-binary_sensor:
+
+Binary Sensor
+-------------
+
+The state of the radar detection is available via its GPIO pin. It's required to use a GPIO binary sensor to monitor the motion status
+
+.. code-block:: yaml
+
+ binary_sensor:
+ - platform: gpio
+ name: "Human in front"
+ pin: GPIOXX
+
+Configuration variables:
+************************
+
+- Refer to other options from :ref:`Binary Sensor ` and :doc:`GPIO Binary Sensor `.
+
+.. _at581x-switch:
+
+Switch
+------
+
+:ref:`Switch components ` are used to enable/disable radio frequency hardware.
+
+.. code-block:: yaml
+
+ switch:
+ - platform: at581x
+ at581x_id: Radar
+ name: "Enable Radar"
+
+Configuration variables:
+************************
+
+- **at581x_id** (*Optional*, :ref:`config-id`): The ID of the AT581x component defined above.
+ Required when multiple instances of the ``at581x`` component are defined.
+- All other options from :ref:`Switch `.
+
+.. _at581x-actions:
+
+Actions
+-------
+
+.. _at581x-action_settings:
+
+``at581x.settings`` Action
+**************************
+
+.. warning::
+
+ The hardware frontend reset option is only required to reset the frontend in case it is struck, before sending the
+ new configuration. However, a frontend reset is always performed after changing the settings.
+
+The radar has several settings which can be changed. These settings are not saved in non-volatile memory
+and need to be set on each boot.
+
+The settings action allows changing of any number of the radar's internal parameters/settings. With this
+action, any unspecified parameters will remain unchanged.
+
+.. code-block:: yaml
+
+ on_...:
+ - at581x.settings:
+ id: "Waveradar"
+ hw_frontend_reset: false
+ frequency: 5800MHz
+ sensing_distance: 200 # 0-1023
+ poweron_selfcheck_time: 2000ms
+ protect_time: 1s
+ trigger_base: 500ms
+ trigger_keep: 10s
+ stage_gain: 3 # 0-12 the higher the value the smaller the gain
+ power_consumption: 70µA
+
+
+Configuration variables:
+````````````````````````
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID of the sensor on which settings should be
+ changed. If only one radar is defined, this is optional.
+- **hw_frontend_reset** (*Optional*, boolean): If set to true, a reset of the analog frontend will be performed before
+ changing other options. Ignored if not set or set to ``false``. Upon applying the settings a frontend reset
+ will be performed anyway, this is only useful if the sensor is not answering or locked up.
+- **frequency** (*Optional*, int): Any of the possible frequencies (5696, 5715, 5730, 5748, 5765, 5784, 5800, 5819, 5836, 5851, 5869, 5888) in MHz.
+- **sensing_distance** (*Optional*, int): A unitless number, in range 0-1023, specifying the maximum distance to detect motion
+- **poweron_selfcheck_time** (*Optional*, int): The delay to perform self check and calibration on power on. Recommanded not to change this
+- **protect_time** (*Optional*, int): The delay after an end-of-trigger event where the detection will not trigger anymore. Max 65535ms
+- **trigger_base** (*Optional*, int): The delay while a detection must be active to change the state of the sensor. Max 65535ms
+- **trigger_keep** (*Optional*, int): The delay that the output will stay high after a detection event. This is usually what you want to change.
+- **stage_gain** (*Optional*, int): The analog gain to use for threshold test. Any value in range 0-12, with 12 being the lowest gain and 0 the highest
+- **power_consumption** (*Optional*, int): Any of the possible power profile (48, 56, 63, 70, 77, 91, 105, 115, 40, 44, 47, 51, 54, 61, 68, 78) in µA
+
+
+``at581x.reset`` Action
+***********************
+
+Restart the sensor.
+
+.. code-block:: yaml
+
+ on_...:
+ at581x.reset:
+
+Configuration variables:
+````````````````````````
+
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID of the AT581x component. Useful when multiple instances of this component are defined.
+
+See Also
+--------
+- :ref:`I2C bus `
+- :ref:`Binary Sensor `
+- :doc:`GPIO Binary Sensor `
+- :ref:`config-id`
+- :ghedit:`Edit`
diff --git a/components/binary_sensor/ble_presence.rst b/components/binary_sensor/ble_presence.rst
index 8f744dbb5..b9fdd1f00 100644
--- a/components/binary_sensor/ble_presence.rst
+++ b/components/binary_sensor/ble_presence.rst
@@ -30,10 +30,15 @@ The ``ble_presence`` binary sensor platform lets you track the presence of a Blu
mac_address: AC:37:43:77:5F:4C
name: "ESP32 BLE Tracker Google Home Mini"
min_rssi: -80dB
+ # Presence based on Identity Resolving Key (IRK)
+ - platform: ble_presence
+ irk: 1234567890abcdef1234567890abcdef
+ name: "ESP32 BLE Tracker iPhone"
# Presence based on BLE Service UUID
- platform: ble_presence
service_uuid: '11aa'
name: "ESP32 BLE Tracker Test Service 16 bit"
+ timeout: 45s
# Presence based on iBeacon UUID
- platform: ble_presence
ibeacon_uuid: '68586f1e-89c2-11eb-8dcd-0242ac130003'
@@ -51,14 +56,17 @@ Configuration variables:
- **name** (**Required**, string): The name of the binary sensor.
- **mac_address** (*Optional*, MAC Address): The MAC address to track for this
- binary sensor. Note that exactly one of ``mac_address``, ``service_uuid`` or ``ibeacon_uuid``
+ binary sensor. Note that exactly one of ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid``
+ must be present.
+- **irk** (*Optional*, 16 byte hex string): The Identity Resolving Key (IRK) to track for this
+ binary sensor. Note that exactly one of ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid``
must be present.
- **service_uuid** (*Optional*, string): 16 bit, 32 bit, or 128 bit BLE Service UUID
which can be tracked if the device randomizes the MAC address. Note that exactly one of
- ``mac_address``, ``service_uuid`` or ``ibeacon_uuid`` must be present.
+ ``mac_address``, ``irk``, ``service_uuid`` or ``ibeacon_uuid`` must be present.
- **ibeacon_uuid** (*Optional*, string): The `universally unique identifier `__
to identify the beacon that needs to be tracked. Note that exactly one of ``mac_address``,
- ``service_uuid`` or ``ibeacon_uuid`` must be present.
+ ``irk``, ``service_uuid`` or ``ibeacon_uuid`` must be present.
- **ibeacon_major** (*Optional*, int): The iBeacon major identifier of the beacon that needs
to be tracked. Usually used to group beacons, for example for grouping all beacons in the
same building.
@@ -66,7 +74,9 @@ Configuration variables:
to be tracked. Usually used to identify beacons within an iBeacon group.
- **id** (*Optional*, :ref:`config-id`): Manually specify
the ID used for code generation.
-- **min_rssi** (*Optional*, int): at which minimum RSSI level would the component report the device be precent
+- **min_rssi** (*Optional*, int): at which minimum RSSI level would the component report the device be present.
+- **timeout** (*Optional*, :ref:`config-time`): The delay after last detecting the device before publishing not present state.
+ The default is 5 minutes.
- All other options from :ref:`Binary Sensor `.
.. _esp32_ble_tracker-setting_up_devices:
@@ -105,8 +115,15 @@ iBeacon major and minor identifiers, BLE manufacturer data, RSSI and other data
debugging purposes. Note that this is useful only during set-up and a less verbose log level
should be specified afterwards.
-Please note that devices that show a ``RANDOM`` address type in the logs cannot be used for
-MAC address based tracking, since their MAC-address periodically changes. Instead you can:
+Please note that devices that show a ``RANDOM`` address type in the logs probably use a privacy
+feature called Resolvable Private Addresses to avoid BLE tracking. Since their MAC-address periodically
+changes, they can't be tracked by the MAC address. However, if you know the devices "Identity Resolving
+Key" (IRK), you can check if the generated private MAC address belongs to the device with the IRK.
+
+There is no support to obtain the key with ESPHome. For now you will have to use one of the options
+described in the ESPresense project: https://espresense.com/beacons
+
+Alternatively you can:
- Create a BLE beacon, set a unique 16 bit, 32 bit or 128 bit Service UUID and track your device
based on that. Make sure you don't pick a `GATT Service UUID
diff --git a/components/binary_sensor/cap1188.rst b/components/binary_sensor/cap1188.rst
index 0cc7a5113..016720311 100644
--- a/components/binary_sensor/cap1188.rst
+++ b/components/binary_sensor/cap1188.rst
@@ -30,7 +30,7 @@ required to be set up in your configuration for this sensor to work.
cap1188:
id: cap1188_component
address: 0x29
- reset_pin: 14
+ reset_pin: GPIOXX
touch_threshold: 0x40
allow_multiple_touches: true
diff --git a/components/binary_sensor/custom.rst b/components/binary_sensor/custom.rst
index d2ee55fdc..f983584cb 100644
--- a/components/binary_sensor/custom.rst
+++ b/components/binary_sensor/custom.rst
@@ -1,22 +1,28 @@
Custom Binary Sensor
====================
+.. seo::
+ :description: Instructions for setting up Custom C++ binary sensors with ESPHome.
+ :image: language-cpp.svg
+ :keywords: C++, Custom
+
.. warning::
- Custom components are deprecated, not recommended for new configurations
- and will be removed from ESPHome in a future release.
- Please look at creating a real ESPHome component and "importing" it into your
- configuration with :doc:`/components/external_components`.
+ Custom components are deprecated, not recommended for new configurations and will be removed from ESPHome in a
+ future release. Please look at creating a real ESPHome component and "importing" it into your configuration with
+ :doc:`/components/external_components`.
- You can find some basic documentation on creating your own components
- at :ref:`contributing_to_esphome`.
+ You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
-This integration can be used to create custom binary sensors in ESPHome
-using the C++ (Arduino) API.
+.. warning::
-Please first read :doc:`/components/sensor/custom` guide,
-the same principles apply here and binary sensors are very similar
-to sensors internally.
+ While we try to keep the ESPHome YAML configuration options as stable as possible, the ESPHome API is less
+ stable. If something in the APIs needs to be changed in order for something else to work, we will do so.
+
+This component can be used to create custom binary sensors in ESPHome using the C++ (Arduino) API.
+
+Please first read :doc:`/components/sensor/custom` guide, the same principles apply here and binary
+sensors are very similar to sensors internally.
The example below is an example of a custom binary sensor; this custom sensor is essentially the
same as the gpio binary sensor.
diff --git a/components/binary_sensor/esp32_touch.rst b/components/binary_sensor/esp32_touch.rst
index e5bbcd2ed..7c6bc25f3 100644
--- a/components/binary_sensor/esp32_touch.rst
+++ b/components/binary_sensor/esp32_touch.rst
@@ -130,8 +130,8 @@ an ``OFF`` state.
binary_sensor:
- platform: esp32_touch
- name: "ESP32 Touch Pad GPIO27"
- pin: GPIO27
+ name: "ESP32 Touch Pad"
+ pin: GPIOXX
threshold: 1000
Configuration variables:
@@ -149,6 +149,35 @@ Configuration variables:
wake-up from a touch event. Note that no filter(s) is/are active during deep sleep.
- All other options from :ref:`Binary Sensor `.
+
+Raw Values
+----------
+
+If access to the raw values is required, a template sensor can be created that polls for them:
+
+.. code-block:: yaml
+
+ # Example configuration entry for accessing raw values
+ esp32_touch:
+ id: esp32_touch_1
+
+ binary_sensor:
+ - platform: esp32_touch
+ id: esp32_touch_pad
+ pin: GPIOXX
+ threshold: 0
+
+ sensor:
+ - platform: template
+ name: "Raw touch value"
+ lambda: |-
+ return id(esp32_touch_pad).get_value();
+ update_interval: 3s
+
+One example of use is a wide area pressure sensor that integrates a number of smaller sensors in an area. Make two strips
+of aluminium foil that sandwich paper, and connect one wire to a touch pin and the other to ground. Set up several sensors
+under a flexible object like a plastic mat, add the raw values, and apply a threshold.
+
.. _esp32-touch-pad-pins:
Touch Pad Pins
diff --git a/components/binary_sensor/haier.rst b/components/binary_sensor/haier.rst
new file mode 100644
index 000000000..69a581bde
--- /dev/null
+++ b/components/binary_sensor/haier.rst
@@ -0,0 +1,68 @@
+Haier Climate Binary Sensors
+============================
+
+.. seo::
+ :description: Instructions for setting up additional binary sensors for Haier climate devices.
+ :image: haier.svg
+
+Additional sensors for Haier Climate device. **These sensors are supported only by the hOn protocol**.
+
+
+.. figure:: images/haier-climate.jpg
+ :align: center
+ :width: 50.0%
+
+.. code-block:: yaml
+
+ # Example configuration entry
+ uart:
+ baud_rate: 9600
+ tx_pin: GPIOXX
+ rx_pin: GPIOXX
+ id: ac_port
+
+ climate:
+ - platform: haier
+ id: haier_ac
+ protocol: hOn
+ name: Haier AC
+ uart_id: ac_port
+
+ binary_sensor:
+ - platform: haier
+ haier_id: haier_ac
+ compressor_status:
+ name: Haier Outdoor Compressor Status
+ defrost_status:
+ name: Haier Defrost Status
+ four_way_valve_status:
+ name: Haier Four Way Valve Status
+ indoor_electric_heating_status:
+ name: Haier Indoor Electric Heating Status
+ indoor_fan_status:
+ name: Haier Indoor Fan Status
+ outdoor_fan_status:
+ name: Haier Outdoor Fan Status
+
+Configuration variables:
+------------------------
+
+- **haier_id** (**Required**, :ref:`config-id`): The id of haier climate component
+- **compressor_status** (*Optional*): A binary sensor that indicates Haier climate compressor activity.
+ All options from :ref:`Binary Sensor `.
+- **defrost_status** (*Optional*): A binary sensor that indicates defrost procedure activity.
+ All options from :ref:`Binary Sensor `.
+- **four_way_valve_status** (*Optional*): A binary sensor that indicates four way valve status.
+ All options from :ref:`Binary Sensor `.
+- **indoor_electric_heating_status** (*Optional*): A binary sensor that indicates electrical heating system activity.
+ All options from :ref:`Binary Sensor `.
+- **indoor_fan_status** (*Optional*): A binary sensor that indicates indoor fan activity.
+ All options from :ref:`Binary Sensor `.
+- **outdoor_fan_status** (*Optional*): A binary sensor that indicates outdoor fan activity.
+ All options from :ref:`Binary Sensor `.
+
+See Also
+--------
+
+- :doc:`Haier Climate `
+- :ghedit:`Edit`
diff --git a/components/binary_sensor/homeassistant.rst b/components/binary_sensor/homeassistant.rst
index f98924abd..2628c5d58 100644
--- a/components/binary_sensor/homeassistant.rst
+++ b/components/binary_sensor/homeassistant.rst
@@ -34,7 +34,6 @@ Configuration variables:
- **entity_id** (**Required**, string): The entity ID to import from Home Assistant.
- **attribute** (*Optional*, string): The name of the state attribute to import from the
specified entity. The entity state is used when this option is omitted.
- Requires Home Assistant 2021.6 or newer.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor `.
diff --git a/components/binary_sensor/hydreon_rgxx.rst b/components/binary_sensor/hydreon_rgxx.rst
index 844b9a0ca..47a5b7dba 100644
--- a/components/binary_sensor/hydreon_rgxx.rst
+++ b/components/binary_sensor/hydreon_rgxx.rst
@@ -12,12 +12,6 @@ For this sensor to work, a :doc:`/components/sensor/hydreon_rgxx` must be set up
.. code-block:: yaml
# Example RG-9 entry
-
- uart:
- rx_pin: GPIO16
- tx_pin: GPIO17
- baud_rate: 9600
-
sensor:
- platform: hydreon_rgxx
model: "RG_9"
diff --git a/components/binary_sensor/images/haier-climate.jpg b/components/binary_sensor/images/haier-climate.jpg
new file mode 100644
index 000000000..a6b738a98
Binary files /dev/null and b/components/binary_sensor/images/haier-climate.jpg differ
diff --git a/components/binary_sensor/index.rst b/components/binary_sensor/index.rst
index cd6611fb2..7cab5120d 100644
--- a/components/binary_sensor/index.rst
+++ b/components/binary_sensor/index.rst
@@ -35,7 +35,7 @@ Configuration variables:
you want the binary sensor to use that name, you can set ``name: None``.
- **device_class** (*Optional*, string): The device class for the
- sensor. See https://developers.home-assistant.io/docs/core/entity/binary-sensor/#available-device-classes
+ sensor. See https://www.home-assistant.io/integrations/binary_sensor/#device-class
for a list of available options.
- **icon** (*Optional*, icon): Manually set the icon to use for the binary sensor in the frontend.
- **filters** (*Optional*, list): A list of filters to apply on the binary sensor values such as
@@ -66,12 +66,12 @@ Advanced options:
a ``name`` will implicitly set this to true.
- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
(usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
- Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+ Defaults to ``false``.
- **publish_initial_state** (*Optional*, boolean): If true, then the sensor will publish its initial state at boot or when
HA first connects, depending on the platform. This means that any applicable triggers will be run. Defaults to ``false``.
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
- for a list of available options. Requires Home Assistant 2021.11 or newer.
+ for a list of available options.
Set to ``""`` to remove the default entity category.
- If MQTT enabled, all other options from :ref:`MQTT Component `.
@@ -208,6 +208,16 @@ Specify any :ref:`lambda ` for more complex filters. The input va
the binary sensor is ``x`` and you can return ``true`` for ON, ``false`` for OFF, and ``{}`` to stop
the filter chain.
+``settle``
+**********
+
+(**Required**, time, :ref:`templatable `): When a signal is received, publish the state
+but wait for the received state to remain the same for specified time period before publishing any
+additional state changes. This filter complements the ``delayed_on_off`` filter but publishes value changes at
+the beginning of the delay period.
+When using a lambda call, you should return the delay value in milliseconds.
+**Useful for debouncing binary switches**.
+
Binary Sensor Automation
------------------------
diff --git a/components/binary_sensor/modbus_controller.rst b/components/binary_sensor/modbus_controller.rst
index 1c0b83197..8e8ecea77 100644
--- a/components/binary_sensor/modbus_controller.rst
+++ b/components/binary_sensor/modbus_controller.rst
@@ -16,26 +16,25 @@ Configuration variables:
- **name** (**Required**, string): The name of the sensor.
- **register_type** (**Required**): type of the modbus register.
- - ``coil``: Function 01 (01hex) Read Coils - Reads the ON/OFF status of discrete coils in the device.
- - ``discrete_input``: Function 02(02hex) - Reads the ON/OFF status of discrete inputs in the device.
- - ``holding``: Function 03 (03hex) Read Holding Registers - Read the binary contents of holding registers in the device.
- - ``read``: Function 04 (04hex) Read Input Registers - Read the binary contents of input registers in the device.
+ - ``coil``: Coils are 1-bit registers (ON/OFF values) that are used to control discrete outputs. Read and Write access. Modbus *Function Code 1 (Read Coil Status)* will be used.
+ - ``discrete_input``: discrete input register (read only coil) are similar to coils but can only be read. Modbus *Function Code 2 (Read Input Status)* will be used.
+ - ``holding``: Holding Registers - Holding registers are the most universal 16-bit register. Read and Write access. Modbus *Function Code 3 (Read Holding Registers)* will be used.
+ - ``read``: Read Input Registers - registers are 16-bit registers used for input, and may only be read. Modbus *Function Code 4 (Read Input Registers)* will be used.
-- **address** (**Required**, int): start address of the first register in a range
-- **bitmask** (*Optional*, int): Some values are packed in a response. The bitmask is used to determined if the result is true or false
-- **skip_updates** (*Optional*, int): By default all sensors of a modbus_controller are updated together. For data points that don't change very frequently updates can be skipped. A value of 5 would only update this sensor range in every 5th update cycle
+- **address** (**Required**, int): start address of the first register in a range (can be decimal or hexadecimal).
+- **bitmask** (*Optional*, int): sometimes multiple values are packed in a single register's response. The bitmask is used to determined if the result is true or false. See :ref:`bitmasks`.
+- **skip_updates** (*Optional*, int): By default all sensors of a modbus_controller are updated together. For data points that don't change very frequently updates can be skipped. A value of 5 would only update this sensor range in every 5th update cycle. Note: The modbus_controller groups components by address ranges to reduce number of transactions. All components with the same starting address will be updated in one request. ``skip_updates`` applies for *all* components in the same range.
+- **register_count** (*Optional*, int): The number of consecutive registers this read request should span or skip in a single command. Default is 1. See :ref:`modbus_register_count` for more details.
- **response_size** (*Optional*, int): Size of the response for the register in bytes. Defaults to register_count*2.
- **force_new_range** (*Optional*, boolean): If possible sensors with sequential addresses are grouped together and requested in one range. Setting ``force_new_range: true`` enforces the start of a new range at that address.
- **custom_command** (*Optional*, list of bytes): raw bytes for modbus command. This allows using non-standard commands. If ``custom_command`` is used ``address`` and ``register_type`` can't be used.
- custom data must contain all required bytes including the modbus device address. The crc is automatically calculated and appended to the command.
- See :ref:`modbus_custom_command` how to use ``custom_command``
+ Custom data must contain all required bytes including the modbus device address. The CRC is automatically calculated and appended to the command.
+ See :ref:`modbus_custom_command` how to use ``custom_command``.
- **lambda** (*Optional*, :ref:`lambda `):
- Lambda to be evaluated every update interval to get the new value of the sensor
-
- Parameters
+ Lambda to be evaluated every update interval to get the new value of the sensor. Parameters:
- **x** (bool): The parsed float value of the modbus data
- - **data** (std::vector): vector containing the complete raw modbus response bytes for this sensor
- **item** (const pointer to a ModbusBinarySensor object): The sensor object itself.
Possible return values for the lambda:
@@ -43,21 +42,19 @@ Configuration variables:
- ``return true/false;`` the new value for the sensor.
-- **offset** (*Optional*, int): not required for most cases
- offset from start address in bytes. If more than one register is read a modbus read registers command this value is used to find the start of this datapoint relative to start address. The component calculates the size of the range based on offset and size of the value type
- The value for offset depends on the register type. If a binary_sensor is created from an input register the offset is in bytes. For coil and discrete input resisters the LSB of the first data byte contains the coil addressed in the request. The other coils follow toward the high-order end of this byte and from low order to high order in subsequent bytes. For the registers offset is the position of the relevant bit.
- To get the value of the coil register 2 can be retrieved using address: 2 / offset: 0 or address: 0 / offset 2
+ - **offset** (*Optional*, int): Offset from start address in bytes (only required for uncommon response encodings). If more than one register is written in a command, this value is used to find the start of this datapoint relative to the start address. The component calculates the size of the range based on offset and size of the value type. The value for offset depends on the register type. If a binary_sensor is created from an input register, the offset is in bytes. For coil and discrete input resisters, the LSB of the first data byte contains the coil addressed in the request. The other coils follow toward the high-order end of this byte and from low order to high order in subsequent bytes. For registers, the offset is the position of the relevant bit. To get the value of the coil register, 2 can be retrieved using ``address: 2`` / ``offset: 0`` or ``address: 0`` / ``offset 2``.
+- All other options from :ref:`Binary Sensor `.
-Example
+Example:
+--------
.. code-block:: yaml
binary_sensor:
- platform: modbus_controller
- modbus_controller_id: epever
- id: battery_internal_resistance_abnormal
- name: "Battery internal resistance abnormal"
+ modbus_controller_id: modbus1
+ name: "Error status"
register_type: read
address: 0x3200
bitmask: 0x80 #(bit 8)
@@ -65,11 +62,14 @@ Example
See Also
--------
-- :apiclass:`:modbus_controller::ModbusBinarySensor`
+- :doc:`/components/modbus`
- :doc:`/components/modbus_controller`
-- :doc:`/components/switch/modbus_controller`
-- :doc:`/components/output/modbus_controller`
- :doc:`/components/sensor/modbus_controller`
+- :doc:`/components/output/modbus_controller`
+- :doc:`/components/switch/modbus_controller`
+- :doc:`/components/number/modbus_controller`
+- :doc:`/components/select/modbus_controller`
- :doc:`/components/text_sensor/modbus_controller`
- https://www.modbustools.com/modbus.html
+- :apiclass:`:modbus_controller::ModbusBinarySensor`
- :ghedit:`Edit`
diff --git a/components/binary_sensor/nfc.rst b/components/binary_sensor/nfc.rst
new file mode 100644
index 000000000..9c41f9520
--- /dev/null
+++ b/components/binary_sensor/nfc.rst
@@ -0,0 +1,90 @@
+NFC Binary Sensor
+=================
+
+.. seo::
+ :description: Instructions for setting up a NFC binary sensor in ESPHome
+ :image: nfc.png
+ :keywords: PN532, PN7150, PN7160, NFC
+
+.. _nfc-platform:
+
+The ``nfc`` binary sensor platform provides an easy way for you to determine if an NFC tag is presented to the reader.
+The tag may be identified in one of three ways:
+
+- By given unique ID (``uid``) -- for example ``74-10-37-94``
+- By a given NDEF tag "name", or...
+- By a given string contained in the tag's NDEF message/data
+
+Note that this platform is currently supported by the :doc:`PN7150 <../pn7150>` and :doc:`PN716x <../pn7160>` only;
+one of these components must be present in your device's configuration in order to use it.
+
+.. code-block:: yaml
+
+ # Example configuration entries
+ binary_sensor:
+ - platform: nfc
+ ndef_contains: pulse
+ name: "NFC 1 Tag"
+ - platform: nfc
+ tag_id: pulsed
+ name: "NFC 2 Tag"
+ - platform: nfc
+ uid: 74-10-37-94
+ name: "MFC Tag"
+
+Configuration variables:
+------------------------
+
+- **ndef_contains** (*Optional*, string): A (sub)string that must appear in the tag's NDEF message. May not be used
+ with ``tag_id`` and/or ``uid`` (below).
+- **tag_id** (*Optional*, string): A string that identifies the tag; in effect, its name. Specifically, this looks
+ for the Home Assistant URI encoded into one of the tag's NDEF records and then looks for this specific string. May
+ not be used with ``ndef_contains`` and/or ``uid``.
+- **uid** (*Optional*, string): The unique ID of the NFC tag. This is a hyphen-separated list of hexadecimal values.
+ For example: ``74-10-37-94``. May not be used with ``ndef_contains`` and/or ``tag_id`` (above).
+- All other options from :ref:`Binary Sensor `.
+
+.. _nfc-setting_up_tags:
+
+Setting Up Tags
+---------------
+
+To set up a binary sensor for a given NFC tag, you must first know either its unique ID (``uid``), tag ID (if it was
+prepared using the Home Assistant Companion app) or (part of) a string that is contained within its NDEF message.
+
+To obtain a tag's UID:
+
+- Set up a simple NFC component (such as the :doc:`PN532 `, :doc:`PN7150 <../pn7150>` or :doc:`PN716x <../pn7160>`)
+ configuration without any binary sensors.
+- Approach the NFC reader with an NFC tag. When the tag is sufficiently close to the reader, you'll see a message in the
+ ESPHome device's logs similar to this:
+
+ .. code::
+
+ Read tag type Mifare Classic with UID 1C-E5-E7-A6
+
+- Either:
+
+ - Copy this ID and use it to create a ``binary_sensor`` entry as shown in the configuration example above, or...
+ - Use the tag ID (as determined when it was prepared with the Home Assistant Companion app) to define the ``tag_id``
+ parameter for the ``binary_sensor`` as shown above, or...
+ - Choose a substring contained within the tag's NDEF message and use this to define the ``ndef_contains`` parameter
+ as shown in the example above. If present, the tag's NDEF records will appear in the log on the lines just below
+ the message shown above.
+
+Repeat this process for each tag.
+
+Note that, since *you* are able to define the NDEF message, this approach is more flexible and even allows multiple
+cards/tags to share the same message.
+
+See Also
+--------
+
+- :doc:`index`
+- :doc:`pn532`
+- :doc:`../pn7150`
+- :doc:`../pn7160`
+- :apiref:`pn532/pn532.h`
+- :apiref:`pn7150/pn7150.h`
+- :apiref:`pn7160/pn7160.h`
+- :ghedit:`Edit`
diff --git a/components/binary_sensor/rc522.rst b/components/binary_sensor/rc522.rst
index 48e60e643..1c89732b1 100644
--- a/components/binary_sensor/rc522.rst
+++ b/components/binary_sensor/rc522.rst
@@ -42,7 +42,7 @@ you can then create individual binary sensors that track if an NFC/RFID tag is c
spi:
rc522_spi:
- cs_pin: GPIO15
+ cs_pin: GPIOXX
binary_sensor:
- platform: rc522
diff --git a/components/ble_client.rst b/components/ble_client.rst
index a14cdf5a8..98697f840 100644
--- a/components/ble_client.rst
+++ b/components/ble_client.rst
@@ -38,11 +38,13 @@ to discover available client devices.
ble_client:
- mac_address: FF:FF:20:00:0F:15
id: itag_black
+ auto_connect: true
Configuration variables:
------------------------
- **mac_address** (**Required**, MAC Address): The MAC address of the BLE device to connect to.
+- **auto_connect** (*Optional*, boolean): If true the device will be automatically connected when found by the :doc:`/components/esp32_ble_tracker`. Defaults to true.
- **id** (**Required**, :ref:`config-id`): The ID to use for code generation, and for reference by dependent components.
Automations:
@@ -153,6 +155,57 @@ This automation is triggered when a numeric comparison is requested by the BLE d
id: ble_itag
accept: True
+.. _ble_client-connect_action:
+
+``ble_client.connect`` Action
+-----------------------------
+
+This action is useful only for devices with ``auto_connect: false`` and allows a connection to be made from
+within an automation. Once connected other actions like ``ble_write`` can be used. This is useful where
+a BLE server needs only to be interacted with occasionally, and thus does not need a constant
+connection held.
+
+The following example updates the time of a Xiaomi MHO-C303 clock once per hour. Note that the BLE tracker must
+be stopped during the connect attempt, and restarted afterwards. This would not be necessary if the tracker had
+``continuous: false`` set. In this example scenario there is another BLE device that does require the scanner to be
+on, hence the stop and start of the scan during connect.
+
+.. code-block:: yaml
+
+ ble_client:
+ - id: ble_clock
+ mac_address: 17:75:BC:F2:94:4D
+ auto_connect: false
+ - id: other_device
+ mac_address: 0D:33:12:66:00:D4
+
+ interval:
+ - interval: 60min
+ then:
+ - esp32_ble_tracker.stop_scan:
+ - ble_client.connect: ble_clock
+ - ble_client.ble_write:
+ id: ble_clock
+ service_uuid: EBE0CCB0-7A0A-4B0C-8A1A-6FF2997DA3A6
+ characteristic_uuid: EBE0CCB7-7A0A-4B0C-8A1A-6FF2997DA3A6
+ value: !lambda |-
+ uint32_t t = id(sntp_time).now().timestamp + ESPTime::timezone_offset();
+ return {(uint8_t)t, (uint8_t)(t >> 8), (uint8_t)(t >> 16), (uint8_t)(t >> 24), 0};
+ - ble_client.disconnect: ble_clock
+ - esp32_ble_tracker.start_scan:
+
+Any actions after the ``connect`` action will proceed only after the connect succeeds. If the connect
+fails the subsequent actions in the automation block will *not* be executed. This should be considered
+if scanning has been stopped - another mechanism may be required to restart it.
+
+.. _ble_client-disconnect_action:
+
+``ble_client.disconnect`` Action
+--------------------------------
+
+This action disconnects a device that was connected with the ``ble_client.connect`` action.
+Execution of the automation block sequence resumes after the disconnect has completed.
+
.. _ble_client-ble_write_action:
``ble_client.ble_write`` Action
@@ -161,6 +214,8 @@ This automation is triggered when a numeric comparison is requested by the BLE d
This action triggers a write to a specified BLE characteristic. The write is attempted in
a best-effort fashion and will only succeed if the ``ble_client``'s connection has been
established and the peripheral exposes the expected BLE service and characteristic.
+Execution of the automation block sequence resumes after the write has completed. A write failure will *not*
+stop execution of succeeding actions (this allows a disconnect to be executed, for example.)
Example usage:
diff --git a/components/bluetooth_proxy.rst b/components/bluetooth_proxy.rst
index 8703f113a..10c38bb32 100644
--- a/components/bluetooth_proxy.rst
+++ b/components/bluetooth_proxy.rst
@@ -11,7 +11,7 @@ Integration in Home Assistant which automatically aggregates all ESPHome Bluetoo
Adapters you might have. This exceptional feature offers fault tolerant connection between the Bluetooth devices
and Home Assistant.
-Note that while ths component is named ``bluetooth_proxy``, only BLE devices (and their Home Assistant integrations)
+Note that while this component is named ``bluetooth_proxy``, only BLE devices (and their Home Assistant integrations)
are supported.
If you're looking to create an ESPHome node that is just a Bluetooth Proxy, see
@@ -32,7 +32,7 @@ our `Bluetooth Proxy installer ` | ``daikin_arc`` | yes |
++---------------------------------------+---------------------+----------------------+
| :ref:`Daikin BRC` | ``daikin_brc`` | yes |
+---------------------------------------+---------------------+----------------------+
| :ref:`Delonghi` | ``delonghi`` | yes |
+---------------------------------------+---------------------+----------------------+
+| Emmeti | ``emmeti`` | yes |
++---------------------------------------+---------------------+----------------------+
| Fujitsu General | ``fujitsu_general`` | yes |
+---------------------------------------+---------------------+----------------------+
| :ref:`GREE` | ``gree`` | |
@@ -42,7 +46,7 @@ submit a feature request (see FAQ).
+---------------------------------------+---------------------+----------------------+
| Midea | ``midea_ir`` | yes |
+---------------------------------------+---------------------+----------------------+
-| Mitsubishi | ``mitsubishi`` | |
+| :ref:`Mitsubishi` | ``mitsubishi`` | yes |
+---------------------------------------+---------------------+----------------------+
| Noblex | ``noblex`` | yes |
+---------------------------------------+---------------------+----------------------+
@@ -72,7 +76,7 @@ controller unit.
# Example configuration entry
remote_transmitter:
- pin: GPIO32
+ pin: GPIOXX
carrier_duty_percent: 50%
climate:
@@ -152,7 +156,7 @@ IR receiver.
remote_receiver:
id: rcvr
pin:
- number: GPIO14
+ number: GPIOXX
inverted: true
mode:
input: true
@@ -220,6 +224,21 @@ Configuration variables:
header_high: 3265us # AC Units from LG in Brazil, for example use these timings
header_low: 9856us
+.. _daikin_arc:
+
+``daikin_arc`` Climate
+-------------------------
+
+The Daikin ARC remotes are used by the japanese model of Daikin.
+
+.. code-block:: yaml
+
+ # Example configuration entry
+ climate:
+ - platform: daikin_arc
+ name: "AC"
+ sensor: room_temperature
+
.. _daikin_brc:
``daikin_brc`` Climate
@@ -253,6 +272,48 @@ Known working with:
- Delonghi PAC WE 120HP
+.. _mitsubishi:
+
+``mitsubishi`` Climate
+------------------------
+
+Additonal configurations available for this platform.
+
+Configuration variables:
+
+- **set_fan_mode** (*Optional*, string): Select the fan modes desired or that are supported on your remote. Defaults to ``3levels``
+
+ - Options are: ``3levels`` , ``4levels``, ``quiet_4levels``.
+
+ - ``3levels``; Low [fan speed 1], Medium [2], High [3]
+ - ``4levels``; Low [1], Middle [2], Medium [3], High [4]
+ - ``quiet_4levels``; Low [1], Middle [2], Medium [3], High [4], Quiet [5]
+
+- **supports_dry** (*Optional*, boolean): Enables setting dry mode for this unit. Defaults to ``false``.
+- **supports_fan_only** (*Optional*, boolean): Enables setting fan only mode for this unit. Confirm that mode is supported on your remote. Defaults to ``false``.
+
+- **horizontal_default** (*Optional*, string): What to default to when the AC unit's horizontal direction is *not* set to swing. Defaults to ``middle``.
+
+ - Options are: ``left``, ``middle-left``, ``middle``, ``middle-right``, ``right``, ``auto``
+- **vertical_default** (*Optional*, string): What to default to when the AC unit's vertical direction is *not* set to swing. Defaults to ``middle``.
+
+ - Options are: ``down``, ``middle-down``, ``middle``, ``middle-up``, ``up``, ``auto``
+
+.. note::
+
+ - This climate IR component is also known to work with some Stiebel Eltron Units. It has been tested with Stiebel Eltron IR-Remote ``KM07F`` and unit ``ACW 25 i``
+
+.. code-block:: yaml
+
+ # Example configuration entry
+ climate:
+ - platform: mitsubishi
+ name: "Heatpump"
+ set_fan_mode: "quiet_4levels"
+ supports_dry: "true"
+ supports_fan_only: "true"
+ horizontal_default: "left"
+ vertical_default: "down"
.. _toshiba:
@@ -284,7 +345,7 @@ Configuration variables:
``update_interval`` must be less than seven minutes or the ``RAC-PT1411HWRU`` will revert to using its own
internal temperature sensor; a value of 30 seconds seems to work well. See :doc:`/components/sensor/index`
for more information.
-
+
- This climate IR component is also known to work with Midea model MAP14HS1TBL and may work with other similar
models, as well. (Midea acquired Toshiba's product line and re-branded it.)
@@ -362,8 +423,8 @@ Configuration variables:
``zhlt01`` Climate
---------------------
-ZH/LT-01 is a remote control that is used with many locally branded split airconditioners.
-Supported brands include:
+ZH/LT-01 is a remote control that is used with many locally branded split airconditioners.
+Supported brands include:
- Eurom
- Chigo
diff --git a/components/climate/custom.rst b/components/climate/custom.rst
index e4d86f19e..1544fa9f1 100644
--- a/components/climate/custom.rst
+++ b/components/climate/custom.rst
@@ -1,21 +1,27 @@
Custom Climate
==============
+.. seo::
+ :description: Instructions for setting up Custom C++ climate components with ESPHome.
+ :image: language-cpp.svg
+ :keywords: C++, Custom
+
.. warning::
- Custom components are deprecated, not recommended for new configurations
- and will be removed from ESPHome in a future release.
- Please look at creating a real ESPHome component and "importing" it into your
- configuration with :doc:`/components/external_components`.
+ Custom components are deprecated, not recommended for new configurations and will be removed from ESPHome in a
+ future release. Please look at creating a real ESPHome component and "importing" it into your configuration with
+ :doc:`/components/external_components`.
- You can find some basic documentation on creating your own components
- at :ref:`contributing_to_esphome`.
+ You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
-This integration can be used to create custom climate devices in ESPHome
-using the C++ (Arduino) API.
+.. warning::
-Please first read :doc:`/components/sensor/custom` guide,
-the same principles apply here.
+ While we try to keep the ESPHome YAML configuration options as stable as possible, the ESPHome API is less
+ stable. If something in the APIs needs to be changed in order for something else to work, we will do so.
+
+This component can be used to create custom climate devices in ESPHome using the C++ (Arduino) API.
+
+Please first read :doc:`/components/sensor/custom` guide, the same principles apply here.
The example below is an example of a custom climate device - all climate devices must override
two methods (:apiclass:`Climate `):
diff --git a/components/climate/haier.rst b/components/climate/haier.rst
index 9f818f100..843ecfa0b 100644
--- a/components/climate/haier.rst
+++ b/components/climate/haier.rst
@@ -2,14 +2,14 @@ Haier Climate
=============
.. seo::
- :description: Instructions for setting up a Haier climate devices.
+ :description: Instructions for setting up Haier climate devices.
:image: air-conditioner.svg
This is an implementation of the ESPHome component to control HVAC on the base of the SmartAir2 and hOn Haier protocols (AC that is controlled by the hOn or SmartAir2 application).
-There are two versions of the Haier protocol. The older one is using an application called SmartAir2 and the newer one - an application called hOn. Both protocols are compatible on the transport level but have different commands to control appliances.
+There are two versions of the Haier protocol: the older version uses an application called SmartAir2 while the newer version uses an application called hOn. Both protocols are compatible on the transport level but utilize different commands to control appliances.
-Older Haier models controlled by the SmartAir2 application are using the KZW-W002 module. This module can’t be reused, and you need to replace it with an ESP (RPI pico w) module. The USB connector on a board doesn’t support the USB protocol. It is a UART port that just uses a USB connector. To connect the ESP board to your AC you can cut a USB type A cable and connect wires to the climate connector.
+Older Haier models controlled by the SmartAir2 application are using the KZW-W002 module. This module can’t be reused, and you need to replace it with an ESP or RPI Pico W module. The USB connector on the board doesn’t support the USB protocol. It is a UART port that just uses a USB connector. To connect the ESP board to your AC you can cut a USB type A cable and connect wires to the climate connector.
.. list-table:: Haier UART pinout
:header-rows: 1
@@ -43,7 +43,7 @@ Older Haier models controlled by the SmartAir2 application are using the KZW-W00
Newer Haier models using a module called ESP32-for-Haier. It is an ESP32 single-core board with an ESP32-S0WD chip. In some cases, you can reuse this module and flash it with ESPHome, but some new modules don’t support this. They look the same but have encryption enabled.
-**Warning!** The new generation of ESP32-Haier devices has encryption enabled, so they can only be flashed with firmware that is signed with a private key. There is no way to make them work with ESPHome, so if you try to do it, the board will get into a boot loop with error ``rst:0x10 (RTCWDT_RTC_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)`` The only way to recover this board is to flash it with the original image. So before starting your experiments make a backup image.
+**Warning!** The new generation of ESP32-Haier devices has encryption enabled, so they can only be flashed with firmware that is signed with a private key. There is no way to make them work with ESPHome, so if you try to do it, the board will get into a boot loop with the error ``rst:0x10 (RTCWDT_RTC_RESET),boot:0x13 (SPI_FAST_FLASH_BOOT)`` The only way to recover this board is to flash it with the original image. So before starting your experiments make a backup image.
.. figure:: images/haier_pinout.jpg
:align: center
@@ -51,31 +51,22 @@ Newer Haier models using a module called ESP32-for-Haier. It is an ESP32 single-
ESP32-for-Haier UART0 pinout
-Also, you can use any other ESP32, ESP8266 or a RPI pico W board. In this case, you will need to cut the original wire or make a connector yourself (the board has a JST SM04B-GHS-TB connector)
+Also, you can use any other ESP32, ESP8266, or an RPI pico W board. In this case, you will need to cut the original wire or make a connector yourself (the board has a JST SM04B-GHS-TB connector)
This component requires a :ref:`uart` to be setup.
.. code-block:: yaml
# Example configuration entry
-
- uart:
- baud_rate: 9600
- tx_pin: 17
- rx_pin: 16
- id: ac_port
-
climate:
- platform: haier
id: haier_ac
protocol: hOn
- name: Haier AC
+ name: Haier AC
uart_id: ac_port
wifi_signal: true
beeper: true
display: true
- outdoor_temperature:
- name: Haier AC outdoor temperature
visual:
min_temperature: 16 °C
max_temperature: 30 °C
@@ -92,10 +83,23 @@ This component requires a :ref:`uart` to be setup.
- VERTICAL
- HORIZONTAL
- BOTH
- supported_presets:
- - ECO
- - BOOST
- - SLEEP
+ supported_presets:
+ - AWAY
+ - ECO
+ - BOOST
+ - SLEEP
+ on_alarm_start:
+ then:
+ - logger.log:
+ level: WARN
+ format: "Alarm activated. Code: %d. Message: \"%s\""
+ args: [ code, message]
+ on_alarm_end:
+ then:
+ - logger.log:
+ level: INFO
+ format: "Alarm deactivated. Code: %d. Message: \"%s\""
+ args: [ code, message]
Configuration variables:
@@ -103,30 +107,63 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **uart_id** (*Optional*, :ref:`config-id`): ID of the UART port to communicate with AC.
-- **protocol** (*Optional*, string): Defines protocol of communication with AC. Possible values: hon or smartair2. Default value is smartair2.
+- **protocol** (*Optional*, string): Defines communication protocol with AC. Possible values: hon or smartair2. The default value is smartair2.
- **name** (**Required**, string): The name of the climate device.
- **wifi_signal** (*Optional*, boolean): If true - send wifi signal level to AC.
-- **answer_timeout** (*Optional*, :ref:`config-time`): Responce timeout. Default value is 200ms.
+- **answer_timeout** (*Optional*, :ref:`config-time`): Responce timeout. The default value is 200ms.
- **alternative_swing_control** (*Optional*, boolean): (supported by smartAir2 only) If true - use alternative values to control swing mode. Use only if the original control method is not working for your AC.
-- **control_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the control packet. Can help with some newer models of ACs that use bigger packets. Default value: 10.
+- **control_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the control packet. Can help with some newer models of ACs that use bigger packets. The default value: 10.
- **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: MONITOR_ONLY - no control, just monitor status, SET_GROUP_PARAMETERS - set all AC parameters with one command (default method), SET_SINGLE_PARAMETER - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
-- **display** (*Optional*, boolean): Can be used to set AC display off.
+- **display** (*Optional*, boolean): Can be used to set the AC display off.
- **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
-- **outdoor_temperature** (*Optional*): Temperature sensor for outdoor temperature. Supported only by hOn protocol.
-
- - **name** (**Required**, string): The name of the sensor.
- - **id** (*Optional*, :ref:`config-id`): ID of the sensor, can be used for code generation
- - All other options from :ref:`Sensor `.
- **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: 'OFF', HEAT_COOL, COOL, HEAT, DRY, FAN_ONLY
- **supported_swing_modes** (*Optional*, list): Can be used to disable some swing modes if your AC does not support it. Possible values: 'OFF', VERTICAL, HORIZONTAL, BOTH
-- **supported_presets** (*Optional*, list): Can be used to disable some presets. Possible values for smartair2 are: BOOST, COMFORT. Possible values for hOn are: ECO, BOOST, SLEEP
+- **supported_presets** (*Optional*, list): Can be used to disable some presets. Possible values for smartair2 are: AWAY, BOOST, COMFORT. Possible values for hOn are: AWAY, ECO, BOOST, SLEEP. AWAY preset can be enabled only in HEAT mode, it is disabled by default
+- **on_alarm_start** (*Optional*, :ref:`Automation `): (supported only by hOn) Automation to perform when AC activates a new alarm. See :ref:`haier-on_alarm_start`
+- **on_alarm_end** (*Optional*, :ref:`Automation `): (supported only by hOn) Automation to perform when AC deactivates a new alarm. See :ref:`haier-on_alarm_end`
- All other options from :ref:`Climate `.
Automations
-----------
-climate.haier.power_on Action
-*****************************
+.. _haier-on_alarm_start:
+
+``on_alarm_start`` Trigger
+**************************
+
+This automation will be triggered when a new alarm is activated by AC. The error code of the alarm will be given in the variable "code" (type uint8_t), error message in the variable "message" (type char*). Those variables can be used in :ref:`lambdas `
+
+.. code-block:: yaml
+
+ climate:
+ - protocol: hOn
+ on_alarm_start:
+ then:
+ - logger.log:
+ level: WARN
+ format: "Alarm activated. Code: %d. Message: \"%s\""
+ args: [ code, message]
+
+.. _haier-on_alarm_end:
+
+``on_alarm_end`` Trigger
+************************
+
+This automation will be triggered when a previously activated alarm is deactivated by AC. The error code of the alarm will be given in the variable "code" (type uint8_t), error message in the variable "message" (type char*). Those variables can be used in :ref:`lambdas `
+
+.. code-block:: yaml
+
+ climate:
+ - protocol: hOn
+ on_alarm_end:
+ then:
+ - logger.log:
+ level: INFO
+ format: "Alarm deactivated. Code: %d. Message: \"%s\""
+ args: [ code, message]
+
+``climate.haier.power_on`` Action
+*********************************
This action turns AC power on.
@@ -136,8 +173,8 @@ This action turns AC power on.
then:
climate.haier.power_on: device_id
-climate.haier.power_off Action
-******************************
+``climate.haier.power_off`` Action
+**********************************
This action turns AC power off
@@ -147,8 +184,8 @@ This action turns AC power off
then:
climate.haier.power_off: device_id
-climate.haier.power_toggle Action
-*********************************
+``climate.haier.power_toggle`` Action
+*************************************
This action toggles AC power
@@ -158,8 +195,8 @@ This action toggles AC power
then:
climate.haier.power_toggle: device_id
-climate.haier.display_on Action
-*******************************
+``climate.haier.display_on`` Action
+***********************************
This action turns the AC display on
@@ -169,8 +206,8 @@ This action turns the AC display on
then:
climate.haier.display_on: device_id
-climate.haier.display_off Action
-********************************
+``climate.haier.display_off`` Action
+************************************
This action turns the AC display off
@@ -180,8 +217,8 @@ This action turns the AC display off
then:
climate.haier.display_off: device_id
-climate.haier.health_on Action
-******************************
+``climate.haier.health_on`` Action
+**********************************
Turn on health mode (`UV light sterilization `__)
@@ -191,8 +228,8 @@ Turn on health mode (`UV light sterilization `__
@@ -261,8 +298,8 @@ climate.haier.start_self_cleaning Action
then:
- climate.haier.start_self_cleaning: device_id
-climate.haier.start_steri_cleaning Action
-*****************************************
+``climate.haier.start_steri_cleaning`` Action
+*********************************************
(supported only by hOn) Start 56°C steri-cleaning
@@ -276,6 +313,8 @@ See Also
--------
- `haier-esphome `__
+- :doc:`Haier Climate Sensors `
+- :doc:`Haier Climate Binary Sensors `
- :doc:`/components/climate/index`
- :apiref:`haier/climate/haier.h`
- :ghedit:`Edit`
diff --git a/components/climate/index.rst b/components/climate/index.rst
index dde76b23b..263913e73 100644
--- a/components/climate/index.rst
+++ b/components/climate/index.rst
@@ -80,10 +80,10 @@ Advanced options:
a ``name`` will implicitly set this to true.
- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
(usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
- Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+ Defaults to ``false``.
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
- for a list of available options. Requires Home Assistant 2021.11 or newer.
+ for a list of available options.
Set to ``""`` to remove the default entity category.
MQTT options:
diff --git a/components/climate/midea.rst b/components/climate/midea.rst
index fc560077e..cec59359c 100644
--- a/components/climate/midea.rst
+++ b/components/climate/midea.rst
@@ -25,17 +25,6 @@ The ``midea`` component creates a Midea air conditioner climate device.
.. code-block:: yaml
# Example configuration entry
-
- # Disable logging over UART (required)
- logger:
- baud_rate: 0
-
- # UART settings for Midea dongle (required)
- uart:
- tx_pin: 1 # hardware dependant
- rx_pin: 3 # hardware dependant
- baud_rate: 9600
-
# Main settings
climate:
- platform: midea
diff --git a/components/climate/tuya.rst b/components/climate/tuya.rst
index fe48beb1b..1879bc2a3 100644
--- a/components/climate/tuya.rst
+++ b/components/climate/tuya.rst
@@ -39,8 +39,10 @@ Based on this, you can create the climate device as follows:
switch_datapoint: 1
target_temperature_datapoint: 3
current_temperature_datapoint: 4
- eco_datapoint: 7
- eco_temperature: 20 °C
+ preset:
+ eco:
+ datapoint: 8
+ temperature: 28
Configuration variables:
------------------------
@@ -50,22 +52,46 @@ Configuration variables:
- **supports_heat** (*Optional*, boolean): Specifies if the device has a heating mode. Defaults to ``true``.
- **supports_cool** (*Optional*, boolean): Specifies if the device has a cooling mode. Defaults to ``false``.
- **switch_datapoint** (**Required**, int): The datapoint id number of the climate switch (device on/off).
-- **active_state_datapoint** (*Optional*, int): The datapoint id number of the active state - :ref:`see below `.
-- **active_state_heating_value** (*Optional*, int): The active state datapoint value the device reports when heating. Defaults to ``1`` - :ref:`see below `.
-- **active_state_cooling_value** (*Optional*, int): The active state datapoint value the device reports when cooling - :ref:`see below `.
+- **active_state** (*Optional*): Configuration for the Active State Configuration.
+
+ - **datapoint** (**Required**, int): The datapoint id number of the active state - :ref:`see below `.
+ - **heating_value** (*Optional*, int): The active state datapoint value the device reports when heating. Defaults to ``1`` - :ref:`see below `.
+ - **cooling_value** (*Optional*, int): The active state datapoint value the device reports when cooling - :ref:`see below `.
+ - **drying_value** (*Optional*, int): The active state datapoint value the device reports when in drying mode.
+ - **fanonly_value** (*Optional*, int): The active state datapoint value the device reports when in Fan Only mode.
+- **preset** (*Optional*): Configuration for presets.
+
+ - **eco** (*Optional*): Configuration for Eco preset.
+
+ - **datapoint** (**Required**, int): The datapoint id number of the Eco action.
+ - **temperature** (*Optional*, int): Temperature setpoint for Eco preset.
+ - **sleep** (*Optional*): Configuration for Sleep preset
+
+ - **datapoint** (**Required**, int): The Datapoint id number of the Sleep Action
+- **swing_mode** (*Optional*): Configuration for the swing (oscillation) modes.
+
+ - **vertical_datapoint** (*Optional*, int): The datapoint id number of the vertical swing action.
+ - **horizontal_datapoint** (*Optional*, int): The datapoint id number of the horizontal swing action.
+- **fan_mode** (*Optional*): Configuration for fan modes/fan speeds.
+
+ - **datapoint** (**Required**, int): The datapoint id number of the Fan value state.
+ - **auto_value** (*Optional*, int): The datapoint value the device reports when the fan is on ``auto`` speed.
+ - **low_value** (*Optional*, int): The datapoint value the device reports when the fan is on ``low`` speed.
+ - **medium_value** (*Optional*, int): The datapoint value the device reports when the fan is on ``medium`` speed.
+ - **middle_value** (*Optional*, int): The datapoint value the device reports when the fan is on ``middle`` speed. (May set to device's ``high`` value if you have a ``Turbo`` option).
+ - **high_value** (*Optional*, int): The datapoint value the device reports when the fan is on ``high`` speed. (Sometimes called ``Turbo``).
- **heating_state_pin** (*Optional*, :ref:`config-pin`): The input pin indicating that the device is heating - :ref:`see below `. Only used if **active_state_datapoint** is not configured.
- **cooling_state_pin** (*Optional*, :ref:`config-pin`): The input pin indicating that the device is cooling - :ref:`see below `. Only used if **active_state_datapoint** is not configured.
- **target_temperature_datapoint** (**Required**, int): The datapoint id number of the target temperature.
- **current_temperature_datapoint** (**Required**, int): The datapoint id number of the current temperature.
- **temperature_multiplier** (*Optional*, float): A multiplier to modify the incoming and outgoing temperature values - :ref:`see below `.
-- **eco_datapoint** (*Optional*, int): The datapoint id number of the eco mode state.
-- **eco_temperature** (*Optional*, float): The target temperature the controller uses while the eco mode is active.
+
- **reports_fahrenheit** (*Optional*, boolean): Set to ``true`` if the device reports temperatures in Fahrenheit. ESPHome expects all climate temperatures to be in Celcius, otherwise unexpected conversions will take place when it is published to Home Assistant. Defaults to ``false``.
If the device has different multipliers for current and target temperatures, **temperature_multiplier** can be replaced with both of:
-- **current_temperature_multiplier** (*Optional*, float): A multiplier to modify the current temperature value.
-- **target_temperature_multiplier** (*Optional*, float): A multiplier to modify the target temperature value.
+ - **current_temperature_multiplier** (*Optional*, float): A multiplier to modify the current temperature value.
+ - **target_temperature_multiplier** (*Optional*, float): A multiplier to modify the target temperature value.
- All other options from :ref:`Climate `.
diff --git a/components/copy.rst b/components/copy.rst
index 93f21c6d4..5cc7191c8 100644
--- a/components/copy.rst
+++ b/components/copy.rst
@@ -1,11 +1,11 @@
-Copy Integration
-================
+Copy Component
+==============
.. seo::
- :description: Instructions for setting up the copy integration in ESPHome
+ :description: Instructions for setting up the copy component in ESPHome
:image: content-copy.svg
-The ``copy`` integration can be used to copy an existing component (like a sensor, switch, etc.)
+The ``copy`` component can be used to copy an existing component (like a sensor, switch, etc.)
and create a duplicate mirroring the source's state and forwarding actions such as turning on to the source.
For each of the supported platforms, the configuration consists of the required configuration
diff --git a/components/cover/custom.rst b/components/cover/custom.rst
index 4b49dbc5c..c623a54f9 100644
--- a/components/cover/custom.rst
+++ b/components/cover/custom.rst
@@ -1,24 +1,29 @@
Custom Cover
============
+.. seo::
+ :description: Instructions for setting up Custom C++ covers with ESPHome.
+ :image: language-cpp.svg
+ :keywords: C++, Custom
+
.. warning::
- Custom components are deprecated, not recommended for new configurations
- and will be removed from ESPHome in a future release.
- Please look at creating a real ESPHome component and "importing" it into your
- configuration with :doc:`/components/external_components`.
+ Custom components are deprecated, not recommended for new configurations and will be removed from ESPHome in a
+ future release. Please look at creating a real ESPHome component and "importing" it into your configuration with
+ :doc:`/components/external_components`.
- You can find some basic documentation on creating your own components
- at :ref:`contributing_to_esphome`.
+ You can find some basic documentation on creating your own components at :ref:`contributing_to_esphome`.
-This integration can be used to create custom covers in ESPHome
-using the C++ (Arduino) API.
+.. warning::
-Please first read :doc:`/components/sensor/custom` guide,
-the same principles apply here.
+ While we try to keep the ESPHome YAML configuration options as stable as possible, the ESPHome API is less
+ stable. If something in the APIs needs to be changed in order for something else to work, we will do so.
-The example below is an example of a custom cover - all covers must override
-two methods:
+This component can be used to create custom covers in ESPHome using the C++ (Arduino) API.
+
+Please first read :doc:`/components/sensor/custom` guide, the same principles apply here.
+
+The example below is an example of a custom cover - all covers must override two methods:
- ``get_traits``: This should return a :apiclass:`CoverTraits ` object
representing the capabilities of the cover.
diff --git a/components/cover/images/he60r-sch.jpg b/components/cover/images/he60r-sch.jpg
index aaf74702c..b69d95f30 100644
Binary files a/components/cover/images/he60r-sch.jpg and b/components/cover/images/he60r-sch.jpg differ
diff --git a/components/cover/images/he60r.jpg b/components/cover/images/he60r.jpg
index 025c76db6..9b539f09a 100644
Binary files a/components/cover/images/he60r.jpg and b/components/cover/images/he60r.jpg differ
diff --git a/components/cover/index.rst b/components/cover/index.rst
index d6eaeff3b..146f4db9e 100644
--- a/components/cover/index.rst
+++ b/components/cover/index.rst
@@ -36,7 +36,7 @@ Configuration variables:
you want the cover to use that name, you can set ``name: None``.
- **device_class** (*Optional*, string): The device class for the
- sensor. See https://www.home-assistant.io/components/cover/ for a list of available options.
+ sensor. See https://www.home-assistant.io/integrations/cover/#device-class for a list of available options.
- **icon** (*Optional*, icon): Manually set the icon to use for the cover in the frontend.
Advanced options:
@@ -46,10 +46,10 @@ Advanced options:
a ``name`` will implicitly set this to true.
- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
(usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
- Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+ Defaults to ``false``.
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
- for a list of available options. Requires Home Assistant 2021.11 or newer.
+ for a list of available options.
Set to ``""`` to remove the default entity category.
MQTT options:
diff --git a/components/cover/time_based.rst b/components/cover/time_based.rst
index 0f5e542dd..e5a5150e9 100644
--- a/components/cover/time_based.rst
+++ b/components/cover/time_based.rst
@@ -77,7 +77,22 @@ Configuration variables:
``esp8266_restore_from_flash: true`` option set.
See :doc:`esp8266_restore_from_flash ` for details.
+Handle stop_action:
+------------------------
+For some cover controllers, separate switches for UP and DOWN action are used while a stop is issued when sending a counter command.
+This can be handled at the **stop_action** by using the folling lamda function:
+.. code-block:: yaml
+
+ stop_action:
+ - lambda: !lambda |-
+ if (id(cover).last_operation() == CoverOperation::COVER_OPERATION_OPENING) {
+ // Cover is currently opening
+ id(cover_button_down).press();
+ } else if (id(cover).last_operation() == CoverOperation::COVER_OPERATION_CLOSING) {
+ // Cover is currently closing
+ id(cover_button_up).press();
+ }
See Also
--------
diff --git a/components/cover/tuya.rst b/components/cover/tuya.rst
index 2293cdd63..917b87545 100644
--- a/components/cover/tuya.rst
+++ b/components/cover/tuya.rst
@@ -45,7 +45,7 @@ Configuration variables:
Supported devices
-----------------
-Tuya cover devices known to be supported by this integration:
+Tuya cover devices known to be supported by this component:
- Tuya ``M515EGWT`` (motor for bead chain roller blinds)
diff --git a/components/datetime/index.rst b/components/datetime/index.rst
new file mode 100644
index 000000000..c13c979a5
--- /dev/null
+++ b/components/datetime/index.rst
@@ -0,0 +1,327 @@
+Datetime Component
+==================
+
+.. seo::
+ :description: Instructions for setting up datetime components in ESPHome.
+ :image: folder-open.svg
+
+ESPHome has support for components to create a datetime entity. A datetime entity
+currently represents a date that can be set by the user/frontend.
+
+.. note::
+
+ Requires Home Assistant 2024.4 or newer.
+
+.. _config-datetime:
+
+Base Datetime Configuration
+---------------------------
+
+All datetime in ESPHome have a name and an optional icon.
+
+.. code-block:: yaml
+
+ # Example datetime configuration
+ name: Date to check
+
+ # Optional variables:
+ icon: "mdi:calendar-alert"
+
+Configuration variables:
+
+- **name** (**Required**, string): The name for the datetime.
+
+ .. note::
+
+ If you have a :ref:`friendly_name ` set for your device and
+ you want the datetime to use that name, you can set ``name: None``.
+
+- **icon** (*Optional*, icon): Manually set the icon to use for the datetime 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.
+- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
+ (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
+ Defaults to ``false``.
+- **entity_category** (*Optional*, string): The category of the entity.
+ See https://developers.home-assistant.io/docs/core/entity/#generic-properties
+ for a list of available options.
+ Set to ``""`` to remove the default entity category.
+- **time_id** (**Required**, :ref:`config-id`): The ID of the time entity. Automatically set
+ to the ID of a time component if only a single one is defined.
+
+MQTT Options:
+
+- All other options from :ref:`MQTT Component `.
+
+Time and DateTime Options:
+
+- **on_time** (*Optional*, :ref:`automation`): Automation to run when the current datetime or time matches the current state.
+ Only valid on ``time`` or ``datetime`` types.
+
+Automation
+----------
+
+You can access the most recent state as a ``ESPTime`` object by ``id(datetime_id).state_as_esptime()``
+
+.. _datetime-on_value:
+
+``on_value``
+************
+
+This automation will be triggered when a new value is published. In :ref:`Lambdas `
+you can get the value as a ESPTime object from the trigger with ``x``.
+
+.. code-block:: yaml
+
+ datetime:
+ - platform: template
+ # ...
+ on_value:
+ then:
+ - lambda: |-
+ if(x.hour >= 12) {
+ ESP_LOGD("main", "Updated hour is later or equal to 12");
+ } else {
+ ESP_LOGD("main", "Updated hour is earlier than 12");
+ }
+
+Configuration variables: See :ref:`Automation `.
+
+Date Automation
+---------------
+
+.. _datetime-date_set_action:
+
+``datetime.date.set`` Action
+****************************
+
+This is an :ref:`Action ` for setting a datetime date state.
+The ``date`` provided can be in one of 3 formats:
+
+.. code-block:: yaml
+
+ # String date
+ - datetime.date.set:
+ id: my_date
+ date: "2023-12-04"
+
+ # Individual date parts
+ - datetime.date.set:
+ id: my_date
+ date:
+ year: 2023
+ month: 12
+ day: 4
+
+ # Using a lambda
+ - datetime.date.set:
+ id: my_date
+ date: !lambda |-
+ // Return an ESPTime struct
+ return {.day_of_month: 4, .month: 12, .year: 2023};
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the datetime to set.
+- **date** (**Required**, string, date parts, :ref:`templatable `):
+ The value to set the datetime to.
+
+
+
+.. _datetime-lambda_calls:
+
+lambda calls
+************
+
+From :ref:`lambdas `, you can call several methods on all datetimes to do some
+advanced stuff (see the full API Reference for more info).
+
+- ``.make_call()``: Make a call for updating the datetime value.
+
+ .. code-block:: cpp
+
+ // Within lambda, set the date to 2024-02-25
+ auto call = id(my_date).make_call();
+ call.set_date("2024-02-25");
+ call.perform();
+
+ Check the API reference for information on the methods that are available for
+ the ``DateCall`` object.
+
+- ``.year``: Retrieve the current year of the ``date``. It will be ``0`` if no value has been set.
+- ``.month``: Retrieve the current month of the ``date``. It will be ``0`` if no value has been set.
+- ``.day``: Retrieve the current day of the ``date``. It will be ``0`` if no value has been set.
+- ``.state_as_esptime()``: Retrieve the current value of the datetime as a :apistruct:`ESPTime` object.
+
+ .. code-block:: cpp
+
+ // For example, create a custom log message when a value is received:
+ ESP_LOGI("main", "Value of my datetime: %04d-%02d-%02d", id(my_date).year, id(my_date).month, id(my_date).day);
+
+Time Automation
+---------------
+
+.. _datetime-time_set_action:
+
+``datetime.time.set`` Action
+****************************
+
+This is an :ref:`Action ` for setting a datetime time state.
+The ``time`` provided can be in one of 3 formats:
+
+.. code-block:: yaml
+
+ # String time
+ - datetime.time.set:
+ id: my_time
+ time: "12:34:56"
+
+ # Individual time parts
+ - datetime.time.set:
+ id: my_time
+ time:
+ hour: 12
+ minute: 34
+ second: 56
+
+ # Using a lambda
+ - datetime.time.set:
+ id: my_time
+ time: !lambda |-
+ // Return an ESPTime struct
+ return {.second: 56, .minute: 34, .hour: 12};
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the datetime to set.
+- **time** (**Required**, string, time parts, :ref:`templatable `):
+ The value to set the datetime to.
+
+
+.. _datetime-time-lambda_calls:
+
+lambda calls
+************
+
+From :ref:`lambdas `, you can call several methods on all datetimes to do some
+advanced stuff (see the full API Reference for more info).
+
+- ``.make_call()``: Make a call for updating the datetime value.
+
+ .. code-block:: cpp
+
+ // Within lambda, set the time to 12:34:56
+ auto call = id(my_time).make_call();
+ call.set_date("12:34:56");
+ call.perform();
+
+ Check the API reference for information on the methods that are available for
+ the ``TimeCall`` object.
+
+- ``.hour``: Retrieve the current hour of the ``time``. It will be ``0`` if no value has been set.
+- ``.minute``: Retrieve the current minute of the ``time``. It will be ``0`` if no value has been set.
+- ``.second``: Retrieve the current second of the ``time``. It will be ``0`` if no value has been set.
+- ``.state_as_esptime()``: Retrieve the current value of the datetime as a :apistruct:`ESPTime` object.
+
+ .. code-block:: cpp
+
+ // For example, create a custom log message when a value is received:
+ ESP_LOGI("main", "Value of my datetime: %0d:%02d:%02d", id(my_time).hour, id(my_time).minute, id(my_time).second);
+
+
+DateTime Automation
+-------------------
+
+.. _datetime-datetime_set_action:
+
+``datetime.datetime.set`` Action
+********************************
+
+This is an :ref:`Action ` for setting a datetime datetime state.
+The ``datetime`` provided can be in one of 3 formats:
+
+.. code-block:: yaml
+
+ # String datetime
+ - datetime.time.set:
+ id: my_datetime
+ datetime: "2024-12-31 12:34:56"
+
+ # Individual datetime parts
+ - datetime.datetime.set:
+ id: my_datetime
+ datetime:
+ year: 2024
+ month: 12
+ day: 31
+ hour: 12
+ minute: 34
+ second: 56
+
+ # Using a lambda
+ - datetime.datetime.set:
+ id: my_datetime
+ datetime: !lambda |-
+ // Return an ESPTime struct
+ return {.second: 56, .minute: 34, .hour: 12, .day_of_month: 31, .month: 12, .year: 2024};
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the datetime to set.
+- **datetime** (**Required**, string, datetime parts, :ref:`templatable `):
+ The value to set the datetime to.
+
+
+.. _datetime-datetime-lambda_calls:
+
+Lambda calls
+************
+
+For more complex use cases, several methods are available for use on datetimes from within :ref:`lambdas `. See the full API Reference for more information.
+
+- ``.make_call()``: Make a call for updating the datetime value.
+
+ .. code-block:: cpp
+
+ // Within lambda, set the datetime to 2024-12-31 12:34:56
+ auto call = id(my_datetime).make_call();
+ call.set_date("2024-12-31 12:34:56");
+ call.perform();
+
+ Check the API reference for information on the methods that are available for
+ the ``DateTimeCall`` object.
+
+- ``.year``: Retrieve the current year of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.month``: Retrieve the current month of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.day``: Retrieve the current day of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.hour``: Retrieve the current hour of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.minute``: Retrieve the current minute of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.second``: Retrieve the current second of the ``datetime``. It will be ``0`` if no value has been set.
+- ``.state_as_esptime()``: Retrieve the current value of the datetime as a :apistruct:`ESPTime` object.
+
+ .. code-block:: cpp
+
+ // For example, create a custom log message when a value is received:
+ ESP_LOGI("main", "Value of my datetime: %04d-%02d-%02d %0d:%02d:%02d",
+ id(my_datetime).year, id(my_datetime).month, id(my_datetime).day,
+ id(my_datetime).hour, id(my_datetime).minute, id(my_datetime).second);
+
+
+See Also
+--------
+
+- :apiref:`DateTimeBase `
+- :apiref:`DateEntity `
+- :apiref:`DateCall `
+- :apiref:`TimeEntity `
+- :apiref:`TimeCall `
+- :apiref:`DateTimeEntity `
+- :apiref:`DateTimeCall `
+- :ghedit:`Edit`
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ *
diff --git a/components/datetime/template.rst b/components/datetime/template.rst
new file mode 100644
index 000000000..e99161908
--- /dev/null
+++ b/components/datetime/template.rst
@@ -0,0 +1,106 @@
+Template Datetime
+=================
+
+.. seo::
+ :description: Instructions for setting up template datetime with ESPHome.
+ :image: description.svg
+
+The ``template`` datetime platform allows you to create a datetime with templated values
+using :ref:`lambdas `.
+
+.. code-block:: yaml
+
+ datetime:
+ # Example Date
+ - platform: template
+ id: my_date
+ type: date
+ name: Pick a Date
+ optimistic: yes
+ initial_value: "2024-01-30"
+ restore_value: true
+
+ # Example Time
+ - platform: template
+ id: my_time
+ type: time
+ name: Pick a Time
+ optimistic: yes
+ initial_value: "12:34:56"
+ restore_value: true
+
+ # Example DateTime
+ - platform: template
+ id: my_datetime
+ type: datetime
+ name: Pick a DateTime
+ optimistic: yes
+ initial_value: "2024-12-31 12:34:56"
+ restore_value: true
+
+Configuration variables:
+------------------------
+
+- **type** (*Required*, enum): The type of the datetime. Can be one of ``date`` or ``time``.
+- **lambda** (*Optional*, :ref:`lambda `):
+ Lambda to be evaluated every update interval to get the current value of the datetime.
+- **set_action** (*Optional*, :ref:`Action `): The action that should
+ be performed when the remote (like Home Assistant's frontend) requests to set the
+ dateime value. The new value is available to lambdas in the ``x`` variable.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval on which to update the datetime
+ 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 datetime 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``.
+- **initial_value** (*Optional*, string): The value to set the state to on setup if not
+ restored with ``restore_value``. Can be one of:
+
+ - For ``type: date``:
+
+ - A string in the format ``%Y-%m-%d`` , eg: ``"2023-12-04"``.
+ - An object including ``year``, ``month``, ``day``.
+
+ .. code-block:: yaml
+
+ initial_value:
+ year: 2023
+ month: 12
+ day: 4
+
+ - For ``type: time``:
+
+ - A string in the format ``%H:%M:%S`` , eg: ``"12:34:56"``.
+ - An object including ``hour``, ``minute``, ``second``.
+
+ .. code-block:: yaml
+
+ initial_value:
+ hour: 12
+ minute: 34
+ second: 56
+
+ - For ``type: datetime``:
+
+ - A string in the format ``%Y-%m-%d %H:%M:%S`` , eg: ``"2023-12-04 12:34:56"``.
+ - An object including ``year``, ``month``, ``day``, ``hour``, ``minute``, ``second``.
+
+ .. code-block:: yaml
+
+ initial_value:
+ year: 2023
+ month: 12
+ day: 4
+ hour: 12
+ minute: 34
+ second: 56
+
+- All other options from :ref:`Datetime `.
+
+See Also
+--------
+
+- :ref:`automation`
+- :apiref:`template/datetime/template_date.h`
+- :ghedit:`Edit`
diff --git a/components/deep_sleep.rst b/components/deep_sleep.rst
index c9914a96a..92e890766 100644
--- a/components/deep_sleep.rst
+++ b/components/deep_sleep.rst
@@ -21,7 +21,9 @@ to wake up on any RTC pin (``GPIO0``, ``GPIO2``, ``GPIO4``, ``GPIO12``, ``GPIO13
``GPIO15``, ``GPIO25``, ``GPIO26``, ``GPIO27``, ``GPIO32``, ``GPIO39``).
While in deep sleep mode, the node will not do any work and not respond to any network traffic,
-even Over The Air updates.
+even Over The Air updates. If the device's entities are appearing as **Unavailable** while your device is actively
+sleeping, this component was likely added after the device was added to Home Assistant. To prevent this behavior,
+you can remove and re-add the device in Home Assistant.
.. code-block:: yaml
@@ -32,8 +34,8 @@ even Over The Air updates.
.. note::
- Some ESP8266s have an onboard USB chip (e.g. D1 mini) on the chips' control line that is connected to the RST pin. This enables the flasher to reboot the ESP when required. This may interfere with deep sleep on some devices and prevent the ESP from waking when it's powered through its USB connector. Powering the ESP from a separate 3.3V source connected to the 3.3V pin and GND will solve this issue. In these cases, using a USB to TTL adapter will allow you to log ESP activity.
-
+ Some ESP8266s have an onboard USB chip (e.g. D1 mini) on the chips' control line that is connected to the RST pin. This enables the flasher to reboot the ESP when required. This may interfere with deep sleep on some devices and prevent the ESP from waking when it's powered through its USB connector. Powering the ESP from a separate 3.3V source connected to the 3.3V pin and GND will solve this issue. In these cases, using a USB to TTL adapter will allow you to log ESP activity.
+
Configuration variables:
------------------------
@@ -85,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:
diff --git a/components/demo.rst b/components/demo.rst
index faccce99f..65eef4b51 100644
--- a/components/demo.rst
+++ b/components/demo.rst
@@ -1,12 +1,12 @@
-Demo Integration
-================
+Demo Component
+==============
.. seo::
- :description: Instructions for setting up the demo integration in ESPHome
+ :description: Instructions for setting up the demo component in ESPHome
:image: description.svg
-The ``demo`` integration can be used for testing to generate sample instances of many
-different integrations (sensors, lights, ...)
+The ``demo`` component can be used for testing to generate sample instances of many
+different components (sensors, lights, ...)
.. figure:: images/demo-ui.png
:align: center
@@ -20,7 +20,7 @@ different integrations (sensors, lights, ...)
Configuration variables:
------------------------
-This integration has no configuration variables
+This component has no configuration variables
See Also
--------
diff --git a/components/dfplayer.rst b/components/dfplayer.rst
index 9b2f5e655..672cc4615 100644
--- a/components/dfplayer.rst
+++ b/components/dfplayer.rst
@@ -2,7 +2,7 @@ DF-Player mini
==============
.. seo::
- :description: Instructions for setting up DF Player Mini integration in ESPHome.
+ :description: Instructions for setting up DF Player Mini component in ESPHome.
:image: dfplayer.svg
The ``dfplayer`` (`datasheet `__), component
@@ -14,8 +14,7 @@ allows you to play sound and music stored in an SD card or USB flash drive.
DF-Player mini Module.
-For this integration to work you need to have set up a :ref:`UART bus `
-in your configuration.
+For this component to work you need to have set up a :ref:`UART bus ` in your configuration.
Overview
--------
@@ -31,16 +30,7 @@ will be required.
.. code-block:: yaml
# Example configuration entry
- uart:
- tx_pin: GPIO2
- rx_pin: GPIO5
- baud_rate: 9600
-
- # Declare DFPlayer mini module
dfplayer:
- on_finished_playback:
- then:
- logger.log: 'Somebody press play!'
Configuration variables:
------------------------
@@ -114,11 +104,11 @@ Configuration options:
``dfplayer.play_mp3`` Action
----------------------------
-Plays a track inside the folder ``mp3``. Files inside the folder must be numbered from 1
+Plays a track inside the folder ``mp3``. Files inside the folder must be numbered from 1
to 9999, like ``0001.mp3``, ``0002.mp3``, ... etc.
-The folder name needs to be ``mp3``, placed under the SD card root directory, and the
-mp3 file name needs to be 4 digits, for example, "0001.mp3", placed under the mp3 folder.
-If you want, you can add additional text after the number in the filename, for example,
+The folder name needs to be ``mp3``, placed under the SD card root directory, and the
+mp3 file name needs to be 4 digits, for example, "0001.mp3", placed under the mp3 folder.
+If you want, you can add additional text after the number in the filename, for example,
``0001hello.mp3``, but must always be referenced by number only in yaml.
.. code-block:: bash
@@ -345,8 +335,8 @@ Sample code
.. code-block:: yaml
uart:
- tx_pin: GPIO2
- rx_pin: GPIO5
+ tx_pin: GPIOXX
+ rx_pin: GPIOXX
baud_rate: 9600
dfplayer:
diff --git a/components/display/addressable_light.rst b/components/display/addressable_light.rst
index 44c125b7e..8f9e39481 100644
--- a/components/display/addressable_light.rst
+++ b/components/display/addressable_light.rst
@@ -19,18 +19,6 @@ The display requires that an :apiclass:`AddressableLight `): A lambda that returns the integer address of the LED
- given the supplied the ``x`` and ``y`` pixel coordinate. By default, a left-to-right direct pixel mapper is used.
+ given the supplied the ``x`` and ``y`` pixel coordinate. By default, a left-to-right direct pixel mapper is used.
- **lambda** (*Optional*, :ref:`lambda `): The lambda to use for rendering the content on the display.
``it`` will be an instance of :apiclass:`DisplayBuffer `.
- See :ref:`display-engine` for more information.
+ See :ref:`display-engine` for more information.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
@@ -73,7 +61,7 @@ Configuration variables:
When enabled (the default, but also via ``it.set_enabled(true)``), any effect currently running on the
addressable light will be disabled. When disabled (``it.set_enabled(false)``), the last configured effect will
be restored.
-
+
While the display is enabled, it is still possible to control the parent addressable light component in some
limited capacity. Changing the brightness will still work, but changing the color will have no affect. It is not
adivsable to enable any effects (ex: rainbow, color wipe, etc) while the display is enabled, as this will cause a
diff --git a/components/display/fonts.rst b/components/display/fonts.rst
new file mode 100644
index 000000000..47ab89461
--- /dev/null
+++ b/components/display/fonts.rst
@@ -0,0 +1,160 @@
+.. _display-fonts:
+
+Font Renderer Component
+=======================
+
+.. seo::
+ :description: Instructions for setting up fonts in ESPHome.
+ :image: format-font.svg
+
+ESPHome's graphical rendering engine also has a powerful font drawer which integrates seamlessly into the system. You have the option to use **any** OpenType/TrueType (``.ttf``, ``.otf``, ``.woff``) font file at **any** size, as well as fixed-size `PCF `_ and `BDF `_ bitmap fonts.
+
+These fonts can be used in ESPHome's :ref:`own rendering engine `.
+
+To use fonts you can either
+ - Just grab a ``.ttf``, ``.otf``, ``.woff``, ``.pcf``, or ``.bdf`` file from somewhere on the internet and place it, for example, inside a ``fonts`` folder next to your configuration file.
+ - Use the ``gfonts://`` short form to use Google Fonts directly.
+ - Load a font from a URL directly on build.
+
+Next, create a ``font:`` section in your configuration:
+
+.. code-block:: yaml
+
+ # Various ways to configure fonts
+ font:
+ - file: "fonts/Comic Sans MS.ttf"
+ id: my_font
+ size: 20
+ bpp: 2
+
+ - file: "fonts/tom-thumb.bdf"
+ id: tomthumb
+
+ # gfonts://family[@weight]
+ - file: "gfonts://Roboto"
+ id: roboto_20
+ size: 20
+
+ - file:
+ type: gfonts
+ family: Roboto
+ weight: 900
+ id: roboto_16
+ size: 16
+
+ - file: "gfonts://Material+Symbols+Outlined"
+ id: icons_50
+ size: 50
+ glyphs: ["\U0000e425"] # mdi-timer
+
+ - file: "fonts/RobotoCondensed-Regular.ttf"
+ id: roboto_special_28
+ size: 28
+ bpp: 4
+ glyphs: [
+ a,A,á,Á,e,E,é,É,
+ (,),+,-,_,.,°,•,µ,
+ "\u0020", #space
+ "\u0021", #!
+ "\u0022", #"
+ "\u0027", #'
+ ]
+
+ - file: "fonts/RobotoCondensed-Regular.ttf"
+ id: my_font_with_icons
+ size: 20
+ bpp: 4
+ extras:
+ - file: "fonts/materialdesignicons-webfont.ttf"
+ glyphs: [
+ "\U000F02D1", # mdi-heart
+ "\U000F05D4", # mdi-airplane-landing
+ ]
+
+ - file: "https://github.com/IdreesInc/Monocraft/releases/download/v3.0/Monocraft.ttf"
+ id: web_font
+ size: 20
+ - file:
+ url: "https://github.com/IdreesInc/Monocraft/releases/download/v3.0/Monocraft.ttf"
+ type: web
+ id: web_font2
+ size: 24
+
+ display:
+ # ...
+
+Configuration variables:
+------------------------
+
+- **file** (**Required**, string): The path (relative to where the .yaml file is) of the font
+ file. You can also use the ``gfonts://`` short form to use Google Fonts, or use the below structure:
+
+ - **type** (**Required**, string): Can be ``local``, ``gfonts`` or ``web``.
+
+ **Local Fonts**:
+
+ - **path** (**Required**, string): The path (relative to where the .yaml file is) of the OpenType/TrueType or bitmap font file.
+
+ **Google Fonts**:
+
+ Each Google Font will be downloaded once and cached for future use. This can also be used to download Material
+ Symbols or Icons as in the example above.
+
+ - **family** (**Required**, string): The name of the Google Font family.
+ - **italic** (*Optional*, boolean): Whether the font should be italic.
+ - **weight** (*Optional*, enum): The weight of the font. Can be either the text name or the integer value:
+ - **thin**: 100
+ - **extra-light**: 200
+ - **light**: 300
+ - **regular**: 400 (**default**)
+ - **medium**: 500
+ - **semi-bold**: 600
+ - **bold**: 700
+ - **extra-bold**: 800
+ - **black**: 900
+
+ **Web Fonts**:
+
+ - **url** (**Required**, string): The URL of the TrueType or bitmap font file.
+
+- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the font later
+ in your display code.
+- **size** (*Optional*, int): The size of the font in pt (not pixel!).
+ If you want to use the same font in different sizes, create two font objects. Note: *size* is ignored
+ by bitmap fonts. Defaults to ``20``.
+- **bpp** (*Optional*, int): The bit depth of the rendered font from OpenType/TrueType, for anti-aliasing. Can be ``1``, ``2``, ``4``, ``8``. Defaults to ``1``.
+- **glyphs** (*Optional*, list): A list of characters you plan to use. Only the characters you specify
+ here will be compiled into the binary. Adjust this if you need some special characters or want to
+ reduce the size of the binary if you don't plan to use some glyphs. You can also specify glyphs by their codepoint (see below). Defaults to ``!"%()+=,-_.:°/?0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz``.
+- **extras** (*Optional*, enum): A list of font glyph configurations you'd like to include within this font, from other OpenType/TrueType files (eg. icons from other font, but at the same size as the main font):
+
+ - **file** (**Required**, string): The path of the font file with the extra glyphs.
+ - **glyphs** (**Required**, list): A list of glyphs you want to include. Can't repeat the same glyph codepoint if it was declared in the level above.
+
+.. note::
+
+ OpenType/TrueType font files offer icons at codepoints far from what's reachable on a standard keyboard, for these it's needed
+ to specify the unicode codepoint of the glyph as a hex address escaped with ``\u`` or ``\U``.
+
+ - Code points up to ``0xFFFF`` are encoded like ``\uE6E8``. Lowercase ``\u`` and exactly 4 hexadecimal digits.
+ - Code points above ``0xFFFF`` are encoded like ``\U0001F5E9``. Capital ``\U`` and exactly 8 hexadecimal digits.
+
+ The ``extras`` section only supports OpenType/TrueType files, ``size`` and ``bpp`` will be the same as the above level. This will allow printing icons alongside the characters in the same string, like ``I \uF004 You \uF001``.
+
+ Many font sizes with multiple glyphs at high bit depths will increase the binary size considerably. Make your choices carefully.
+
+
+.. note::
+
+ To use fonts you will need to have the python ``pillow`` package installed, as ESPHome uses that package
+ to translate the OpenType/TrueType and bitmap font files into an internal format. If you're running this as a Home Assistant add-on or with the official ESPHome docker image, it should already be installed. Otherwise you need
+ to install it using ``pip install "pillow==10.2.0"``.
+
+See Also
+--------
+
+- :apiref:`display/display_buffer.h`
+- :ref:`display-engine`
+- `MDI cheatsheet `__,
`Aliexpress `__) and other
-displays from the same chip family with ESPHome. As this is a somewhat higher resolution display and may require pins
-beyond the typical SPI connections, it is better suited for use with the ESP32.
+displays from the same chip family with ESPHome. As this is a somewhat higher resolution display and requires additional pins
+beyond the basic SPI connections, and a reasonable amount of RAM, it is not well suited for the ESP8266.
**Note:** use of 16 bit colors requires double the amount of RAM as 8 bit, and may need PSRAM to be available.
@@ -52,8 +55,8 @@ beyond the typical SPI connections, it is better suited for use with the ESP32.
display:
- platform: ili9xxx
model: ili9341
- dc_pin: 27
- reset_pin: 33
+ dc_pin: GPIOXX
+ reset_pin: GPIOXX
lambda: |-
it.fill(COLOR_BLACK);
it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
@@ -63,10 +66,11 @@ Configuration variables:
- **model** (**Required**): The model of the display. Options are:
- - ``M5STACK``, ``TFT 2.4``, ``TFT 2.4R``, ``S3BOX``, ``S3BOX_LITE``, ``ST7789V``
+ - ``M5STACK``, ``TFT 2.4``, ``TFT 2.4R``, ``S3BOX``, ``S3BOX_LITE``, ``WSPICOLCD``
- ``ILI9341``, ``ILI9342``, ``ILI9486``, ``ILI9488``, ``ILI9488_A`` (alternative gamma configuration for ILI9488)
- ``ILI9481``, ``ILI9481-18`` (18 bit mode)
- ``ST7789V``, ``ST7796``
+ - ``GC9A01A``
- **dc_pin** (**Required**, :ref:`Pin Schema `): The DC pin.
- **reset_pin** (*Optional*, :ref:`Pin Schema `): The RESET pin.
@@ -92,9 +96,8 @@ 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``.
- **transform** (*Optional*): Transform the display presentation using hardware. All defaults are ``false``. This option cannot be used with ``rotation``.
@@ -102,17 +105,35 @@ 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:
-
+**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 ` . 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
**********************
+To use hardware rotation, use both ``dimensions`` and ``transform``, e.g. this config will turn a landscape display with
+height 320 and width 480 into portrait. Note that the dimensions are those of the final display.
+
+.. code-block:: yaml
+
+ transform:
+ swap_xy: true
+ mirror_x: true
+ dimensions:
+ height: 480
+ 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 ` for more detail on this configuration section.
@@ -159,13 +180,13 @@ To configure a dimmable backlight:
# Define a PWM output on the ESP32
output:
- platform: ledc
- pin: 32
- id: gpio_32_backlight_pwm
+ pin: GPIOXX
+ id: backlight_pwm
# Define a monochromatic, dimmable light for the backlight
light:
- platform: monochromatic
- output: gpio_32_backlight_pwm
+ output: backlight_pwm
name: "Display Backlight"
id: back_light
restore_mode: ALWAYS_ON
@@ -183,8 +204,8 @@ To configure an image adaptive color pallet to show greater than 8 bit color dep
display:
- platform: ili9xxx
model: ili9341
- dc_pin: 4
- reset_pin: 22
+ dc_pin: GPIOXX
+ reset_pin: GPIOXX
rotation: 90
id: tft_ha
color_palette: IMAGE_ADAPTIVE
@@ -202,20 +223,37 @@ This config rotates the display into landscape mode using the driver chip.
display:
- platform: ili9xxx
model: st7789v
- height: 170
- width: 320
- offset_height: 35
- offset_width: 0
+ dimensions:
+ height: 170
+ width: 320
+ offset_height: 35
+ offset_width: 0
transform:
swap_xy: true
mirror_x: false
mirror_y: true
color_order: bgr
data_rate: 80MHz
- cs_pin: 10
+ cs_pin: GPIOXX
dc_pin: GPIO13
reset_pin: GPIO9
+For Lilygo TTGO Boards if you move from the st7789v to this you need the following settings to make it work.
+
+.. code-block:: yaml
+
+ display:
+ - platform: ili9xxx
+ model: st7789v
+ #TTGO TDisplay 135x240
+ dimensions:
+ height: 240
+ width: 135
+ offset_height: 40
+ offset_width: 52
+ # Required or the colors are all inverted, and Black screen is White
+ invert_colors: true
+
See Also
--------
diff --git a/components/display/images/display_rendering_colors.png b/components/display/images/display_rendering_colors.png
new file mode 100644
index 000000000..df5830179
Binary files /dev/null and b/components/display/images/display_rendering_colors.png differ
diff --git a/components/display/images/display_rendering_graph.png b/components/display/images/display_rendering_graph.png
new file mode 100644
index 000000000..9c2c30d45
Binary files /dev/null and b/components/display/images/display_rendering_graph.png differ
diff --git a/components/display/images/display_rendering_line.png b/components/display/images/display_rendering_line.png
new file mode 100644
index 000000000..633c0d42a
Binary files /dev/null and b/components/display/images/display_rendering_line.png differ
diff --git a/components/display/images/display_rendering_shapes.png b/components/display/images/display_rendering_shapes.png
new file mode 100644
index 000000000..b6a034710
Binary files /dev/null and b/components/display/images/display_rendering_shapes.png differ
diff --git a/components/display/images/display_rendering_text.png b/components/display/images/display_rendering_text.png
new file mode 100644
index 000000000..3e5fb7834
Binary files /dev/null and b/components/display/images/display_rendering_text.png differ
diff --git a/components/display/images/graph_dualtrace.png b/components/display/images/graph_dualtrace.png
deleted file mode 100644
index 4beeacf91..000000000
Binary files a/components/display/images/graph_dualtrace.png and /dev/null differ
diff --git a/components/display/images/graph_screen.png b/components/display/images/graph_screen.png
deleted file mode 100644
index a47ed6ca5..000000000
Binary files a/components/display/images/graph_screen.png and /dev/null differ
diff --git a/components/display/images/indicator.jpg b/components/display/images/indicator.jpg
new file mode 100644
index 000000000..14ec131c2
Binary files /dev/null and b/components/display/images/indicator.jpg differ
diff --git a/components/display/images/st7567-full.jpg b/components/display/images/st7567-full.jpg
new file mode 100644
index 000000000..be850c491
Binary files /dev/null and b/components/display/images/st7567-full.jpg differ
diff --git a/components/display/images/t-display-amoled.jpg b/components/display/images/t-display-amoled.jpg
new file mode 100644
index 000000000..59163f509
Binary files /dev/null and b/components/display/images/t-display-amoled.jpg differ
diff --git a/components/display/images/t4-s3.jpg b/components/display/images/t4-s3.jpg
new file mode 100644
index 000000000..00448c410
Binary files /dev/null and b/components/display/images/t4-s3.jpg differ
diff --git a/components/display/images/test_card.jpg b/components/display/images/test_card.jpg
new file mode 100644
index 000000000..49ba2cf8a
Binary files /dev/null and b/components/display/images/test_card.jpg differ
diff --git a/components/display/images/waveshare_touch-s3.jpg b/components/display/images/waveshare_touch-s3.jpg
new file mode 100644
index 000000000..111284a7e
Binary files /dev/null and b/components/display/images/waveshare_touch-s3.jpg differ
diff --git a/components/display/index.rst b/components/display/index.rst
index 12fdee505..0dd4a1eab 100644
--- a/components/display/index.rst
+++ b/components/display/index.rst
@@ -2,17 +2,17 @@ Display Component
=================
.. seo::
- :description: Instructions for setting up the display integration.
+ :description: Instructions for setting up the display component.
:image: folder-open.svg
The ``display`` component houses ESPHome's powerful rendering and display
engine. Fundamentally, there are these types of displays:
- Text based displays like :doc:`7-Segment displays ` or
- :doc:`some LCD displays `.
-- Displays like the :doc:`nextion` that have their own processors for rendering.
-- Binary displays which can toggle ON/OFF any pixel, like :doc:`E-Paper displays ` or
- :doc:`OLED displays `.
+ :doc:`LCD displays `.
+- Graphical serial displays like :doc:`nextion` that have their own processors for rendering.
+- Graphical binary displays which can toggle ON/OFF any pixel, like :doc:`E-Paper `,
+ :doc:`OLED ` or :doc:`TFT ` displays.
For the last type, ESPHome has a powerful rendering engine that can do
many things like draw some basic shapes, print text with any font you want, or even show images.
@@ -24,11 +24,6 @@ using an API that is designed to
- be simple and to be used without programming experience
- but also be flexible enough to work with more complex tasks like displaying an analog clock.
-.. note::
-
- Display hardware is complex and sometimes doesn't behave as expected. If you're having trouble with your display,
- please see :ref:`troubleshooting` below.
-
.. _display-engine:
Display Rendering Engine
@@ -38,6 +33,11 @@ In this section we will be discussing how to use ESPHome's display rendering eng
and some basic commands. Please note that this only applies to displays that can control each pixel
individually.
+.. note::
+
+ Display hardware is complex and sometimes doesn't behave as expected. If you're having trouble with your display,
+ please see :ref:`troubleshooting` below.
+
So, first a few basics: When setting up a display platform in ESPHome there will be a configuration
option called ``lambda:`` which will be called every time ESPHome wants to re-render the display.
In each cycle, the display is automatically cleared before the lambda is executed. You can disable
@@ -45,6 +45,9 @@ this behavior by setting ``auto_clear_enabled: false``.
In the lambda, you can write code like in any :ref:`lambda ` in ESPHome. Display
lambdas are additionally passed a variable called ``it`` which represents the rendering engine object.
+.. figure:: images/display_rendering_line.png
+ :align: center
+
.. code-block:: yaml
display:
@@ -72,10 +75,12 @@ x always represents the horizontal axis (width) and y the vertical axis (height)
the rendering engine is always first specify the ``x`` coordinate and then the ``y`` coordinate.
Basic Shapes
-************
+------------
-Now that you know a bit more about ESPHome's coordinate system, let's draw some basic shapes like lines, rectangles
-and circles:
+Now that you know a bit more about ESPHome's coordinate system, let's draw some basic shapes like lines, rectangles, circles or even polygons:
+
+.. figure:: images/display_rendering_shapes.png
+ :align: center
.. code-block:: yaml
@@ -85,15 +90,28 @@ and circles:
lambda: |-
// Draw a line from [0,0] to [100,50]
it.line(0, 0, 100, 50);
- // Draw the outline of a rectangle with the top left at [50,60], a width of 30 and a height of 42
- it.rectangle(50, 60, 30, 42);
- // Draw the same rectangle, but this time filled.
- it.filled_rectangle(50, 60, 30, 42);
+ // Draw the outline of a rectangle with the top left at [5,20], a width of 30 and a height of 42
+ it.rectangle(5, 20, 30, 42);
+ // Draw the same rectangle a few pixels apart, but this time filled
+ it.filled_rectangle(40, 40, 30, 42);
- // Circles! Let's draw one with the center at [25,25] and a radius of 10
- it.circle(25, 25, 10);
+ // Circles! Let's draw one with the center at [20,40] and a radius of 10
+ it.circle(20, 40, 10);
// ... and the same thing filled again
- it.filled_circle(25, 25, 10);
+ it.filled_circle(20, 75, 10);
+
+ // Triangles... Let's draw the outline of a triangle from the [x,y] coordinates of its three points
+ // [25,5], [100,5], [80,25]
+ it.triangle(25, 5, 100, 5, 80, 25);
+ // and a filled triangle !
+ it.filled_triangle(115, 5, 95, 25, 125, 70);
+
+ // Regular Polygons? Let's draw a filled, pointy-topped hexagon inscribed in a circle
+ // centered on [170,45] with a radius of 20
+ it.filled_regular_polygon(170, 45, 20, EDGES_HEXAGON);
+ // and the outline of flat-topped octagon around it!
+ it.regular_polygon(170, 45, 40, EDGES_OCTAGON, VARIATION_FLAT_TOP);
+ // Need to rotate the polygon, or retrieve the coordinates of its vertices? Check the API!
All the above methods can optionally also be called with an argument at the end which specifies in which
color to draw. For monochrome displays, only ``COLOR_ON`` (the default if color is not given) and ``COLOR_OFF`` are supported.
@@ -104,33 +122,35 @@ color to draw. For monochrome displays, only ``COLOR_ON`` (the default if color
- platform: ...
# ...
lambda: |-
- // Turn the whole display on.
+ // Turn the whole display on
it.fill(COLOR_ON);
- // Turn the whole display off.
+ // Turn the whole display off
it.fill(COLOR_OFF);
// Turn a single pixel off at [50,60]
it.draw_pixel_at(50, 60, COLOR_OFF);
- // Turn off a whole display portion.
- it.rectangle(50, 50, 30, 42, COLOR_OFF);
-
For color displays (e.g. TFT displays), you can use the Color class.
+.. figure:: images/display_rendering_colors.png
+ :align: center
+
.. code-block:: yaml
display:
- platform: ...
# ...
lambda: |-
+ auto black = Color(0, 0, 0);
auto red = Color(255, 0, 0);
auto green = Color(0, 255, 0);
auto blue = Color(0, 0, 255);
auto white = Color(255, 255, 255);
- it.rectangle(20, 50, 30, 30, white);
- it.rectangle(25, 55, 30, 30, red);
- it.rectangle(30, 60, 30, 30, green);
- it.rectangle(35, 65, 30, 30, blue);
+ it.filled_circle(20, 32, 15, black);
+ it.filled_circle(40, 32, 15, red);
+ it.filled_circle(60, 32, 15, green);
+ it.filled_circle(80, 32, 15, blue);
+ it.filled_circle(100, 32, 15, white);
Additionally, you have access to two helper methods which will fetch the width and height of the display:
@@ -143,113 +163,19 @@ Additionally, you have access to two helper methods which will fetch the width a
// Draw a circle in the middle of the display
it.filled_circle(it.get_width() / 2, it.get_height() / 2, 20);
+ // Turn off bottom half of the screen
+ it.filled_rectangle(0, it.get_height()/2, it.get_width(), it.get_height()/2, COLOR_OFF);
You can view the full API documentation for the rendering engine in the "API Reference" in the See Also section.
-.. _display-fonts:
-
-Fonts
-*****
-
-The rendering engine also has a powerful font drawer which integrates seamlessly into ESPHome.
-Whereas in most Arduino display projects you have to use one of a few pre-defined fonts in very
-specific sizes, with ESPHome you have the option to use **any** TrueType (``.ttf``) font file
-at **any** size, as well as fixed-size `PCF `_ and `BDF `_ bitmap fonts! Granted the reason for it is
-actually not having to worry about the licensing of font files :)
-
-To use fonts you first have to define a font object in your ESPHome configuration file. Just grab
-a ``.ttf``, ``.pcf``, or ``.bdf`` file from somewhere on the internet and place it, for example,
-inside a ``fonts`` folder next to your configuration file.
-
-Next, create a ``font:`` section in your configuration:
-
-.. code-block:: yaml
-
- font:
- - file: "fonts/Comic Sans MS.ttf"
- id: my_font
- size: 20
-
- # gfonts://family[@weight]
- - file: "gfonts://Roboto"
- id: roboto
- size: 20
-
- - file:
- type: gfonts
- family: Roboto
- weight: 900
- id: font2
- size: 16
-
- - file: "fonts/tom-thumb.bdf"
- id: tomthumb
-
- - file: 'gfonts://Material+Symbols+Outlined'
- id: icon_font_50
- size: 50
- glyphs: ["\U0000e425"] # mdi-timer
-
- display:
- # ...
-
-Configuration variables:
-
-- **file** (**Required**): The path (relative to where the .yaml file is) of the font
- file. You can use the ``gfonts://`` short form to use Google Fonts, or use the below structure:
-
- - **type** (**Required**, string): Can be ``gfonts`` or ``local``.
-
- **Google Fonts**:
-
- Each Google Font will be downloaded once and cached for future use. This can also be used to download Material
- Symbols or Icons as in the example above.
-
- - **family** (**Required**, string): The name of the Google Font family.
- - **weight** (*Optional*, enum): The weight of the font. Can be either the text name or the integer value:
-
- - **thin**: 100
- - **extra-light**: 200
- - **light**: 300
- - **regular**: 400 (**default**)
- - **medium**: 500
- - **semi-bold**: 600
- - **bold**: 700
- - **extra-bold**: 800
- - **black**: 900
-
- - **italic** (*Optional*, boolean): Whether the font should be italic.
-
- **Local Fonts**:
-
- - **path** (**Required**, string): The path (relative to where the .yaml file is) of the TrueType or bitmap font file.
-
-- **id** (**Required**, :ref:`config-id`): The ID with which you will be able to reference the font later
- in your display code.
-- **size** (*Optional*, int): The size of the font in pt (not pixel!).
- If you want to use the same font in different sizes, create two font objects. Note: *size* is ignored
- by bitmap fonts. Defaults to ``20``.
-- **glyphs** (*Optional*, list): A list of characters you plan to use. Only the characters you specify
- here will be compiled into the binary. Adjust this if you need some special characters or want to
- reduce the size of the binary if you don't plan to use some glyphs. The items in the list can also
- be more than one character long if you for example want to use font ligatures. Defaults to
- ``!"%()+=,-_.:°0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz``.
-
-
-.. note::
-
- To use fonts you will need to have the python ``pillow`` package installed, as ESPHome uses that package
- to translate the TrueType and bitmap font files into an internal format. If you're running this as a Home Assistant
- add-on or with the official ESPHome docker image, it should already be installed. Otherwise you need
- to install it using
- ``pip install "pillow==10.1.0"``.
-
.. _display-static_text:
Drawing Static Text
-*******************
+-------------------
-In your display code, you can render static text by referencing the font and just entering your string:
+To be able to display text, you need to prepare some fonts. ESPHome's :ref:`font renderer ` allows you to use OpenType/TrueType/Bitmap fonts for your texts. This is very flexiblle because you can prepare various sets of fonts at different sizes with a different number of glyphs which is extremely convenient when we're talking about flash space.
+
+In your display code, you can render static text by referencing the font and just entering your string enclosed in double quotes:
.. code-block:: yaml
@@ -290,11 +216,25 @@ As with basic shapes, you can also specify a color for the text:
// Syntax is always: it.print(, , , [color=COLOR_ON], [align=TextAlign::TOP_LEFT], );
it.print(0, 0, id(my_font), COLOR_ON, "Left aligned");
+In case of fonts rendered at higher bit depths, the background color has to be specified after the text in order for antialiasing to work:
+
+.. code-block:: yaml
+
+ display:
+ - platform: ...
+ # ...
+ lambda: |-
+ // Syntax is always: it.print(, , , [color=COLOR_ON], [align], , [color=COLOR_OFF]);
+ it.print(0, 0, id(my_font_with_icons), COLOR_ON, TextAlign::CENTER, "Just\U000f05d4here. Already\U000F02D1this.", COLOR_OFF);
+
+
+.. figure:: images/display_rendering_text.png
+ :align: center
.. _display-printf:
Formatted Text
-**************
+--------------
Static text by itself is not too impressive. What we really want is to display *dynamic* content like sensor values
on the display!. That's where ``printf`` comes in. ``printf`` is a formatting engine from the C era and ESPHome
@@ -344,7 +284,7 @@ Another interesting format string is ``%7.2f``, which would become the right-jus
- ``.2`` - round the decimal number to ``2`` digits after the decimal point.
- ``f`` - specifier: f(loat).
-You can even have as many format strings as you want in a single printf call. Just make sure the put the
+You can even have as many formatted items as you want in a single printf call. Just make sure the put the
arguments after the format string in the right order.
.. code-block:: yaml
@@ -366,6 +306,19 @@ To display a text string from a ``text_sensor``, append ``.c_str()`` to the end
lambda: |-
it.printf(0, 0, id(my_font), "Text to follow: %s", id(template_text).state.c_str());
+
+When using anti-aliased fonts you will probably need to specify the color to draw the characters, and the background
+color to mix in for anti-aliasing. This requires the full version of `printf`, e.g.:
+
+.. code-block:: yaml
+
+ display:
+ - platform: ...
+ # ...
+ lambda: |-
+ it.printf(10, 100, id(roboto), Color(0x123456), COLOR_OFF, display::TextAlign::BASELINE, "%f", id(heap_free).state);
+
+
The last printf tip for use in displays I will discuss here is how to display binary sensor values. You
*could* of course just check the state with an ``if`` statement as the first few lines in the example below, but if
you want to be efficient you can use an *inline if* too. With the ``%s`` print specifier you can tell it to
@@ -398,14 +351,14 @@ use any string you pass it, like ``"ON"`` or ``"OFF"``.
.. _display-strftime:
Displaying Time
-***************
+---------------
You can display current time using a time component. Please see the example :ref:`here `.
.. _clipping:
Screen Clipping
-***************
+---------------
Screen clipping is a new set of methods since version 2023.2.0 of esphome. It could be useful when you just want to show
a part of an image or make sure that what you draw on the screen does not go outside a specific region on the screen.
@@ -457,12 +410,10 @@ With ``get_clipping();`` you get a ``Rect`` object back with the latest set clip
With ``is_clipping();`` tells you if clipping is activated.
-
-
.. _config-color:
Color
-*****
+-----
When using RGB-capable displays in ESPHome you may wish to use custom colors.
A ``color`` component exists for just this purpose:
@@ -512,20 +463,15 @@ RGB displays use red, green, and blue, while grayscale displays may use white.
.. _display-graphs:
Graph Component
-***************
+---------------
You can display a graph of a sensor value(s) using this component. The states used for the graph are stored in
memory at the time the sensor updates and will be lost when the device reboots.
Examples:
-.. figure:: images/graph_screen.png
+.. figure:: images/display_rendering_graph.png
:align: center
- :width: 60.0%
-
-.. figure:: images/graph_dualtrace.png
- :align: center
- :width: 60.0%
Graph component with options for grids, border and line-types.
@@ -552,6 +498,7 @@ Graph component with options for grids, border and line-types.
color: my_red
- sensor: my_outside_temperature
line_type: SOLID
+ continuous: true
line_thickness: 3
color: my_blue
- sensor: my_beer_temperature
@@ -580,6 +527,7 @@ Trace specific fields:
- **sensor** (*Optional*, :ref:`config-id`): The sensor value to plot
- **line_thickness** (*Optional*): Defaults to 3
- **line_type** (*Optional*): Specifies the plot line-type. Can be one of the following: ``SOLID``, ``DOTTED``, ``DASHED``. Defaults to ``SOLID``.
+- **continuous** (*Optional*): connects the individual points to make a continuous line. Defaults to ``false``.
- **color** (*Optional*): Sets the color of the sensor trace.
And then later in code:
@@ -623,8 +571,11 @@ And then later in code:
- Axis labels are currently not possible without manually placing them.
- The grid and border color is set with it.graph(), while the traces are defined separately.
+
+.. _display-qrcode:
+
QR Code Component
-*****************
+-----------------
Use this component to generate a QR-code containing a string on the device, which can then be drawn on compatible displays.
@@ -659,8 +610,17 @@ To draw the QR-code, call the ``it.qr_code`` function from your render lambda:
// Draw the QR-code at position [x=50,y=0] with white color and a 2x scale
it.qr_code(50, 0, id(homepage_qr), Color(255,255,255), 2);
+ // Draw the QR-code in the center of the screen with white color and a 2x scale
+ auto size = id(homepage_qr).get_size() * 2; // Multiply by scale
+ auto x = (it.get_width() / 2) - (size / 2);
+ auto y = (it.get_height() / 2) - (size / 2);
+ it.qr_code(x, y, id(homepage_qr), Color(255,255,255), 2);
+
+
+.. _display-image:
+
Images
-******
+------
Use this component to store graphical images on the device, you can then draw the images on compatible displays.
@@ -775,7 +735,7 @@ You can also use this to invert images in two colors display, use ``COLOR_OFF``
as the additional parameters.
Animation
-*********
+---------
Allows to use animated images on displays. Animation inherits all options from the image component.
It adds additional lambda methods: ``next_frame()``, ``prev_frame()`` and ``set_frame()`` to change the shown picture of a gif.
@@ -975,54 +935,36 @@ Additionally the old page will be given as the variable ``from`` and the new one
Troubleshooting
---------------
-Color Test Pattern
-******************
+Using the Color Test Card
+-------------------------
-If you're experiencing issues with your color display, the script below can help you to identify what might be wrong.
-It will show 3 color bars in **RED**, **GREEN** and **BLUE**. To help the graphics display team determine
-the best way to help you, **a picture of the result of this script is very helpful.**
+If you're experiencing issues with your color display, the ``show_test_card: true`` option can help you to identify what might be wrong.
+
+- It will show bars for Red, Green and Blue, graduating to black and white.
+- Together with that it will show the letters "**R**", "**G**" and "**B**" to validate the display geometry.
+- There will be a rectangle around the corners of the display with a marker at the 0,0 corner which should be at the top left of the screen.
+
+.. figure:: images/test_card.jpg
+ :align: center
+ :width: 50.0%
+
+
+
+When all points above are shown correctly then the display is working as expected.
+To help the graphics display team determine the best way to help you, **a picture of the result of this option is very helpful.**
Should you `create an issue `__ in GitHub regarding your display, please
-be sure to **include a link to where you purchased it** so that we can validate the configuration you've used.
+be sure to **include a link to where you purchased the display** so that we can validate the configuration you've used.
-.. code-block:: yaml
+.. note::
- display:
- - platform: ...
- ...
- lambda: |-
- int shift_x = (it.get_width()-310)/2;
- int shift_y = (it.get_height()-256)/2;
- for(auto i = 0; i<256; i++) {
- it.horizontal_line(shift_x+ 0,i+shift_y,50, my_red.fade_to_white(i));
- it.horizontal_line(shift_x+ 50,i+shift_y,50, my_red.fade_to_black(i));
-
- it.horizontal_line(shift_x+105,i+shift_y,50, my_green.fade_to_white(i));
- it.horizontal_line(shift_x+155,i+shift_y,50, my_green.fade_to_black(i));
-
- it.horizontal_line(shift_x+210,i+shift_y,50, my_blue.fade_to_white(i));
- it.horizontal_line(shift_x+260,i+shift_y,50, my_blue.fade_to_black(i));
- }
- it.rectangle(shift_x+ 0, 0+shift_y, shift_x+ 310, 256+shift_y, my_yellow);
-
- color:
- - id: my_blue
- blue: 100%
- - id: my_red
- red: 100%
- - id: my_green
- green: 100%
- - id: my_white
- red: 100%
- blue: 100%
- green: 100%
- - id: my_yellow
- hex: ffff00
+ For displays in 8 bit mode you will see distinct color blocks rather than a smooth gradient.
See Also
--------
- :apiref:`display/display_buffer.h`
+- :ref:`Fonts `
- :ghedit:`Edit`
.. toctree::
diff --git a/components/display/inkplate6.rst b/components/display/inkplate6.rst
index d5069fc34..a55503685 100644
--- a/components/display/inkplate6.rst
+++ b/components/display/inkplate6.rst
@@ -10,7 +10,7 @@ All-in-one e-paper display ``Inkplate 6``, ``Inkplate 10`` and ``Inkplate 6 Plus
The Inkplate 6, 10 and 6 Plus are powerful, Wi-Fi enabled ESP32 based six-inch e-paper displays -
recycled from a Kindle e-reader. Its main feature is simplicity.
-Learn more at `Inkplate's website `, you need to have an ``i2c:`` section in your configuration.
@@ -65,7 +65,7 @@ Configuration variables:
.. note::
- If you're not seeing anything on the display, try turning the contrast potentiometer around on the
+ If you're not seeing anything on the display, try turning the contrast potentiometer around on the
PCF8574 board.
.. _lcd-gpio:
@@ -74,7 +74,7 @@ lcd_gpio Component
------------------
The ``lcd_gpio`` version of this component addresses the screen directly and does not employ a GPIO expander module.
-Each of the data pins of the LCD needs a dedicated GPIO pin on the ESP. Connecting the screen this way offers
+Each of the data pins of the LCD needs a dedicated GPIO pin on the ESP. Connecting the screen this way offers
faster refresh, especially in conjunction with an :ref:`LCD Menu `.
.. figure:: images/lcd_gpio.svg
@@ -90,12 +90,12 @@ faster refresh, especially in conjunction with an :ref:`LCD Menu `.
- platform: lcd_gpio
dimensions: 20x4
data_pins:
- - GPIO32
- - GPIO33
- - GPIO5
- - GPIO17
- enable_pin: D4
- rs_pin: D5
+ - GPIOXX
+ - GPIOXX
+ - GPIOXX
+ - GPIOXX
+ enable_pin: GPIOXX
+ rs_pin: GPIOXX
lambda: |-
it.print("Hello World!");
@@ -105,8 +105,8 @@ Configuration variables:
- **dimensions** (**Required**, string): The dimensions of the display with ``COLUMNSxROWS``. If you're not
sure, power the display on, turn contrast high up and just count them.
- **data_pins** (**Required**, list of :ref:`pins `): A list of the data pins you
- have hooked up to the LCD. The list can either be 4 items long (operating in 4-bit mode with
- either the first 4 data pins connected or the last 4 data pins connected), or 8 items long (when you have
+ have hooked up to the LCD. The list can either be 4 items long (operating in 4-bit mode with
+ either the first 4 data pins connected or the last 4 data pins connected), or 8 items long (when you have
connected all 8 data pins).
- **enable_pin** (**Required**, :ref:`pin `): The pin you have ``E`` (``06``) hooked up to.
- **rs_pin** (**Required**, :ref:`pin `): The pin you have ``RS`` (``04``) hooked up to.
@@ -118,7 +118,7 @@ Configuration variables:
.. note::
- If you're not seeing anything on the display, make sure you apply ``3.3V`` to the ``VEE`` (``03``) contrast control
+ If you're not seeing anything on the display, make sure you apply ``3.3V`` to the ``VEE`` (``03``) contrast control
pin of the board. You can use a potentiometer to make it adjustable.
@@ -177,7 +177,7 @@ The LCD display has the possibility to define up to eight user defined character
``0`` to ``7`` and mirrored at ``8`` to ``15`` (i.e. ``\x08`` can be used instead of the ``\0`` that can
be problematic in strings). Each character has eight lines of five bits, with the first line on the top
and the most significant bit on the left, meaning that ``0b10000`` followed by six zeros and a ``0b00001``
-defines a dot at the upper left and lower right of the character.
+defines a dot at the upper left and lower right of the character.
.. code-block:: yaml
@@ -221,7 +221,7 @@ Keep in mind that the display lambda runs for every ``update_interval``, so if t
it cannot be overridden from other parts.
With the ``lcd_gpio``, the backlight is lit by applying ``Vcc`` to the ``BLA`` (``15``) pin and connect ``BLK`` (``16``)
-pin to ``GND``. The backlight can draw more power than the microcontroller output pins can supply, so it is advisable
+pin to ``GND``. The backlight can draw more power than the microcontroller output pins can supply, so it is advisable
to use a transistor as a switch to control the power for the backlight pins.
Below an example for a typical use-case where the backlight is turned on when a motion sensor activates and
diff --git a/components/display/max7219.rst b/components/display/max7219.rst
index ad1b1c6c5..11e069f1c 100644
--- a/components/display/max7219.rst
+++ b/components/display/max7219.rst
@@ -8,7 +8,7 @@ MAX7219 7-Segment Display
The ``max7219`` display platform allows you to use MAX7219 7-segment display drivers (
`datasheet `__,
`hobbycomponents `__)
-with ESPHome. Please note that this integration is *only* for 7-segment display, not matrix configurations.
+with ESPHome. Please note that this component is *only* for 7-segment display, not matrix configurations.
.. figure:: images/max7219-full.jpg
:align: center
@@ -16,7 +16,7 @@ with ESPHome. Please note that this integration is *only* for 7-segment display,
MAX7219 7-Segment Display.
-As the communication with the MAX7219 is done using SPI for this integration, you need
+As the communication with the MAX7219 is done using SPI for this component, you need
to have an :ref:`SPI bus ` in your configuration with both the **mosi_pin** set (miso_pin is not required).
Connect VCC to 3.3V (the manufacturer recommends 4+ V, but 3.3V seems to work fine), DIN to your ``mosi_pin`` and
CS to your set ``cs_pin`` and finally GND to GND.
diff --git a/components/display/max7219digit.rst b/components/display/max7219digit.rst
index 2c7923c43..650ef878e 100644
--- a/components/display/max7219digit.rst
+++ b/components/display/max7219digit.rst
@@ -5,7 +5,7 @@ MAX7219 Digit Display
:description: Instructions for setting up MAX7219 Digit displays.
:image: max7219digit.jpg
-The ``max7219`` display platform allows you to use MAX7219 digit with ESPHome. Please note that this integration
+The ``max7219`` display platform allows you to use MAX7219 digit with ESPHome. Please note that this component
is *only* for the digit "matrix" display, for the 7 segment display see :doc:`max7219`.
.. figure:: images/max7219digit.png
@@ -14,7 +14,7 @@ is *only* for the digit "matrix" display, for the 7 segment display see :doc:`ma
MAX7219 Digit Display.
-As the communication with the MAX7219 Digit is done using SPI for this integration, you need
+As the communication with the MAX7219 Digit is done using SPI for this component, you need
to have an :ref:`SPI bus ` in your configuration with both the **mosi_pin** set (miso_pin is not required).
Connect VCC to 3.3V (the manufacturer recommends 4+ V, but 3.3V seems to work fine), DIN to your ``mosi_pin`` and
CS to your set ``cs_pin`` and finally GND to GND.
diff --git a/components/display/nextion.rst b/components/display/nextion.rst
index 95c29a89e..09d8a85f9 100644
--- a/components/display/nextion.rst
+++ b/components/display/nextion.rst
@@ -18,15 +18,15 @@ with ESPHome.
As the communication with the Nextion LCD display is done using UART, you need to have an :ref:`UART bus `
in your configuration with ``rx_pin`` both the ``tx_pin`` set to the respective pins on the display.
The Nextion uses a baud rate of 9600 by default. It may be configured to use a faster speed by adding (for
-example)
+example)
.. code-block:: c++
baud=115200 // Sets the baud rate to 115200
bkcmd=0 // Tells the Nextion to not send responses on commands. This is the current default but can be set just in case
-
-
+
+
to the ``program.s`` source file (in the Nextion Editor) before the ``page`` line.
This permits faster communication with the Nextion display and it is highly recommended when using :ref:`uart-hardware_uarts`. Without a hardware uart make sure to set the baud rate to 9600.
@@ -36,17 +36,9 @@ The below example configures a UART for the Nextion display to use
.. code-block:: yaml
# Example configuration entry
- uart:
- id: uart_2
- rx_pin: GPIO16
- tx_pin: GPIO17
- baud_rate: 115200
-
-
display:
- platform: nextion
id: nextion1
- uart_id: uart_2
lambda: |-
it.set_component_value("gauge", 50);
it.set_component_text("textview", "Hello World!");
@@ -73,7 +65,7 @@ Configuration variables:
- **on_wake** (*Optional*, :ref:`Action `): An action to be performed when the Nextion wakes up. See :ref:`Nextion Automation `.
- **on_page** (*Optional*, :ref:`Action `): An action to be performed after a page change. See :ref:`Nextion Automation `.
- **on_touch** (*Optional*, :ref:`Action `): An action to be performed after a touch event (press or release). See :ref:`Nextion Automation `.
-
+
.. _display-nextion_lambda:
Rendering Lambda
@@ -113,7 +105,7 @@ Lambda Calls
************
Several methods are available for use within :ref:`lambdas `; these permit advanced functionality beyond simple
-display updates. See the full :apiref:`nextion/nextion.h` for more info.
+display updates. See the full :apiref:`nextion/nextion.h` for more info.
.. _nextion_upload_tft:
@@ -126,7 +118,7 @@ The developer tools in Home Assistant can be used to trigger the update. The bel
services:
- service: update_nextion
then:
- - lambda: 'id(nextion1)->upload_tft();'
+ - lambda: 'id(nextion1)->upload_tft();'
.. _nextion_update_all_components:
@@ -178,7 +170,7 @@ The developer tools in Home Assistant can be used to trigger the update. The bel
.. _nextion_queue_types:
- Queue Types:
+ Queue Types:
- SENSOR 0
- BINARY_SENSOR 1
- SWITCH 2
@@ -291,7 +283,7 @@ The following arguments will be available:
Uploading A TFT File
--------------------
This will download the file from the tft_url and will transfer it over the UART to the Nextion.
-Once completed both the ESP and Nextion will reboot. During the upload process esphome will be
+Once completed both the ESP and Nextion will reboot. During the upload process esphome will be
unresponsive and no logging will take place. This uses the same protocol as the Nextion editor and
only updates the changes of the TFT file. If HTTPS/SSL is enabled it will be about 1kB/sec.
@@ -304,7 +296,7 @@ To host the TFT file you can use Home Assistant itself or any other web server.
Home Assistant
**************
-To host the TFT file from Home Assistant, create a www directory if it doesn't exist in your config
+To host the TFT file from Home Assistant, create a www directory if it doesn't exist in your config
directory. You can create a subdirectory for those files as well.
For example if the file is located
@@ -321,8 +313,8 @@ The below NGINX example configuration will serve files out of the /var/www/nexti
.. code-block:: nginx
server {
- listen 80;
- access_log /var/log/nginx/nextion_access.log;
+ listen 80;
+ access_log /var/log/nginx/nextion_access.log;
error_log /var/log/nginx/nextion_error.log;
root /var/www/nextion;
}
diff --git a/components/display/qspi_amoled.rst b/components/display/qspi_amoled.rst
new file mode 100644
index 000000000..5d65d8b46
--- /dev/null
+++ b/components/display/qspi_amoled.rst
@@ -0,0 +1,186 @@
+Quad SPI AMOLED Displays
+========================
+
+.. seo::
+ :description: Instructions for setting up quad SPI AMOLED displays.
+ :image: t4-s3.jpg
+
+.. _qspi_amoled:
+
+Models
+------
+This display driver supports AMOLED displays with quad SPI interfaces.
+
+This driver has been tested with the following displays:
+
+ - Lilygo T4-S3
+ - Lilygo T-Display S3 AMOLED
+
+Usage
+-----
+This component requires an ESP32 and the use of
+ESP-IDF. PSRAM is a requirement due to the size of the display buffer. A :ref:`quad SPI bus ` interface must be configured.
+
+.. figure:: images/t4-s3.jpg
+ :align: center
+ :width: 75.0%
+
+ Lilygo T4-S3
+
+.. figure:: images/t-display-amoled.jpg
+ :align: center
+ :width: 75.0%
+
+ Lilygo T-Display S3 AMOLED
+
+
+.. code-block:: yaml
+
+ # Example minimal configuration entry
+
+ display:
+ - platform: qspi_amoled
+ model: RM690B0
+ data_rate: 80MHz
+ spi_mode: mode0
+ dimensions:
+ width: 450
+ height: 600
+ offset_width: 16
+ color_order: rgb
+ invert_colors: false
+ brightness: 255
+ cs_pin: GPIOXX
+ reset_pin: GPIOXX
+ enable_pin: GPIOXX
+
+
+Configuration variables:
+************************
+
+- **model** (**Required**): One of ``RM67162`` or ``RM690B0``.
+- **cs_pin** (**Required**, :ref:`Pin Schema `): The chip select pin.
+- **reset_pin** (*Optional*, :ref:`Pin Schema `): The RESET pin.
+- **enable_pin** (*Optional*, :ref:`Pin Schema `): The display enable pin.
+- **brightness** (*Optional*, int): A brightness value in the range 0-255
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.
+- **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display in each loop (''true'', default),
+ or to keep the existing display content (must overwrite explicitly, e.g., only on data change).
+- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
+- **color_order** (*Optional*): Should be one of ``rgb`` (default) or ``bgr``.
+- **dimensions** (**Required**): Dimensions of the screen, specified either as *width* **x** *height* (e.g ``320x240``) or with separate config keys.
+ - **height** (**Required**, int): Specifies height of display in pixels.
+ - **width** (**Required**, int): Specifies width of display.
+ - **offset_width** (*Optional*, int): Specify an offset for the x-direction of the display, typically used when a display 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.
+
+- **rotation** (*Optional*): Rotate the display presentation in software. Choose one of ``0°``, ``90°``, ``180°``, or ``270°``.
+- **transform** (*Optional*): Transform the display presentation using hardware. All defaults are ``false``. This option cannot be used with ``rotation``.
+
+ - **swap_xy** (*Optional*, boolean): If true, exchange the x and y axes.
+ - **mirror_x** (*Optional*, boolean): If true, mirror the x axis.
+ - **mirror_y** (*Optional*, boolean): If true, mirror the y axis.
+- **data_rate** (*Optional*): Set the data rate of the SPI interface to the display. One of ``80MHz``, ``40MHz``, ``20MHz``, ``10MHz`` (default), ``5MHz``, ``2MHz`` or ``1MHz``.
+- **spi_mode** (*Optional*): Set the mode for the SPI interface to the display. Default is ``MODE0``.
+- **invert_colors** (*Optional*): With this boolean option you can invert the display colors.
+- **lambda** (*Optional*, :ref:`lambda `): The lambda to use for rendering the content on the display.
+ See :ref:`display-engine` for more information.
+
+
+
+Example configurations
+----------------------
+
+
+Lilygo T4-S3
+************
+
+.. code-block:: yaml
+
+ spi:
+ id: quad_spi
+ type: quad
+ clk_pin: 15
+ data_pins: [14, 10, 16, 12]
+
+ i2c:
+ sda: 6
+ scl: 7
+
+ touchscreen:
+ - platform: cst226
+ id: my_touchscreen
+ interrupt_pin: 8
+ reset_pin: 17
+
+ display:
+ - platform: qspi_amoled
+ model: RM690B0
+ data_rate: 80MHz
+ spi_mode: mode0
+ dimensions:
+ width: 450
+ height: 600
+ offset_width: 16
+ color_order: rgb
+ invert_colors: false
+ brightness: 255
+ cs_pin: 11
+ reset_pin: 13
+ enable_pin: 9
+ update_interval: never
+ auto_clear_enabled: false
+
+ psram:
+ mode: octal
+ speed: 80MHz
+
+Lilygo T-Display S3 AMOLED
+**************************
+
+.. code-block:: yaml
+
+ spi:
+ id: quad_spi
+ type: quad
+ clk_pin: 47
+ data_pins:
+ - 18
+ - 7
+ - 48
+ - 5
+
+ i2c:
+ sda: 3
+ scl: 2
+
+ touchscreen:
+ - platform: cst816
+ id: my_touchscreen
+ interrupt_pin:
+ number: 21
+
+ display:
+ - platform: qspi_amoled
+ model: RM67162
+ id: main_lcd
+ dimensions:
+ height: 240
+ width: 536
+ transform:
+ mirror_x: true
+ swap_xy: true
+ color_order: rgb
+ brightness: 255
+ cs_pin: 6
+ reset_pin: 17
+ enable_pin: 38
+
+
+See Also
+--------
+
+- :doc:`index`
+- :apiref:`qspi_amoled/qspi_amoled.h`
+- :ghedit:`Edit`
diff --git a/components/display/rpi_dpi_rgb.rst b/components/display/rpi_dpi_rgb.rst
new file mode 100644
index 000000000..2b5ae9526
--- /dev/null
+++ b/components/display/rpi_dpi_rgb.rst
@@ -0,0 +1,213 @@
+RPI_DPI_RGB Display Driver
+===========================
+
+.. seo::
+ :description: Instructions for setting up 16 bit "RPI_DPI_RGB" parallel displays
+ :image: waveshare_touch-s3.jpg
+
+.. _rpi_dpi_rgb:
+
+Models
+------
+This display driver supports displays with 16 bit parallel interfaces, often referred to as "RPI_DPI_RGB" type.
+These have a parallel interface but no SPI interface and require no configuration of the driver chip.
+
+This driver has been tested with the following displays:
+
+ - Waveshare ESP32-S3-Touch-LCD-4.3
+ - Makerfabs 4.3" display (Sunton)
+
+Usage
+-----
+This component requires an ESP32 (usually an ESP32-S3 because of the number of GPIO pins required) and the use of
+ESP-IDF. PSRAM is a requirement due to the size of the display buffer.
+
+.. figure:: images/waveshare_touch-s3.jpg
+ :align: center
+ :width: 75.0%
+
+ Waveshare ESP32-S3 Touch 4.3
+
+
+.. code-block:: yaml
+
+
+ # Example minimal configuration entry
+ display:
+ - platform: rpi_dpi_rgb
+ id: rpi_disp
+ dimensions:
+ width: 800
+ height: 480
+ de_pin: REPLACE_ME
+ hsync_pin: REPLACE_ME
+ vsync_pin: REPLACE_ME
+ pclk_pin: REPLACE_ME
+
+ data_pins:
+ red:
+ - XX #r1
+ - XX #r2
+ - XX #r3
+ - XX #r4
+ - XX #r5
+ green:
+ - XX #g0
+ - XX #g1
+ - XX #g2
+ - XX #g3
+ - XX #g4
+ - XX #g5
+ blue:
+ - XX #b1
+ - XX #b2
+ - XX #b3
+ - XX #b4
+ - XX #b5
+
+Configuration variables:
+************************
+
+- **data_pins** (**Required**) A list of pins used for the databus. Specified in 3 groups:
+
+ - **red**: (**Required**, :ref:`Pin Schema `) Exactly 5 pin numbers for the red databits, listed from least to most significant bit.
+ - **green**: (**Required**, :ref:`Pin Schema `) Exactly 6 pin numbers for the green databits, listed from least to most significant bit.
+ - **blue**: (**Required**, :ref:`Pin Schema `) Exactly 5 pin numbers for the blue databits, listed from least to most significant bit.
+- **de_pin** (**Required**, :ref:`Pin Schema `): The DE pin
+- **pclk_pin** (**Required**, :ref:`Pin Schema `): The PCLK pin.
+- **hsync_pin** (**Required**, :ref:`Pin Schema `): The Horizontal sync pin.
+- **vsync_pin** (**Required**, :ref:`Pin Schema `): The Vertical sync pin.
+- **reset_pin** (*Optional*, :ref:`Pin Schema `): The RESET pin.
+- **hsync_pulse_width** (*Optional*, int): The horizontal sync pulse width.
+- **hsync_front_porch** (*Optional*, int): The horizontal front porch length.
+- **hsync_back_porch** (*Optional*, int): The horizontal back porch length.
+- **vsync_pulse_width** (*Optional*, int): The vertical sync pulse width.
+- **vsync_front_porch** (*Optional*, int): The vertical front porch length.
+- **vsync_back_porch** (*Optional*, int): The vertical back porch length.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.
+- **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display in each loop (''true'', default),
+ or to keep the existing display content (must overwrite explicitly, e.g., only on data change).
+- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
+- **color_order** (*Optional*): Should be one of ``bgr`` (default) or ``rgb``.
+- **dimensions** (**Required**): Dimensions of the screen, specified either as *width* **x** *height* (e.g ``320x240``) or with separate config keys.
+ - **height** (**Required**, int): Specifies height of display in pixels.
+ - **width** (**Required**, int): Specifies width of display.
+ - **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.
+
+- **pclk_frequency** (*Optional*): Set the pixel clock speed. Default is 16MHz.
+- **pclk_inverted** (*Optional* bool): If the pclk is active negative (default is True)
+- **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.
+- **rotation** (*Optional*): Rotate the display presentation in software. Choose one of ``0°``, ``90°``, ``180°``, or ``270°``.
+- **lambda** (*Optional*, :ref:`lambda `): The lambda to use for rendering the content on the display.
+ See :ref:`display-engine` for more information.
+
+
+The horizontal and vertical ``pulse_width``, ``front_porch`` and ``back_porch`` values are optional, but may require
+changing for a specific display. Refer to the manufacturer's sample code for suitable values. These specify timing
+requirements for the display.
+
+Example configurations
+----------------------
+
+
+Waveshare ESP32-S3 Touch 4.3
+****************************
+
+.. code-block:: yaml
+
+ display:
+ - platform: rpi_dpi_rgb
+ auto_clear_enabled: false
+ color_order: RGB
+ pclk_frequency: 16MHz
+ dimensions:
+ width: 800
+ height: 480
+ de_pin:
+ number: 5
+ hsync_pin:
+ number: 46
+ ignore_strapping_warning: true
+ vsync_pin:
+ number: 3
+ ignore_strapping_warning: true
+ pclk_pin: 7
+ hsync_back_porch: 30
+ hsync_front_porch: 210
+ hsync_pulse_width: 30
+ vsync_back_porch: 4
+ vsync_front_porch: 4
+ vsync_pulse_width: 4
+ data_pins:
+ red:
+ - 1 #r3
+ - 2 #r4
+ - 42 #r5
+ - 41 #r6
+ - 40 #r7
+ blue:
+ - 14 #b3
+ - 38 #b4
+ - 18 #b5
+ - 17 #b6
+ - 10 #b7
+ green:
+ - 39 #g2
+ - 0 #g3
+ - 45 #g4
+ - 48 #g5
+ - 47 #g6
+ - 21 #g7
+
+
+Makerfabs 4.3" 800x480 display
+******************************
+
+.. code-block:: yaml
+
+ display:
+ - platform: rpi_dpi_rgb
+ update_interval: never
+ auto_clear_enabled: false
+ id: rpi_display
+ color_order: RGB
+ rotation: 90
+ dimensions:
+ width: 800
+ height: 480
+ de_pin:
+ number: 40
+ hsync_pin: 39
+ vsync_pin: 41
+ pclk_pin: 42
+ data_pins:
+ red:
+ - 45 #r1
+ - 48 #r2
+ - 47 #r3
+ - 21 #r4
+ - 14 #r5
+ green:
+ - 5 #g0
+ - 6 #g1
+ - 7 #g2
+ - 15 #g3
+ - 16 #g4
+ - 4 #g5
+ blue:
+ - 8 #b1
+ - 3 #b2
+ - 46 #b3
+ - 9 #b4
+ - 1 #b5
+
+
+
+See Also
+--------
+
+- :doc:`index`
+- :apiref:`rpi_dpi_rgb/rpi_dpi_rgb.h`
+- :ghedit:`Edit`
diff --git a/components/display/st7567.rst b/components/display/st7567.rst
new file mode 100644
index 000000000..3c59a7e4a
--- /dev/null
+++ b/components/display/st7567.rst
@@ -0,0 +1,191 @@
+ST7567 LCD Graphic Display
+==========================
+
+.. seo::
+ :description: Instructions for setting up ST7567 Mono STN-LCD display drivers.
+ :image: st7567.jpg
+
+.. _st7567:
+
+Usage
+-----
+
+The ``st7567`` display platform allows you to use wide range of 128x64 display modules based on
+Sitronix ST7567 chipset family (ST7567A, ST7567S, ST7567G, etc.) (`datasheet `__,
+`Sitronix `__) with ESPHome.
+
+Note that this component is for displays that are connected via the :ref:`I²C Bus ` (see :ref:`st7567-i2c`)
+or 3-Wire or 4-Wire :ref:`SPI bus ` (see :ref:`st7567-spi`).
+It's a monochrome LCD graphic display.
+
+.. figure:: images/st7567-full.jpg
+ :align: center
+ :width: 75.0%
+
+ ST7567A based LCD Graphic Display (I²C)
+
+.. note::
+
+ **Voltage:** Check your module specs for required power. Most of the modules are tolerant to range of voltages from 3.3V to 5V, but some might require either 5V or 3.3V.
+
+ **Electrical interference:** To reduce malfunction caused by noise, datasheet recommends to "use the refresh sequence regularly in a specified interval".
+
+ Noone knows what exact interval is - it varies based on your electrical environment - some might need it every hour, for example.
+ Without doing refresh sequence picture on LCD might get glitchy after some time.
+
+ You can plan refresh by using ``interval:`` section and calling ``request_refresh()`` function, after that it will perform display
+ refresh sequence on next component update.
+
+
+.. _st7567-i2c:
+
+Over I²C
+--------
+
+Connect ``SDA`` and ``SCL`` pins on a module to pins you chose for the :ref:`I²C Bus `.
+If your display module has ``RESET`` pin you may optionally connect it to a pin on the
+ESP which may improve reliability. For power, connect ``VCC`` to 3.3V and ``GND`` to ``GND``.
+
+
+.. code-block:: yaml
+
+ # Example minimal configuration entry
+ i2c:
+ sda: D1
+ scl: D2
+
+ display:
+ - platform: st7567_i2c
+ id: my_display
+ lambda: |-
+ it.print(0, 0, id(my_font), "Hello World!");
+
+ interval:
+ - interval: 1h
+ then:
+ - lambda: id(my_display).request_refresh();
+
+
+Configuration variables:
+************************
+
+- **address** (*Optional*, int): Manually specify the :ref:`I²C ` address of the display. Defaults to 0x3F.
+- **i2c_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`I²C Component ` if you want
+ to use multiple I²C buses.
+- **reset_pin** (*Optional*, :ref:`Pin Schema `): The RESET pin. Defaults to not connected.
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``1s``.
+- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
+- **lambda** (*Optional*, :ref:`lambda `): The lambda to use for rendering the content on the display.
+- **invert_colors** (*Optional*, boolean): Display hardware color invesion. Defaults to ``false``.
+- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
+ by this option. One of ``0°`` (default), ``90°``, ``180°``, ``270°``.
+- **transform** (*Optional*): Transform the display presentation using hardware. All defaults are ``false``.
+ - **mirror_x** (*Optional*, boolean): If true, mirror the physical X axis.
+ - **mirror_y** (*Optional*, boolean): If true, mirror the physical Y axis.
+
+
+**Speeding up the bus:** To speed up the display update process you can select higher I²C frequencies, for example:
+
+.. code-block:: yaml
+
+ # Example increased I²C bus speed
+ i2c:
+ sda: D1
+ scl: D2
+ frequency: 400kHz
+
+**Hardware rotation:** 180 degree rotation can be implemented in hardware as in the following example:
+
+.. code-block:: yaml
+
+ # Example using transform section to achieve 180° rotation using hardware
+ display:
+ - platform: st7567_i2c
+ id: my_display
+ transform:
+ mirror_x: true
+ mirror_y: true
+ lambda: |-
+ it.print(0, 0, id(my_font), "Hello World!");
+
+
+.. _st7567-spi:
+
+Over SPI
+--------
+
+Connect ``D0`` to the ``CLK`` pin you chose for the :ref:`SPI bus `, connect ``D1`` to the ``MOSI`` pin and ``DC`` and ``CS``
+to some GPIO pins on the ESP. For power, connect ``VCC`` to 3.3V and ``GND`` to ``GND``.
+Optionally you can also connect the ``RESET`` pin to a pin on the ESP which may improve reliability.
+
+.. code-block:: yaml
+
+ # Example minimal configuration entry
+ spi:
+ clk_pin: D1
+ mosi_pin: D2
+
+ display:
+ - platform: st7567_spi
+ id: my_display
+ dc_pin: D3
+ lambda: |-
+ it.print(0, 0, id(my_font), "Hello World!");
+
+ interval:
+ - interval: 1h
+ then:
+ - lambda: id(my_display).request_refresh();
+
+
+Configuration variables:
+************************
+
+- **dc_pin** (**Required**, :ref:`Pin Schema `): The DC pin.
+- **cs_pin** (*Optional*, :ref:`Pin Schema `): The Chip Select (CS) pin.
+- **reset_pin** (*Optional*, :ref:`Pin Schema `): The RESET pin. Defaults to not connected.
+- **spi_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`SPI Component ` if you want
+ to use multiple SPI buses.
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``1s``.
+
+- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
+- **lambda** (*Optional*, :ref:`lambda `): The lambda to use for rendering the content on the display.
+- **invert_colors** (*Optional*, boolean): Display hardware color invesion. Defaults to ``false``.
+- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
+ by this option. One of ``0°`` (default), ``90°``, ``180°``, ``270°``.
+- **transform** (*Optional*): Transform the display presentation using hardware. All defaults are ``false``.
+ - **mirror_x** (*Optional*, boolean): If true, mirror the physical X axis.
+ - **mirror_y** (*Optional*, boolean): If true, mirror the physical Y axis.
+
+
+**Hardware rotation:** 180 degree rotation can be implemented in hardware as in the following example:
+
+.. code-block:: yaml
+
+ # Example using transform section to achieve 180° rotation using hardware
+ display:
+ - platform: st7567_spi
+ id: my_display
+ dc_pin: D3
+ transform:
+ mirror_x: true
+ mirror_y: true
+ lambda: |-
+ it.print(0, 0, id(my_font), "Hello World!");
+
+
+
+
+See Also
+--------
+
+- :doc:`index`
+- :ref:`display-engine`
+- :ref:`Display Menu `
+- :ref:`i2c`
+- :ref:`spi`
+- :apiref:`st7567/st7567.h`
+- :ghedit:`Edit`
diff --git a/components/display/st7701s.rst b/components/display/st7701s.rst
new file mode 100644
index 000000000..ec217ad31
--- /dev/null
+++ b/components/display/st7701s.rst
@@ -0,0 +1,199 @@
+ST7701S Display Driver
+======================
+
+.. seo::
+ :description: Instructions for setting up ST7701S 16 bit "RGB" parallel displays
+ :image: indicator.jpg
+
+.. _st7701s:
+
+Models
+------
+This display driver supports displays with 16 bit parallel interfaces, often referred to as "RGB". It currently
+supports the ST7701S chip.
+
+This driver has been tested with the following displays:
+
+ - Seeed Sensecap Indicator
+ - Makerfabs 4" display
+
+Usage
+-----
+This component requires an ESP32 (usually an ESP32-S3 because of the number of GPIO pins required) and the use of
+ESP-IDF. PSRAM is a requirement due to the size of the display buffer.
+
+.. figure:: images/indicator.jpg
+ :align: center
+ :width: 75.0%
+
+ Sensecap Indicator display
+
+
+.. code-block:: yaml
+
+ # Example minimal configuration entry
+ display:
+ - platform: st7701s
+ dimensions:
+ width: 480
+ height: 480
+ cs_pin: REPLACE_ME
+ reset_pin: REPLACE_ME
+ de_pin: REPLACE_ME
+ hsync_pin: REPLACE_ME
+ vsync_pin: REPLACE_ME
+ pclk_pin: REPLACE_ME
+ # Replace XX with the correct pin number
+
+ data_pins:
+ red:
+ - XX #r1
+ - XX #r2
+ - XX #r3
+ - XX #r4
+ - XX #r5
+ green:
+ - XX #g0
+ - XX #g1
+ - XX #g2
+ - XX #g3
+ - XX #g4
+ - XX #g5
+ blue:
+ - XX #b1
+ - XX #b2
+ - XX #b3
+ - XX #b4
+ - XX #b5
+
+Configuration variables:
+************************
+
+- **init_sequence** (*Optional*, A list of byte arrays): Specifies the init sequence for the display
+- **data_pins** (**Required**): A list of pins used for the databus. Specified in 3 groups.
+
+ - **red**: (**Required**, :ref:`Pin Schema `) Exactly 5 pin numbers for the red databits, listed from least to most significant bit.
+ - **green**: (**Required**, :ref:`Pin Schema `) Exactly 6 pin numbers for the green databits, listed from least to most significant bit.
+ - **blue**: (**Required**, :ref:`Pin Schema `) Exactly 5 pin numbers for the blue databits, listed from least to most significant bit.
+- **de_pin** (**Required**, :ref:`Pin Schema `): The DE pin.
+- **dc_pin** (*Optional*, :ref:`Pin Schema `): The DC pin.
+- **pclk_pin** (**Required**, :ref:`Pin Schema `): The PCLK pin.
+- **hsync_pin** (**Required**, :ref:`Pin Schema `): The Horizontal sync pin.
+- **vsync_pin** (**Required**, :ref:`Pin Schema `): The Vertical sync pin.
+- **reset_pin** (*Optional*, :ref:`Pin Schema `): The RESET pin.
+- **hsync_pulse_width** (*Optional*, int): The horizontal sync pulse width.
+- **hsync_front_porch** (*Optional*, int): The horizontal front porch length.
+- **hsync_back_porch** (*Optional*, int): The horizontal back porch length.
+- **vsync_pulse_width** (*Optional*, int): The vertical sync pulse width.
+- **vsync_front_porch** (*Optional*, int): The vertical front porch length.
+- **vsync_back_porch** (*Optional*, int): The vertical back porch length.
+- **pclk_frequency** (*Optional*): Set the pixel clock speed. Default is 8MHz.
+- **pclk_inverted** (*Optional* bool): If the pclk is active negative (default is True)
+- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.
+- **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display in each loop (''true'', default),
+ or to keep the existing display content (must overwrite explicitly, e.g., only on data change).
+- **pages** (*Optional*, list): Show pages instead of a single lambda. See :ref:`display-pages`.
+- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
+- **color_order** (*Optional*): Should be one of ``bgr`` (default) or ``rgb``.
+- **dimensions** (**Required**): Dimensions of the screen, specified either as *width* **x** *height* (e.g ``320x240``) or with separate config keys.
+
+ - **height** (**Required**, int): Specifies height of display in pixels.
+ - **width** (**Required**, int): Specifies width of display.
+ - **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``,
+ ``20MHz``, ``10MHz``, ``5MHz``, ``2MHz``, ``1MHz`` (default), ``200kHz``, ``75kHz`` or ``1kHz``.
+- **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.
+- **rotation** (*Optional*): Rotate the display presentation in software. Choose one of ``0°``, ``90°``, ``180°``, or ``270°``. This option cannot be used with ``transform``.
+- **transform** (*Optional*): Transform the display presentation using hardware. All defaults are ``false``. This option cannot be used with ``rotation``.
+
+ - **swap_xy** (*Optional*, boolean): If true, exchange the x and y axes.
+ - **mirror_x** (*Optional*, boolean): If true, mirror the x axis.
+ - **mirror_y** (*Optional*, boolean): If true, mirror the y axis.
+- **lambda** (*Optional*, :ref:`lambda `): The lambda to use for rendering the content on the display.
+ See :ref:`display-engine` for more information.
+
+
+**Note:** 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``
+
+The horizontal and vertical ``pulse_width``, ``front_porch`` and ``back_porch`` values are optional, but may require
+changing for a specific display. Refer to the manufacturer's sample code for suitable values. These specify timing
+requirements for the display.
+
+The ``init_sequence`` requires a list of elements, one of which may be a single integer selecting a canned init
+sequence (the default and currently the only sequence is 1), the remainder must be byte arrays providing additional
+init commands, each consisting of a command byte followed by zero or more data bytes.
+
+These will be collected and sent to the display via SPI during initialisation.
+
+Example configurations
+----------------------
+
+Seeed Sensecap Indicator
+************************
+
+.. code-block:: yaml
+
+ display:
+ - platform: st7701s
+ auto_clear_enabled: false
+ update_interval: never
+ spi_mode: MODE3
+ color_order: RGB
+ dimensions:
+ width: 480
+ height: 480
+ invert_colors: true
+ transform:
+ mirror_x: true
+ mirror_y: true
+ cs_pin:
+ pca9554: p_c_a
+ number: 4
+ reset_pin:
+ pca9554: p_c_a
+ number: 5
+ de_pin: 18
+ hsync_pin: 16
+ vsync_pin: 17
+ pclk_pin: 21
+ init_sequence:
+ - 1 # select canned init sequence number 1
+ - [ 0xE0, 0x1F ] # Set sunlight readable enhancement
+ data_pins:
+ red:
+ - 4 #r1
+ - 3 #r2
+ - 2 #r3
+ - 1 #r4
+ - 0 #r5
+ green:
+ - 10 #g0
+ - 9 #g1
+ - 8 #g2
+ - 7 #g3
+ - 6 #g4
+ - 5 #g5
+ blue:
+ - 15 #b1
+ - 14 #b2
+ - 13 #b3
+ - 12 #b4
+ - 11 #b5
+ lambda: |-
+ it.fill(COLOR_BLACK);
+ it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
+
+
+See Also
+--------
+
+- :doc:`index`
+- :apiref:`st7701s/st7701s.h`
+- :ghedit:`Edit`
diff --git a/components/display/st7789v.rst b/components/display/st7789v.rst
index 3073b8194..e56924b6c 100644
--- a/components/display/st7789v.rst
+++ b/components/display/st7789v.rst
@@ -25,6 +25,12 @@ The TTGO T-Display module shown has the display attached to the module's board a
cannot be changed. Other display modules have pin headers or other connectors which must be connected appropriately
to an ESP module.
+.. warning::
+
+ This component has been made redundant since the ST7789V is now supported by the :ref:`ILI9XXX component `. It is recommended
+ that you use the ``ili9xxx`` component as it will be maintained, whereas this component may not be, or may be removed completely
+ in the future.
+
.. note::
Displays larger than the 135x240 pixel display on the TTGO T-Display shown require a significant amount of RAM
@@ -34,17 +40,13 @@ to an ESP module.
.. code-block:: yaml
# Example minimal configuration entry
- spi:
- clk_pin: GPIO18
- mosi_pin: GPIO19
-
display:
- platform: st7789v
model: TTGO TDisplay 135x240
- backlight_pin: GPIO4
- cs_pin: GPIO5
- dc_pin: GPIO16
- reset_pin: GPIO23
+ backlight_pin: GPIOXX
+ cs_pin: GPIOXX
+ dc_pin: GPIOXX
+ reset_pin: GPIOXX
lambda: |-
it.print(0, 0, id(font), "Hello World!");
@@ -72,6 +74,7 @@ If you do specify them they will override any default.
- ``Adafruit RR 280x240`` (round-rectangular display -- some pixels are "deleted" from corners to form rounded shape)
- ``Adafruit S2 TFT FEATHER 240X135``
- ``LILYGO T-Embed 170X320``
+ - ``Waveshare 1.47in 172X320`` (round-rectangular display -- some pixels are "deleted" from corners to form rounded shape)
- ``Custom`` For other displays not listed above
- **height** (**Required**, int): Sets height of display in pixels. Defaults depends ``model``.
@@ -177,6 +180,16 @@ Items marked RQ are hardware dependent but required and not preset. Items marked
- 46
- 12
- 11
+ * - Waveshare 1.47in 172X320
+ - 320/172
+ - 34/0
+ - 21
+ - 22
+ - 23
+ - 4
+ -
+ - 18
+ - 19
* - Custom
- RQ
- RQ
diff --git a/components/display/tm1621.rst b/components/display/tm1621.rst
index 169ff2e95..e1619a965 100644
--- a/components/display/tm1621.rst
+++ b/components/display/tm1621.rst
@@ -22,10 +22,10 @@ The LCD have four signal, ``cs`` for chip select, ``data`` for data signal, ``re
display:
platform: tm1621
id: tm1621_display
- cs_pin: GPIO17
- data_pin: GPIO5
- read_pin: GPIO23
- write_pin: GPIO18
+ cs_pin: GPIOXX
+ data_pin: GPIOXX
+ read_pin: GPIOXX
+ write_pin: GPIOXX
lambda: |-
it.printf(0, "%.1f", id(my_sensor1).state);
it.display_celsius(true);
@@ -82,7 +82,7 @@ Also we have five function to display or not some unites:
- °F on the first line : ``display_fahrenheit(bool)``
- %HR on the second line : ``display_humidity(bool)``
- V on the first line and A on the second line : ``display_voltage(bool)``
- - kW/h on the first line and W on the second line : ``display_kwh(bool)``
+ - kW/h on the first line and W on the second line : ``display_kwh(bool)``
See Also
--------
diff --git a/components/display/tm1638.rst b/components/display/tm1638.rst
index 742f1ccbd..025d1ab99 100644
--- a/components/display/tm1638.rst
+++ b/components/display/tm1638.rst
@@ -23,9 +23,9 @@ The module can be powered with 5v DC. To display the colon punctuation use the
display:
platform: tm1638
id: tm1638_display
- stb_pin: 5
- clk_pin: 18
- dio_pin: 23
+ stb_pin: GPIOXX
+ clk_pin: GPIOXX
+ dio_pin: GPIOXX
intensity: 5
update_interval: 5s
lambda: |-
@@ -113,9 +113,9 @@ The following example creates a typical digital clock with the ``:`` colon flash
display:
platform: tm1638
- clk_pin: 18
- dio_pin: 23
- stb_pin: 5
+ clk_pin: GPIOXX
+ dio_pin: GPIOXX
+ stb_pin: GPIOXX
update_interval: 500ms
lambda: |-
static int i = 0;
@@ -132,16 +132,16 @@ The TM1638 7 Segment Display Keypad & LED Module has 8 LED lights across the top
.. code-block:: yaml
- switch:
+ switch:
- platform: tm1638
id: TM1638Led1
led: 0
-
+
output:
- platform: tm1638
id: TM1638Led2
led: 1
-
+
Buttons
@@ -163,7 +163,7 @@ The TM1638 7 Segment Display Keypad & LED Module has 8 buttons across the top or
on_release:
then:
- switch.turn_off: TM1638Led1
-
+
- platform: tm1638
name: "TM1638 Button 2"
id: TM1638Button2
diff --git a/components/display/waveshare_epaper.rst b/components/display/waveshare_epaper.rst
index 83f842129..73be28b28 100644
--- a/components/display/waveshare_epaper.rst
+++ b/components/display/waveshare_epaper.rst
@@ -7,8 +7,9 @@ Waveshare E-Paper Display
The ``waveshare_epaper`` display platform allows you to use
some E-Paper displays sold by `Waveshare `__
-with ESPHome. The 2.13" `TTGO module `__ with an ESP32 on the board
-is supported as well. Depending on your specific revision of the board you might need to try out the ``-b73`` or ``-b1``
+with ESPHome. The 2.13" `TTGO module `__ and the
+`Waveshare Cloud Module `__ with an ESP32
+on the board are supported as well. Depending on your specific revision of the TTGO board you might need to try out the ``-b73`` or ``-b1``
version (see below).
The 1.54" `Good Display gdew0154m09 `__
as used in the `M5Stack Core Ink `__
@@ -22,7 +23,7 @@ single-color E-Ink displays are implemented and of those only a few modules.
Waveshare E-Paper 2.9 Inch E-Paper Display.
-The communication ESPHome has chosen to use for this integration is 4-wire :ref:`SPI `, as it's the most stable
+The communication ESPHome has chosen to use for this component is 4-wire :ref:`SPI `, as it's the most stable
and high-speed. So you need to make sure your board is set to the 4-wire SPI mode and have an ``spi:`` section in your
configuration.
@@ -88,10 +89,18 @@ Configuration variables:
- ``2.13in-ttgo-b74`` - T5_V2.3.1 with B74 display tested
- ``2.13in-ttgo-b1`` - T5_V2.3 with B1 display tested
- ``2.13in-ttgo-dke`` - T5_V2.3 with DKE group display (DEPG0213BN) tested
+ - ``2.13inv2`` - 2.13in V2 display (Pico e-Paper 2.13v2 and Cloud Module)
+ - ``2.13inv3`` - 2.13in V3 display (Pico e-Paper 2.13v3)
- ``2.70in`` - currently not working with the HAT Rev 2.1 version
+ - ``2.70inv2``
+ - ``2.70in-b`` - Black/White/Red
+ - ``2.70in-bv2`` - Black/White/Red
- ``2.90in``
+ - ``2.90in-dke``
- ``2.90inv2``
+ - ``2.90inv2-r2`` - 2.9in V2 display, but with different initialization and full/partial display refresh management than ``2.90inv2``
- ``2.90in-b`` - B/W rendering only
+ - ``2.90in-bV3`` - B/W rendering only
- ``4.20in``
- ``4.20in-bV2`` - B/W rendering only
- ``5.83in``
@@ -114,13 +123,13 @@ Configuration variables:
- **busy_pin** (*Optional*, :ref:`Pin Schema `): The BUSY pin. Defaults to not connected.
- **reset_pin** (*Optional*, :ref:`Pin Schema `): The RESET pin. Defaults to not connected.
Make sure you pull this pin high (by connecting it to 3.3V with a resistor) if not connected to a GPIO pin.
- The B74 display variant requires the reset pin.
+ The 2.13" B74 and V2 display variants require the reset pin.
- **rotation** (*Optional*): Set the rotation of the display. Everything you draw in ``lambda:`` will be rotated
by this option. One of ``0°`` (default), ``90°``, ``180°``, ``270°``.
- **full_update_every** (*Optional*, int): E-Paper displays have two modes of switching to the next image: A partial
update that only changes the pixels that have changed and a full update mode that first clears the entire display
and then re-draws the image. The former is much quicker and nicer, but every so often a full update needs to happen
- because artifacts accumulate. On the ``1.54in``, ``1.54inv2``, ``2.13in``, ``2.90in`` and ``2.90inv2`` models you have the option to switch only
+ because artifacts accumulate. On the ``1.54in``, ``1.54inv2``, ``2.13in``, ``2.13inv2``, ``2.90in`` and ``2.90inv2`` models, you have the option to only
do a full-redraw every x-th time using this option. Defaults to ``30`` on the described models and a full update for
all other models.
- **reset_duration** (*Optional*, :ref:`config-time`): Duration for the display reset operation. Defaults to ``200ms``.
diff --git a/components/display_menu/graphical_display_menu.rst b/components/display_menu/graphical_display_menu.rst
index 1c8629e76..9949b8b4e 100644
--- a/components/display_menu/graphical_display_menu.rst
+++ b/components/display_menu/graphical_display_menu.rst
@@ -12,14 +12,14 @@ on graphical displays. This offers the user an interactive method to display
labels, control entities like ``switch``, ``select``, ``number`` available locally on the
ESPHome node, without the requirement of a network connection.
-.. figure:: images/graphical_display_menu.jpg
+.. figure:: images/graphical_display_menu.png
:align: center
:width: 60.0%
Overview
--------
-The integration implements the :ref:`Display Menu ` integration providing
+The component implements the :ref:`Display Menu ` component providing
a hierarchical menu primarily intended to be controlled either by a rotary encoder
with a button or a five-button joystick controller.
@@ -34,7 +34,7 @@ engine such as :doc:`E-Paper displays ` or
display: my_display_component
on_redraw:
then:
- component.update: my_dispay_component
+ component.update: my_display_component
active: false
mode: rotary
items:
@@ -71,6 +71,11 @@ When a **display** is specified the menu will create a :ref:`page `. If you are using a drawing lambda, without pages, it will not
+ behave as expected. Instead you will have to use Advanced Mode
+
Advanced Drawing Mode
*********************
@@ -100,7 +105,37 @@ larger user interface (for example rendering a sensor graph and a control menu n
// Arguments: it.menu(x, y, menu, width, height);
it.menu(half_display_width, 0, id(my_menu), half_display_width, display_height);
+Emulating Pop Up Mode
+*********************
+If you wish to emulate Pop Up Mode the following sample will emulate the same behaviour. This can
+be useful if you're using a display without :ref:`pages ` or if you have other
+requirements that requires control over how and where the menu is rendered.
+
+.. code-block:: yaml
+
+ graphical_display_menu:
+ id: my_menu
+ items:
+ # ... other items here ...
+
+ # An exit menu item (or some other mechanism) that calls display_menu.hide
+ - type: command
+ on_value:
+ then:
+ - display_menu.hide: my_menu
+
+ display:
+ - platform: ..
+ lambda: |-
+ const auto width = it.get_width();
+ const auto height = it.get_height();
+
+ if (id(my_menu).is_active()) {
+ it.menu(0, 0, id(my_menu), width, height);
+ } else {
+ it.print(0, 0, id(font), "Menu is hidden, other drawing would go here here");
+ }
Controlling Menu Item Rendering
-------------------------------
@@ -159,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:
diff --git a/components/display_menu/images/graphical_display_menu.jpg b/components/display_menu/images/graphical_display_menu.jpg
deleted file mode 100644
index eaed932d3..000000000
Binary files a/components/display_menu/images/graphical_display_menu.jpg and /dev/null differ
diff --git a/components/display_menu/images/graphical_display_menu.png b/components/display_menu/images/graphical_display_menu.png
new file mode 100644
index 000000000..0f624696a
Binary files /dev/null and b/components/display_menu/images/graphical_display_menu.png differ
diff --git a/components/display_menu/index.rst b/components/display_menu/index.rst
index 752c2ae94..9a38ecbf8 100644
--- a/components/display_menu/index.rst
+++ b/components/display_menu/index.rst
@@ -7,7 +7,7 @@ Display Menu
.. _display_menu:
-The integration provides a menu primarily intended to be controlled either by a rotary encoder
+The component provides a menu primarily intended to be controlled either by a rotary encoder
with a button or a five-button joystick controller. It allows to navigate a hierarchy of items
and submenus with the ability to change the values and execute commands. The menu can
be activated and deactivated on demand, allowing alternating between using the screen for
@@ -17,8 +17,8 @@ Overview
--------
This document describes the configuration and automations common for the components implementing
-this integration. At the moment the character based LCD displays are supported using
-the :ref:`lcd_menu ` integration and an instance of this is used in the configuration
+this component. At the moment the character based LCD displays are supported using
+the :ref:`lcd_menu ` component and an instance of this is used in the configuration
examples.
diff --git a/components/display_menu/lcd_menu.rst b/components/display_menu/lcd_menu.rst
index 676c6d474..9645ece37 100644
--- a/components/display_menu/lcd_menu.rst
+++ b/components/display_menu/lcd_menu.rst
@@ -19,7 +19,7 @@ ESPHome node, without the requirement of a network connection.
Overview
--------
-The integration implements the :ref:`Display Menu ` integration providing
+The component implements the :ref:`Display Menu ` component providing
a hierarchical menu primarily intended to be controlled either by a rotary encoder
with a button or a five-button joystick controller.
diff --git a/components/esp32_ble_tracker.rst b/components/esp32_ble_tracker.rst
index afc7a3bf2..818f8d513 100644
--- a/components/esp32_ble_tracker.rst
+++ b/components/esp32_ble_tracker.rst
@@ -264,6 +264,29 @@ Stops the bluetooth scanning. It can be started again with the above start scan
on_...:
- esp32_ble_tracker.stop_scan:
+Use on single-core chips
+------------------------
+
+On dual-core devices the WiFi component runs on core 1, while this component runs on core 0.
+When using this component on single core chips such as the ESP32-C3 both WiFi and ``ble_tracker`` must run on
+the same core, and this has been known to cause issues when connecting to WiFi. A work-around for this is to
+enable the tracker only while the native API is connected. The following config will achieve this:
+
+.. code-block:: yaml
+
+ esp32_ble_tracker:
+ scan_parameters:
+ continuous: false
+
+ api:
+ encryption:
+ key: !secret encryption_key
+ on_client_connected:
+ - esp32_ble_tracker.start_scan:
+ continuous: true
+ on_client_disconnected:
+ - esp32_ble_tracker.stop_scan:
+
See Also
--------
diff --git a/components/esp32_camera.rst b/components/esp32_camera.rst
index 793e08887..0de4c1ffd 100644
--- a/components/esp32_camera.rst
+++ b/components/esp32_camera.rst
@@ -14,16 +14,16 @@ directly integrate into Home Assistant through the native API.
esp32_camera:
name: My Camera
external_clock:
- pin: GPIO27
+ pin: GPIOXX
frequency: 20MHz
i2c_pins:
- sda: GPIO25
- scl: GPIO23
- data_pins: [GPIO17, GPIO35, GPIO34, GPIO5, GPIO39, GPIO18, GPIO36, GPIO19]
- vsync_pin: GPIO22
- href_pin: GPIO26
- pixel_clock_pin: GPIO21
- reset_pin: GPIO15
+ sda: GPIOXX
+ scl: GPIOXX
+ data_pins: [GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX]
+ vsync_pin: GPIOXX
+ href_pin: GPIOXX
+ pixel_clock_pin: GPIOXX
+ reset_pin: GPIOXX
resolution: 640x480
jpeg_quality: 10
@@ -37,10 +37,10 @@ Configuration variables:
a ``name`` will implicitly set this to true.
- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
(usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
- Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+ Defaults to ``false``.
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
- for a list of available options. Requires Home Assistant 2021.11 or newer.
+ for a list of available options.
Set to ``""`` to remove the default entity category.
Connection Options:
@@ -179,7 +179,7 @@ Configuration for Ai-Thinker Camera
.. warning::
- GPIO16 on this board (and possibly other boards below) is connected to onboard PSRAM.
+ GPIO16 on this board (and possibly other boards below) is connected to onboard PSRAM.
Using this GPIO for other purposes (eg as a button) will trigger the watchdog.
Further information on pin notes can be found here: https://github.com/raphaelbs/esp32-cam-ai-thinker/blob/master/docs/esp32cam-pin-notes.md
diff --git a/components/esphome.rst b/components/esphome.rst
index 80d42af5d..ec0217c50 100644
--- a/components/esphome.rst
+++ b/components/esphome.rst
@@ -40,8 +40,9 @@ Advanced options:
- **build_path** (*Optional*, string): Customize where ESPHome will store the build files
for your node. By default, ESPHome puts the PlatformIO project it uses to build the
- firmware in the ``.esphome/build/`` directory, but you can customize this
- behavior using this option.
+ firmware in the ``.esphome/build/`` (or into path from ``ESPHOME_BUILD_PATH`` environment variable if specified) directory,
+ but you can customize this behavior using this option. Official docker image automatically use `/build` folder
+ as default one in case it is mounted to it.
- **platformio_options** (*Optional*, mapping): Additional options to pass over to PlatformIO in the
platformio.ini file. See :ref:`esphome-platformio_options`.
- **includes** (*Optional*, list of files): A list of C/C++ files to include in the main (auto-generated) sketch file
@@ -57,6 +58,10 @@ Advanced options:
- **name** (**Required**, string): Name of the project
- **version** (**Required**, string): Version of the project
+ - **on_update** (*Optional*, :ref:`Automation `): An automation to perform when the device firmware is updated.
+ This compares the above ``version`` field with the ``version`` that was in the previous firmware
+ as long as the ``name`` matches.
+ The ``version`` is stored in flash memory when the firmware is first run for future comparisons.
- **min_version** (*Optional*, string): The minimum ESPHome version required to compile this configuration.
See :ref:`esphome-min_version`.
- **compile_process_limit** (*Optional*, int): The maximum number of simultaneous compile processes to run.
@@ -324,15 +329,15 @@ The same procedure can be done for changing the static IP of a device.
Adding the MAC address as a suffix to the device name
-----------------------------------------------------
-Using ``name_add_mac_suffix`` allows :doc:`creators ` to
-provision multiple devices at the factory with a single firmware and still
+Using ``name_add_mac_suffix`` allows :doc:`creators ` to
+provision multiple devices at the factory with a single firmware and still
have unique identification for customer installs.
.. note::
- End users will need to create an individual YAML config file if they want to OTA update the
+ End users will need to create an individual YAML config file if they want to OTA update the
devices in the future. Creators can facilitate this process by providing ``dashboard_import`` URL
- for end users. This allows them to easily update their devices as new features are made available
+ for end users. This allows them to easily update their devices as new features are made available
upstream.
diff --git a/components/ethernet.rst b/components/ethernet.rst
index 13a843291..b10165883 100644
--- a/components/ethernet.rst
+++ b/components/ethernet.rst
@@ -14,11 +14,11 @@ This component and the Wi-Fi component may **not** be used simultaneously, even
.. code-block:: yaml
- # Example configuration entry
+ # Example configuration entry for RMII chips
ethernet:
type: LAN8720
- mdc_pin: GPIO23
- mdio_pin: GPIO18
+ mdc_pin: GPIOXX
+ mdio_pin: GPIOXX
clk_mode: GPIO0_IN
phy_addr: 0
@@ -28,6 +28,18 @@ This component and the Wi-Fi component may **not** be used simultaneously, even
gateway: 10.0.0.1
subnet: 255.255.255.0
+.. code-block:: yaml
+
+ # Example configuration entry for SPI chips
+ ethernet:
+ type: W5500
+ clk_pin: GPIOXX
+ mosi_pin: GPIOXX
+ miso_pin: GPIOXX
+ cs_pin: GPIOXX
+ interrupt_pin: GPIOXX
+ reset_pin: GPIOXX
+
Configuration variables:
------------------------
@@ -35,13 +47,17 @@ Configuration variables:
Supported chipsets are:
- - ``LAN8720``
- - ``RTL8201``
- - ``DP83848``
- - ``IP101``
- - ``JL1101``
- - ``KSZ8081``
- - ``KSZ8081RNA``
+ - ``LAN8720`` (RMII)
+ - ``RTL8201`` (RMII)
+ - ``DP83848`` (RMII)
+ - ``IP101`` (RMII)
+ - ``JL1101`` (RMII)
+ - ``KSZ8081`` (RMII)
+ - ``KSZ8081RNA`` (RMII)
+ - ``W5500`` (SPI)
+
+RMII configuration variables:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- **mdc_pin** (**Required**, :ref:`config-pin`): The MDC pin of the board.
Usually this is ``GPIO23``.
@@ -58,6 +74,24 @@ Configuration variables:
- **phy_addr** (*Optional*, int): The PHY addr type of the Ethernet controller. Defaults to 0.
- **power_pin** (*Optional*, :ref:`Pin Schema `): The pin controlling the
power/reset status of the Ethernet controller. Leave unspecified for no power pin (default).
+
+SPI configuration variables:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- **clk_pin** (**Required**, :ref:`config-pin`): The SPI clock pin.
+- **mosi_pin** (**Required**, :ref:`config-pin`): The SPI MOSI pin.
+- **miso_pin** (**Required**, :ref:`config-pin`): The SPI MISO pin.
+- **cs_pin** (**Required**, :ref:`config-pin`): The SPI chip select pin.
+- **interrupt_pin** (*Optional*, :ref:`config-pin`): The interrupt pin.
+- **reset_pin** (*Optional*, :ref:`config-pin`): The reset pin.
+- **clock_speed** (*Optional*, float): The SPI clock speed.
+ Any frequency between `8Mhz` and `80Mhz` is allowed, but the nearest integer division
+ of `80Mhz` is used, i.e. `16Mhz` (`80Mhz` / 5) is used when `15Mhz` is configured.
+ Default: `26.67Mhz`.
+
+Advanced common configuration variables:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
- **manual_ip** (*Optional*): Manually configure the static IP of the node.
- **static_ip** (**Required**, IPv4 address): The static IP of your node.
@@ -83,6 +117,10 @@ Configuration variables:
clock signal that will not travel reliably over these types of connections. For more
information and wiring details refer to the link in the *See also* section.
+.. note::
+
+ SPI based chips do *not* use :doc:`spi`. This means that SPI pins can't be shared with other devices.
+
Configuration examples
----------------------
@@ -98,6 +136,10 @@ Configuration examples
phy_addr: 0
power_pin: GPIO12
+.. note::
+
+ WROVER version of Olimex POE cards change CLK to ping GPIO0, configuration must be `clk_mode: GPIO0_OUT`.
+
**Olimex ESP32-EVB**:
@@ -222,7 +264,7 @@ Configuration examples
clk_mode: GPIO17_OUT
phy_addr: 1
-**LILYGO T-ETH-Lite**:
+**LILYGO T-ETH-Lite ESP32**:
.. code-block:: yaml
diff --git a/components/event/index.rst b/components/event/index.rst
new file mode 100644
index 000000000..85004ac46
--- /dev/null
+++ b/components/event/index.rst
@@ -0,0 +1,147 @@
+Event Component
+===============
+
+.. seo::
+ :description: Instructions for setting up event components in ESPHome.
+ :image: folder-open.svg
+
+ESPHome supports the creation of event entities in Home Assistant.
+These entities allow for the triggering of custom events within the Home Assistant ecosystem,
+enabling complex automations and integrations. An event entity is represented as a stateless
+entity associated with a device that has a pre-defined set of event types which can be
+triggered in Home Assistant via automations.
+
+.. note::
+
+ Events in ESPHome are designed to trigger an action in Home Assistant, and have a unidirectional flow from ESPHome to Home Assistant.
+ Home Assistant event entities are different from events on event bus. If you just want to trigger an event on the
+ Home Assistant event bus, you should use a :ref:`Home Assistant event ` instead.
+
+
+.. note::
+
+ Home Assistant Core 2024.5 or higher is required for ESPHome event entities to work.
+
+.. _config-event:
+
+Base Event Configuration
+------------------------
+
+Each event in ESPHome needs to be configured with a list of event types it can trigger and an optional device class.
+
+.. code-block:: yaml
+
+ # Example event configuration
+ event:
+ - platform: ...
+ name: Motion Detected Event
+ id: my_event
+
+ # Optional variables:
+ icon: "mdi:motion-sensor"
+ device_class: "motion"
+ on_event:
+ then:
+ - logger.log: "Event triggered"
+
+Configuration variables:
+
+One of ``id`` or ``name`` is required.
+
+- **id** (**Required**, :ref:`config-id`): Manually specify the ID used for code generation, allowing for further customization or interaction with this event within ESPHome scripts or lambda functions.
+- **name** (**Required**, string): The name for the event.
+
+ .. note::
+
+ If you have a :ref:`friendly_name ` set for your device and
+ you want the event to use that name, you can set ``name: None``.
+
+- **icon** (*Optional*, icon): Manually set the icon to use for the event 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.
+- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend,
+ (usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
+- **entity_category** (*Optional*, string): The category of the entity.
+ See https://developers.home-assistant.io/docs/core/entity/#generic-properties
+ for a list of available options. Set to ``""`` to remove the default entity category.
+- **device_class** (*Optional*, string): The device class for the event. The following device classes are supported by event entities:
+
+ - None: Generic event. This is the default and doesn't need to be set.
+ - ``button``: For remote control buttons.
+ - ``doorbell``: Specifically for buttons that are used as a doorbell.
+ - ``motion``: For motion events detected by a motion sensor.
+
+ See https://www.home-assistant.io/integrations/event/#device-class
+ for a list of available options.
+
+Automations:
+
+- **on_event** (*Optional*, :ref:`Automation `): An automation to perform when an event is triggered.
+
+MQTT options:
+
+- All other options from :ref:`MQTT Component `.
+
+Event Automation
+----------------
+
+.. _event-on_event:
+
+``on_event``
+************
+
+This automation will be triggered when an event of the specified types is triggered.
+
+.. code-block:: yaml
+
+ event:
+ - platform: template
+ # ...
+ on_event:
+ then:
+ - logger.log: "Event Triggered"
+
+Configuration variables: see :ref:`Automation `.
+
+``event.trigger`` Action
+************************
+
+This action allows for the triggering of an event from within an automation.
+
+.. code-block:: yaml
+
+ - event.trigger:
+ id: my_event
+ event_type: "custom_event"
+
+Configuration variables:
+
+- **id** (**Required**, :ref:`config-id`): The ID of the event.
+- **event_type** (**Required**, string): The type of event to trigger.
+
+.. _event-lambda_calls:
+
+lambda Calls
+************
+
+From :ref:`lambdas `, you can trigger an event.
+
+- ``trigger(std::string event_type)``: Trigger an event with the specified type.
+
+ .. code-block:: cpp
+
+ // Within lambda, trigger the event.
+ id(my_event).trigger("custom_event");
+
+See Also
+--------
+
+- :apiref:`event/event.h`
+- :ghedit:`Edit`
+
+.. toctree::
+ :maxdepth: 1
+ :glob:
+
+ *
diff --git a/components/event/template.rst b/components/event/template.rst
new file mode 100644
index 000000000..d0a8d5533
--- /dev/null
+++ b/components/event/template.rst
@@ -0,0 +1,31 @@
+Template Event
+==============
+
+.. seo::
+ :description: Instructions for setting up template events that can trigger arbitrary automations when an event occurs.
+ :image: description.svg
+
+The ``template`` event platform enables you to define events that trigger specific automations or actions within Home Assistant. These custom events can be utilized to orchestrate complex behaviors across your smart home ecosystem based on conditions or sequences defined in your ESPHome configuration.
+
+.. code-block:: yaml
+
+ # Example configuration entry
+ event:
+ - platform: template
+ name: "Template Event"
+ event_types:
+ - "custom_event_1"
+ - "custom_event_2"
+
+Configuration variables:
+------------------------
+
+- **event_types** (**Required**, list): A list of custom event identifiers that this template event is capable of triggering. These identifiers can be used in Home Assistant automations or ESPHome scripts to perform actions when the event occurs.
+- All other options from :ref:`Event `.
+
+See Also
+--------
+
+- :doc:`/guides/automations`
+- :doc:`/components/event/index`
+- :ghedit:`Edit`
diff --git a/components/exposure_notifications.rst b/components/exposure_notifications.rst
index 75f323de3..1007cf55f 100644
--- a/components/exposure_notifications.rst
+++ b/components/exposure_notifications.rst
@@ -52,7 +52,7 @@ minute, the indicator will be on.
switch:
- platform: gpio
- pin: GPIO22
+ pin: GPIOXX
id: led
script:
diff --git a/components/external_components.rst b/components/external_components.rst
index 32a89747b..d24482171 100644
--- a/components/external_components.rst
+++ b/components/external_components.rst
@@ -46,6 +46,7 @@ Configuration variables:
- **ref** (*Optional*, string): Git ref (branch or tag). If not specified the default branch is used.
- **username** (*Optional*, string): Username for the Git server, if one is required
- **password** (*Optional*, string): Password for the Git server, if one is required
+ - **path** (*Optional*, string): Path inside the repo, if different from ``components`` or ``esphome/components``
local options:
diff --git a/components/fan/binary.rst b/components/fan/binary.rst
index eefad56e1..c7328c5e7 100644
--- a/components/fan/binary.rst
+++ b/components/fan/binary.rst
@@ -14,18 +14,13 @@ The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan
.. code-block:: yaml
# Example configuration entry
- output:
- - id: fan_output
- platform: gpio
- pin: GPIO16
-
fan:
- platform: binary
output: fan_output
name: "Living Room Fan"
-
-
-
+
+
+
Configuration variables:
------------------------
diff --git a/components/fan/hbridge.rst b/components/fan/hbridge.rst
index 4ed716697..7e4295f8c 100644
--- a/components/fan/hbridge.rst
+++ b/components/fan/hbridge.rst
@@ -23,14 +23,6 @@ The ``hbridge`` fan platform allows you to use a compatible *h-bridge* (L298N, D
.. code-block:: yaml
# Example configuration entry
- output:
- - platform: ...
- id: motor_forward_pin
- pin: GPIO5
- - platform: ...
- id: motor_reverse_pin
- pin: GPIO4
-
fan:
- platform: hbridge
id: my_fan
diff --git a/components/fan/index.rst b/components/fan/index.rst
index 7dfdb0ef6..08039308a 100644
--- a/components/fan/index.rst
+++ b/components/fan/index.rst
@@ -49,10 +49,10 @@ Configuration variables:
a ``name`` will implicitly set this to true.
- **disabled_by_default** (*Optional*, boolean): If true, then this entity should not be added to any client's frontend
(usually Home Assistant) without the user manually enabling it (via the Home Assistant UI).
- Requires Home Assistant 2021.9 or newer. Defaults to ``false``.
+ Defaults to ``false``.
- **entity_category** (*Optional*, string): The category of the entity.
See https://developers.home-assistant.io/docs/core/entity/#generic-properties
- for a list of available options. Requires Home Assistant 2021.11 or newer.
+ for a list of available options.
Set to ``""`` to remove the default entity category.
MQTT options:
@@ -73,14 +73,20 @@ MQTT options:
Automation triggers:
+- **on_state** (*Optional*, :ref:`Action `): An automation to perform
+ when the fan state is changed. See :ref:`fan-on_state_trigger`.
- **on_turn_on** (*Optional*, :ref:`Action `): An automation to perform
when the fan is turned on. See :ref:`fan-on_turn_on_off_trigger`.
- **on_turn_off** (*Optional*, :ref:`Action `): An automation to perform
when the fan is turned off. See :ref:`fan-on_turn_on_off_trigger`.
+- **on_direction_set** (*Optional*, :ref:`Action `): An automation to perform
+ when the fan direction is changed. See :ref:`fan-on_direction_set_trigger`.
+- **on_oscillating_set** (*Optional*, :ref:`Action `): An automation to perform
+ when the fan oscillating state is changed. See :ref:`fan-on_oscillating_set_trigger`.
- **on_speed_set** (*Optional*, :ref:`Action `): An automation to perform
- when the fan speed is set/changed. See :ref:`fan-on_speed_set_trigger`.
+ when the fan speed is changed. See :ref:`fan-on_speed_set_trigger`.
- **on_preset_set** (*Optional*, :ref:`Action `): An automation to perform
- when the fan preset mode is set/changed. See :ref:`fan-on_preset_set_trigger`.
+ when the fan preset mode is changed. See :ref:`fan-on_preset_set_trigger`.
.. _fan-toggle_action:
@@ -175,6 +181,24 @@ This :ref:`condition ` passes if the given fan is on or off.
then:
- script.execute: my_script
+.. _fan-on_state_trigger:
+
+``fan.on_state`` Trigger
+------------------------
+
+This trigger is activated each time the fan state is changed. It will fire when the state is either set via API e.g. in Home Assistant or locally by an automation or a lambda function.
+A pointer to the ``Fan`` is available as a variable called ``x``.
+
+.. code-block:: yaml
+
+ fan:
+ - platform: speed # or any other platform
+ # ...
+ on_state:
+ - logger.log:
+ format: "Fan State changed! Fan Speed is %d!"
+ args: [ x->speed ]
+
.. _fan-on_turn_on_off_trigger:
``fan.on_turn_on`` / ``fan.on_turn_off`` Trigger
@@ -193,12 +217,49 @@ if a command to turn the fan on or off already matches the current state.
on_turn_off:
- logger.log: "Fan Turned Off!"
+.. _fan-on_direction_set_trigger:
+
+``fan.on_direction_set`` Trigger
+--------------------------------
+
+This trigger is activated each time the fan direction is changed. It will fire when the direction is either set via API e.g. in Home Assistant or locally by an automation or a lambda function.
+The new direction is available as a variable called ``x``. (``0`` is FORWARD, ``1`` is REVERSE)
+
+.. code-block:: yaml
+
+ fan:
+ - platform: speed # or any other platform
+ # ...
+ on_direction_set:
+ - logger.log:
+ format: "Fan Direction was changed to %s!"
+ args: [ x == 0 ? "FORWARD" : "REVERSE" ]
+
+.. _fan-on_oscillating_set_trigger:
+
+``fan.on_oscillating_set`` Trigger
+----------------------------------
+
+This trigger is activated each time the fan oscillating state is changed. It will fire when the state is either set via API e.g. in Home Assistant or locally by an automation or a lambda function.
+The new oscillating state is available as a variable called ``x``.
+
+.. code-block:: yaml
+
+ fan:
+ - platform: speed # or any other platform
+ # ...
+ on_oscillating_set:
+ - logger.log:
+ format: "Fan Oscillating State was changed to %s!"
+ args: [ ONOFF(x) ]
+
.. _fan-on_speed_set_trigger:
``fan.on_speed_set`` Trigger
----------------------------
This trigger is activated each time the fan speed is changed. It will fire when the speed is either set via API e.g. in Home Assistant or locally by an automation or a lambda function.
+The new speed is available as a variable called ``x``.
.. code-block:: yaml
@@ -206,7 +267,9 @@ This trigger is activated each time the fan speed is changed. It will fire when
- platform: speed # or any other platform
# ...
on_speed_set:
- - logger.log: "Fan Speed was changed!"
+ - logger.log:
+ format: "Fan Speed was changed to %d!"
+ args: [ x ]
.. _fan-on_preset_set_trigger:
@@ -214,6 +277,7 @@ This trigger is activated each time the fan speed is changed. It will fire when
-----------------------------
This trigger is activated each time the fan preset mode is changed. It will fire when the preset mode is either set via API e.g. in Home Assistant or locally by an automation or a lambda function.
+The new mode is available as a variable called ``x``.
.. code-block:: yaml
@@ -221,7 +285,9 @@ This trigger is activated each time the fan preset mode is changed. It will fire
- platform: speed # or any other platform
# ...
on_preset_set:
- - logger.log: "Fan preset mode was changed!"
+ - logger.log:
+ format: "Fan preset mode was changed to %s!"
+ args: [ x.c_str() ]
Lambda calls
------------
diff --git a/components/fan/speed.rst b/components/fan/speed.rst
index 2f9f5bc6b..e23f0b009 100644
--- a/components/fan/speed.rst
+++ b/components/fan/speed.rst
@@ -23,9 +23,8 @@ supports speed settings.
Configuration variables:
------------------------
-- **output** (**Required**, :ref:`config-id`): The id of the
- :ref:`float output
+
+Then:
+
+#. Fnd your device in the device list
+#. Click the "configure" button next to it
+#. Check the "Allow the device to make Home Assistant service calls" box
+#. Then click "submit".
+
.. _api-homeassistant_event_action:
``homeassistant.event`` Action
******************************
+.. note::
+
+ Be sure to :ref:`follow the instructions above