Skip to content

[esp32_hall] Remove esp32_hall #5003

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025
Merged

[esp32_hall] Remove esp32_hall #5003

merged 1 commit into from
Jun 17, 2025

Conversation

swoboda1337
Copy link
Contributor

@swoboda1337 swoboda1337 commented Jun 17, 2025

Description:

See: https://docs.espressif.com/projects/arduino-esp32/en/latest/migration_guides/2.x_to_3.0.html#hall-sensor

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /components/index.rst when creating new documents for new components or cookbook.

@swoboda1337 swoboda1337 changed the base branch from current to next June 17, 2025 15:14
Copy link

netlify bot commented Jun 17, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit a10e51f
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6851864f5e065a0008533e90
😎 Deploy Preview https://deploy-preview-5003--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 17, 2025

Caution

Review failed

Failed to post review comments.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 469fdf7 and a10e51f.

⛔ Files ignored due to path filters (16)
  • _static/changelog-2025.6.0.png is excluded by !**/*.png
  • components/images/openthread.png is excluded by !**/*.png
  • components/sensor/images/LC709203f_battery_markings.jpg is excluded by !**/*.jpg
  • components/sensor/images/LC709203f_battery_profiles.jpg is excluded by !**/*.jpg
  • components/sensor/images/LC709203f_feather_product_image.jpg is excluded by !**/*.jpg
  • components/sensor/images/LC709203f_product_image.jpg is excluded by !**/*.jpg
  • components/sensor/images/LC709203f_thermistor_connection.jpg is excluded by !**/*.jpg
  • components/sensor/images/LC709203f_ui.jpg is excluded by !**/*.jpg
  • components/sensor/images/cm1106.png is excluded by !**/*.png
  • components/sensor/images/esp32_hall-ui.png is excluded by !**/*.png
  • images/cm1106.png is excluded by !**/*.png
  • images/es8388.svg is excluded by !**/*.svg
  • images/lc709203f.jpg is excluded by !**/*.jpg
  • images/ldo.svg is excluded by !**/*.svg
  • images/openthread.png is excluded by !**/*.png
  • images/usb.svg is excluded by !**/*.svg
📒 Files selected for processing (49)
  • Doxygen (1 hunks)
  • Makefile (1 hunks)
  • _static/version (1 hunks)
  • changelog/2025.6.0.rst (1 hunks)
  • changelog/index.rst (1 hunks)
  • components/alarm_control_panel/template.rst (1 hunks)
  • components/audio_dac/es8388.rst (1 hunks)
  • components/binary_sensor/index.rst (4 hunks)
  • components/debug.rst (1 hunks)
  • components/display/inkplate6.rst (1 hunks)
  • components/display/max7219digit.rst (1 hunks)
  • components/display/nextion.rst (1 hunks)
  • components/esp32.rst (3 hunks)
  • components/esp32_ble.rst (2 hunks)
  • components/esp_ldo.rst (1 hunks)
  • components/index.rst (6 hunks)
  • components/light/esp32_rmt_led_strip.rst (1 hunks)
  • components/logger.rst (2 hunks)
  • components/lvgl/index.rst (2 hunks)
  • components/lvgl/widgets.rst (1 hunks)
  • components/media_player/speaker.rst (1 hunks)
  • components/online_image.rst (2 hunks)
  • components/openthread.rst (1 hunks)
  • components/remote_receiver.rst (1 hunks)
  • components/remote_transmitter.rst (1 hunks)
  • components/rp2040.rst (1 hunks)
  • components/sensor/ccs811.rst (2 hunks)
  • components/sensor/cm1106.rst (1 hunks)
  • components/sensor/dps310.rst (1 hunks)
  • components/sensor/ee895.rst (1 hunks)
  • components/sensor/ens160.rst (2 hunks)
  • components/sensor/esp32_hall.rst (0 hunks)
  • components/sensor/hte501.rst (1 hunks)
  • components/sensor/hyt271.rst (1 hunks)
  • components/sensor/lc709203f.rst (1 hunks)
  • components/sensor/mhz19.rst (1 hunks)
  • components/sensor/ms5611.rst (1 hunks)
  • components/sensor/ms8607.rst (1 hunks)
  • components/sensor/senseair.rst (1 hunks)
  • components/sensor/sgp30.rst (1 hunks)
  • components/sensor/shtcx.rst (1 hunks)
  • components/sensor/t6615.rst (1 hunks)
  • components/spi.rst (1 hunks)
  • components/switch/modbus_controller.rst (1 hunks)
  • components/sx1509.rst (2 hunks)
  • components/usb_host.rst (1 hunks)
  • components/usb_uart.rst (1 hunks)
  • conf.py (1 hunks)
  • guides/supporters.rst (6 hunks)
💤 Files with no reviewable changes (1)
  • components/sensor/esp32_hall.rst
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams

**: - Do not generate or add any sequence diagrams

  • changelog/index.rst
  • components/debug.rst
  • components/sensor/dps310.rst
  • components/media_player/speaker.rst
  • components/sensor/ms8607.rst
  • components/sensor/ens160.rst
  • components/light/esp32_rmt_led_strip.rst
  • components/sensor/hte501.rst
  • components/display/inkplate6.rst
  • Makefile
  • components/sensor/ms5611.rst
  • components/sensor/senseair.rst
  • components/sensor/sgp30.rst
  • components/sensor/hyt271.rst
  • components/sensor/mhz19.rst
  • components/spi.rst
  • components/sensor/ee895.rst
  • components/alarm_control_panel/template.rst
  • components/esp32_ble.rst
  • components/sensor/shtcx.rst
  • components/rp2040.rst
  • Doxygen
  • components/sensor/ccs811.rst
  • components/remote_transmitter.rst
  • components/switch/modbus_controller.rst
  • components/display/nextion.rst
  • conf.py
  • components/sensor/t6615.rst
  • components/remote_receiver.rst
  • components/sensor/lc709203f.rst
  • components/esp_ldo.rst
  • components/usb_host.rst
  • components/sensor/cm1106.rst
  • components/logger.rst
  • components/audio_dac/es8388.rst
  • guides/supporters.rst
  • components/online_image.rst
  • components/display/max7219digit.rst
  • components/openthread.rst
  • components/index.rst
  • components/lvgl/widgets.rst
  • changelog/2025.6.0.rst
  • components/esp32.rst
  • _static/version
  • components/sx1509.rst
  • components/binary_sensor/index.rst
  • components/usb_uart.rst
  • components/lvgl/index.rst
🪛 Gitleaks (8.26.0)
components/openthread.rst

49-49: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

🔇 Additional comments (122)
components/sensor/dps310.rst (1)

34-34: Consistent Optional designation for pressure
Pressure is correctly marked as Optional, matching the pattern used across other sensor docs.

components/sensor/ens160.rst (3)

1-116: File mismatch with PR objectives
This file updates ENS160 documentation, but the PR objectives mention removing esp32_hall docs. Please verify if these changes belong in this pull request.

Likely an incorrect or invalid review comment.


58-58: Optionality marking is correct
Marking eco2 as optional aligns with other sensor platform docs and improves clarity.


62-62: Optionality marking is correct
Marking tvoc as optional aligns with other sensor platform docs and improves clarity.

components/lvgl/index.rst (1)

156-156: Buffer size description is clear and accurate
The updated text concisely explains the default allocation and fallback behavior for buffer_size, and the recommendation for devices without PSRAM is sensible.

components/binary_sensor/index.rst (3)

84-86: Good: Added an “Actions” section header
The new “Actions” header is formatted consistently with other section titles and clearly separates configuration variables from actions.


88-91: Approve new invalidate_state action anchor
The anchor and header for the binary_sensor.invalidate_state action are correctly added and follow the existing documentation style.


299-301: Approve clarification in on_state trigger behavior
The updated description accurately reflects that on_state only fires on initial valid states when trigger_on_initial_state is enabled.

components/sensor/mhz19.rst (2)

40-42: Correctly updated co2 to optional
Marking the co2 field as optional aligns with the revised component schema and is consistent with other sensor platform docs.


43-45: Correctly updated temperature to optional
Changing temperature to optional accurately reflects its unofficial and often inaccurate nature, and matches the overall configuration flexibility.

guides/supporters.rst (6)

115-115: Approve new contributor: AndersWestman
Entry is correctly formatted and placed in alphabetical order.


813-813: Approve new contributor: Hannah_GBS
The entry follows the existing formatting and is correctly positioned.


1089-1089: Approve new contributor: KoalaBear84
Formatting and alphabetical placement are consistent with the list.


1431-1431: Approve new contributor: Nick (@neponn)
Entry is correctly formatted and alphabetized.


2115-2115: Approve new contributor: xilard
The new entry matches the formatting conventions and sort order.


