Skip to content

[LVGL] New input group handling + new Encoder/Keypad set_group action #5086

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 3 commits into
base: next
Choose a base branch
from

Conversation

manoamaro
Copy link

Description:

Update documentation for new LGVL configuration:

  • lvgl.groups
  • lgvl.default_group (missing documentation)
  • lvgl.encoder.set_group action
  • lvgl.keypad.set_group action

Related issue (if applicable): fixes esphome/feature-requests#3166

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.

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 Jul 10, 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 July 10, 2025 20:57
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.

@manoamaro manoamaro force-pushed the feature/lvgl-groups branch from c5d4093 to 4db1159 Compare July 10, 2025 20:59
Copy link

netlify bot commented Jul 10, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit c5d4093
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6870292c69f9ff0008b06403
😎 Deploy Preview https://deploy-preview-5086--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.

Copy link
Contributor

coderabbitai bot commented Jul 10, 2025

Caution

Review failed

Failed to post review comments.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1247961 and c5d4093.

📒 Files selected for processing (1)
  • components/lvgl/index.rst (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams

**: - Do not generate or add any sequence diagrams

⚙️ Source: CodeRabbit Configuration File

List of files the instruction was applied to:

  • components/lvgl/index.rst
🧠 Learnings (2)
📓 Common learnings
Learnt from: jesserockz
PR: esphome/esphome-docs#4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
components/lvgl/index.rst (1)
Learnt from: jesserockz
PR: esphome/esphome-docs#4901
File: changelog/2025.4.0.rst:124-126
Timestamp: 2025-05-12T00:02:50.869Z
Learning: In the ESPHome changelog structure, the "All changes" section should have the `:open:` attribute to be expanded by default, but the "Dependency Changes" section should NOT have this attribute as it should remain collapsed by default.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build
🔇 Additional comments (2)
components/lvgl/index.rst (2)

111-113: Addition fits nicely – no issues spotted.
The new groups/default_group options are clearly documented and the cross-references are correct.


932-939: Looks good – matches surrounding style.
Header length & underline are already correct for this block and the content mirrors the encoder action.

Walkthrough

The documentation for the LVGL component was updated to introduce the concept of "groups" for widgets, encoders, and keypads. New configuration options for defining groups and assigning default groups were added, along with new actions to dynamically set the group for encoders and keypads at runtime.

Changes

File(s) Change Summary
components/lvgl/index.rst Added documentation for groups and default_group config options; updated group assignment for encoders/keypads; documented new set_group actions for encoders and keypads.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ESPHome_Config
    participant LVGL_Component

    User->>ESPHome_Config: Define groups and default_group
    ESPHome_Config->>LVGL_Component: Initialize with groups and default_group

    User->>LVGL_Component: Assign encoder/keypad to group (via config)
    LVGL_Component->>LVGL_Component: Validate group exists in groups list

    User->>LVGL_Component: Call lvgl.encoder.set_group or lvgl.keypad.set_group action
    LVGL_Component->>LVGL_Component: Reassign encoder/keypad to specified group (validate group)
Loading

Assessment against linked issues

Objective Addressed Explanation
Support creation of LVGL groups and allow assigning widgets, encoders, and keypads to groups (#3166)
Allow updating the group assigned to a keypad or encoder at runtime (#3166)

Suggested reviewers

  • nagyrobi

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@manoamaro manoamaro changed the base branch from current to next July 10, 2025 20:59
@probot-esphome probot-esphome bot added next and removed current labels Jul 10, 2025
Copy link

netlify bot commented Jul 10, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit ff212f8
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6874084bee7faa0008875c76
😎 Deploy Preview https://deploy-preview-5086--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.

@manoamaro manoamaro force-pushed the feature/lvgl-groups branch from 292a5f5 to ff212f8 Compare July 13, 2025 19:26
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.

Support creation of LVGL groups
1 participant