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

Many example yaml tidy-ups

This commit is contained in:
Jesse Hills 2024-05-07 05:03:16 +00:00
parent 435ac13488
commit bab084cd69
No known key found for this signature in database
GPG Key ID: BEAAE804EFD8E83A
148 changed files with 898 additions and 1542 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
components/alarm_control_panel/template.rst
View File

@ -169,7 +169,7 @@ Example:
name: Zone 1
device_class: door
pin:
number: D1
number: GPIOXX
mode: INPUT_PULLUP
inverted: True
- platform: gpio
@ -177,7 +177,7 @@ Example:
name: Zone 2
device_class: door
pin:
number: D2
number: GPIOXX
mode: INPUT_PULLUP
inverted: True
- platform: gpio
@ -185,7 +185,7 @@ Example:
name: Zone 3
device_class: motion
pin:
number: D3
number: GPIOXX
mode: INPUT_PULLUP
inverted: True
- platform: gpio
@ -193,7 +193,7 @@ Example:
name: Zone 4
device_class: door
pin:
number: D4
number: GPIOXX
mode: INPUT_PULLUP
inverted: True
- platform: homeassistant
@ -206,7 +206,7 @@ Example:
id: siren
name: Siren
icon: mdi:alarm-bell
pin: D7
pin: GPIOXX
See Also

13
components/at581x.rst
View File

@ -32,17 +32,6 @@ a :doc:`/components/i2c` component (and its requisite GPIO pins) is required in
id: "Radar"
i2c_id: bus_a
binary_sensor:
- platform: gpio
pin: GPIO21
name: "Radar motion"
switch:
# Switch to turn on/off RF emission
- platform: at581x
at581x_id: "Radar"
name: "Enable Radar"
.. _at581x-component:
Component/Hub
@ -87,7 +76,7 @@ The state of the radar detection is available via its GPIO pin. It's required to
binary_sensor:
- platform: gpio
name: "Human in front"
pin: GPIO21
pin: GPIOXX
Configuration variables:
************************

2
components/binary_sensor/cap1188.rst
View File

@ -30,7 +30,7 @@ required to be set up in your configuration for this sensor to work.
cap1188:
id: cap1188_component
address: 0x29
reset_pin: 14
reset_pin: GPIOXX
touch_threshold: 0x40
allow_multiple_touches: true

6
components/binary_sensor/esp32_touch.rst
View File

@ -130,8 +130,8 @@ an ``OFF`` state.
binary_sensor:
- platform: esp32_touch
name: "ESP32 Touch Pad GPIO27"
pin: GPIO27
name: "ESP32 Touch Pad"
pin: GPIOXX
threshold: 1000
Configuration variables:
@ -164,7 +164,7 @@ If access to the raw values is required, a template sensor can be created that p
binary_sensor:
- platform: esp32_touch
id: esp32_touch_pad
pin: GPIO4
pin: GPIOXX
threshold: 0
sensor:

4
components/binary_sensor/haier.rst
View File

@ -17,8 +17,8 @@ Additional sensors for Haier Climate device. **These sensors are supported only
# Example configuration entry
uart:
baud_rate: 9600
tx_pin: 17
rx_pin: 16
tx_pin: GPIOXX
rx_pin: GPIOXX
id: ac_port
climate:

6
components/binary_sensor/hydreon_rgxx.rst
View File

@ -12,12 +12,6 @@ For this sensor to work, a :doc:`/components/sensor/hydreon_rgxx` must be set up
.. code-block:: yaml
# Example RG-9 entry
uart:
rx_pin: GPIO16
tx_pin: GPIO17
baud_rate: 9600
sensor:
- platform: hydreon_rgxx
model: "RG_9"

2
components/binary_sensor/rc522.rst
View File

@ -42,7 +42,7 @@ you can then create individual binary sensors that track if an NFC/RFID tag is c
spi:
rc522_spi:
cs_pin: GPIO15
cs_pin: GPIOXX
binary_sensor:
- platform: rc522

2
components/button/output.rst
View File

@ -17,7 +17,7 @@ momentarily set a GPIO pin using a button.
# Example configuration entry
output:
- platform: gpio
pin: 25
pin: GPIOXX
id: output1
button:

4
components/button/uart.rst
View File

@ -11,10 +11,6 @@ The ``uart`` button platform allows you to send a pre-defined sequence of bytes
.. code-block:: yaml
# Example configuration entry
uart:
baud_rate: 9600
tx_pin: D0
button:
- platform: uart
name: "UART String Output"

24
components/canbus.rst
View File

@ -197,8 +197,8 @@ You only need to specify the RX and TX pins. Any GPIO will work.
# Example configuration entry
canbus:
- platform: esp32_can
tx_pin: GPIO5
rx_pin: GPIO4
tx_pin: GPIOXX
rx_pin: GPIOXX
can_id: 4
bit_rate: 50kbps
on_frame:
@ -273,7 +273,7 @@ For wiring up the MSP2515 please refer to the section below.
# Example configuration entry
canbus:
- platform: mcp2515
cs_pin: D5
cs_pin: GPIOXX
can_id: 4
bit_rate: 50kbps
on_frame:
@ -359,7 +359,7 @@ Standard IDs and Extended IDs can coexist on the same segment.
- platform: mcp2515
id: my_mcp2515
spi_id: McpSpi
cs_pin: GPIO14
cs_pin: GPIOXX
can_id: 0x1fff
use_extended_id: true
bit_rate: 125kbps
@ -385,9 +385,9 @@ Button is connected on a can node which sends an A message on ID 0x100 with payl
spi:
id: McpSpi
clk_pin: GPIO16
mosi_pin: GPIO5
miso_pin: GPIO4
clk_pin: GPIOXX
mosi_pin: GPIOXX
miso_pin: GPIOXX
binary_sensor:
- platform: template
@ -398,7 +398,7 @@ Button is connected on a can node which sends an A message on ID 0x100 with payl
- platform: mcp2515
id: my_mcp2515
spi_id: McpSpi
cs_pin: GPIO14
cs_pin: GPIOXX
can_id: 4
bit_rate: 125kbps
on_frame:
@ -430,15 +430,15 @@ Buttons are connected on the CAN-Node and also the motor is connected via CAN.
spi:
id: McpSpi
clk_pin: GPIO16
mosi_pin: GPIO5
miso_pin: GPIO4
clk_pin: GPIOXX
mosi_pin: GPIOXX
miso_pin: GPIOXX
canbus:
- platform: mcp2515
id: my_mcp2515
spi_id: McpSpi
cs_pin: GPIO14
cs_pin: GPIOXX
can_id: 4
bit_rate: 125kbps
on_frame:

4
components/climate/climate_ir.rst
View File

@ -76,7 +76,7 @@ controller unit.
# Example configuration entry
remote_transmitter:
pin: GPIO32
pin: GPIOXX
carrier_duty_percent: 50%
climate:
@ -156,7 +156,7 @@ IR receiver.
remote_receiver:
id: rcvr
pin:
number: GPIO14
number: GPIOXX
inverted: true
mode:
input: true

7
components/climate/haier.rst
View File

@ -58,13 +58,6 @@ This component requires a :ref:`uart` to be setup.
.. code-block:: yaml
# Example configuration entry
uart:
baud_rate: 9600
tx_pin: 17
rx_pin: 16
id: ac_port
climate:
- platform: haier
id: haier_ac

11
components/climate/midea.rst
View File

@ -25,17 +25,6 @@ The ``midea`` component creates a Midea air conditioner climate device.
.. code-block:: yaml
# Example configuration entry
# Disable logging over UART (required)
logger:
baud_rate: 0
# UART settings for Midea dongle (required)
uart:
tx_pin: 1 # hardware dependant
rx_pin: 3 # hardware dependant
baud_rate: 9600
# Main settings
climate:
- platform: midea

13
components/dfplayer.rst
View File

@ -31,16 +31,7 @@ will be required.
.. code-block:: yaml
# Example configuration entry
uart:
tx_pin: GPIO2
rx_pin: GPIO5
baud_rate: 9600
# Declare DFPlayer mini module
dfplayer:
on_finished_playback:
then:
logger.log: 'Somebody press play!'
Configuration variables:
------------------------
@ -345,8 +336,8 @@ Sample code
.. code-block:: yaml
uart:
tx_pin: GPIO2
rx_pin: GPIO5
tx_pin: GPIOXX
rx_pin: GPIOXX
baud_rate: 9600
dfplayer:

12
components/display/addressable_light.rst
View File

