From 5bb89271cf5afbb9db73f06f2532cc223850bbc2 Mon Sep 17 00:00:00 2001 From: Clyde Stubbs <2366188+clydebarrow@users.noreply.github.com> Date: Mon, 13 Jan 2025 05:56:59 +1100 Subject: [PATCH] Update auto_clear description (#4522) --- components/display/index.rst | 2 +- components/display/pvvx_mithermometer.rst | 2 +- components/display/qspi_dbi.rst | 6 ++---- components/display/rpi_dpi_rgb.rst | 4 +--- components/display/st7701s.rst | 4 +--- 5 files changed, 6 insertions(+), 12 deletions(-) diff --git a/components/display/index.rst b/components/display/index.rst index 43f3ba8e8..b83fadd29 100644 --- a/components/display/index.rst +++ b/components/display/index.rst @@ -33,7 +33,7 @@ All display components inherit these configuration variables. All *graphical* displays also inherit these configuration variables. -- **auto_clear_enabled** (*Optional*, boolean): If the display should be cleared before each update. Defaults to ``true``. +- **auto_clear_enabled** (*Optional*, boolean): If the display should be cleared before each update. Defaults to ``true`` if a lambda or pages are configured, false otherwise. - **show_test_card** (*Optional*, boolean): If the display should show a test card. Defaults to ``false``. If set, any code in the ``lambda`` config option will be ignored. - **rotation** (*Optional*, integer): The rotation of the display in degrees, one of 0, 90, 180 or 270. Defaults to ``0``. - **pages** (*Optional*, list): Pages configuration - see below. diff --git a/components/display/pvvx_mithermometer.rst b/components/display/pvvx_mithermometer.rst index 05cc78723..f80190c12 100644 --- a/components/display/pvvx_mithermometer.rst +++ b/components/display/pvvx_mithermometer.rst @@ -55,7 +55,7 @@ Configuration variables: - **lambda** (*Optional*, :ref:`lambda `): The lambda to use to define the information to be displayed. See :ref:`display-pvvx_mithermometer_lambda` for more information. - **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display data before each lambda call, - or to keep the existing display content (must overwrite explicitly, e.g., only on data change). Defaults to ``true``. + or to keep the existing display content (must overwrite explicitly, e.g., only on data change). Defaults to ``true`` if a lambda or pages are configured, false otherwise. - **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. .. _display-pvvx_mithermometer_lambda: diff --git a/components/display/qspi_dbi.rst b/components/display/qspi_dbi.rst index e1030791a..077f0a035 100644 --- a/components/display/qspi_dbi.rst +++ b/components/display/qspi_dbi.rst @@ -70,8 +70,8 @@ Configuration variables: - **enable_pin** (*Optional*, :ref:`Pin Schema `): The display enable pin. - **brightness** (*Optional*, int): A brightness value in the range 0-255 - **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``. -- **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display in each loop (''true'', default), - or to keep the existing display content (must overwrite explicitly, e.g., only on data change). +- **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display data before each lambda call, + or to keep the existing display content (must overwrite explicitly, e.g., only on data change). Defaults to ``true`` if a lambda or pages are configured, false otherwise. - **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. - **color_order** (*Optional*): Should be one of ``rgb`` (default) or ``bgr``. @@ -137,8 +137,6 @@ Lilygo T4-S3 cs_pin: 11 reset_pin: 13 enable_pin: 9 - update_interval: never - auto_clear_enabled: false psram: mode: octal diff --git a/components/display/rpi_dpi_rgb.rst b/components/display/rpi_dpi_rgb.rst index 5a52cc232..dbc9eab6f 100644 --- a/components/display/rpi_dpi_rgb.rst +++ b/components/display/rpi_dpi_rgb.rst @@ -86,7 +86,7 @@ Configuration variables: - **vsync_front_porch** (*Optional*, int): The vertical front porch length. - **vsync_back_porch** (*Optional*, int): The vertical back porch length. - **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``. -- **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display in each loop (''true'', default), +- **auto_clear_enabled** (*Optional*, boolean): If the display should be cleared before each update. Defaults to ``true`` if a lambda or pages are configured, false otherwise. or to keep the existing display content (must overwrite explicitly, e.g., only on data change). - **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. @@ -120,7 +120,6 @@ Waveshare ESP32-S3 Touch 4.3 display: - platform: rpi_dpi_rgb - auto_clear_enabled: false color_order: RGB pclk_frequency: 16MHz dimensions: @@ -171,7 +170,6 @@ Makerfabs 4.3" 800x480 display display: - platform: rpi_dpi_rgb update_interval: never - auto_clear_enabled: false id: rpi_display color_order: RGB rotation: 90 diff --git a/components/display/st7701s.rst b/components/display/st7701s.rst index 2ce5dcfac..085a76904 100644 --- a/components/display/st7701s.rst +++ b/components/display/st7701s.rst @@ -90,8 +90,7 @@ Configuration variables: - **pclk_frequency** (*Optional*): Set the pixel clock speed. Default is 8MHz. - **pclk_inverted** (*Optional* bool): If the pclk is active negative (default is True) - **update_interval** (*Optional*, :ref:`config-time`): The interval to re-draw the screen. Defaults to ``5s``. -- **auto_clear_enabled** (*Optional*, boolean): Whether to automatically clear the display in each loop (''true'', default), - or to keep the existing display content (must overwrite explicitly, e.g., only on data change). +- **auto_clear_enabled** (*Optional*, boolean): If the display should be cleared before each update. Defaults to ``true`` if a lambda or pages are configured, false otherwise. - **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. - **color_order** (*Optional*): Should be one of ``bgr`` (default) or ``rgb``. @@ -139,7 +138,6 @@ Seeed Sensecap Indicator display: - platform: st7701s - auto_clear_enabled: false update_interval: never spi_mode: MODE3 color_order: RGB