Skip to content

Conversation

@clydebarrow
Copy link
Contributor

Description:

Related issue (if applicable): fixes #5495

Pull request in esphome with YAML changes (if applicable):

  • esphome/esphome#

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.

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:

  1. Comment on this pull request with the following command, replacing COMPONENT_NAME with your component name in UPPER_CASE format with underscores (e.g., BME280, SHT3X, DALLAS_TEMP):

    @esphomebot generate image COMPONENT_NAME
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

Copilot AI review requested due to automatic review settings November 17, 2025 03:37
@esphome esphome bot added the current label Nov 17, 2025
@clydebarrow clydebarrow added this to the 2025.10.6 milestone Nov 17, 2025
@netlify
Copy link

netlify bot commented Nov 17, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 05d93d8
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/691beb6342a445000806464c
😎 Deploy Preview https://deploy-preview-5630--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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 17, 2025

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Two documentation pages updated: removed an anchor reference and adjusted LVGL spinbox examples to replace deprecated step values with selected_digit entries (different digit values per example). No code or control-flow changes.

Changes

Cohort / File(s) Summary
Anchor edit & spinbox example
content/components/lvgl/widgets.md
Removed an anchor reference (lvgl-widget-canvas) and updated the spinbox example replacing step: 0.5 with selected_digit: 2.
Cookbook spinbox updates
content/cookbook/lvgl.md
Replaced step usage in thermostat and another spinbox example: step: 0.5selected_digit: 0 (thermostat), and other step occurrences updated to corresponding selected_digit values.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Documentation-only edits; repetitive parameter replacement.
  • Pay attention to the exact selected_digit values in each example to ensure they reflect intended precision.

Suggested reviewers

  • swoboda1337

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The PR partially addresses issue #5495: it updates examples to use selected_digit [1], but does not update increment/decrement action documentation [2] or address the scaling issues with update/value actions [3, 4]. Verify with the issue author whether this PR is intended to address only item 1 of the issue, or if additional documentation updates for items 2-4 are expected.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating LVGL spinbox examples to use selected_digit instead of step.
Description check ✅ Passed The description relates to the changeset by referencing the linked issue #5495 that prompted the documentation updates for spinbox examples.
Out of Scope Changes check ✅ Passed All changes are scoped to updating LVGL spinbox examples with selected_digit, directly addressing the primary requirement from issue #5495.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 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 865feca and 312fc80.

📒 Files selected for processing (2)
  • content/components/lvgl/widgets.md (1 hunks)
  • content/cookbook/lvgl.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • content/components/lvgl/widgets.md
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

  • Do not generate or add any sequence diagrams

Files:

  • content/cookbook/lvgl.md
🔇 Additional comments (1)
content/cookbook/lvgl.md (1)

519-536: selected_digit: 0 is correct for this configuration.

With digits: 3 and decimal_places: 1, selected_digit: 0 correctly selects the least-significant digit, which is the 0.1 (tenths) place. This enables the intended 0.1°C precision for the thermostat. The change from step: 0.5 to selected_digit: 0 is semantically correct and achieves decimal-precision control as expected.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining why this PR is needed, why this solution was chosen, and what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot finished reviewing on behalf of clydebarrow November 17, 2025 03:40
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates LVGL spinbox examples to use the selected_digit parameter instead of the deprecated step parameter, addressing issue #5495.

Key Changes

  • Replaced step with selected_digit in spinbox widget examples
  • Removed duplicate anchor tags in widgets documentation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
content/cookbook/lvgl.md Updated two examples to use selected_digit: thermostat spinbox (line 526) and screen timeout number (line 2232)
content/components/lvgl/widgets.md Removed duplicate anchor tags and updated spinbox example to use selected_digit (line 1589)

@swoboda1337 swoboda1337 enabled auto-merge (squash) November 18, 2025 03:43
@swoboda1337 swoboda1337 merged commit 47af9cd into esphome:current Nov 18, 2025
5 checks passed
@jesserockz jesserockz mentioned this pull request Nov 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

LVGL spinbox examples use step and are unclear regarding the value

2 participants