2162-2162: Approve updated last‐updated date
The page’s “last updated” date has been revised in line with the current PR timeline.

components/sensor/t6615.rst (1)

41-42: Mark co2 field as optional.
Aligns with other sensor docs to allow the CO₂ measurement to be omitted if not needed.

components/sensor/ms8607.rst (3)

36-37: Make temperature config optional.
Consistent with the release-wide update to optional sensor blocks.


39-40: Make pressure config optional.
Matches the optionality pattern applied across MS8607 sub-sensors.


42-46: Make humidity config optional.
Properly reflects that the humidity block may be omitted.

components/sensor/senseair.rst (1)

37-38: Mark co2 field as optional.
Follows the same doc style updates for CO₂ sensor platforms.

components/sensor/hyt271.rst (2)

20-23: Simplify example names.
Shorter sensor names (“Temperature”/“Humidity”) improve clarity and align with other examples.


27-31: Make temperature and humidity configs optional.
Ensures users can omit these blocks if only defaults are needed.

components/sensor/hte501.rst (2)

25-28: Simplify example names.
Using generic names keeps examples concise and uniform across docs.


32-36: Mark temperature and humidity configs optional.
Consistent with the broader documentation shift to optional sensor sections.

components/sensor/shtcx.rst (2)

29-31: Example sensor names simplified appropriately. The updated names “Temperature” and “Humidity” align with other sensor docs.


36-42: Marking temperature and humidity sensors as optional is consistent. The change from Required to Optional accurately reflects default behaviors.

components/sensor/ms5611.rst (1)

31-33: Example sensor names updated correctly. Using generic “Temperature” and “Pressure” matches the style in other docs.

components/sensor/sgp30.rst (4)

22-25: Example sensor names simplified appropriately. Using “eCO2” and “TVOC” is clear and consistent.


29-34: Sensor fields correctly marked as Optional. Changing eco2 and tvoc to Optional aligns with defaults.


37-38: Default value updated properly. The store_baseline default of true is documented correctly.


43-44: Update interval default increased. Documenting the 60s interval matches the release-wide change.

components/sensor/ee895.rst (2)

25-30: Example sensor names updated correctly. The names “CO2,” “Temperature,” and “Pressure” are now generic and consistent.


34-44: Sensor fields correctly marked as Optional. Changing the blocks to Optional simplifies configuration and reflects defaults.

components/sensor/ccs811.rst (3)

41-41: Marking eCO₂ as optional is correct.
Aligns with other sensor docs simplifying example verbosity.


45-45: Marking TVOC as optional is correct.
Consistent with default behaviors and example simplification.


59-59: Clarified I²C address default properly.
“Defaults to 0x5A” matches the hardware spec.

components/esp32_ble.rst (3)

25-25: Example default setting looks good.
Including disable_bt_logs: true # Default, saves flash clarifies behavior.


45-46: Configuration entry is clear and accurate.
Defaults and purpose are well documented.


47-50: Note block effectively explains compile‐time log pruning.
Provides necessary context on unused Bluetooth log categories.

components/online_image.rst (2)

42-42: Request‐headers option is a useful addition.
Docs correctly specify templatable mapping of HTTP headers.


81-94: Example usage of cached is clear and well-indented.
YAML and lambda blocks align with other docs.

components/display/max7219digit.rst (1)

73-75: Missing table of contents entry for new Actions section
You’ve added an “Actions” anchor and heading but haven’t updated any toctree or navigation references to expose it. Ensure this section is discoverable in the sidebar or contents.

changelog/index.rst (1)

4-6: Redirect updated correctly
The redirect URL now points to /changelog/2025.6.0.html, matching the new release.

_static/version (1)

1-1: Version bump is correct
Updating to 2025.7.0-dev aligns with the development version.

Makefile (1)

2-2: ESPHOME_REF update looks good
Bumping ESPHOME_REF to 2025.6.0b2 correctly references the upcoming beta release.

Doxygen (1)

41-41: Doxygen PROJECT_NUMBER bump
Setting PROJECT_NUMBER = 2025.6.0-dev aligns with the documentation target for the upcoming release.

components/debug.rst (1)

46-48: Approve generalized logger comment

The updated note correctly states that the logger must be configured without making assumptions about default levels.

components/remote_transmitter.rst (2)

54-54: Add ESP32-C5 RMT symbol table entry

The new entry for ESP32-C5 aligns with other variant tables and uses the correct symbol sizes.


57-57: Add ESP32-P4 RMT symbol table entry

The ESP32-P4 entry correctly reflects its larger symbol memory; consistent with other component docs.

components/light/esp32_rmt_led_strip.rst (2)

71-71: Add ESP32-C5 LED strip memory info

The ESP32-C5 variant entry matches the expected memory and block size.


74-74: Add ESP32-P4 LED strip memory info

The ESP32-P4 memory size entry correctly reflects its capacity.

conf.py (1)

74-76: Bump documentation version to 2025.7

The version and release have been updated to 2025.7 and 2025.7.0-dev to match the upcoming release cycle.

components/remote_receiver.rst (2)

100-100: Add ESP32-C5 RMT symbol table entry

The ESP32-C5 entry in the IDF configuration table matches the updated symbol memory sizes.


103-103: Add ESP32-P4 RMT symbol table entry

The ESP32-P4 entry is correctly specified with its 384 symbol memory size.

components/logger.rst (4)

109-115: Add ESP32-C5 to default UART GPIO pins
The new row for ESP32-C5 correctly lists TX/RX pins and USB_SERIAL_JTAG mapping.


123-129: Add ESP32-P4 to default UART GPIO pins
The ESP32-P4 row is properly formatted and aligns with other variants.


172-175: Add ESP32-C5 to default hardware interfaces
ESP32-C5 now appears with USB_CDC/USB_SERIAL_JTAG defaults, consistent with C3 and C6 entries.


178-181: Add ESP32-P4 to default hardware interfaces
The new ESP32-P4 entry correctly mirrors the C5 configuration.

components/esp_ldo.rst (3)

11-17: Example configuration is clear
The YAML snippet correctly demonstrates how to set up channel 3 with a voltage value.


21-24: Configuration variables well defined
Parameters channel, voltage, and adjustable are documented accurately with required/optional flags.


25-37: Runtime adjustment action documented correctly
The esp_ldo.voltage.adjust action is laid out clearly, including lambda example.

components/index.rst (6)

49-49: Add ESP32-P4 LDO regulator to Microcontroller Peripherals
The new entry appears in the correct section and position.


92-92: Add OpenThread to Network Hardware
OpenThread entry is correctly placed and formatted.


168-170: Add USB Host and USB UART to Peripheral Interfaces
Both new entries align with the Hardware Peripheral Interfaces/Busses section.


225-225: Add CM1106 to Air Quality sensors
CM1106 appears in the correct alphabetical position.


480-480: Add LC709203F to Miscellaneous sensors
LC709203F is inserted appropriately in the sensor list.


659-659: Add ES8388 to Audio DAC Components
ES8388 entry matches formatting of other DAC components.

components/usb_host.rst (7)

1-2: File header and title OK
The title "USB Host Interface" clearly identifies the component.


9-14: Component description is clear
The prose accurately explains supported chips, device limits, and hub constraints.


16-24: Example configuration is correct
YAML example demonstrates optional ID and vid/pid usage as described.


26-31: Configuration variables documented properly
id and devices parameters are clearly defined with correct types.


32-38: Device configuration options complete
Vendor and product ID fields are marked required, wildcard behavior noted.


41-48: Behavior description is thorough
Connection/disconnection logging behavior is precisely documented at DEBUG and VERBOSE levels.


53-55: See Also links are appropriate
References to usb_uart and API headers are correct.

components/sensor/lc709203f.rst (9)

9-14: Intro paragraph is clear
The description accurately introduces the component and provides relevant datasheet and product links.


15-20: Images section formatting is correct
Image directives are properly configured with width and overview images.


21-25: Note directive usage is appropriate
The .. note:: clearly warns about the absence of a built-in temperature sensor.


41-48: Configuration variables are well-documented
The defaults, valid ranges, and references for size and voltage provide clear guidance to users.


69-77: Home Assistant view example is accurate
The UI screenshot example and captioning correctly illustrate expected Home Assistant output.


78-88: Skip Pack Size section
This section follows existing patterns and needs no changes.


91-100: Skip Pack Voltage section
This section is consistent with documentation style.


105-113: Skip Temperature Sensor section
The thermistor wiring and explanation are clear and correctly formatted.


117-122: Skip Acknowledgments
Gratitude section is well-formatted and appropriate.

components/audio_dac/es8388.rst (8)

