Skip to content

Conversation

@tomaszduda23
Copy link
Contributor

Description:

Related issue (if applicable): fixes

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

esphome/esphome#11535

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.

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 UPPER_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 images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

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

@esphomebot generate image DHT22

esphome[bot]
esphome bot previously requested changes Oct 25, 2025
Copy link

@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
Copy link

esphome bot commented Oct 25, 2025

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 esphome bot marked this pull request as draft October 25, 2025 19:17
@tomaszduda23 tomaszduda23 changed the base branch from current to next October 25, 2025 19:17
@esphome esphome bot added the next label Oct 25, 2025
@esphome esphome bot dismissed their stale review October 25, 2025 19:18

Base branch has been corrected - dismissing previous review.

@tomaszduda23
Copy link
Contributor Author

@esphomebot generate image ZIGBEE

@github-actions
Copy link

github-actions bot commented Oct 25, 2025

@netlify
Copy link

netlify bot commented Oct 25, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit baca7df
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68fd27d89a9302000817082c
😎 Deploy Preview https://deploy-preview-5526--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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 25, 2025

Caution

Review failed

Failed to post review comments

Walkthrough

This PR adds documentation for newly supported components (Zigbee, ESP-NOW packet transport, Nordic UART Service, and additional sensors), updates documentation for existing components with expanded features or configuration options, and increments the version to 2025.11.0-dev. It is primarily documentation expansion and clarification with no functional code changes.

Changes

Cohort / File(s) Summary
New Component Documentation
content/components/ble_nus.md, content/components/zigbee.md, content/components/packet_transport/espnow.md, content/components/sensor/bh1900nux.md, content/components/sensor/hdc2010.md
Added documentation for five new components: Nordic UART Service BLE interface, Zigbee end device support, ESP-NOW packet transport platform, and two new sensors (BH1900NUX temperature and HDC2010 temperature/humidity).
Climate Component Updates
content/components/climate/climate_ir.md, content/components/climate/thermostat.md
Expanded Toshiba IR model support (RAS-2819T) with protocol details; introduced humidity control actions (dehumidify, humidify, off) and humidity_hysteresis configuration for thermostat.
Display Component Updates
content/components/display/mipi_rgb.md, content/components/display/mipi_spi.md
Updated supported display boards table (renamed WAVESHARE-4 board, added WAVESHARE-5-1024X600); documented WAVESHARE-ESP32-S3-TOUCH-LCD-3.49 model and expanded transform options with mirror_y and disabled transform support.
Sensor Documentation Updates
content/components/sensor/filter/heartbeat.md, content/components/sensor/ina2xx.md, content/components/sensor/xgzp68xx.md
Enhanced heartbeat filter with optimistic mode; added reset_on_boot option to INA2xx; restructured XGZP68xx documentation to distinguish non-C and C series with updated configuration examples and calibration guidance.
Core Component Configuration Updates
content/components/esp32.md, content/components/esp32_improv.md, content/components/esphome.md, content/components/script.md
Added VFS (Virtual File System) optimization options to ESP32 documentation; introduced next_url parameter to esp32_improv; added includes_c option to esphome core; expanded script mode documentation with detailed max_runs semantics per mode.
Remote Component Documentation
content/components/remote_receiver.md, content/components/remote_transmitter.md
Added Symphony remote codec support with on_symphony automation trigger for receiver and transmit_symphony action for transmitter.
Component Index and Configuration Updates
content/components/_index.md, content/components/packet_transport/_index.md, content/components/packages.md, content/components/uponor_smatrix.md
Updated component indexes to include new entries (Zigbee, Nordic NUS, HDC2010, ESP-NOW); documented !extend and !remove usage with substitutions; migrated uponor_smatrix addressing from 16-bit to 32-bit format across all examples.
Documentation Additions
content/guides/cli.md, data/version.yaml
Added documentation for esphome analyze-memory CLI command; bumped version to 2025.11.0-dev.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Files requiring attention: content/components/uponor_smatrix.md (significant addressing scheme migration across multiple sections), content/components/esp32.md (extensive VFS documentation additions), content/components/climate/thermostat.md (new humidity control feature documentation)
  • Verification points: Ensure new component documentation files are complete with all required front matter and examples; confirm addressing format changes in uponor_smatrix are consistently applied across hub, climate, and sensor sections; validate configuration variable defaults and descriptions match implementation

Possibly related PRs

Suggested labels

has-parent, next

Suggested reviewers

  • bdraco
  • clydebarrow

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
Title Check ❓ Inconclusive The title "Zigbee2" is vague and lacks clarity regarding its specific meaning. While the changeset does include a new Zigbee component documentation file (content/components/zigbee.md) as well as numerous other documentation additions (BLE NUS, climate updates, sensor documentation, ESP-NOW, and more), the title fails to communicate what "2" signifies or what the actual changes entail. A teammate scanning commit history would struggle to understand the scope and purpose of this PR from the title alone. The title appears to reference only one aspect of a much broader changeset containing multiple new components and documentation updates. Consider revising the title to more clearly convey the primary changes. A more descriptive title such as "Add Zigbee end device documentation" or "Add Zigbee, BLE NUS, and sensor components documentation" would better communicate the scope of changes to reviewers and future maintainers reviewing the commit history.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed The PR description is related to the changeset and indicates this is new documentation with a matching ESPHome pull request (#11535). It includes proper checklist items showing the author understands the merge target ("next" for new documentation) and acknowledges the requirement to add links in /components/index.rst. While the description is sparse on detailed explanation of individual changes, it clearly communicates the purpose (new documentation) and references the corresponding implementation PR, making it relevant to the changeset overall.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@tomaszduda23 tomaszduda23 marked this pull request as ready for review October 25, 2025 19:33
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