Skip to content

Conversation

@stuartparmenter
Copy link
Contributor

@stuartparmenter stuartparmenter commented Dec 31, 2025

Description:

  • esp32-trinity was supported originally but missed from docs
  • C6 was never properly supported (code is in the library, but it tries to use PSRAM and there is no PSRAM on the C6. The parlio implementation is memory heavy and is maybe not practical to actually support, but tbd).
  • Expand bit depth for 0.2.1 update

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

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

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

@esphomebot generate image dht22

esphome[bot]
esphome bot previously requested changes Dec 31, 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 esphome bot marked this pull request as draft December 31, 2025 04:14
@esphome
Copy link

esphome bot commented Dec 31, 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.

@stuartparmenter stuartparmenter changed the base branch from current to next December 31, 2025 04:14
@esphome esphome bot added the next label Dec 31, 2025
@esphome esphome bot dismissed their stale review December 31, 2025 04:15

Base branch has been corrected - dismissing previous review.

@netlify
Copy link

netlify bot commented Dec 31, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 5c1906a
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6954a331c8faa900081746d8
😎 Deploy Preview https://deploy-preview-5837--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.

@stuartparmenter stuartparmenter changed the title Hub75 updates [hub75] Update documentation Dec 31, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 31, 2025

Caution

Review failed

Failed to post review comments

Walkthrough

This PR updates ESPHome documentation across multiple components, standardizing frequency parameter types from int/float to frequency, introducing new platform support (BK72xx in deep_sleep, UART events), adding new configuration options (ESP32 OTA rollback, HUB75 brightness action), and refactoring the sprinkler component to use H-Bridge switch control. It also updates version information and release note generation tooling.

Changes

Cohort / File(s) Summary
Frequency Type Standardization
content/components/at581x.md, content/components/canbus/mcp2515.md, content/components/esp32_camera.md, content/components/i2c.md, content/components/output/esp8266_pwm.md, content/components/output/ledc.md, content/components/output/libretiny_pwm.md, content/components/output/pca9685.md, content/components/sensor/ade7880.md, content/components/sx126x.md, content/components/sx127x.md
Updated parameter type annotations from int/float to frequency enum; preserved valid values and defaults. Includes clock field in MCP2515 and frequency parameter updates across multiple output and sensor components.
Frequency Display Format Updates
content/components/libretiny.md, content/components/output/ledc.md, content/components/packet_transport/sx12*.md, content/components/servo.md, content/components/sx12*.md
Converted frequency display format from numeric Hz (e.g., 433920000) or "X Hz" to human-readable units (433.92MHz, 1kHz). Affects example configurations and parameter descriptions.
New Platform Support & Events
content/components/_index.md, content/components/deep_sleep.md, content/components/event/uart.md
Added UART event documentation; expanded deep_sleep to support BK72xx with timer/pin wakeup (up to 36 hours), multi-pin wakeup configuration, and platform-specific examples.
HUB75 Display Component
content/components/display/hub75.md
Added new hub75.set_brightness action; introduced esp32-trinity board preset and updated Apollo Automation M1 revision labels; expanded bit_depth range from 6–12 to 4–12; added driver compatibility and pin usage notes; removed ESP32-C6 from supported variants.
ESP32 & Platform Configurations
content/components/esp32.md, content/components/http_request.md, content/components/mqtt.md, content/components/speaker/resampler.md, content/components/spi.md
Added optional enable_ota_rollback to ESP32 Advanced Configuration; clarified SSL/TLS support is ESP32-specific in HTTP request; updated MQTT TLS documentation from esp-idf to ESP32-wide terminology; removed ESP-IDF conditional from resampler task_stack_in_psram; changed "ESP-IDF limit" to "ESP32 limit" in SPI.
Sensor Component Updates
content/components/sensor/bme68x_bsec2.md, content/components/sensor/hm3301.md, content/components/sensor/mmc5603.md, content/components/sensor/pmsx003.md
Added optional id field to bme68x_bsec2; expanded hm3301 Air Quality documentation with AQI/CAQI standards and smoothing filter examples; corrected mmc5603 branding (MMC5693→MMC5603) and added auto_set_reset configuration option; introduced AQI configuration for pmsx003 with calculation types and scales.
Sprinkler Component Refactoring
content/components/sprinkler.md
Migrated from individual pump/valve on/off switch pairs to unified H-Bridge switch control; removed pulse_duration options; refactored examples to use pump_switch_id and valve_switch_id with H-Bridge switches; updated board value (featheresp32→esp32dev); revised narrative and cross-references to reflect new architecture.
Update Component & Version Management
content/components/update/_index.md, data/version.yaml, script/generate_release_notes.py
Added new update.check Action to trigger update checks without installation; bumped version to 2026.1.0-dev; refactored release notes script to generalize PR collection across multiple release types via new _collect_prs_from_tags() and _get_previous_release_prs() methods to exclude previously-released PRs.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested labels

has-parent, next, component: hub75

Suggested reviewers

  • DjordjeMandic
  • swoboda1337
  • jesserockz

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title '[hub75] Update documentation' is specific to the main changes (hub75 component documentation updates) but incompletely describes the changeset, which includes 30+ files with frequency type updates, new UART event component, and version bumps.
Description check ✅ Passed The PR description clearly explains hub75-specific changes (esp32-trinity support, C6 removal, bit_depth expansion) and is directly related to the changeset, though it does not address all 30+ other files modified.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
✨ 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

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

@stuartparmenter stuartparmenter marked this pull request as ready for review January 4, 2026 00:35
@swoboda1337 swoboda1337 merged commit 6fd4f49 into esphome:next Jan 5, 2026
15 of 19 checks passed
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.

2 participants