esphome-docs
esphome-docs copied to clipboard
New lanbon_l8_hd light platform
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#8255
Checklist:
-
[X] I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.
or -
[ ] I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature. -
[X] Link added in
/index.rstwhen creating new documents for new components or cookbook.
Deploy Preview for esphome ready!
| Name | Link |
|---|---|
| Latest commit | 74645c7e4dcc47aa845400602a4dcc4dd61ceda0 |
| Latest deploy log | https://app.netlify.com/projects/esphome/deploys/688ff74e9506040008cdf143 |
| Deploy Preview | https://deploy-preview-4675--esphome.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
Walkthrough
The changes update version information and configuration variables throughout the documentation. Project version numbers were bumped in files such as the Doxyfile, Makefile, _static/version, and conf.py. Several changelog files were revised to reflect new release details, while multiple component documents were updated to add new configuration variables, sections, and actions. Deprecated custom component documentation was removed entirely to encourage the use of external components. Additionally, new sections were introduced in the Web API documentation (e.g. for the Alarm Control Panel) and guides were refined to improve clarity.
Changes
| File(s) | Change Summary |
|---|---|
Doxyfile, Makefile, _static/version, conf.py |
Updated project version numbers and version-references (e.g. 2024.12.4 β 2025.3.0-dev, 2024.12.4 β 2025.2.0b3). |
changelog/2025.2.0.rst, changelog/index.rst, changelog/v1.14.0.rst |
Revised changelog entries with new release notes, removals, and breaking changes. |
Multiple component docs (e.g. files in components/animation.rst, audio_adc/*, audio_dac/*, display/*, esp32_ble_server.rst, modbus.rst, online_image.rst, opentherm.rst, etc.) |
Added new documentation sections, configuration variables, and actions; clarified descriptions and reorganized content. |
remote_receiver.rst, remote_transmitter.rst |
Enhanced documentation for remote control components with new actions and configuration options. |
Custom/Deprecated Component Docs (e.g. components/binary_sensor/custom.rst, components/climate/custom.rst, components/cover/custom.rst, components/light/custom.rst, components/text_sensor/custom.rst, components/output/custom.rst, plus files under custom/ such as i2c.rst, index.rst, spi.rst, uart.rst) |
Removed deprecated custom component documentation to drive migration toward external components. |
Guides & Cookbook (e.g. guides/contributing.rst, guides/diy.rst, guides/getting_started_command_line.rst, guides/supporters.rst, cookbook/lambda_magic.rst, cookbook/lvgl.rst) |
Rephrased terminology regarding custom versus external components, updated contributor lists, added logging configuration tips, and removed outdated examples. |
web-api/index.rst |
Introduced a new βAlarm Control Panelβ section with GET and POST endpoints documentation. |
index.rst, schema_doc.py |
Updated the main documentation index to add new components (e.g. XXTEA, Mixer Speaker) and removed references to deprecated custom components from the schema. |
Sequence Diagram(s)
sequenceDiagram
participant Client
participant WebAPI
Client->>WebAPI: GET /alarm_control_panel/my_alarm
WebAPI-->>Client: JSON response { id, state, value }
Client->>WebAPI: POST /alarm_control_panel/my_alarm/arm_away (or other arm/disarm commands)
WebAPI-->>Client: HTTP 200 OK
Possibly related PRs
- esphome/esphome-docs#4634: Adjusts the
PROJECT_NUMBERin the Doxyfile, directly related to the versioning updates presented here.
Suggested labels
next
Suggested reviewers
- clydebarrow
β¨ Finishing Touches
- [ ] π Generate Docstrings (Beta)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
πͺ§ 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.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 generate unit testing code.@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.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.
Ping!
There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.