@ -19,18 +19,6 @@ The display requires that an :apiclass:`AddressableLight <light::AddressableLigh
.. code-block:: yaml
light:
- platform: fastled_clockless
chipset: WS2812B
pin: GPIO4
num_leds: 64
rgb_order: GRB
name: "led_matrix"
id: led_matrix_light
default_transition_length: 0s
color_correct: [50%, 50%, 50%]
restore_mode: ALWAYS_ON
display:
- platform: addressable_light
id: led_matrix_display

16
components/display/ili9xxx.rst
View File

@ -55,8 +55,8 @@ beyond the basic SPI connections, and a reasonable amount of RAM, it is not well
display:
- platform: ili9xxx
model: ili9341
dc_pin: 27
reset_pin: 33
dc_pin: GPIOXX
reset_pin: GPIOXX
lambda: |-
it.fill(COLOR_BLACK);
it.print(0, 0, id(my_font), id(my_red), TextAlign::TOP_LEFT, "Hello World!");
@ -180,13 +180,13 @@ To configure a dimmable backlight:
# Define a PWM output on the ESP32
output:
- platform: ledc
pin: 32
id: gpio_32_backlight_pwm
pin: GPIOXX
id: backlight_pwm
# Define a monochromatic, dimmable light for the backlight
light:
- platform: monochromatic
output: gpio_32_backlight_pwm
output: backlight_pwm
name: "Display Backlight"
id: back_light
restore_mode: ALWAYS_ON
@ -204,8 +204,8 @@ To configure an image adaptive color pallet to show greater than 8 bit color dep
display:
- platform: ili9xxx
model: ili9341
dc_pin: 4
reset_pin: 22
dc_pin: GPIOXX
reset_pin: GPIOXX
rotation: 90
id: tft_ha
color_palette: IMAGE_ADAPTIVE
@ -234,7 +234,7 @@ This config rotates the display into landscape mode using the driver chip.
mirror_y: true
color_order: bgr
data_rate: 80MHz
cs_pin: 10
cs_pin: GPIOXX
dc_pin: GPIO13
reset_pin: GPIO9

12
components/display/lcd_display.rst
View File

@ -90,12 +90,12 @@ faster refresh, especially in conjunction with an :ref:`LCD Menu <lcd_menu>`.
- platform: lcd_gpio
dimensions: 20x4
data_pins:
- GPIO32
- GPIO33
- GPIO5
- GPIO17
enable_pin: D4
rs_pin: D5
- GPIOXX
- GPIOXX
- GPIOXX
- GPIOXX
enable_pin: GPIOXX
rs_pin: GPIOXX
lambda: |-
it.print("Hello World!");

8
components/display/nextion.rst
View File

@ -36,17 +36,9 @@ The below example configures a UART for the Nextion display to use
.. code-block:: yaml
# Example configuration entry
uart:
id: uart_2
rx_pin: GPIO16
tx_pin: GPIO17
baud_rate: 115200
display:
- platform: nextion
id: nextion1
uart_id: uart_2
lambda: |-
it.set_component_value("gauge", 50);
it.set_component_text("textview", "Hello World!");

6
components/display/qspi_amoled.rst
View File

@ -50,9 +50,9 @@ ESP-IDF. PSRAM is a requirement due to the size of the display buffer. A :ref:`q
color_order: rgb
invert_colors: false
brightness: 255
cs_pin: 11
reset_pin: 13
enable_pin: 9
cs_pin: GPIOXX
reset_pin: GPIOXX
enable_pin: GPIOXX
Configuration variables:

12
components/display/st7789v.rst
View File

@ -40,17 +40,13 @@ to an ESP module.
.. code-block:: yaml
# Example minimal configuration entry
spi:
clk_pin: GPIO18
mosi_pin: GPIO19
display:
- platform: st7789v
model: TTGO TDisplay 135x240
backlight_pin: GPIO4
cs_pin: GPIO5
dc_pin: GPIO16
reset_pin: GPIO23
backlight_pin: GPIOXX
cs_pin: GPIOXX
dc_pin: GPIOXX
reset_pin: GPIOXX
lambda: |-
it.print(0, 0, id(font), "Hello World!");

8
components/display/tm1621.rst
View File

@ -22,10 +22,10 @@ The LCD have four signal, ``cs`` for chip select, ``data`` for data signal, ``re
display:
platform: tm1621
id: tm1621_display
cs_pin: GPIO17
data_pin: GPIO5
read_pin: GPIO23
write_pin: GPIO18
cs_pin: GPIOXX
data_pin: GPIOXX
read_pin: GPIOXX
write_pin: GPIOXX
lambda: |-
it.printf(0, "%.1f", id(my_sensor1).state);
it.display_celsius(true);

12
components/display/tm1638.rst
View File

@ -23,9 +23,9 @@ The module can be powered with 5v DC. To display the colon punctuation use the
display:
platform: tm1638
id: tm1638_display
stb_pin: 5
clk_pin: 18
dio_pin: 23
stb_pin: GPIOXX
clk_pin: GPIOXX
dio_pin: GPIOXX
intensity: 5
update_interval: 5s
lambda: |-
@ -113,9 +113,9 @@ The following example creates a typical digital clock with the ``:`` colon flash
display:
platform: tm1638
clk_pin: 18
dio_pin: 23
stb_pin: 5
clk_pin: GPIOXX
dio_pin: GPIOXX
stb_pin: GPIOXX
update_interval: 500ms
lambda: |-
static int i = 0;

16
components/esp32_camera.rst
View File

@ -14,16 +14,16 @@ directly integrate into Home Assistant through the native API.
esp32_camera:
name: My Camera
external_clock:
pin: GPIO27
pin: GPIOXX
frequency: 20MHz
i2c_pins:
sda: GPIO25
scl: GPIO23
data_pins: [GPIO17, GPIO35, GPIO34, GPIO5, GPIO39, GPIO18, GPIO36, GPIO19]
vsync_pin: GPIO22
href_pin: GPIO26
pixel_clock_pin: GPIO21
reset_pin: GPIO15
sda: GPIOXX
scl: GPIOXX
data_pins: [GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX, GPIOXX]
vsync_pin: GPIOXX
href_pin: GPIOXX
pixel_clock_pin: GPIOXX
reset_pin: GPIOXX
resolution: 640x480
jpeg_quality: 10

16
components/ethernet.rst
View File

@ -17,8 +17,8 @@ This component and the Wi-Fi component may **not** be used simultaneously, even
# Example configuration entry for RMII chips
ethernet:
type: LAN8720
mdc_pin: GPIO23
mdio_pin: GPIO18
mdc_pin: GPIOXX
mdio_pin: GPIOXX
clk_mode: GPIO0_IN
phy_addr: 0
@ -33,12 +33,12 @@ This component and the Wi-Fi component may **not** be used simultaneously, even
# Example configuration entry for SPI chips
ethernet:
type: W5500
clk_pin: GPIO19
mosi_pin: GPIO21
miso_pin: GPIO23
cs_pin: GPIO18
interrupt_pin: GPIO36
reset_pin: GPIO22
clk_pin: GPIOXX
mosi_pin: GPIOXX
miso_pin: GPIOXX
cs_pin: GPIOXX
interrupt_pin: GPIOXX
reset_pin: GPIOXX
Configuration variables:
------------------------

2
components/exposure_notifications.rst
View File

@ -52,7 +52,7 @@ minute, the indicator will be on.
switch:
- platform: gpio
pin: GPIO22
pin: GPIOXX
id: led
script:

5
components/fan/binary.rst
View File

@ -14,11 +14,6 @@ The ``binary`` fan platform lets you represent any binary :ref:`output` as a fan
.. code-block:: yaml
# Example configuration entry
output:
- id: fan_output
platform: gpio
pin: GPIO16
fan:
- platform: binary
output: fan_output

8
components/fan/hbridge.rst
View File

@ -23,14 +23,6 @@ The ``hbridge`` fan platform allows you to use a compatible *h-bridge* (L298N, D
.. code-block:: yaml
# Example configuration entry
output:
- platform: ...
id: motor_forward_pin
pin: GPIO5
- platform: ...
id: motor_reverse_pin
pin: GPIO4
fan:
- platform: hbridge
id: my_fan

55
components/fingerprint_grow.rst
View File

@ -30,16 +30,10 @@ If available on your reader model, it's recommended to connect 3.3VT (touch indu
.. code-block:: yaml
# Example configuration entry
uart:
rx_pin: GPIO13
tx_pin: GPIO15
baud_rate: 57600
# Declare Grow Fingerprint Reader
fingerprint_grow:
sensing_pin: GPIO12
sensing_pin: GPIOXX
sensor_power_pin:
number: GPIO18
number: GPIOXX
inverted: true
idle_period_to_sleep: 5s
@ -93,46 +87,27 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
Optional Sensor Configuration:
Sensor
------
- **fingerprint_count**: The number of enrolled fingerprints stored on the reader.
- **name** (**Required**, string): The name for the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
- **last_finger_id**: The last matched enrolled fingerprint as set by :ref:`fingerprint_grow-on_finger_scan_matched`.
- **name** (**Required**, string): The name for the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
- **last_confidence**: The last matched confidence as set by :ref:`fingerprint_grow-on_finger_scan_matched`.
- **name** (**Required**, string): The name for the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
- **status**: The integer representation of the internal status register of the reader.
- **name** (**Required**, string): The name for the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
- **capacity**: The fingerprint storage capacity of the reader.
- **name** (**Required**, string): The name for the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
- **security_level**: The integer representation of the currently configured security level of the reader. Higher security levels reduce the false acceptance rate (FAR) at the expense of increasing the false rejection rate (FRR). Range is 1 (lowest) to 5 (highest).
- **name** (**Required**, string): The name for the sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
.. _fingerprint_grow-sleep_mode:
@ -150,14 +125,14 @@ This is a wiring example for the R503 and below you can find the respective conf
.. code-block:: yaml
uart:
rx_pin: GPIO16
tx_pin: GPIO17
rx_pin: GPIOXX
tx_pin: GPIOXX
baud_rate: 57600
fingerprint_grow:
sensing_pin: GPIO4
sensing_pin: GPIOXX
sensor_power_pin:
number: GPIO18
number: GPIOXX
inverted: true
idle_period_to_sleep: 5s
@ -513,12 +488,12 @@ Sample code
.. code-block:: yaml
uart:
rx_pin: GPIO13
tx_pin: GPIO15
rx_pin: GPIOXX
tx_pin: GPIOXX
baud_rate: 57600
fingerprint_grow:
sensing_pin: GPIO12
sensing_pin: GPIOXX
on_finger_scan_invalid:
- homeassistant.event:
event: esphome.test_node_finger_scan_invalid

3
components/gps.rst
View File

@ -22,9 +22,6 @@ in your configuration - only the RX pin should be necessary.
.. code-block:: yaml
# Example configuration entry
uart:
rx_pin: D7
baud_rate: 9600
# Declare GPS module
gps:

12
components/i2c.rst
View File

@ -20,8 +20,8 @@ connecting the wires from each device back to the two I²C pins on the ESP.
# Example configuration entry for ESP32
i2c:
sda: 21
scl: 22
sda: GPIOXX
scl: GPIOXX
scan: true
id: bus_a
@ -51,12 +51,12 @@ Configuration variables:
# Example configuration entry
i2c:
- id: bus_a
sda: 13
scl: 16
sda: GPIOXX
scl: GPIOXX
scan: true
- id: bus_b
sda: 14
scl: 15
sda: GPIOXX
scl: GPIOXX
scan: true
# Sensors should be specified as follows
- platform: bme680

4
components/i2s_audio.rst
View File

@ -14,8 +14,8 @@ This component only works on ESP32 based chips.
# Example configuration entry
i2s_audio:
i2s_lrclk_pin: GPIO33
i2s_bclk_pin: GPIO19
i2s_lrclk_pin: GPIOXX
i2s_bclk_pin: GPIOXX
Configuration variables:
------------------------

4
components/light/binary.rst
View File

@ -20,10 +20,6 @@ The ``binary`` light platform creates a simple ON/OFF-only light from a
name: "Desk Lamp"
output: light_output
output:
- id: light_output
platform: gpio
pin: GPIO16
Configuration variables:
------------------------

2
components/light/esp32_rmt_led_strip.rst
View File

@ -12,7 +12,7 @@ This is a component using the ESP32 RMT peripheral to drive most addressable LED
light:
- platform: esp32_rmt_led_strip
rgb_order: GRB
pin: GPIO13
pin: GPIOXX
num_leds: 30
rmt_channel: 0
chipset: ws2812

6
components/light/fastled.rst
View File

@ -47,7 +47,7 @@ Clockless FastLED lights differ from the
light:
- platform: fastled_clockless
chipset: WS2811
pin: GPIO23
pin: GPIOXX
num_leds: 60
rgb_order: BRG
name: "FastLED WS2811 Light"
@ -126,8 +126,8 @@ whereas the clockless lights only need a single pin.
light:
- platform: fastled_spi
chipset: WS2801
data_pin: GPIO23
clock_pin: GPIO22
data_pin: GPIOXX
clock_pin: GPIOXX
num_leds: 60
rgb_order: BRG
name: "FastLED SPI Light"

11
components/light/hbridge.rst
View File

@ -18,17 +18,6 @@ The pins are switched alternatively to allow two sets of lights to operate.
.. code-block:: yaml
# Example configuration entry
# Specify the two pins of the h-bridge as PWM pins
output:
- platform: esp8266_pwm
id: pina
pin: GPIO12
- platform: esp8266_pwm
id: pinb
pin: GPIO14
# Create a light using the hbridge
light:
- platform: hbridge
id: mainlight

5
components/light/monochromatic.rst
View File

@ -26,11 +26,6 @@ The ``monochromatic`` light platform creates a simple brightness-only light from
name: "Kitchen Lights"
output: output_component1
# Example output entry
output:
- platform: esp8266_pwm
id: output_component1
pin: D1
Configuration variables:
------------------------

2
components/light/neopixelbus.rst
View File

@ -28,7 +28,7 @@ the `NeoPixelBus <https://github.com/Makuna/NeoPixelBus/>`__ library internally.
- platform: neopixelbus
type: GRB
variant: WS2811
pin: GPIO23
pin: GPIOXX
num_leds: 60
name: "NeoPixel Light"

9
components/light/rgb.rst
View File

@ -28,12 +28,6 @@ The ``rgb`` light platform creates an RGB light from 3 :ref:`float output compon
green: output_component2
blue: output_component3
# Example output entry
output:
- platform: esp8266_pwm
id: output_component1
pin: D1
# Repeat for green and blue output
Color Correction
----------------
@ -54,9 +48,8 @@ perceived intensity of different colors will generally vary. This can be done by
# Example output entry
output:
- platform: esp8266_pwm
- platform: ...
id: output_component1
pin: D1
max_power: 80%
# Repeat for green and blue output

3
components/light/rgbw.rst
View File

@ -38,9 +38,8 @@ perceived intensity of different colors will generally vary. This can be done by
# Example output entry
output:
- platform: esp8266_pwm
- platform: ...
id: output_component1
pin: D1
max_power: 80%
.. note::

3
components/light/rgbww.rst
View File

@ -44,9 +44,8 @@ perceived intensity of different colors will generally vary. This can be done by
# Example output entry
output:
- platform: esp8266_pwm
- platform: ...
id: output_component1
pin: D1
max_power: 80%
.. note::

2
components/light/rp2040_pio_led_strip.rst
View File

@ -13,7 +13,7 @@ This is a component using the RP2040 PIO peripheral to drive most addressable LE
- platform: rp2040_pio_led_strip
name: led_strip
id: led_strip
pin: GPIO13
pin: GPIOXX
num_leds: 10
pio: 0
rgb_order: GRB

5
components/light/spi_led_strip.rst
View File

@ -18,14 +18,9 @@ LEDs, or any others with a similar interface - SPI, 8 bits per colour and BGR or
.. code-block:: yaml
# Example configuration entry
spi:
mosi_pin: GPIO3
clk_pin: GPIO9
light:
- platform: spi_led_strip
num_leds: 30
color_correct: [80%, 60%, 100%]
id: rgb_led
name: "RGB LED Strip"
data_rate: 1MHz

4
components/light/status_led.rst
View File

@ -22,7 +22,7 @@ When the device is in OK state, the LED will be restored to the state of the ``b
light:
- platform: status_led
name: "Switch state"
pin: GPIO2
pin: GPIOXX
.. note::
@ -50,7 +50,7 @@ Configuration variables:
.. code-block:: yaml
pin:
number: GPIO2
number: GPIOXX
inverted: true

15
components/lightwaverf.rst
View File

@ -22,19 +22,8 @@ Using an inexpensive RF transmitter and receiver you can control your devices vi
# Specify the two pins to connect the receiver and transmitter
lightwaverf:
read_pin: 13
write_pin: 14
# Create a switch to trigger a light
switch:
- platform: template
name: "Turn off sofa"
id: light_off_ceiling_sofa
turn_on_action:
lightwaverf.send_raw:
code: [0x04, 0x00, 0x00, 0x00, 0x0f, 0x03, 0x0d, 0x09, 0x08, 0x08]
name: "Sofa"
repeat: 1
read_pin: GPIOXX
write_pin: GPIOXX
Note: To gather the RAW codes from the remote, setup the ``read_pin`` and observe in the logs the printing of the codes.

2
components/lock/output.rst
View File

@ -16,7 +16,7 @@ The ``output`` lock platform allows you to use any output component as a lock.
# Example configuration entry
output:
- platform: gpio
pin: 25
pin: GPIOXX
id: 'generic_out'
lock:
- platform: output

16
components/matrix_keypad.rst
View File

@ -23,15 +23,15 @@ Component
matrix_keypad:
id: mykeypad
rows:
- pin: 21
- pin: 19
- pin: 18
- pin: 5
- pin: GPIOXX
- pin: GPIOXX
- pin: GPIOXX
- pin: GPIOXX
columns:
- pin: 17
- pin: 16
- pin: 4
- pin: 15
- pin: GPIOXX
- pin: GPIOXX
- pin: GPIOXX
- pin: GPIOXX
keys: "123A456B789C*0#D"
has_diodes: false

35
components/max6956.rst
View File

@ -58,19 +58,7 @@ Binary Sensor Example
.. code-block:: yaml
# Example configuration : pin as input with pullup
i2c:
id: bus_a
sda: GPIO13
scl: GPIO16
scan: false
max6956:
- id: max6956_1
address: 0x40
i2c_id: bus_a
# Individual input
# Example configuration
binary_sensor:
- platform: gpio
name: "MaxIn Pin 4"
@ -91,18 +79,7 @@ Switch Example
.. code-block:: yaml
# Example configuration : pin as output
i2c:
id: bus_a
sda: GPIO13
scl: GPIO16
max6956:
- id: max6956_1
address: 0x40
i2c_id: bus_a
# Individual output
# Example configuration
switch:
- platform: gpio
name: "MaxIn Pin 8"
@ -126,8 +103,8 @@ Led driver Example
# Example configuration : pin as led driver, current globaly
i2c:
id: bus_a
sda: GPIO13
scl: GPIO16
sda: GPIOXX
scl: GPIOXX
switch:
- platform: template
@ -178,8 +155,8 @@ Led driver Example
# Example configuration : pin as led driver, current managed individualy (RBG led)
i2c:
id: bus_a
sda: GPIO13
scl: GPIO16
sda: GPIOXX
scl: GPIOXX
max6956:
- id: max6956_1

4
components/mcp23Sxx.rst
View File

@ -26,7 +26,7 @@ The MCP23S08 component (`datasheet <http://ww1.microchip.com/downloads/en/Device
# Example configuration entry
mcp23s08:
- id: 'mcp23s08_hub'
cs_pin: D8
cs_pin: GPIOXX
deviceaddress: 0
# Individual outputs
@ -94,7 +94,7 @@ binary sensor or GPIO switch.
# Example configuration entry
mcp23s17:
- id: 'mcp23s17_hub'
cs_pin: D8
cs_pin: GPIOXX
deviceaddress: 0
# Individual outputs

2
components/media_player/i2s_audio.rst
View File

@ -15,7 +15,7 @@ via the :doc:`/components/i2s_audio`. This platform only works on ESP32 based ch
- platform: i2s_audio
name: ESPHome I2S Media Player
dac_type: external
i2s_dout_pin: GPIO22
i2s_dout_pin: GPIOXX
mode: mono
Configuration variables:

8
components/microphone/i2s_audio.rst
View File

@ -24,12 +24,12 @@ This platform only works on ESP32 based chips.
- platform: i2s_audio
id: external_mic
adc_type: external
i2s_din_pin: GPIO23
i2s_din_pin: GPIOXX
- platform: i2s_audio
id: adc_mic
adc_type: internal
adc_pin: GPIO35
adc_pin: GPIOXX
Configuration variables:
@ -80,7 +80,7 @@ M5Stack Atom Echo
microphone:
- platform: i2s_audio
adc_type: external
i2s_din_pin: GPIO23
i2s_din_pin: GPIOXX
pdm: true
RaspiAudio Muse Luxe
@ -90,7 +90,7 @@ RaspiAudio Muse Luxe
microphone:
- platform: i2s_audio
i2s_din_pin: GPIO35
i2s_din_pin: GPIOXX
adc_type: external
pdm: false

8
components/modbus_controller.rst
View File

@ -78,7 +78,7 @@ Technically there is no difference between the "inline" and the standard definit
...
modbus:
flow_control_pin: 5
flow_control_pin: GPIOXX
id: modbus1
modbus_controller:
@ -586,13 +586,13 @@ The response is mapped to the sensor based on ``register_count`` and offset in b
uart:
id: mod_bus
tx_pin: 19
rx_pin: 18
tx_pin: GPIOXX
rx_pin: GPIOXX
baud_rate: 115200
stop_bits: 1
modbus:
#flow_control_pin: 23
#flow_control_pin: GPIOXX
send_wait_time: 200ms
id: mod_bus_epever

4
components/output/ac_dimmer.rst
View File

@ -34,9 +34,9 @@ for example the `RobotDyn dimmer
output:
- platform: ac_dimmer
id: dimmer1
gate_pin: D7
gate_pin: GPIOXX
zero_cross_pin:
number: D6
number: GPIOXX
mode:
input: true
inverted: yes

4
components/output/bp1658cj.rst
View File

@ -24,8 +24,8 @@ It is used in some smart light bulbs:
# Example configuration entry
bp1658cj:
data_pin: GPIO6
clock_pin: GPIO7
data_pin: GPIOXX
clock_pin: GPIOXX
max_power_color_channels: 4 # Valid values 0-15
max_power_white_channels: 6 # Valid values 0-15

4
components/output/bp5758d.rst
View File

@ -24,8 +24,8 @@ It is used in some smart light bulbs:
# Example configuration entry
bp5758d:
data_pin: GPIO3
clock_pin: GPIO5
data_pin: GPIOXX
clock_pin: GPIOXX
Configuration variables:

2
components/output/esp8266_pwm.rst
View File

@ -15,7 +15,7 @@ like the one on the ESP32 (see :doc:`ledc`) are preferred.
# Example configuration entry
output:
- platform: esp8266_pwm
pin: D1
pin: GPIOXX
frequency: 1000 Hz
id: pwm_output

2
components/output/gpio.rst
View File

@ -14,7 +14,7 @@ will not show up in Home Assistant. See :doc:`/components/switch/gpio`.
# Example configuration entry
output:
- platform: gpio
pin: D1
pin: GPIOXX
id: gpio_d1
Configuration variables:

55
components/output/ledc.rst
View File

@ -12,6 +12,32 @@ of the ESP32 as an output component.
The frequency range of LEDC is from 10Hz to 40MHz - however, higher frequencies require a smaller
bit depth which means the output is not that accurate for frequencies above ~300kHz.
Configuration variables:
------------------------
- **pin** (**Required**, :ref:`config-pin`): The pin to use LEDC on. Can only be GPIO0-GPIO33.
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **frequency** (*Optional*, float): At which frequency to run the LEDC
channel’s timer. Defaults to 1000Hz.
- All other options from :ref:`Output <config-output>`.
Advanced options:
- **channel** (*Optional*, int): Manually set the `LEDC
channel <https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/peripherals/ledc.html#configure-channel>`__
to use. Two adjacent channels share the same timer. Defaults to an automatic selection.
Note: When configuring custom frequencies for two or more outputs, ensure that you manually specify
channel 0, 2, 4, 6 for each output. This will prevent issues that arise from automatic selection,
which chooses adjacent channels with shared timers. See
`Issue #3114 <https://github.com/esphome/issues/issues/3114>`__ for more details.
- **phase_angle** (*Optional*, float): Set a phase angle to the other channel of this timer.
Range 0-360°, defaults to 0°
Note: this variable is only available for the esp-idf framework
Example Usage For a Light
*************************
@ -20,8 +46,8 @@ Example Usage For a Light
# Example configuration entry
output:
- platform: ledc
pin: GPIO19
id: gpio_19
pin: GPIOXX
id: gpio_
# Example usage in a light
light:
@ -63,31 +89,6 @@ Example Usage For a Piezo Buzzer
id: buzzer
level: "50%"
Configuration variables:
------------------------
- **pin** (**Required**, :ref:`config-pin`): The pin to use LEDC on. Can only be GPIO0-GPIO33.
- **id** (**Required**, :ref:`config-id`): The id to use for this output component.
- **frequency** (*Optional*, float): At which frequency to run the LEDC
channel’s timer. Defaults to 1000Hz.
- All other options from :ref:`Output <config-output>`.
Advanced options:
- **channel** (*Optional*, int): Manually set the `LEDC
channel <https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/peripherals/ledc.html#configure-channel>`__
to use. Two adjacent channels share the same timer. Defaults to an automatic selection.
Note: When configuring custom frequencies for two or more outputs, ensure that you manually specify
channel 0, 2, 4, 6 for each output. This will prevent issues that arise from automatic selection,
which chooses adjacent channels with shared timers. See
`Issue #3114 <https://github.com/esphome/issues/issues/3114>`__ for more details.
- **phase_angle** (*Optional*, float): Set a phase angle to the other channel of this timer.
Range 0-360°, defaults to 0°
Note: this variable is only available for the esp-idf framework
Recommended frequencies
-----------------------

14
components/output/my9231.rst
View File

@ -31,14 +31,9 @@ global ``my9231`` hub and give it an id, and then define the
# Example configuration entry
my9231:
- data_pin: GPIO12
clock_pin: GPIO14
- data_pin: GPIOXX
clock_pin: GPIOXX
# Individual outputs
output:
- platform: my9231
id: 'my9231_output1'
channel: 0
Configuration variables:
************************
@ -68,11 +63,6 @@ The MY931/MY9291 output component exposes a MY931/MY9291 channel of a global
.. code-block:: yaml
# Example configuration entry
my9231:
- data_pin: GPIO12
clock_pin: GPIO14
# Individual outputs
output:
- platform: my9231

2
components/output/pca9685.rst
View File

@ -44,7 +44,7 @@ global ``pca9685`` hub and give it an id, and then define the
output:
# generate PWM from ESP32 ledc
- platform: ledc
pin: 25
pin: GPIOXX
id: extclk
min_power: 1
frequency: 40MHz

4
components/output/sigma_delta_output.rst
View File

@ -35,7 +35,7 @@ This component can be used as a drop-in replacement for :doc:`/components/output
id: sd_heater_output
# Output to a pin
pin: 15
pin: GPIOXX
# Use the same output, but through automations
turn_on_action:
@ -46,7 +46,7 @@ This component can be used as a drop-in replacement for :doc:`/components/output
- output.turn_off: heater_relay
- platform: gpio
pin: 15
pin: GPIOXX
id: heater_relay
Configuration variables:

2
components/output/slow_pwm.rst
View File

@ -22,7 +22,7 @@ heating element through a relay where a fast PWM update cycle would not be appro
# Example configuration entry
output:
- platform: slow_pwm
pin: D1
pin: GPIOXX
id: my_slow_pwm
period: 15s

22
components/output/sm16716.rst
View File

@ -28,22 +28,11 @@ global ``sm16716`` hub and give it an id, and then define the
# Example configuration entry
sm16716:
data_pin: GPIO14
clock_pin: GPIO4
data_pin: GPIOXX
clock_pin: GPIOXX
num_channels: 3
num_chips: 1
# Individual outputs
output:
- platform: sm16716
id: output_red
channel: 0
- platform: sm16716
id: output_green
channel: 1
- platform: sm16716
id: output_blue
channel: 2
Configuration variables:
************************
@ -69,13 +58,6 @@ The SM16716 output component exposes a SM16716 channel of a global
.. code-block:: yaml
# Example configuration entry
sm16716:
data_pin: GPIO14
clock_pin: GPIO4
num_channels: 3
num_chips: 1
# Individual outputs
output:
- platform: sm16716

31
components/output/sm2135.rst
View File

@ -27,31 +27,9 @@ global ``sm2135`` hub and give it an id, and then define the
# Example configuration entry
sm2135:
data_pin: GPIO12
clock_pin: GPIO14
data_pin: GPIOXX
clock_pin: GPIOXX
# Individual outputs
output:
- platform: sm2135
id: output_red
channel: 0
max_power: 0.8
- platform: sm2135
id: output_green
channel: 1
max_power: 0.8
- platform: sm2135
id: output_blue
channel: 2
max_power: 0.8
- platform: sm2135
id: output_white
channel: 3
max_power: 0.8
- platform: sm2135
id: output_warmwhite
channel: 4
max_power: 0.8
Configuration variables:
************************
@ -82,11 +60,6 @@ The SM2135 output component exposes a SM2135 channel of a global
.. code-block:: yaml
# Example configuration entry
sm2135:
data_pin: GPIO12
clock_pin: GPIO14
# Individual outputs
output:
- platform: sm2135

4
components/output/sm2235.rst
View File

@ -21,8 +21,8 @@ global ``sm2235`` hub and give it an id, and then define the
# Example configuration entry
sm2235:
data_pin: GPIO4
clock_pin: GPIO5
data_pin: GPIOXX
clock_pin: GPIOXX
max_power_color_channels: 9
max_power_white_channels: 9

4
components/output/sm2335.rst
View File

@ -24,8 +24,8 @@ global ``sm2335`` hub and give it an id, and then define the
# Example configuration entry
sm2335:
data_pin: GPIO4
clock_pin: GPIO5
data_pin: GPIOXX
clock_pin: GPIOXX
max_power_color_channels: 9
max_power_white_channels: 9

8
components/output/template.rst
View File

@ -22,14 +22,10 @@ The ``template`` output component can be used to create templated binary and flo
id: output2
level: !lambda return state;
- platform: esp8266_pwm
- platform: ...
id: output1
pin: GPIO12
inverted: true
- platform: esp8266_pwm
- platform: ...
id: output2
pin: GPIO14
inverted: true

24
components/output/tlc5947.rst
View File

@ -27,21 +27,9 @@ global ``tlc5947`` hub and give it an id, and then define the
# Example configuration entry
tlc5947:
data_pin: GPIO12
clock_pin: GPIO14
lat_pin: GPIO15
# Individual outputs
output:
- platform: tlc5947
id: output_red
channel: 0
- platform: tlc5947
id: output_green
channel: 1
- platform: tlc5947
id: output_blue
channel: 2
data_pin: GPIOXX
clock_pin: GPIOXX
lat_pin: GPIOXX
Configuration variables:
************************
@ -66,12 +54,6 @@ The tlc5947 output component exposes a tlc5947 channel of a global
.. code-block:: yaml
# Example configuration entry
tlc5947:
data_pin: GPIO12
clock_pin: GPIO14
lat_pin: GPIO15
# Individual outputs
output:
- platform: tlc5947

20
components/output/tlc5971.rst
View File

@ -27,20 +27,9 @@ global ``tlc5971`` hub and give it an id, and then define the
# Example configuration entry
tlc5971:
data_pin: GPIO12
clock_pin: GPIO14
data_pin: GPIOXX
clock_pin: GPIOXX
# Individual outputs
output:
- platform: tlc5971
id: output_red
channel: 0
- platform: tlc5971
id: output_green
channel: 1
- platform: tlc5971
id: output_blue
channel: 2
Configuration variables:
************************
@ -63,11 +52,6 @@ The tlc5971 output component exposes a tlc5971 channel of a global
.. code-block:: yaml
# Example configuration entry
tlc5971:
data_pin: GPIO12
clock_pin: GPIO14
# Individual outputs
output:
- platform: tlc5971

6
components/output/x9c.rst
View File

@ -33,9 +33,9 @@ All chips are controlled by a three wire interface and feature 100 possible wipe
output:
- platform: x9c
id: x9c_pot
cs_pin: GPIO25
inc_pin: GPIO27
ud_pin: GPIO26
cs_pin: GPIOXX
inc_pin: GPIOXX
ud_pin: GPIOXX
initial_value: 0.5
Configuration variables:

10
components/pipsolar.rst
View File

@ -37,16 +37,8 @@ There is a buffer to buffer up to 10 commands.
.. code-block:: yaml
# Example configuration entry
uart:
- id: uart_bus
tx_pin: GPIO18
rx_pin: GPIO19
# most devices use 2400 as baud_rate
baud_rate: 2400
pipsolar:
- uart_id: uart_bus
id: inverter0
- id: inverter0
Configuration variables:
~~~~~~~~~~~~~~~~~~~~~~~~

8
components/pn7150.rst
View File

@ -30,10 +30,10 @@ In addition, the :doc:`binary_sensor/nfc` platform may be used to quickly and ea
.. code-block:: yaml
pn7150_i2c:
dwl_req_pin: 17
irq_pin: 35
ven_pin: 16
wkup_req_pin: 21
dwl_req_pin: GPIOXX
irq_pin: GPIOXX
ven_pin: GPIOXX
wkup_req_pin: GPIOXX
emulation_message: https://www.home-assistant.io/tag/pulse_ce
tag_ttl: 1000ms

18
components/pn7160.rst
View File

@ -42,11 +42,11 @@ The ``pn7160_spi`` component allows you to use :ref:`SPI-equipped <spi>` PN7160
.. code-block:: yaml
pn7160_spi:
cs_pin: 15
dwl_req_pin: 17
irq_pin: 35
ven_pin: 16
wkup_req_pin: 21
cs_pin: GPIOXX
dwl_req_pin: GPIOXX
irq_pin: GPIOXX
ven_pin: GPIOXX
wkup_req_pin: GPIOXX
emulation_message: https://www.home-assistant.io/tag/pulse_ce
tag_ttl: 1000ms
@ -87,10 +87,10 @@ The ``pn7160_i2c`` component allows you to use :ref:`I²C-equipped <i2c>` PN7160
.. code-block:: yaml
pn7160_i2c:
dwl_req_pin: 17
irq_pin: 35
ven_pin: 16
wkup_req_pin: 21
dwl_req_pin: GPIOXX
irq_pin: GPIOXX
ven_pin: GPIOXX
wkup_req_pin: GPIOXX
emulation_message: https://www.home-assistant.io/tag/pulse_ce
tag_ttl: 1000ms

2
components/power_supply.rst
View File

@ -21,7 +21,7 @@ after the last output has been disabled.
# Example configuration entry
power_supply:
- id: 'power_supply1'
pin: 13
pin: GPIOXX
Configuration variables:
------------------------

9
components/remote_receiver.rst
View File

@ -20,7 +20,7 @@ which will trigger when they hear their own configured signal.
# Example configuration entry
remote_receiver:
pin: GPIO32
pin: GPIOXX
dump: all
Configuration variables:
@ -206,10 +206,6 @@ then immediately OFF.
.. code-block:: yaml
# Example configuration entry
remote_receiver:
pin: GPIO32
dump: all
binary_sensor:
- platform: remote_receiver
name: "Panasonic Remote Input"
@ -439,7 +435,7 @@ Remote code selection (exactly one of these has to be included):
remote_receiver:
pin:
number: D4
number: GPIOXX
inverted: true
mode:
input: true
@ -475,4 +471,3 @@ See Also
- `IRRemoteESP8266 <https://github.com/markszabo/IRremoteESP8266/>`__ by `Mark Szabo-Simon <https://github.com/markszabo>`__
- :apiref:`remote/remote_receiver.h`
- :ghedit:`Edit`

21
components/remote_transmitter.rst
View File

@ -24,18 +24,9 @@ remote signals.
# Example configuration entry
remote_transmitter:
pin: GPIO32
pin: GPIOXX
carrier_duty_percent: 50%
# Individual switches
switch:
- platform: template
name: "Panasonic TV Off"
turn_on_action:
remote_transmitter.transmit_panasonic:
address: 0x4004
command: 0x100BCBD
Configuration variables:
------------------------
@ -911,7 +902,7 @@ remote_receiver instance:
.. code-block:: yaml
remote_receiver:
pin: D0
pin: GPIOXX
dump: all
Compile and upload the code. While viewing the log output from the ESP,
@ -940,7 +931,7 @@ IR diode to a new pin on the ESP and configure a global ``remote_transmitter`` i
.. code-block:: yaml
remote_transmitter:
pin: D1
pin: GPIOXX
# Infrared remotes use a 50% carrier signal
carrier_duty_percent: 50%
@ -986,7 +977,7 @@ First, connect the RF module to a pin on the ESP and set up a remote_receiver in
.. code-block:: yaml
remote_receiver:
pin: D0
pin: GPIOXX
dump: all
# Settings to optimize recognition of RF devices
tolerance: 50%
@ -1018,7 +1009,7 @@ You should see log output like below:
.. code-block:: yaml
remote_receiver:
pin: D0
pin: GPIOXX
dump:
- rc_switch
tolerance: 50%
@ -1036,7 +1027,7 @@ RF transmitter to a new pin on the ESP and configure a global ``remote_transmitt
.. code-block:: yaml
remote_transmitter:
pin: D1
pin: GPIOXX
# RF uses a 100% carrier signal
carrier_duty_percent: 100%

2
components/rtttl.rst
View File

@ -165,7 +165,7 @@ Sample code
output:
- platform: esp8266_pwm
pin: D1
pin: GPIOXX
id: rtttl_out
rtttl:

2
components/sensor/adc.rst
View File

@ -22,7 +22,7 @@ ADC in your device to measure a voltage on certain pins.
# Example configuration entry
sensor:
- platform: adc
pin: A0
pin: GPIOXX
name: "Living Room Brightness"
update_interval: 60s

18
components/sensor/adc128s102.rst
View File

@ -31,16 +31,9 @@ sensors for your projects.
# Example configuration entry
adc128s102:
cs_pin: GPIO15
cs_pin: GPIOXX
id: my_adc
sensor:
- platform: adc128s102 # Attached to pin 0 of the ADC128S102.
update_interval: 1s
adc128s102_id: my_adc
id: freezer_temp_source
channel: 0 # ADC128S102 channel
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The id to use for this ADC128S102 component.
- **cs_pin** (**Required**, int): The SPI cable select pin to use
@ -52,6 +45,15 @@ The ``adc128s102`` sensor allows you to use your ADC128S102 12-Bit A/D Converter
First, setup a :ref:`ADC128S102 Hub <adc128s102-component>` for your ADC128S102 sensor and then use this
sensor platform to create individual sensors that will report the voltage to Home Assistant.
.. code-block:: yaml
sensor:
- platform: adc128s102 # Attached to pin 0 of the ADC128S102.
update_interval: 1s
adc128s102_id: my_adc
id: freezer_temp_source
channel: 0 # ADC128S102 channel
Configuration variables:
- **adc128s102_id** (**Required**, :ref:`config-id`): The id of the parent ADC128S102 component.

14
components/sensor/ade7880.rst
View File

@ -190,9 +190,9 @@ configured).
sensor:
- platform: ade7880
irq0_pin:
number: GPIO13
number: GPIOXX
irq1_pin:
number: GPIO5
number: GPIOXX
phase_a:
name: Room Heater
voltage: Voltage
@ -217,9 +217,9 @@ Heater Current', etc.
sensor:
- platform: ade7880
irq0_pin:
number: GPIO13
number: GPIOXX
irq1_pin:
number: GPIO5
number: GPIOXX
phase_a:
voltage: Voltage
current:
@ -249,11 +249,11 @@ configuration mode.
sensor:
- platform: ade7880
irq0_pin:
number: GPIO13
number: GPIOXX
irq1_pin:
number: GPIO5
number: GPIOXX
reset_pin:
number: GPIO16
number: GPIOXX
frequency: 60Hz
phase_a:
name: Phase A

42
components/sensor/ade7953.rst
View File

@ -35,7 +35,7 @@ Over I²C
# Example configuration entry for i2c
sensor:
- platform: ade7953_i2c
irq_pin: GPIO16
irq_pin: GPIOXX
voltage:
name: ADE7953 Voltage
frequency:
@ -129,69 +129,35 @@ Over SPI
.. code-block:: yaml
# Example configuration entry for SPI (taken from a Shelly Pro 4PM)
# Example configuration entry for SPI
sensor:
- platform: ade7953_spi
cs_pin: GPIO04
irq_pin: GPIO35
current_pga_gain_a: 2x
current_pga_gain_b: 2x
current_gain_a: 0x600000
current_gain_b: 0x600000
cs_pin: GPIOXX
irq_pin: GPIOXX
voltage:
name: "Voltage"
filters:
- delta: 1
frequency:
name: ADE7953 Frequency
filters:
- delta: 0.1
current_a:
name: "Current A"
filters:
- delta: 0.01
current_b:
name: "Current B"
filters:
- delta: 0.01
power_factor_a:
name: "Power Factor A"
filters:
- delta: 5
power_factor_b:
name: "ADE7953 Power Factor B"
filters:
- delta: 5
apparent_power_a:
name: "Apparent Power A"
filters:
- delta: 1
apparent_power_b:
name: "Apparent Power B"
filters:
- delta: 1
active_power_a:
name: "Power A"
id: active_power_1
# active_power is inverted, so multiply by -1
filters:
- multiply: -1
- delta: 1
active_power_b:
name: "Power B"
id: active_power_2
# active_power is inverted, so multiply by -1
filters:
- multiply: -1
- delta: 1
reactive_power_a:
name: "Reactive Power A"
filters:
- delta: 1
reactive_power_b:
name: "Reactive Power B"
filters:
- delta: 1
Configuration variables:
************************