1-3: Header and title formatting
The heading underline matches the title length and adheres to Sphinx conventions.


4-8: SEO directive is configured properly
The .. seo:: block includes description, image, and keywords as expected.


22-27: YAML example for audio_dac
The example snippet correctly demonstrates basic DAC setup.


28-33: Primary configuration variables
address and i2c_id options are documented with defaults and references.


35-49: Select platform example and options
The select example and available parameters (LINE1, LINE2, BOTH) are clear and correct.


50-61: Select configuration variables
The es8388_id, dac_output, and adc_input_mic settings are well-described.


82-135: ESP32 Audio Kit example
Comprehensive end-to-end configuration is provided; the nested YAML structure and component references are accurate.


136-143: See Also links
The references to related documentation (index, API headers) and the edit URL are appropriate.

components/sensor/cm1106.rst (13)

4-7: SEO metadata is complete
The .. seo:: block correctly provides description, image, and keywords.


9-16: Introductory paragraph and figure
Introduction and sensor image are well-presented, with correct alignment and captioning.


17-21: UART wiring instructions
The connection details for RX/TX pins and baud rate are clear and accurate.


22-29: Basic YAML configuration example
The example clearly shows how to set up the CM1106 sensor; formatting and indentation are correct.


31-36: CO₂ sensor variable
co2 option is clearly described with reference to the sensor schema.


37-39: Update interval description
Defaults and reference are correct for update_interval.


40-44: UART and ID settings
Descriptions for uart_id and id are accurate and follow conventions.


45-49: Calibration action header
The zero-point calibration action is introduced clearly.


55-60: Calibration YAML snippet
The action syntax example is correct.


63-70: API action usage
Home Assistant API action example is accurate.


74-83: Button automation example
The template button example is well-structured and uses the diagnostic category appropriately.


86-99: Pseudo-automatic calibration example
The lambda function and filter are formatted correctly and demonstrate usage clearly.


106-112: See Also references
Links to sensor filters and API reference are properly formatted.

changelog/2025.6.0.rst (5)

10-20: Component summary table
The .. imgtable:: entries correctly list new components with images and links.


34-42: Python 3.10 section is clear
The rationale and instructions for upgrading Python versions are well explained.


50-56: Code optimizations overview
This section concisely describes the focus of performance improvements.


58-63: BME68x via BSEC2 note
The removal of the Arduino dependency is properly documented.


65-69: Full list heading
The “Full list of changes” heading clearly introduces the detailed change list.

components/openthread.rst (10)

1-7: Header and SEO are correctly configured
The main heading, underline, and .. seo:: block adhere to project guidelines.


8-13: Introduction is accurate
The overview of Thread vs. Zigbee and requirement for higher-level protocols is clear.


14-17: Note directive is appropriate
The warning about needing a Thread border router helps set expectations.


19-23: Usage example is valid
The ESP-IDF configuration snippet correctly highlights board and framework settings.


24-31: YAML section for basic setup
The code-block for enabling IPv6 and OpenThread parameters is well-formatted.


35-38: Configuration examples header
The heading introduces the dataset configuration examples effectively.


40-54: OpenThread Dataset example
All required TLV fields, channel, network_name, network_key, etc., are correctly shown.


65-68: TLV example header
The section explaining raw TLV input is concise and clear.


70-75: TLV YAML snippet
The example TLV string and formatting reflect Home Assistant's output accurately.


76-79: TLV configuration variable
The tlv parameter description correctly indicates its purpose.

components/usb_uart.rst (1)

89-94: Verify inclusion in components index.
Ensure that components/usb_uart.rst has been added to components/index.rst under “Hardware Peripheral Interfaces/Busses” alongside usb_host.

components/esp32.rst (1)

112-115: Verify and update Espressif documentation links.
The Kconfig links point to ESP-IDF v5.3.3. Confirm that this is the intended release and update to the latest stable version if needed.

Walkthrough

This update introduces ESPHome 2025.6.0, adding new documentation for multiple hardware components (e.g., ES8388 audio DAC, LC709203F battery monitor, USB Host/UART, OpenThread, ESP32-P4 LDO, CM1106 CO2 sensor) and expands configuration options for several platforms. Numerous documentation files were updated for clarity, new features, and support for additional ESP32 variants. Version numbers and changelogs were updated accordingly.

Changes

