search

home-assistant / developers.home-assistant

Developers website for Home Assistant.
https://developers.home-assistant.io
Other
314 stars 966 forks source link

Add µV unit for voltage #2456

Closed tr4nt0r closed 1 week ago

tr4nt0r commented 1 week ago

Proposed change

Add µV as voltage unit

Type of change

Additional information

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The documentation for the sensor and number entities has been updated. For the sensor entity, the `SensorDeviceClass.VOLTAGE` entry now supports "µV" along with "V" and "mV". The number entity documentation clarifies properties and methods, including updates to `native_unit_of_measurement`, `native_step`, and the addition of `µV` in `NumberDeviceClass.VOLTAGE`. New methods `set_native_value` and `async_set_native_value` have been introduced to facilitate value updates. ## Changes | File | Change Summary | |---------------------------------------|-----------------------------------------------------------------| | docs/core/entity/sensor.md | Updated `SensorDeviceClass.VOLTAGE` units from "V, mV" to "V, mV, µV". | | docs/core/entity/number.md | Clarified `native_unit_of_measurement` and `native_step`; added `µV` to `NumberDeviceClass.VOLTAGE`; introduced `set_native_value` and `async_set_native_value` methods. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Documentation User->>Documentation: Request sensor entity information Documentation-->>User: Provide updated sensor details User->>Documentation: Query supported units for VOLTAGE Documentation-->>User: Return units: V, mV, µV User->>Documentation: Request number entity information Documentation-->>User: Provide updated number details User->>Documentation: Query properties of number entity Documentation-->>User: Return properties and methods ```
📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 5881d3233bccc1459524bb6ea7636bc4851a2b06 and 8f4ee71969418220665aeedc4f3d29ef0620e5ad.
📒 Files selected for processing (1) * `docs/core/entity/number.md` (1 hunks)
🔇 Additional comments (1)
docs/core/entity/number.md (1) `75-75`: **LGTM! The µV unit is correctly added.** The addition of µV (microvolt) as a supported unit for voltage measurements is technically accurate and properly formatted. The units are listed in the conventional order from larger to smaller units (V, mV, µV), and the proper Unicode character µ is used.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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` or `@coderabbitai title` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.