12
components/sensor/ads1118.rst
View File

@ -25,7 +25,7 @@ It uses the :ref:`SPI Bus <spi>` for communication.
.. code-block:: yaml
ads1118:
cs_pin: GPIO15
cs_pin: GPIOXX
Configuration variables:
************************
@ -46,14 +46,12 @@ sensor platform to create individual sensors that will report the voltage.
.. code-block:: yaml
ads1118:
cs_pin: GPIO15
sensor:
- platform: ads1118
type: 'adc'
id: 'batt_volt'
name: "Battery Voltage"
multiplexer: 'A3_GND'
type: adc
id: batt_volt
name: Battery Voltage
multiplexer: A3_GND
gain: 4.096
update_interval: .01s

60
components/sensor/as3935.rst
View File

@ -58,20 +58,10 @@ The ``as3935_spi`` sensor platform allows you to use your AS3935 sensor
.. code-block:: yaml
# Example configuration for SPI (decide for one!)
# Example configuration for SPI
as3935_spi:
cs_pin: GPIO12
irq_pin: GPIO13
# Example lightning and energy sensor
sensor:
- platform: as3935
lightning_energy:
name: "Lightning Energy"
distance:
name: "Distance Storm"
binary_sensor:
- platform: as3935
name: "Storm Alert"
cs_pin: GPIOXX
irq_pin: GPIOXX
Configuration variables:
@ -117,19 +107,9 @@ The ``as3935_i2c`` sensor platform allows you to use your AS3935 sensor
.. code-block:: yaml
# Example configuration for I²C (decide for one!)
# Example configuration for I²C
as3935_i2c:
irq_pin: GPIO12
# Example shared configuration
sensor:
- platform: as3935
lightning_energy:
name: "Lightning Energy"
distance:
name: "Distance Storm"
binary_sensor:
- platform: as3935
name: "Storm Alert"
irq_pin: GPIOXX
Configuration variables:
************************
@ -173,19 +153,22 @@ Sensor
A sensor platform to read lightning data
.. code-block:: yaml
sensor:
- platform: as3935
lightning_energy:
name: Lightning Energy
distance:
name: Distance Storm
Configuration variables:
- **lightning_energy** (*Optional*): Lightning energy value. According to the datasheet this is only a pure value that doesn't have any physical meaning.
- **name** (**Required**, string): The name for the lightning energy sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
- **distance** (*Optional*): Distance in km to the front of the storm and not the distance to a lightning strike.
- **name** (**Required**, string): The name for the distance sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
All options from :ref:`Sensor <config-sensor>`.
Binary Sensor
@ -193,11 +176,16 @@ Binary Sensor
Binary sensor that indicates if a lightning strike was detected.
.. code-block:: yaml
# Example storm alert binary sensor
binary_sensor:
- platform: as3935
name: Storm Alert
Configuration variables:
- **name** (**Required**, string): The name of the binary sensor.
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
- All options from :ref:`Binary Sensor <config-binary_sensor>`.
See Also

6
components/sensor/as5600.rst
View File

@ -30,7 +30,7 @@ the :ref:`I²C Bus <i2c>` and connect the sensor to the pins specified there.
.. code-block:: yaml
as5600:
dir_pin: 22
dir_pin: GPIOXX
start_position: 0deg
range: 180deg
@ -136,7 +136,7 @@ For example, let's say we have the following component config:
start_position: 90deg
range: 180deg
direction: clockwise
dir_pin: 22
dir_pin: GPIOXX
- If the magnet north was at the right side of the chip (i.e. 1024 / 90deg raw position), the scaled position would report a value of ``0``.
- If the magnet north was at the bottom of the chip (i.e. 2048 / 180deg raw position), the scaled position would report a value of ``2048``.
@ -180,7 +180,7 @@ sensor platform to create individual sensors that will report the position to Ho
.. code-block:: yaml
as5600:
dir_pin: 22
dir_pin: GPIOXX
sensor:
- platform: as5600

8
components/sensor/atm90e26.rst
View File

@ -111,13 +111,13 @@ Keeping the calibration values at the top of your yaml might make editing easier
metering_cal: '7481' # default: 7481 - Calibrate this to match your meter based on the CF1 (CFx) pulse.
spi:
clk_pin: 18
miso_pin: 19
mosi_pin: 23
clk_pin: GPIOXX
miso_pin: GPIOXX
mosi_pin: GPIOXX
sensor:
- platform: atm90e26
cs_pin: 5
cs_pin: GPIOXX
voltage:
name: House Voltage
accuracy_decimals: 1

10
components/sensor/atm90e32.rst
View File

@ -168,7 +168,7 @@ a time-series-database, e.g. InfluxDB.
sensor:
#IC1 Main
- platform: atm90e32
cs_pin: 5
cs_pin: GPIOXX
phase_a:
forward_active_energy:
name: ${disp_name} ct1 FAWattHours
@ -208,13 +208,13 @@ Additional Examples
# Example configuration entry for split single phase meter
spi:
clk_pin: 18
miso_pin: 19
mosi_pin: 23
clk_pin: GPIOXX
miso_pin: GPIOXX
mosi_pin: GPIOXX
sensor:
- platform: atm90e32
cs_pin: 5
cs_pin: GPIOXX
phase_a:
voltage:
name: "EMON Line Voltage A"

8
components/sensor/binary_sensor_map.rst
View File

@ -102,19 +102,19 @@ The maximum amount of observations/channels supported is 64.
binary_sensor:
- platform: gpio
pin: 4
pin: GPIOXX
id: bit0
- platform: gpio
pin: 5
pin: GPIOXX
id: bit1
- platform: gpio
pin: 6
pin: GPIOXX
id: bit2
- platform: gpio
pin: 7
pin: GPIOXX
id: bit3
# ...

12
components/sensor/bl0939.rst
View File

@ -20,20 +20,8 @@ Additionally, you need to set the baud rate to 4800, parity to ``NONE`` and stop
.. code-block:: yaml
# Example configuration entry
# Disable logging over serial
logger:
baud_rate: 0
uart:
tx_pin: GPIO25
rx_pin: GPIO26
baud_rate: 4800
parity: NONE
stop_bits: 2
sensor:
- platform: bl0939
update_interval: 30s
voltage:
name: 'BL0939 Voltage'
current_1:

14
components/sensor/bme280.rst
View File

@ -28,13 +28,10 @@ required to be set up in your configuration for this sensor to work.
- platform: bme280_i2c
temperature:
name: "BME280 Temperature"
oversampling: 16x
pressure:
name: "BME280 Pressure"
humidity:
name: "BME280 Humidity"
address: 0x77
update_interval: 60s
# Example configuration entry SPI
@ -42,40 +39,31 @@ required to be set up in your configuration for this sensor to work.
- platform: bme280_spi
temperature:
name: "BME280 Temperature"
oversampling: 16x
pressure:
name: "BME280 Pressure"
humidity:
name: "BME280 Humidity"
cs_pin: GPIO5
update_interval: 60s
cs_pin: GPIOXX
Configuration variables:
------------------------
- **temperature** (*Optional*): The information for the temperature sensor.
- **name** (**Required**, string): The name for the temperature
sensor.
- **oversampling** (*Optional*): The oversampling parameter for the temperature sensor.
See :ref:`Oversampling Options <bme280-oversampling>`.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **pressure** (*Optional*): The information for the pressure sensor.
- **name** (**Required**, string): The name for the pressure sensor.
- **oversampling** (*Optional*): The oversampling parameter for the temperature sensor.
See :ref:`Oversampling Options <bme280-oversampling>`.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **humidity** (*Optional*): The information for the pressure sensor.
- **name** (**Required**, string): The name for the humidity sensor.
- **oversampling** (*Optional*): The oversampling parameter for the temperature sensor.
See :ref:`Oversampling Options <bme280-oversampling>`.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **address** (*Optional*, int): Manually specify the I²C address of

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.0 KiB

After

Width:  |  Height:  |  Size: 3.4 KiB

7
components/sensor/cs5460a.rst
View File

@ -35,11 +35,6 @@ driven by a GPIO or wired to VCC.
.. code-block:: yaml
# Example configuration entry
spi:
clk_pin: 18
mosi_pin: 23
miso_pin: 19
sensor:
- platform: cs5460a
current:
@ -58,7 +53,7 @@ driven by a GPIO or wired to VCC.
current_gain: 0.01
voltage_gain: 0.000573
pulse_energy: 1 Wh
cs_pin: 33
cs_pin: GPIOXX
Configuration variables:
------------------------

11
components/sensor/cse7761.rst
View File

@ -20,16 +20,6 @@ Additionally, you need to set the baud rate to 38400 and parity to ``EVEN``.
.. code-block:: yaml
# Example configuration entry
# Disable logging over serial
logger:
baud_rate: 0
uart:
tx_pin: GPIO25
rx_pin: GPIO26
baud_rate: 38400
parity: EVEN
sensor:
- platform: cse7761
voltage:
@ -42,7 +32,6 @@ Additionally, you need to set the baud rate to 38400 and parity to ``EVEN``.
name: 'CSE7761 Active Power 1'
active_power_2:
name: 'CSE7761 Active Power 2'
update_interval: 5s
.. note::

20
components/sensor/dallas.rst
View File

@ -28,13 +28,7 @@ if you don't have massively long wires.
# Example configuration entry
dallas:
- pin: 23
# Individual sensors
sensor:
- platform: dallas
address: 0x1c0000031edd2a28
name: "Livingroom Temperature"
- pin: GPIOXX
Configuration variables:
************************
@ -71,10 +65,6 @@ To initialize a sensor, first supply either ``address`` **or** ``index`` to iden
.. code-block:: yaml
# Example configuration entry
dallas:
- pin: GPIO23
# Individual sensors
sensor:
- platform: dallas
@ -114,7 +104,7 @@ the scanning will happen even with no sensors connected. For example with this c
# Example configuration entry
dallas:
- pin: GPIO23
- pin: GPIOXX
# Note you don't have to add any sensors at this point
@ -128,7 +118,7 @@ Now we can add the individual sensors to our configuration:
# Example configuration entry
dallas:
- pin: GPIO23
- pin: GPIOXX
sensor:
- platform: dallas
@ -154,9 +144,9 @@ Use this if you have multiple dallas hubs:
# Example configuration entry
dallas:
- pin: GPIO23
- pin: GPIOXX
id: hub_1
- pin: GPIO24
- pin: GPIOXX
id: hub_2
sensor:

235
components/sensor/daly_bms.rst
View File

@ -15,18 +15,29 @@ The BMS communicates via :ref:`UART <uart>`.
:align: center
:width: 100.0%
Component/Hub
-------------
.. code-block:: yaml
# Example configuration entry (ESP8266)
uart:
tx_pin: GPIO1
rx_pin: GPIO3
baud_rate: 9600
# Example configuration entry
daly_bms:
update_interval: 20s
Configuration variables:
************************
- **update_interval** (*Optional*, :ref:`config-time`): Delay between data requests.
- **address** (*Optional*, int): Address to use, defaults to ``0x80``.
Sensor
------
A sensor platform to read BMS data
.. code-block:: yaml
sensor:
- platform: daly_bms
voltage:
@ -68,11 +79,81 @@ The BMS communicates via :ref:`UART <uart>`.
cell_4_voltage:
name: "Cell 4 Voltage"
Configuration variables:
************************
- **voltage** (*Optional*): Voltage of the battery pack connected to Daly BMS.
All options from :ref:`Sensor <config-sensor>`.
- **current** (*Optional*): Current flowing trough the BMS (input or output from batttery).
All options from :ref:`Sensor <config-sensor>`.
- **battery_level** (*Optional*): Battery level in % (SoC).
All options from :ref:`Sensor <config-sensor>`.
- **max_cell_voltage** (*Optional*): The cell of the battery with the higher voltage.
All options from :ref:`Sensor <config-sensor>`.
- **max_cell_voltage_number** (*Optional*): The cell number of the battery with the higher voltage.
All options from :ref:`Sensor <config-sensor>`.
- **min_cell_voltage** (*Optional*): The cell of the battery with the lower voltage.
All options from :ref:`Sensor <config-sensor>`.
- **min_cell_voltage_number** (*Optional*): The cell number of the battery with the lower voltage.
All options from :ref:`Sensor <config-sensor>`.
- **max_temperature** (*Optional*): The higher temperature measured from the temperature sensors.
All options from :ref:`Sensor <config-sensor>`.
- **max_temperature_probe_number** (*Optional*): The sensor number which has measured the higher temperature.
All options from :ref:`Sensor <config-sensor>`.
- **min_temperature** (*Optional*): The lower temperature measured from the temperature sensors.
All options from :ref:`Sensor <config-sensor>`.
- **min_temperature_probe_number** (*Optional*): The sensor number which has measured the lower temperature.
All options from :ref:`Sensor <config-sensor>`.
- **remaining_capacity** (*Optional*): The capacity in Ah left in the battery.
All options from :ref:`Sensor <config-sensor>`.
- **cells_number** (*Optional*): The number of cells in series in the battery pack.
All options from :ref:`Sensor <config-sensor>`.
- **temperature_1** (*Optional*): The first temperature sensor.
All options from :ref:`Sensor <config-sensor>`.
- **temperature_2** (*Optional*): The second temperature sensor.
All options from :ref:`Sensor <config-sensor>`.
- **cell_1_voltage** (*Optional*): The voltage of cell number 1. Cell number can be from 1 to 16.
All options from :ref:`Sensor <config-sensor>`.
Text Sensor
-----------
Text sensor that indicates the status of BMS.
.. code-block:: yaml
text_sensor:
- platform: daly_bms
status:
name: "BMS Status"
Configuration variables:
************************
- **status** (*Optional*): The BMS Status (Charging, Discharging, Stationary).
All options from :ref:`Text Sensor <config-text_sensor>`.
Binary Sensor
-------------
Binary sensor that indicates the status of MOS.
.. code-block:: yaml
binary_sensor:
- platform: daly_bms
@ -81,152 +162,14 @@ The BMS communicates via :ref:`UART <uart>`.
discharging_mos_enabled:
name: "Discharging MOS"
Component/Hub
-------------
Configuration variables:
************************
- **update_interval** (*Optional*, :ref:`config-time`): Delay between data requests.
- **address** (*Optional*, int): Address to use, defaults to ``0x80``.
Sensor
------
A sensor platform to read BMS data
Configuration variables:
************************
- **voltage** (*Optional*): Voltage of the battery pack connected to Daly BMS.
- **name** (**Required**, string): The name for the voltage sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **current** (*Optional*): Current flowing trough the BMS (input or output from batttery).
- **name** (**Required**, string): The name for the current sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **battery_level** (*Optional*): Battery level in % (SoC).
- **name** (**Required**, string): The name for the SoC sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **max_cell_voltage** (*Optional*): The cell of the battery with the higher voltage.
- **name** (**Required**, string): The name for the Max Cell Voltage sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **max_cell_voltage_number** (*Optional*): The cell number of the battery with the higher voltage.
- **name** (**Required**, string): The name for the Max Cell Voltage Number sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **min_cell_voltage** (*Optional*): The cell of the battery with the lower voltage.
- **name** (**Required**, string): The name for the Min Cell Voltage sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **min_cell_voltage_number** (*Optional*): The cell number of the battery with the lower voltage.
- **name** (**Required**, string): The name for the Min Cell Voltage Number sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **max_temperature** (*Optional*): The higher temperature measured from the temperature sensors.
- **name** (**Required**, string): The name for the Max Temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **max_temperature_probe_number** (*Optional*): The sensor number which has measured the higher temperature.
- **name** (**Required**, string): The name for the Max Temperature Probe Number sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **min_temperature** (*Optional*): The lower temperature measured from the temperature sensors.
- **name** (**Required**, string): The name for the Min Temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **min_temperature_probe_number** (*Optional*): The sensor number which has measured the lower temperature.
- **name** (**Required**, string): The name for the Min Temperature Probe Number sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **remaining_capacity** (*Optional*): The capacity in Ah left in the battery.
- **name** (**Required**, string): The name for the Remaining Capacity sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **cells_number** (*Optional*): The number of cells in series in the battery pack.
- **name** (**Required**, string): The name for the Cells Number sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **temperature_1** (*Optional*): The first temperature sensor.
- **name** (**Required**, string): The name for the first temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **temperature_2** (*Optional*): The second temperature sensor.
- **name** (**Required**, string): The name for the second temperature sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
- **cell_1_voltage** (*Optional*): The voltage of cell number 1. Cell number can be from 1 to 16.
- **name** (**Required**, string): The name for the cell voltage sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
Text Sensor
-----------
Text sensor that indicates the status of BMS.
Configuration variables:
************************
- **status** (*Optional*): The BMS Status (Charging, Discharging, Stationary).
- **name** (**Required**, string): The name for the BMS status text sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Text Sensor <config-text_sensor>`.
Binary Sensor
-------------
Binary sensor that indicates the status of MOS.
Configuration variables:
************************
- **charging_mos_enabled** (*Optional*): The BMS charging MOS status to enable the recharge of the battery.
- **name** (**Required**, string): The name for the charging MOS binary sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
All options from :ref:`Binary Sensor <config-binary_sensor>`.
- **discharging_mos_enabled** (*Optional*): The BMS discharging mos status to enable the load.
- **name** (**Required**, string): The name for the discharging MOS binary sensor.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Binary Sensor <config-binary_sensor>`.
All options from :ref:`Binary Sensor <config-binary_sensor>`.
Control BMS

17
components/sensor/growatt_solar.rst
View File

@ -15,25 +15,14 @@ The ``Growatt Inverter`` sensor platform allows you to use growatt inverter data
Growatt Logo
The communication with this integration is done over a :ref:`UART bus <uart>` using :ref:`Modbus <modbus>`.
You must therefore have a ``uart:`` entry in your configuration with both the TX and RX pins set
You must therefore have a ``uart:`` and ``modbus:`` entry in your configuration with both the TX and RX pins set
to some pins on your board and the baud rate set to 9600.
.. code-block:: yaml
# Example configuration entry
uart:
- id: gw_uart
baud_rate: 9600
tx_pin: GPIO1
rx_pin: GPIO3
modbus:
uart_id: gw_uart
flow_control_pin: GPIO4
# Example configuration
sensor:
- platform: growatt_solar
update_interval: 10s
protocol_version: RTU
inverter_status:
@ -96,8 +85,6 @@ to some pins on your board and the baud rate set to 9600.
name: "Growatt Inverter Module Temp"
Configuration variables:
------------------------

13
components/sensor/haier.rst
View File

@ -15,19 +15,6 @@ Additional sensors for Haier Climate device. **These sensors are supported only
.. code-block:: yaml
# Example configuration entry
uart:
baud_rate: 9600
tx_pin: 17
rx_pin: 16
id: ac_port
climate:
- platform: haier
id: haier_ac
protocol: hOn
name: Haier AC
uart_id: ac_port
sensor:
- platform: haier
haier_id: haier_ac

13
components/sensor/havells_solar.rst
View File

@ -17,23 +17,12 @@ with ESPHome.
Havells On Grid Solar Inverter.
The communication with this integration is done over a :ref:`UART bus <uart>` using :ref:`Modbus <modbus>`.
You must therefore have a ``uart:`` entry in your configuration with both the TX and RX pins set
You must therefore have a ``uart:`` and ``modbus:`` entry in your configuration with both the TX and RX pins set
to some pins on your board and the baud rate set to 9600.
.. code-block:: yaml
# Example configuration entry
uart:
- id: modbus_uart
baud_rate: 9600
tx_pin: GPIO1
rx_pin: GPIO3
modbus:
uart_id: modbus_uart
flow_control_pin: GPIO4
sensor:
- platform: havells_solar
update_interval: 60s

18
components/sensor/hlw8012.rst
View File

@ -28,9 +28,9 @@ be measured at the same exact points in time.
# Example configuration entry
sensor:
- platform: hlw8012
sel_pin: 5
cf_pin: 14
cf1_pin: 13
sel_GPIOXX
cf_pin: GPIOXX
cf1_pin: GPIOXX
current:
name: "HLW8012 Current"
voltage:
@ -87,9 +87,9 @@ the initial measurement mode to match whichever mode the device uses, and disabl
# Example configuration entry for device with fixed measurement mode
sensor:
- platform: hlw8012
sel_pin: 5
cf_pin: 14
cf1_pin: 13
sel_pin: GPIOXX
cf_pin: GPIOXX
cf1_pin: GPIOXX
current:
name: "HLW8012 Current"
voltage:
@ -113,10 +113,10 @@ when SEL=1 voltage is measured. To accommodate this change use the following con
- platform: hlw8012
model: BL0937
sel_pin:
number: 12
number: GPIOXX
inverted: true
cf_pin: 4
cf1_pin: 5
cf_pin: GPIOXX
cf1_pin: GPIOXX
current:
name: "BL0937 Current"
voltage:

9
components/sensor/honeywellabp.rst
View File

@ -24,13 +24,12 @@ required to be set up in your configuration for this sensor to work
sensor:
- platform: honeywellabp
pressure:
name: "Honeywell pressure"
unit_of_measurement: "psi"
name: Honeywell pressure
min_pressure: 0
max_pressure: 15
temperature:
name: "Honeywell temperature"
cs_pin: GPIO5 #D5
name: Honeywell temperature
cs_pin: GPIOXX
Configuration variables:
------------------------
@ -41,10 +40,8 @@ the measurement range and ``unit_of_measurement`` to the appropriate unit for yo
- **pressure** (*Optional*): The information for the pressure sensor.
- **name** (**Required**, string): The name for the pressure sensor.
- **min_pressure** (**Required**, int or float): Minimum pressure for the pressure sensor, default unit ``psi``.
- **max_pressure** (**Required**, int or float): Maximum pressure for the pressure sensor, default unit ``psi``.
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
Some sensors do not have temperature sensing ability, see datasheet. In some cases the sensor may return a valid temperature even though the

15
components/sensor/hrxl_maxsonar_wr.rst
View File

@ -27,28 +27,15 @@ multiple times per second, filtering is highly recommended.
.. code-block:: yaml
# Example configuration entry
uart:
rx_pin: 36
baud_rate: 9600
sensor:
- platform: "hrxl_maxsonar_wr"
name: "Rainwater Tank"
# Tweak the filters for your application
filters:
- sliding_window_moving_average:
window_size: 12
send_every: 12
- or:
- throttle: "20min"
- delta: 0.02
Configuration variables:
------------------------
- **name** (**Required**, string): The name of the sensor.
- All other options from :ref:`Sensor <config-sensor>`.
- All options from :ref:`Sensor <config-sensor>`.
Advanced options:

44
components/sensor/hydreon_rgxx.rst
View File

@ -26,58 +26,40 @@ Device FAQ: `<https://rainsensors.com/support/rg-9-rg-15-faq/>`__
.. code-block:: yaml
# Example RG-9 entry
uart:
rx_pin: GPIO16
tx_pin: GPIO17
baud_rate: 9600
sensor:
- platform: hydreon_rgxx
model: "RG_9"
id: "hydreon_1"
update_interval: 20s
disable_led: false
model: RG_9
id: hydreon_1
moisture:
name: "Rain Level"
name: Rain Level
temperature:
name: "Device Temperature"
name: Device Temperature
binary_sensor:
- platform: hydreon_rgxx
hydreon_rgxx_id: "hydreon_1"
hydreon_rgxx_id: hydreon_1
too_cold:
entity_category: diagnostic
name: "Temperature Status"
name: Temperature Status
lens_bad:
entity_category: diagnostic
name: "Lens Status"
name: Lens Status
em_sat:
entity_category: diagnostic
name: "Emitter Saturation"
name: Emitter Saturation
.. code-block:: yaml
# Example RG-15 entry
uart:
rx_pin: GPIO16
tx_pin: GPIO17
baud_rate: 9600
sensor:
- platform: hydreon_rgxx
model: "RG_15"
model: RG_15
resolution: high
update_interval: 60s
acc:
name: "rain"
name: Rain
event_acc:
name: "rain event"
name: Rain Event"
total_acc:
name: "rain total"
name: Rain Total"
r_int:
name: "rain intensity"
name: Rain Intensity
Configuration variables:
------------------------

6
components/sensor/kuntze.rst
View File

@ -48,12 +48,6 @@ A configured modbus component is optional. It will be automatically created.
.. code-block:: yaml
# Example configuration entry
uart:
- id: uart_bus
tx_pin: GPIO16
rx_pin: GPIO17
baud_rate: 19200
parity: EVEN
sensor:
- platform: kuntze

Some files were not shown because too many files have changed in this diff Show More