diff --git a/components/touchscreen/cst226.rst b/components/touchscreen/cst226.rst new file mode 100644 index 000000000..a9ddfaeab --- /dev/null +++ b/components/touchscreen/cst226.rst @@ -0,0 +1,46 @@ +cst226 Touch Screen Controller +=============================== + +.. seo:: + :description: Instructions for setting up cst226 touch screen controller with ESPHome + :image: t4-s3.jpg + :keywords: cst226, T4-S3 + +The ``cst226`` touchscreen platform allows using the touch screen controllers based on the cst226 chip with ESPHome. +The :ref:`I²C ` is required to be set up in your configuration for this touchscreen to work. + +This controller is used in the Lilygo T4-S3 AMOLED Display. + + +.. figure:: images/t4-s3.jpg + :align: center + :width: 50.0% + + cst226 touchscreen on Lilygo T4-S3 AMOLED Display + +Base Touchscreen Configuration +------------------------------ + +.. code-block:: yaml + + # Example configuration entry + touchscreen: + platform: cst226 + id: my_touchscreen + interrupt_pin: GPIO3 + +Configuration variables: +************************ + +- **id** (*Optional*, :ref:`config-id`): Manually set the ID of this touchscreen. +- **interrupt_pin** (**Required**, :ref:`Pin Schema `): The touch detection pin. +- **rotation** (*Optional*): Set the rotation of the touchscreen. By default this will be set to match the display associated with the touchscreen, but this allows more control. Choices are ``0``, ``90``, ``180`` and ``270``. + +- All other options from :ref:`Touchscreen `. + + +See Also +-------- + +- :apiref:`cst226/touchscreen/cst226_touchscreen.h` +- :ghedit:`Edit` diff --git a/components/touchscreen/images/t4-s3.jpg b/components/touchscreen/images/t4-s3.jpg new file mode 100644 index 000000000..16d997b22 Binary files /dev/null and b/components/touchscreen/images/t4-s3.jpg differ diff --git a/images/t4-s3.jpg b/images/t4-s3.jpg new file mode 100644 index 000000000..16d997b22 Binary files /dev/null and b/images/t4-s3.jpg differ diff --git a/index.rst b/index.rst index c1d69e1a4..4a4b64fcc 100644 --- a/index.rst +++ b/index.rst @@ -699,6 +699,7 @@ Touchscreen Components Lilygo T5 4.7", components/touchscreen/lilygo_t5_47, lilygo_t5_47_touch.jpg TT21100, components/touchscreen/tt21100, esp32-s3-korvo-2-lcd.png XPT2046, components/touchscreen/xpt2046, xpt2046.jpg + CST226, components/touchscreen/cst226, t4-s3.jpg GT911, components/touchscreen/gt911, esp32_s3_box_3.png FT63X6, components/touchscreen/ft63x6, wt32-sc01.png