Skip to content

Commit 96d1950

Browse files
authored
[il9xxx] Add notes about psram and 8 bit changes (#4699)
1 parent 896f3ac commit 96d1950

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

changelog/2025.2.0.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,19 @@ from a boolean to an enum; in addition, the ``type`` configuration variable is n
106106

107107
Finally, the :doc:`/components/online_image` was updated to add support for both BMP and JPEG image formats.
108108

109+
ILI9XXX Display Component
110+
-------------------------
111+
112+
There are two changes to the :doc:`/components/display/ili9xxx` component. Previously the component automatically loaded
113+
the ``psram`` component - this has been removed, and you must now explicitly include the
114+
``psram`` component in your configuration if your display requires it. The bit-depth defaults to 16 bit as before, but
115+
there is no attempt to automatically fallback to 8 bit if insufficient memory is available. You must now explicitly
116+
select 8-bit mode with the ``color_palette`` configuration variable if required.
117+
118+
The symptoms caused by these changes are likely to be a blank screen or a screen that is not displaying correctly. Check
119+
the runtime logs for any errors or warnings that may indicate the cause of the issue, specifically memory allocation
120+
failures.
121+
109122
Full list of changes
110123
--------------------
111124

components/display/ili9xxx.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,14 @@ beyond the basic SPI connections, and a reasonable amount of RAM, it is not well
4242

4343
.. note::
4444

45-
The default color depth is 16 bit (RGB565). 8 bit color is also supported, but the color palette must be set to one of the available options.
45+
PSRAM is not automatically enabled on the ESP32 (this changed with the 2025.2 release.) If PSRAM is available, you
46+
should enable it with the :doc:`PSRAM configuration </components/psram>`.
4647
Use of 16 bit colors requires twice the amount of RAM as 8 bit, and may not be usable unless PSRAM is available.
4748

49+
.. note::
50+
51+
The default color depth is 16 bit (RGB565). 8 bit color is also supported, but the color palette must be set to one of the available options.
52+
Use of 16 bit colors requires twice the amount of RAM as 8 bit, and may not be usable unless PSRAM is available.
4853

4954
.. figure:: images/ili9341-full.jpg
5055
:align: center

0 commit comments

Comments
 (0)