Skip to content

Clarify accuracy_decimals in sensor #4837

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 1 commit into
base: current
Choose a base branch
from

Conversation

gdt
Copy link

@gdt gdt commented Apr 22, 2025

While accuracy_decimals doesn't change the value sent across the API,
Home Assistant rounds at ingestion time. Explain this, so that
people will realize that if they want e.g. 0.01C in Home Assistant,
they need to change accuracy_decimals and can't just change the
entity's display resolution.

Description:

esphome/issues#5830
https://community.home-assistant.io/t/difference-between-accuracy-decimals-and-round/703755/16

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
Contributor

coderabbitai bot commented Apr 22, 2025

Walkthrough

The change updates the documentation for the accuracy_decimals configuration option in the sensor component. The new documentation provides a more detailed explanation of how accuracy_decimals affects the display and handling of sensor values, particularly in relation to Home Assistant integration. It clarifies that this setting influences the number of decimal places shown and used by data consumers, but does not alter the actual value transmitted via the API. No code or control flow was modified; the update is limited to documentation improvements.

Changes

File(s) Change Summary
components/sensor/index.rst Expanded and clarified the documentation for the accuracy_decimals option, explaining its effect and behavior.

Suggested labels

current

Suggested reviewers

  • frenck
  • nagyrobi

📜 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 802e1a5 and e2594cd.

📒 Files selected for processing (1)
  • components/sensor/index.rst (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • components/sensor/index.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.

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: 0

🧹 Nitpick comments (1)
components/sensor/index.rst (1)

59-67: Documentation Clarity: Capitalization and spacing consistency
The phrase “esphome integration” should be capitalized to “ESPHome integration” to align with project naming. Also, there’s an extra space before “The number of digits…”—it’s best to keep a single space after periods for consistency.

Proposed diff:

- While this
-   does not change the value sent across the API, Home Assistant's esphome integration will round the value accordingly before using or
-   storing it.  The number of digits will also be used to set the
+ While this does not change the value sent across the API, Home Assistant's ESPHome integration will round the value accordingly before using or storing it. The number of digits will also be used to set the
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 95d4a6e and 802e1a5.

📒 Files selected for processing (1)
  • components/sensor/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/sensor/index.rst

Copy link

netlify bot commented Apr 22, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit e2594cd
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/6808185adc4a9800084e26bc
😎 Deploy Preview https://deploy-preview-4837--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.

While accuracy_decimals doesn't change the value sent across the API,
Home Assistant rounds at ingestion time.   Explain this, so that
people will realize that if they want e.g. 0.01C in Home Assistant,
they need to change accuracy_decimals and can't just change the
entity's display resolution.
@gdt gdt force-pushed the clarify-accuracy-decimals branch from 802e1a5 to e2594cd Compare April 22, 2025 22:29
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.

1 participant