Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-27 17:37:45 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #2730 from esphome/bump-2023.3.0b2

Browse Source 
2023.3.0b2
This commit is contained in:
Jesse Hills 2023-03-09 19:03:57 +13:00 committed by GitHub
commit 6be6f7631d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 50 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxygen
View File

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

2
Makefile
View File

@ -1,5 +1,5 @@
ESPHOME_PATH = ../esphome
ESPHOME_REF = 2023.3.0b1
ESPHOME_REF = 2023.3.0b2
.PHONY: html html-strict cleanhtml deploy help live-html Makefile netlify netlify-api api netlify-dependencies svg2png copy-svg2png minify

1
_redirects
View File

@ -8,3 +8,4 @@
/devices/esp32.html /components/esp32.html
/changelog/2022.12.4.html /changelog/2022.12.0.html 301
/components/display/ili9341.html /components/display/ili9xxx.html 301

2
_static/version
View File

@ -1 +1 @@
2023.3.0b1
2023.3.0b2

10
changelog/2023.3.0.rst
View File

@ -61,6 +61,16 @@ Breaking Changes
- Sprinkler "v2" updates :esphomepr:`4159` by :ghuser:`kbx81` (breaking-change)
- sn74hc165 fixes :esphomepr:`4457` by :ghuser:`jesserockz` (breaking-change)
Beta Changes
^^^^^^^^^^^^
- Fix ethernet clk_mode for GPIO0_OUT :esphomepr:`4307` by :ghuser:`jorticus`
- Add ESP32-S3 support in NeoPixelBus component :esphomepr:`4114` by :ghuser:`rcloran`
- Renaming and extending the ili9341 to the ili9xxx component :esphomepr:`4275` by :ghuser:`nielsnl68` (new-integration) (breaking-change)
- Drop unused, broken logging macros :esphomepr:`4534` by :ghuser:`oxan`
- Revert storing Font glyphs in manually-allocated memory :esphomepr:`4516` by :ghuser:`oxan`
- Correct BME680 gas calculation and heater_off :esphomepr:`4498` by :ghuser:`CarlosGS`
All changes
^^^^^^^^^^^

42
components/display/ili9341.rst → components/display/ili9xxx.rst
View File

@ -1,21 +1,25 @@
ILI9341 TFT LCD
===============
ILI9xxx TFT LCD Series
======================
.. seo::
:description: Instructions for setting up ILI9341 TFT LCD display drivers.
:description: Instructions for setting up ILI9xxx TFT LCD display drivers.
:image: ili9341.jpg
.. _ili9341:
.. _ili9xxx:
Usage
-----
This component is the successor of the ILI9341 component allowing to control more display drivers and use 16bit colors when enough free ram.
The ``ili9341`` display platform allows you to use
The ``ILI9xxx`` display platform allows you to use
ILI9341 (`datasheet <https://cdn-shop.adafruit.com/datasheets/ILI9341.pdf>`__,
`Aliexpress <https://www.aliexpress.com/af/Ili9341.html>`__)
displays with ESPHome. As this is a somewhat higher resolution display and may require pins
`Aliexpress <https://www.aliexpress.com/af/Ili9341.html>`__) 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.
**Note:** To use 16bit instead of 8bit colors use a esp32 with enough PSRAM the display.
.. figure:: images/ili9341-full.jpg
:align: center
:width: 75.0%
@ -27,15 +31,13 @@ beyond the typical SPI connections, it is better suited for use with the ESP32.
# Example minimal configuration entry
display:
- platform: ili9341
model: TFT 2.4
- platform: ili9xxx
model: ili9341
cs_pin: 14
dc_pin: 27
led_pin: 32 ### see note below ###
reset_pin: 33
lambda: |-
it.fill(Color::BLACK);
it.fill(COLOR_BLACK);
it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
Configuration variables:
@ -43,15 +45,12 @@ Configuration variables:
- **model** (**Required**): The model of the display. Options are:
- ``M5STACK``
- ``TFT 2.4``
- ``TFT 2.4R`` (ILI9342)
- ``M5STACK``, ``TFT 2.4``, ``TFT 2.4R``
- ``ILI9341``, ``ILI9342``, ``ILI9481``, ``ILI9486``, ``ILI9488``, ``ST7796``
- **cs_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The CS pin.
- **dc_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The DC pin.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The RESET pin.
- **led_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The display's backlight pin. **Note:** Connect to a
PWM-capable pin to switch/dim the display's backlight **or** save a pin by connecting it through a 3.3K resistor to the +3V supply.
- **rotation** (*Optional*): Set the rotation of the display. Everything drawn in the ``lambda:`` will be rotated
per this option. One of ``0°`` (default), ``90°``, ``180°``, or ``270°``.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`): The lambda to use for rendering the content on the display.
@ -124,7 +123,7 @@ To configure a dimmable backlight:
light:
- platform: monochromatic
output: gpio_32_backlight_pwm
name: "ILI9341 Display Backlight"
name: "Display Backlight"
id: back_light
restore_mode: ALWAYS_ON
@ -139,11 +138,10 @@ To configure an image adaptive color pallet to show greater than 8 bit color dep
type: RGB24
display:
- platform: ili9341
model: TFT 2.4
- platform: ili9xxx
model: ili9341
cs_pin: 5
dc_pin: 4
led_pin: 15
reset_pin: 22
rotation: 90
id: tft_ha
@ -158,5 +156,5 @@ See Also
--------
- :doc:`index`
- :apiref:`ili9341/ili9341_display.h`
- :apiref:`ili9xxx/ili9xxx_display.h`
- :ghedit:`Edit`

5
components/light/neopixelbus.rst
View File

@ -127,7 +127,8 @@ settings vary by method:
- **async** (*Optional*, boolean): Use an asynchronous transfer. Defaults to ``false``. If enabled,
the logger must be disabled even if bus 1 is used.
- **esp32_i2s**: The recommended method for ESP32. Available on all output pins. Additional options:
- **esp32_i2s**: The recommended method for ESP32, but not available on the ESP32-S3 or ESP32-C3.
Available on all output pins. Additional options:
- **bus** (*Optional*): The I2S bus to use. The ESP32 has bus 0 or 1 available, but the ESP32-S2 only bus 0.
One of ``0``, ``1``, ``dynamic``.
@ -135,7 +136,7 @@ settings vary by method:
- **esp32_rmt**: An alternative method for ESP32 that uses the RMT peripheral to send data.
Available on all output pins. Additional options:
- **channel** (*Optional*): The RMT channel to use. The ESP32 has channels 0-7, ESP32-S2 0-3 and ESP32-C3 0-1.
- **channel** (*Optional*): The RMT channel to use. The ESP32 has channels 0-7, ESP32-S2 0-3, ESP32-S3 0-3, and ESP32-C3 0-1.
Defaults to 6 on ESP32, and 1 on other ESP32 variants.
The following method is available only for two-wire chips (specify ``data_pin`` and ``clock_pin``):

2
components/logger.rst
View File

@ -1,3 +1,5 @@
.. _logger:
Logger Component
================

10
components/kuntze.rst → components/sensor/kuntze.rst
View File

@ -11,7 +11,7 @@ instrument in ESPHome. It uses :ref:`UART <uart>` (ModBUS) for communication.
Once configured you can use sensors as described below for your projects.
.. figure:: ../images/kuntze.jpg
.. figure:: ../../images/kuntze.jpg
:align: center
Kuntze Neon® Multi instrument
@ -30,14 +30,14 @@ The device communicates at ``19200`` baud ``8E1``. To connect to ESPHome, an RS4
transceiver is needed. Choose a type which does not need a trigger to send and
receive data, for example:
.. figure:: ../images/rs485.jpg
.. figure:: ../../images/rs485.jpg
The controller connects to the UART of the MCU. For ESP32 GPIO `16` to `TXD` and `17`
to RXD are the default ones but any other pins can be used as well. 3.3V to VCC and GND to GND.
.. warning::
If you are using the :doc:`logger` make sure you are not using the same pins for it or otherwise disable the UART
If you are using the :ref:`logger` make sure you are not using the same pins for it or otherwise disable the UART
logging with the ``baud_rate: 0`` option.
Component
@ -52,7 +52,7 @@ A configured modbus component is optional. It will be automatically created.
- id: uart_bus
tx_pin: GPIO16
rx_pin: GPIO17
baud_rate: 19600
baud_rate: 19200
parity: EVEN
sensor:
@ -81,7 +81,7 @@ See Also
--------
- :ref:`uart`
- :doc:`logger`
- :ref:`logger`
- :ref:`Sensor <config-sensor>`
- `Kuntze manuals <https://www.kuntze.com/en/downloads-2/>`__
- `Communication protocol <https://www.kuntze.com/wp-content/uploads/2021/05/2019_Manual_Modbus-RTU_ENG.pdf>`__

2
conf.py
View File

@ -69,7 +69,7 @@ author = "ESPHome"
# The short X.Y version.
version = "2023.3"
# The full version, including alpha/beta/rc tags.
release = "2023.3.0b1"
release = "2023.3.0b2"
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

3
guides/supporters.rst
View File

@ -360,7 +360,6 @@ Contributors
- `Antoine GRÉA (@grea09) <https://github.com/grea09>`__
- `Gil Peeters (@grillp) <https://github.com/grillp>`__
- `George (@grob6000) <https://github.com/grob6000>`__
- `Stefan Grufman (@GruffyPuffy) <https://github.com/GruffyPuffy>`__
- `gsexton (@gsexton) <https://github.com/gsexton>`__
- `Gabriel Sieben (@gsieben) <https://github.com/gsieben>`__
- `Jadson Santos (@gtjadsonsantos) <https://github.com/gtjadsonsantos>`__
@ -474,6 +473,7 @@ Contributors
- `JonnyaiR (@jonnyair) <https://github.com/jonnyair>`__
- `Jonathan V (@jonofmac) <https://github.com/jonofmac>`__
- `Joppy (@JoppyFurr) <https://github.com/JoppyFurr>`__
- `Jared Sanson (@jorticus) <https://github.com/jorticus>`__
- `Joshua Spence (@joshuaspence) <https://github.com/joshuaspence>`__
- `Joscha Wagner (@jowgn) <https://github.com/jowgn>`__
- `Javier Peletier (@jpeletier) <https://github.com/jpeletier>`__
@ -729,6 +729,7 @@ Contributors
- `randomllama (@randomllama) <https://github.com/randomllama>`__
- `rbaron (@rbaron) <https://github.com/rbaron>`__
- `Robert Cambridge (@rcambrj) <https://github.com/rcambrj>`__
- `Russell Cloran (@rcloran) <https://github.com/rcloran>`__
- `Rebbe Pod (@RebbePod) <https://github.com/RebbePod>`__
- `Alex (@redwngsrul) <https://github.com/redwngsrul>`__
- `Regev Brody (@regevbr) <https://github.com/regevbr>`__

3
index.rst
View File

@ -365,6 +365,7 @@ Miscellaneous
uFire ISE sensor, components/sensor/ufire_ise, ufire_ise.png, pH & Temperature
Resol VBus, components/vbus, resol_deltasol_bs_plus.jpg
Person Sensor (SEN21231), components/sensor/sen21231, sen21231.png
Kuntze pool sensor, components/sensor/kuntze, kuntze.jpg
Motion
@ -564,7 +565,7 @@ Display Components
ST7735, components/display/st7735, st7735.jpg
ST7789V, components/display/st7789v, st7789v.jpg
ST7920, components/display/st7920, st7920.jpg
ILI9341, components/display/ili9341, ili9341.jpg
ILI9xxx, components/display/ili9xxx, ili9341.jpg
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
Inkplate, components/display/inkplate6, inkplate6.jpg
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg