Add documentation for Addressable Light Digital #5021
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
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.
WalkthroughA new documentation file for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ESPHome
participant AddressableLightDigitalDisplay
participant AddressableLEDs
User->>ESPHome: Configure addressable_light_digital_display
ESPHome->>AddressableLightDigitalDisplay: Initialize with config (led_map, light_id, etc.)
AddressableLightDigitalDisplay->>AddressableLEDs: Map segments to LEDs per led_map
User->>AddressableLightDigitalDisplay: Send display command (number, string, time)
AddressableLightDigitalDisplay->>AddressableLEDs: Update segment LEDs
AddressableLEDs-->>User: Visual display updated
Suggested labels
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
components/display/addressable_light_digital_display.rst (1)
5-6: SEO image file mismatchThe SEO metadata references
addressable_light.jpgbut the main figure and component image useaddressable_light_digital_display.jpg. Update the SEO:image:to point toaddressable_light_digital_display.jpgfor consistency.- :image: addressable_light.jpg + :image: addressable_light_digital_display.jpg
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
components/display/images/addressable_light_digital_display.jpgis excluded by!**/*.jpgcomponents/display/images/addressable_light_digital_display_wiring.jpgis excluded by!**/*.jpg
📒 Files selected for processing (2)
components/display/addressable_light_digital_display.rst(1 hunks)components/index.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**: - Do not generate or add any sequence diagrams
components/index.rstcomponents/display/addressable_light_digital_display.rst
🪛 GitHub Check: build
components/display/addressable_light_digital_display.rst
[failure] 81-81:
Directive 'code-block' must be indented with 4 spaces, not 8. See components/display/addressable_light_digital_display.rst:81
🪛 GitHub Actions: Lint
components/display/addressable_light_digital_display.rst
[error] 81-81: lint: Directive 'code-block' must be indented with 4 spaces, not 8.
🔇 Additional comments (1)
components/index.rst (1)
743-743: New index entry looks goodThe "Addressable Light Digital Display" component has been correctly added to the Display Hardware Platforms list.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
daweizhangau
force-pushed
the
addressable_light_digital_display
branch
from
f4da701 to
75240ab
Compare
daweizhangau
force-pushed
the
addressable_light_digital_display
branch
from
0a9ba40 to
6edc7c9
Compare
esphome
bot
dismissed stale reviews from github-actions[bot] and github-actions[bot]
Stale
|
Have rebased onto |
Has to be removed manually 🙈 |
daweizhangau
changed the title
Description:
Pull request in esphome with YAML changes:
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.