File(s) Change Summary
Doxygen, Makefile, _static/version, conf.py Updated version numbers for Doxygen config, Makefile ESPHOME_REF, static version file, and documentation build config.
changelog/2025.6.0.rst, changelog/index.rst Added new changelog for 2025.6.0 and updated changelog index to point to latest version.
guides/supporters.rst Added new contributors and updated last modified date.
components/audio_dac/es8388.rst, components/esp_ldo.rst, components/lc709203f.rst, components/openthread.rst, components/sensor/cm1106.rst, components/usb_host.rst, components/usb_uart.rst Added new documentation files for ES8388 audio DAC, ESP32-P4 LDO, LC709203F battery monitor, OpenThread, CM1106 CO2 sensor, USB Host, and USB UART components.
components/index.rst Updated components index: added new entries (e.g., ESP32-P4 LDO, OpenThread, USB Host/UART, CM1106, LC709203F, ES8388), removed ESP32 Hall Sensor.
components/alarm_control_panel/template.rst Added bypass_auto option for binary sensors in template alarm control panel.
components/binary_sensor/index.rst Added trigger_on_initial_state, on_state_change trigger, and invalidate_state action; clarified automation behavior.
components/display/inkplate6.rst Added transform option with flip_x and flip_y for display orientation.
components/display/max7219digit.rst Documented new runtime actions for display control (invert, power, reverse, intensity).
components/display/nextion.rst Added max_commands_per_loop and max_queue_size options for command queue control.
components/debug.rst Clarified logger configuration requirement in example.
components/esp32.rst Expanded supported ESP32 variants, CPU frequency options, and added LWIP optimization and advanced IDF options.
components/esp32_ble.rst Added disable_bt_logs option to selectively disable unused Bluetooth loggers.
components/light/esp32_rmt_led_strip.rst, components/remote_receiver.rst, components/remote_transmitter.rst, components/logger.rst Added ESP32-C5 and ESP32-P4 variants to hardware tables and configuration variable descriptions.
components/lvgl/index.rst Clarified buffer_size default and fallback allocation for LVGL.
components/lvgl/widgets.rst Added content_style option to tabview widget.
components/media_player/speaker.rst Added volume_initial configuration option for speaker media player.
components/online_image.rst Added request_headers config and cached variable for download status in automations.
components/rp2040.rst Added watchdog_timeout option to RP2040 platform.
components/sensor/ccs811.rst, components/sensor/dps310.rst, components/sensor/ee895.rst, components/sensor/ens160.rst, components/sensor/hte501.rst, components/sensor/hyt271.rst, components/sensor/mhz19.rst, components/sensor/ms5611.rst, components/sensor/ms8607.rst, components/sensor/sgp30.rst, components/sensor/shtcx.rst, components/sensor/t6615.rst, components/sensor/senseair.rst Simplified example configs, clarified required/optional status for sensor configuration variables, updated defaults, and improved descriptions.
components/sensor/esp32_hall.rst Removed ESP32 Hall Sensor documentation file.
components/spi.rst Added note on SPI mode support for hardware/software and ESP32 variants.
components/switch/modbus_controller.rst Added assumed_state option and clarified skip_updates behavior.
components/sx1509.rst Updated keypad row/column constraints, added keys and on_key options, referenced key_collector.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ESPHomeDevice
    participant HomeAssistant

    User->>ESPHomeDevice: Configure new component (e.g., ES8388, LC709203F, USB Host/UART, OpenThread)
    ESPHomeDevice-->>User: Validates and applies configuration
    ESPHomeDevice->>HomeAssistant: Sends sensor states / receives commands (if applicable)
    HomeAssistant-->>ESPHomeDevice: Triggers actions (e.g., calibrate, invalidate state)
    ESPHomeDevice-->>HomeAssistant: Reports updated sensor states or action results
Loading

Possibly related PRs

  • [online_image] support HTTP caching #4906: Adds documentation for the online_image component, including the cached variable for HTTP caching, directly related to the new caching documentation in this PR.
  • [esp32] Add config vars for compiler #4986: Updates Doxygen, Makefile, and adds documentation for ES8388, USB Host/UART—matching the new components and version updates in this PR.
  • 2024.5.5 #3916: Updates version numbers in Doxygen, Makefile, and static version files for a previous release cycle, similar to the version bump changes in this PR.

Suggested labels

has-parent, next

Suggested reviewers

  • jesserockz
  • frenck
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@bdraco bdraco merged commit fa83263 into esphome:next Jun 17, 2025
7 of 9 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jun 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants