diff --git a/content/components/_index.md b/content/components/_index.md index 513795af1b..11ee047e7f 100644 --- a/content/components/_index.md +++ b/content/components/_index.md @@ -604,6 +604,7 @@ Often known as "tag" or "card" readers within the community. "GT911","components/touchscreen/gt911","esp32_s3_box_3.png","" "Nextion Binary Sensor","components/binary_sensor/nextion","nextion.jpg","" "TT21100","components/touchscreen/tt21100","esp32-s3-korvo-2-lcd.png","" +"ST7123","components/touchscreen/st7123","tab5.jpg","" "LVGL widget","components/binary_sensor/lvgl","lvgl_c_bns.png","" {{< /imgtable >}} diff --git a/content/components/touchscreen/st7123.md b/content/components/touchscreen/st7123.md new file mode 100755 index 0000000000..e309ae9550 --- /dev/null +++ b/content/components/touchscreen/st7123.md @@ -0,0 +1,37 @@ +--- +description: "Instructions for setting up st7123 touch screen controller with ESPHome" +title: "st7123 Touch Screen Controller" +params: + seo: + description: Instructions for setting up st7123 touch screen controller with ESPHome + image: tab5.jpg +--- + +The `st7123` touchscreen platform allows using the touch screen controllers based on the st7123 chip with ESPHome. +The [I²C](/components/i2c) is required to be set up in your configuration for this touchscreen to work. + +This controller is used in the M5Stack Tab5 (newer version); + +{{< img src="tab5.jpg" alt="Image" caption="st7123 touchscreen on M5Stack Tab5" width="50.0%" class="align-center" >}} + +## Base Touchscreen Configuration + +```yaml +# Example configuration entry +touchscreen: + platform: st7123 + id: my_touchscreen + interrupt_pin: GPIOXX +``` + +### Configuration variables + +- **id** (*Optional*, [ID](/guides/configuration-types#id)): Manually set the ID of this touchscreen. +- **interrupt_pin** (*Optional*, [Pin Schema](/guides/configuration-types#pin-schema)): The touch detection pin. +- **reset_pin** (*Optional*, [Pin Schema](/guides/configuration-types#pin-schema)): The reset pin. + +- All other options from [Touchscreen](/components/touchscreen#config-touchscreen). + +## See Also + +- {{< apiref "st7123/touchscreen/st7123.h" "st7123/touchscreen/st7123.h" >}}