Add documentation for units for energy by distance

[jschlyter]

Proposed change

Document new energy by distance units:

• kWh/100km
• mi/kWh
• km/kWh

Type of change

• Document existing features within Home Assistant
• Document new or changing features which there is an existing pull request elsewhere
• Spelling or grammatical corrections, or rewording for improved clarity
• Changes to the backend of this documentation
• Removed stale or deprecated documentation

Additional information

• This PR fixes or closes issue: fixes #
• Link to relevant existing code or pull request: Energy distance units core#136933

Summary by CodeRabbit

• New Features
  • Added ENERGY_DISTANCE device class for number and sensor entities.
  • Supports energy consumption measurement for electric vehicles.
  • New units of measurement: kWh/100km, mi/kWh, and km/kWh.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new device class ENERGY_DISTANCE for both number and sensor entities, specifically designed to represent energy consumption metrics for electric vehicles. This addition provides a standardized way to track and display energy efficiency measurements across different units like kWh/100km, mi/kWh, and km/kWh. The changes are documentation updates that expand the classification system for energy-related measurements without modifying existing functionality.

Changes

File	Change Summary
docs/core/entity/number.md	Added new device class NumberDeviceClass.ENERGY_DISTANCE for energy consumption by distance
docs/core/entity/sensor.md	Added new device class SensorDeviceClass.ENERGY_DISTANCE for energy consumption by distance

Sequence Diagram

sequenceDiagram
    participant EV as Electric Vehicle
    participant System as Measurement System
    EV->>System: Report Energy Consumption
    System->>System: Classify as ENERGY_DISTANCE
    System-->>EV: Store/Display Measurement

Loading

---

📜 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 afdcc1f and 6a6c5c1.

📒 Files selected for processing (2)

• docs/core/entity/number.md (1 hunks)
• docs/core/entity/sensor.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• docs/core/entity/sensor.md
• docs/core/entity/number.md

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Redirect rules - developers-home-assistant
• GitHub Check: Header rules - developers-home-assistant
• GitHub Check: Pages changed - developers-home-assistant

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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 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.

[abmantis]

Hey @jschlyter ! It would be great if you could add also a blog post to https://developers.home-assistant.io/blog for developers to know about this new unit. Are you ok with doing it?

[jschlyter]

Hey @jschlyter ! It would be great if you could add also a blog post to https://developers.home-assistant.io/blog for developers to know about this new unit. Are you ok with doing it?

Sure, #2553 pending preview