Add BM8563 time component documentation #5542
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
abmantis
force-pushed
the
copilot/add-bm8563-documentation-page
branch
from
cb161ea to
ffcfcb9
Compare
|
@esphomebot generate image BM8563 |
|
@abmantis Here is the image for the component https://github.com/esphome/esphome-docs/actions/runs/18957840089/artifacts/4424235177 |
abmantis
force-pushed
the
copilot/add-bm8563-documentation-page
branch
from
ffcfcb9 to
f7b4e5b
Compare
Co-authored-by: abmantis <[email protected]>
abmantis
force-pushed
the
copilot/add-bm8563-documentation-page
branch
from
f7b4e5b to
86d503c
Compare
Co-authored-by: abmantis <[email protected]>
Co-authored-by: abmantis <[email protected]>
Co-authored-by: abmantis <[email protected]>
Co-authored-by: abmantis <[email protected]>
15 tasks
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the BM8563 RTC time component, a new I2C-based real-time clock module supported by ESPHome.
Key changes:
- Documentation for BM8563 RTC component with configuration options and actions
- Custom SVG icon for the component listing
- Integration into the component index
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| content/components/time/bm8563.md | Complete documentation for BM8563 RTC including configuration, actions (read/write/start_timer), and usage examples |
| static/images/bm8563.svg | Custom SVG icon showing "BM8563" text for component listing |
| content/components/_index.md | Added BM8563 RTC entry to Time Components section with custom icon |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
SSIA.
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
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.Link added in
/components/index.rstwhen 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:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: