Skip to content

Add Feedback valve platform documentation#6724

Draft
exciton wants to merge 2 commits into
esphome:nextfrom
exciton:feedback-valve
Draft

Add Feedback valve platform documentation#6724
exciton wants to merge 2 commits into
esphome:nextfrom
exciton:feedback-valve

Conversation

@exciton
Copy link
Copy Markdown
Contributor

@exciton exciton commented Jun 2, 2026

Description

Add feedback valve platform docs.
This should be merged after these, so the links work properly.

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 /src/content/docs/components/index.mdx when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /public/images/ folder of this repository.

  4. Use the image in your component's index table entry in /src/content/docs/components/index.mdx.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@exciton exciton changed the base branch from current to next June 2, 2026 05:11
Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ImgTable blocks are not in alphabetical order

Found 1 ImgTable block(s) with incorrect ordering below Network Protocols.
Each table has at most one Core item (matching the section name, e.g. "Sensor Core" for the Sensor section), pinned first, followed by Template items (names starting with "Template "), then all remaining items sorted alphabetically.

You can fix this automatically by running:

node script/check_component_index.mjs --fix

See the inline suggestions below for the correct order in each section.

Comment thread src/content/docs/components/index.mdx
@esphome
Copy link
Copy Markdown

esphome Bot commented Jun 2, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

esphome[bot]
esphome Bot previously requested changes Jun 2, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@esphome esphome Bot added the next label Jun 2, 2026
@esphome esphome Bot dismissed their stale review June 2, 2026 05:12

Base branch has been corrected - dismissing previous review.

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 2, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit e895d61
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a1e66ea8027b50008b15175
😎 Deploy Preview https://deploy-preview-6724--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@github-actions github-actions Bot dismissed their stale review June 2, 2026 05:16

Component index ordering has been fixed — dismissing review.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

Caution

Review failed

Failed to post review comments

Walkthrough

This PR updates ESPHome documentation for the 2026.6 release. Changes include a version bump to 2026.6.0-dev, documentation for a new feedback valve platform component, feature additions across multiple components, removal of a legacy configuration option, ESP32 NeoPixelBus deprecation with migration guidance, clarifications on platform configuration behavior, and updates to security and CLI documentation reflecting WiFi authentication and state logging changes.

Changes

ESPHome 2026.6 Documentation Release

Layer / File(s) Summary
Version and component registry update
data/version.yaml, src/content/docs/components/index.mdx
Version updated to 2026.6.0-dev, and the Valve Components table adds a Feedback Valve entry.
New feedback valve component documentation
src/content/docs/components/valve/feedback.mdx
Complete documentation page for the feedback valve platform covering description, example YAML, use cases (time-based, endstop-sensor, movement-sensor), safety features, full configuration variables reference, and API links.
Component feature additions and enhancements
src/content/docs/components/climate/mitsubishi_cn105.mdx, src/content/docs/components/light/index.mdx, src/content/docs/components/lvgl/widgets.mdx, src/content/docs/components/rp2040.mdx, src/content/docs/components/speaker/i2s_audio.mdx
Mitsubishi CN105 adds configurable supported_swing_modes, light component documents new light.effect.next and light.effect.previous actions, LVGL meter scale arc adds optional rounded boolean, RP2040 adds optional variant setting alongside board, and i2s_audio SPDIF sample rate constraints are clarified.
Feature removals and deprecations
src/content/docs/components/display/nextion.mdx, src/content/docs/components/light/neopixelbus.mdx
Nextion documentation removes dump_device_info configuration variable; NeoPixelBus documentation adds ESP32 deprecation notice (removal by 2027.1) with migration paths to esp32_rmt_led_strip and spi_led_strip.
Configuration and platform behavior clarifications
src/content/docs/components/network.mdx, src/content/docs/components/packages.mdx, src/content/docs/components/time/homeassistant.mdx, src/content/docs/components/time/index.mdx
Network documentation notes enable_ipv6 must be true on nRF52; packages documentation enumerates supported Git URL shorthand schemes (Codeberg, GitHub, GitLab); Home Assistant time platform clarifies timezone initialization from build host and updates from Home Assistant unless explicitly configured; time base configuration documents empty string disabling compiled-in timezone.
WiFi security and CLI guide updates
src/content/docs/components/wifi.mdx, src/content/docs/guides/cli.mdx, src/content/docs/guides/security_best_practices.mdx
WiFi min_auth_mode default unified to WPA2 for both ESP32 and ESP8266; CLI guide adds --no-states / --states flags for run and logs commands with environment variable (ESPHOME_LOG_STATES) and override semantics; security best practices consolidates WiFi guidance to reflect WPA2 default with optional ESP32 WPA3-only restriction.

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly summarizes the main change: adding documentation for the Feedback valve platform, which is the primary focus across multiple modified files.
Description check ✅ Passed The description is related to the changeset, mentioning the addition of feedback valve platform docs and correctly noting the matching esphome/esphome pull request, though it contains a minor typo ('feedbac').
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant