Skip to content

Serial multiplexed display #4880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: next
Choose a base branch
from

Conversation

Rendman
Copy link

@Rendman Rendman commented May 3, 2025

Description:

The serial_shift_register display platform allows you to use (for now) two different kinds of serial shift registers to drive segment displays with ESPHome.

Related issue (if applicable): N/A

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.rst when creating new documents for new components or cookbook.

@Rendman Rendman marked this pull request as ready for review May 3, 2025 14:26
Copy link
Contributor

coderabbitai bot commented May 3, 2025

Walkthrough

A new documentation page for the serial_multiplexed_display platform has been added, detailing its configuration and usage for segment displays driven by serial shift registers. The documentation outlines supported hardware, configuration options, and lambda-based rendering capabilities. Additionally, the main components index has been updated to include an entry for this new display hardware platform, with a reference and image.

Changes

Files/Paths Change Summary
components/display/serial_multiplexed_display.rst Added documentation for the serial_multiplexed_display platform, including configuration, usage, and examples.
components/index.rst Added "Serial Multiplexed Displays" entry to the Display Hardware Platforms section, referencing the new component.

Suggested labels

has-parent, next


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e17424 and a803182.

⛔ Files ignored due to path filters (3)
  • components/display/images/serial_multiplexed_display.jpg is excluded by !**/*.jpg
  • components/images/serial_multiplexed_display.jpg is excluded by !**/*.jpg
  • images/serial_multiplexed_display.jpg is excluded by !**/*.jpg
📒 Files selected for processing (1)
  • components/display/serial_multiplexed_display.rst (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/display/serial_multiplexed_display.rst

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
🪧 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 @coderabbitai in 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 @coderabbitai in 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.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 7

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd317d7 and 04aca00.

⛔ Files ignored due to path filters (1)
  • components/display/images/serial_shift_register.jpg is excluded by !**/*.jpg
📒 Files selected for processing (2)
  • components/display/serial_multiplexed_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.rst
  • components/display/serial_multiplexed_display.rst
🪛 GitHub Actions: Lint
components/display/serial_multiplexed_display.rst

[error] 1-1: Sphinx build error: File '/home/runner/work/esphome-docs/esphome-docs/images/serial_shift_register.jpg' for seo tag does not exist.

🔇 Additional comments (1)
components/index.rst (1)

750-750: Add Serial Multiplexed Displays entry
The new entry correctly follows the existing .. imgtable:: pattern and alphabetical order. Please verify that the image file serial_multiplexed_display.jpg exists in the images/ directory and that the path in this index matches the actual file location.

Copy link

netlify bot commented May 3, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit dfe2c27
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/681bdfef38e1f40008596979
😎 Deploy Preview https://deploy-preview-4880--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 site configuration.

Copy link

@github-actions github-actions 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 May 4, 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 May 4, 2025 23:29
@Rendman Rendman changed the base branch from current to next May 4, 2025 23:47
@probot-esphome probot-esphome bot added next and removed current labels May 4, 2025
@Rendman Rendman marked this pull request as ready for review May 4, 2025 23:47
Copy link
Member

@jesserockz jesserockz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still needs to be rebased as it contains many changes and commits it should not have.

@esphome esphome bot marked this pull request as draft May 4, 2025 23:59
@Rendman Rendman marked this pull request as ready for review May 5, 2025 17:14
@esphome esphome bot requested a review from jesserockz May 5, 2025 17:14
@Rendman
Copy link
Author

Rendman commented May 6, 2025

Is this rebased correctly now? Kinda new to git

@jesserockz jesserockz force-pushed the serial_multiplexed_display branch from d7ec282 to dfe2c27 Compare May 7, 2025 22:34
@jesserockz
Copy link
Member

Now I have rebased it and it only contains your changes

@esphome esphome bot marked this pull request as draft May 7, 2025 22:36
@Rendman Rendman marked this pull request as ready for review May 8, 2025 10:58
@esphome esphome bot requested a review from jesserockz May 8, 2025 10:58
@Rendman
Copy link
Author

Rendman commented May 8, 2025

Should be good now

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