mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-12-26 17:27:47 +01:00
Ili9341 doc update (#870)
* ili9341 documentation * fixed file name * change the name one more time * more naming fixes * add missing parenthesis * Update components/display/ili9341.rst Co-authored-by: Guillermo Ruffino <glm.net@gmail.com> * Update ili9341.rst fixed: api ref fixed: led_pin description marked: all pins as required for a proper functioning * Update ili9341.rst * Changes requested to original PR for merge * Make image filenames consistent * Make image filenames consistent take 2 * Example fixes * Right * No, left Co-authored-by: Valeriu <valeriucob@gmail.com> Co-authored-by: Vc <37367415+Valcob@users.noreply.github.com> Co-authored-by: Guillermo Ruffino <glm.net@gmail.com>
This commit is contained in:
parent
c664652250
commit
5b91810122
@ -33,6 +33,7 @@ Changelog - Version 1.15.0 - September 13, 2020
|
|||||||
TM1637, components/display/tm1637, tm1637.jpg
|
TM1637, components/display/tm1637, tm1637.jpg
|
||||||
SSD1351, components/display/ssd1351, ssd1351.jpg
|
SSD1351, components/display/ssd1351, ssd1351.jpg
|
||||||
ST7789V, components/display/st7789v, st7789v.jpg
|
ST7789V, components/display/st7789v, st7789v.jpg
|
||||||
|
ILI9341, components/display/ili9341, ili9341.jpg
|
||||||
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg
|
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg
|
||||||
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg
|
BLE Scanner, components/text_sensor/ble_scanner, bluetooth.svg
|
||||||
Custom UART Text Sensor, components/text_sensor/uart, language-cpp.svg
|
Custom UART Text Sensor, components/text_sensor/uart, language-cpp.svg
|
||||||
|
127
components/display/ili9341.rst
Normal file
127
components/display/ili9341.rst
Normal file
@ -0,0 +1,127 @@
|
|||||||
|
ILI9341 TFT LCD
|
||||||
|
===============
|
||||||
|
|
||||||
|
.. seo::
|
||||||
|
:description: Instructions for setting up ILI9341 TFT LCD display drivers.
|
||||||
|
:image: ili9341-full.jpg
|
||||||
|
|
||||||
|
.. _ili9341:
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
|
||||||
|
The ``ili9341`` display platform allows you to use
|
||||||
|
ILI9341 (`datasheet <https://cdn-shop.adafruit.com/datasheets/ILI9341.pdf>`__,
|
||||||
|
`Aliexpress <https://s.click.aliexpress.com/e/_dTKH6Mt>`__)
|
||||||
|
displays 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.
|
||||||
|
|
||||||
|
.. figure:: images/ili9341-full.jpg
|
||||||
|
:align: center
|
||||||
|
:width: 75.0%
|
||||||
|
|
||||||
|
ILI9341 display
|
||||||
|
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
# Example minimal configuration entry
|
||||||
|
display:
|
||||||
|
- platform: ili9341
|
||||||
|
model: TFT 2.4
|
||||||
|
cs_pin: 14
|
||||||
|
dc_pin: 27
|
||||||
|
led_pin: 32 ### see note below ###
|
||||||
|
reset_pin: 33
|
||||||
|
|
||||||
|
lambda: |-
|
||||||
|
it.fill(COLOR_BLACK);
|
||||||
|
it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
|
||||||
|
|
||||||
|
Configuration variables
|
||||||
|
***********************
|
||||||
|
|
||||||
|
- **model** (**Required**): The model of the display. Options are:
|
||||||
|
|
||||||
|
- ``M5STACK``
|
||||||
|
- ``TFT 2.4``
|
||||||
|
|
||||||
|
- **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.
|
||||||
|
See :ref:`display-engine` for more information.
|
||||||
|
- **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``.
|
||||||
|
- **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.
|
||||||
|
|
||||||
|
Configuration examples
|
||||||
|
**********************
|
||||||
|
|
||||||
|
To utilize the color capabilities of this display module, you'll likely want to add a ``color:`` section to your
|
||||||
|
YAML configuration; please see :ref:`color <config-color>` for more detail on this configuration section.
|
||||||
|
|
||||||
|
To use colors in your lambada:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
color:
|
||||||
|
- id: my_red
|
||||||
|
red: 100%
|
||||||
|
green: 3%
|
||||||
|
blue: 5%
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
display:
|
||||||
|
...
|
||||||
|
lambda: |-
|
||||||
|
it.rectangle(0, 0, it.get_width(), it.get_height(), id(my_red));
|
||||||
|
|
||||||
|
|
||||||
|
To bring in color images:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
image:
|
||||||
|
- file: "image.jpg"
|
||||||
|
id: my_image
|
||||||
|
resize: 200x200
|
||||||
|
type: RGB24
|
||||||
|
|
||||||
|
...
|
||||||
|
|
||||||
|
display:
|
||||||
|
...
|
||||||
|
lambda: |-
|
||||||
|
it.image(0, 0, id(my_image));
|
||||||
|
|
||||||
|
|
||||||
|
To configure a dimmable backlight:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
# Define a PWM output on the ESP32
|
||||||
|
output:
|
||||||
|
- platform: ledc
|
||||||
|
pin: 32
|
||||||
|
id: gpio_32_backlight_pwm
|
||||||
|
|
||||||
|
# Define a monochromatic, dimmable light for the backlight
|
||||||
|
light:
|
||||||
|
- platform: monochromatic
|
||||||
|
output: gpio_32_backlight_pwm
|
||||||
|
name: "ILI9341 Display Backlight"
|
||||||
|
id: back_light
|
||||||
|
restore_mode: ALWAYS_ON
|
||||||
|
|
||||||
|
See Also
|
||||||
|
--------
|
||||||
|
|
||||||
|
- :doc:`index`
|
||||||
|
- :apiref:`ili9341/ili9341.h`
|
||||||
|
- :ghedit:`Edit`
|
BIN
components/display/images/ili9341-full.jpg
Normal file
BIN
components/display/images/ili9341-full.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 56 KiB |
BIN
images/ili9341.jpg
Normal file
BIN
images/ili9341.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 63 KiB |
@ -283,6 +283,7 @@ Display Components
|
|||||||
SSD1331, components/display/ssd1331, ssd1331.jpg
|
SSD1331, components/display/ssd1331, ssd1331.jpg
|
||||||
SSD1351, components/display/ssd1351, ssd1351.jpg
|
SSD1351, components/display/ssd1351, ssd1351.jpg
|
||||||
ST7789V, components/display/st7789v, st7789v.jpg
|
ST7789V, components/display/st7789v, st7789v.jpg
|
||||||
|
ILI9341, components/display/ili9341, ili9341.jpg
|
||||||
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
|
Waveshare E-Paper, components/display/waveshare_epaper, waveshare_epaper.jpg
|
||||||
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg
|
PCD8544 (Nokia 5110/ 3310), components/display/pcd8544, pcd8544.jpg
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user