Upstream
/
esphome-docs
mirror of https://github.com/esphome/esphome-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

text annd text_sensor components

This commit is contained in:
H. Árkosi Róbert 2024-05-09 10:41:46 +02:00
parent b3d173390d
commit d03275897d
9 changed files with 104 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
components/binary_sensor/lvgl.rst
View File

@ -39,4 +39,6 @@ See Also
- :doc:`/components/switch/lvgl`
- :doc:`/components/select/lvgl`
- :doc:`/components/light/lvgl`
- :doc:`/components/text/lvgl`
- :doc:`/components/text_sensor/lvgl`
- :ghedit:`Edit`

6
components/light/lvgl.rst
View File

@ -19,7 +19,7 @@ Configuration options:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the light.
- **led** (**Required**): The ID of a ``led`` widget configured in LVGL, which will reflect the state of the light.
- **widget** (**Required**): The ID of a ``led`` widget configured in LVGL, which will reflect the state of the light.
- All other options from :ref:`light <config-light>`.
@ -29,7 +29,7 @@ Example:
light:
- platform: lvgl
led: led_id
widget: led_id
name: LVGL light
.. note::
@ -45,4 +45,6 @@ See Also
- :doc:`/components/number/lvgl`
- :doc:`/components/switch/lvgl`
- :doc:`/components/select/lvgl`
- :doc:`/components/text/lvgl`
- :doc:`/components/text_sensor/lvgl`
- :ghedit:`Edit`

2
components/number/lvgl.rst
View File

@ -42,4 +42,6 @@ See Also
- :doc:`/components/switch/lvgl`
- :doc:`/components/select/lvgl`
- :doc:`/components/light/lvgl`
- :doc:`/components/text/lvgl`
- :doc:`/components/text_sensor/lvgl`
- :ghedit:`Edit`

2
components/select/lvgl.rst
View File

@ -40,4 +40,6 @@ See Also
- :doc:`/components/number/lvgl`
- :doc:`/components/switch/lvgl`
- :doc:`/components/light/lvgl`
- :doc:`/components/text/lvgl`
- :doc:`/components/text_sensor/lvgl`
- :ghedit:`Edit`

2
components/sensor/lvgl.rst
View File

@ -41,4 +41,6 @@ See Also
- :doc:`/components/select/lvgl`
- :doc:`/components/light/lvgl`
- :doc:`/components/number/lvgl`
- :doc:`/components/text/lvgl`
- :doc:`/components/text_sensor/lvgl`
- :ghedit:`Edit`

2
components/switch/lvgl.rst
View File

@ -45,4 +45,6 @@ See Also
- :doc:`/components/select/lvgl`
- :doc:`/components/light/lvgl`
- :doc:`/components/output/index`
- :doc:`/components/text/lvgl`
- :doc:`/components/text_sensor/lvgl`
- :ghedit:`Edit`

45
components/text/lvgl.rst Normal file
View File

@ -0,0 +1,45 @@
.. _lvgl-txt:
LVGL Text
=========
.. seo::
:description: Instructions for setting up a LVGL textarea Text component.
:image: ../images/lvgl_c_txt.png
The ``lvgl`` text platform creates an editable text component from a LVGL textarea widget
and requires :ref:`LVGL <lvgl-main>` to be configured.
Supported widget is :ref:`lvgl-wgt-txt`. A single text component supports
a single widget, thus you need to choose among which one's state you want to use.
Configuration options:
----------------------
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the text component.
- **widget** (**Required**): The ID of a ``textarea`` widget configured in LVGL, which will reflect the state of the text component.
- All other options from :ref:`Text <config-text>`.
Example:
.. code-block:: yaml
text:
- platform: lvgl
widget: textarea_id
name: "Textarea 1 text"
See Also
--------
- :ref:`LVGL Main component <lvgl-main>`
- :ref:`Textarea widget <lvgl-wgt-txt>`
- :doc:`/components/binary_sensor/lvgl`
- :doc:`/components/sensor/lvgl`
- :doc:`/components/number/lvgl`
- :doc:`/components/switch/lvgl`
- :doc:`/components/light/lvgl`
- :doc:`/components/select/lvgl`
- :doc:`/components/text_sensor/lvgl`
- :ghedit:`Edit`

45
components/text_sensor/lvgl.rst Normal file
View File

@ -0,0 +1,45 @@
.. _lvgl-txs:
LVGL Text Sensor
================
.. seo::
:description: Instructions for setting up a LVGL textarea Text Sensor.
:image: ../images/lvgl_c_txt.png
The ``lvgl`` text platform creates a Text Sensor from a LVGL textarea widget
and requires :ref:`LVGL <lvgl-main>` to be configured.
Supported widget is :ref:`lvgl-wgt-txt`. A single Text Sensor supports
a single widget, thus you need to choose among which one's state you want to use.
Configuration options:
----------------------
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- **name** (**Required**, string): The name of the text sensor.
- **widget** (**Required**): The ID of a ``textarea`` widget configured in LVGL, which will reflect the state of the text sensor.
- All other options from :ref:`Text Sensor <config-text_sensor>`.
Example:
.. code-block:: yaml
text_sensor:
- platform: lvgl
widget: textarea_id
name: "Textarea 1 text"
See Also
--------
- :ref:`LVGL Main component <lvgl-main>`
- :ref:`Textarea widget <lvgl-wgt-txt>`
- :doc:`/components/binary_sensor/lvgl`
- :doc:`/components/sensor/lvgl`
- :doc:`/components/number/lvgl`
- :doc:`/components/switch/lvgl`
- :doc:`/components/light/lvgl`
- :doc:`/components/select/lvgl`
- :doc:`/components/text/lvgl`
- :ghedit:`Edit`

BIN
images/lvgl_c_txt.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.5 KiB