Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-12-25 17:17:54 +01:00
Code Issues Projects Releases Wiki Activity

Use GPIOXX in sample configs (#3702)

Browse Source
This commit is contained in:
Clyde Stubbs 2024-05-15 10:56:30 +10:00 committed by GitHub
parent bfda3aadb7
commit d06ece2d70
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 54 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
components/cover/he60r.rst
View File

@ -26,8 +26,8 @@ below for a sample hardware interface.
baud_rate: 1200
parity: even
stop_bits: 1
tx_pin: REPLACEME
rx_pin: REPLACEME
tx_pin: GPIOXX
rx_pin: GPIOXX
cover:
platform: he60r
@ -72,9 +72,9 @@ Note that this circuit inverts the TX line. A configuration for this would look
parity: even
stop_bits: 1
tx_pin:
number: REPLACEME
number: GPIOXX
inverted: true
rx_pin: REPLACEME
rx_pin: GPIOXX
cover:
platform: he60r
@ -84,7 +84,7 @@ Note that this circuit inverts the TX line. A configuration for this would look
binary_sensor:
- platform: gpio
pin:
number: REPLACEME
number: GPIOXX
inverted: true
mode:
input: true

4
components/dfrobot_sen0395.rst
View File

@ -36,7 +36,7 @@ a :doc:`/components/uart` component (and its requisite GPIO pins) is required in
name: Mmwave Detected via GPIO
device_class: motion
pin:
number: REPLACEME
number: GPIOXX
mode: INPUT_PULLDOWN
switch:
@ -97,7 +97,7 @@ If you don't want/need to change the radar's settings and only need to determine
name: Presence Detected via GPIO
device_class: motion
pin:
number: REPLACEME
number: GPIOXX
mode: INPUT_PULLDOWN
.. _dfrobot_sen0395-via_uart:

2
components/micronova.rst
View File

@ -55,7 +55,7 @@ Component/Hub
.. code-block:: yaml
micronova:
enable_rx_pin: REPLACEME
enable_rx_pin: GPIOXX
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~

8
components/output/my9231.rst
View File

@ -94,7 +94,7 @@ complete configuration for a Sonoff B1 looks like:
.. code-block:: yaml
esphome:
name: REPLACEME
name: GPIOXX
esp8266:
board: esp01_1m
@ -135,7 +135,7 @@ complete configuration for a Sonoff B1 looks like:
light:
- platform: rgbww
name: REPLACEME
name: GPIOXX
red: output_red
green: output_green
blue: output_blue
@ -149,7 +149,7 @@ And here is a complete configuration for the AiThinker AiLight:
.. code-block:: yaml
esphome:
name: REPLACEME
name: GPIOXX
esp8266:
board: esp01_1m
@ -187,7 +187,7 @@ And here is a complete configuration for the AiThinker AiLight:
light:
- platform: rgbw
name: REPLACEME
name: GPIOXX
red: output_red
green: output_green
blue: output_blue

4
components/output/sm16716.rst
View File

@ -93,8 +93,8 @@ A complete configuration for a Feit Electric A19 looks like:
.. code-block:: yaml
esphome:
name: REPLACEME
friendly_name: REPLACEME
name: GPIOXX
friendly_name: GPIOXX
esp8266:
board: esp01_1m

2
components/sensor/ld2410.rst
View File

@ -454,7 +454,7 @@ under account, you can set up a :ref:`GPIO Binary Sensor <gpio-binary-sensor>`:
binary_sensor:
- platform: gpio
pin: REPLACEME
pin: GPIOXX
name: gpio out pin presence
device_class: presence

19
components/touchscreen/cst226.rst
View File

@ -33,12 +33,27 @@ Configuration variables:
************************
- **id** (*Optional*, :ref:`config-id`): Manually set the ID of this touchscreen.
- **interrupt_pin** (**Required**, :ref:`Pin Schema <config-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``.
- **interrupt_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The touch detection pin.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The chip reset pin.
- All other options from :ref:`Touchscreen <config-touchscreen>`.
Sample config for the T4-S3
***************************
.. code-block:: yaml
i2c:
sda: GPIO6
scl: GPIO7
touchscreen:
- platform: cst226
id: my_touchscreen
interrupt_pin: GPIO8
reset_pin: GPIO17
See Also
--------

15
components/touchscreen/cst816.rst
View File

@ -36,7 +36,7 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually set the ID of this touchscreen.
- **interrupt_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The touch detection pin.
- **reset_pin** (**Optional**, :ref:`Pin Schema <config-pin_schema>`): The chip reset pin.
- **reset_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The chip reset pin.
- All other options from :ref:`Touchscreen <config-touchscreen>`.
@ -61,6 +61,19 @@ Configuration variables:
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
Sample config for the T-Display S3 AMOLED
*****************************************
.. code-block:: yaml
i2c:
sda: GPIO3
scl: GPIO2
touchscreen:
- platform: cst816
id: my_touchscreen
interrupt_pin: GPIO21
See Also
--------

3
components/touchscreen/gt911.rst
View File

@ -33,8 +33,7 @@ Configuration variables:
************************
- **id** (*Optional*, :ref:`config-id`): Manually set the ID of this touchscreen.
- **interrupt_pin** (**Required**, :ref:`Pin Schema <config-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``.
- **interrupt_pin** (*Optional*, :ref:`Pin Schema <config-pin_schema>`): The touch detection pin.
- All other options from :ref:`Touchscreen <config-touchscreen>`.

2
components/touchscreen/lilygo_t5_47.rst
View File

@ -15,7 +15,7 @@ The :ref:`I²C <i2c>` is required to be set up in your configuration for this to
# Example configuration entry
touchscreen:
- platform: lilygo_t5_47
interrupt_pin: GPIO13
interrupt_pin: GPIOXX
Configuration variables:

12
components/touchscreen/xpt2046.rst
View File

@ -60,17 +60,17 @@ Base Configuration:
- **threshold** (*Optional*, int): The value to detect the touch or release. Defaults to ``400``.
- **calibration_x_min** (*Depricated*): This value is moved to the ``calibration`` values
- **calibration_x_min** (*Deprecated*): This value is moved to the ``calibration`` values
- **calibration_x_max** (*Depricated*): This value is moved to the ``calibration`` values.
- **calibration_x_max** (*Deprecated*): This value is moved to the ``calibration`` values.
- **calibration_y_min** (*Depricated*): This value is moved to the ``calibration`` values.
- **calibration_y_min** (*Deprecated*): This value is moved to the ``calibration`` values.
- **calibration_y_max** (*Depricated*): This value is moved to the ``calibration`` values.
- **calibration_y_max** (*Deprecated*): This value is moved to the ``calibration`` values.
- **swap_x_y** (*Depricated*): This value is moved to the ``transform`` values as ``swap_xy`` see :ref:`config-touchscreen`.
- **swap_x_y** (*Deprecated*): This value is moved to the ``transform`` values as ``swap_xy`` see :ref:`config-touchscreen`.
- **report_interval** (*Depricated*): This interval is removed in favor of the ``update_interval``.
- **report_interval** (*Deprecated*): This interval is removed in favor of the ``update_interval``.
- All other options from :ref:`config-touchscreen`.