Skip to content
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

Energy by distance units #2553

Merged
merged 3 commits into from
Feb 2, 2025

Conversation

jschlyter
Copy link
Contributor

@jschlyter jschlyter commented Jan 31, 2025

Proposed change

Blog post as requested by @abmantis in #2548 (comment)

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:

Summary by CodeRabbit

  • New Features
    • Introduced a new device class for measuring electric energy consumption per distance unit.
    • Added support for energy distance units including kWh/100km, mi/kWh, and km/kWh.
    • Enhanced unit conversion capabilities for improved handling of inverse units.
    • Added a new enumerator for energy distance units.

@jschlyter jschlyter marked this pull request as ready for review January 31, 2025 16:57
Copy link
Contributor

coderabbitai bot commented Jan 31, 2025

📝 Walkthrough

Walkthrough

A new device class ENERGY_DISTANCE has been introduced to measure energy consumption by distance, specifically for number and sensor entities. This addition allows tracking electric energy usage per distance unit, such as for electric vehicles. The implementation includes a new enumerator UnitOfEnergyDistance and a converter class EnergyDistanceConverter, supporting units like kWh/100km, mi/kWh, and km/kWh. The converter enhances the existing BaseUnitConverter by supporting inverse units.

Changes

File Change Summary
blog/2025-01-31-energy-distance-units.md - Added ENERGY_DISTANCE device class
- Introduced UnitOfEnergyDistance enumerator
- Created EnergyDistanceConverter class

Sequence Diagram

sequenceDiagram
    participant User
    participant EnergyDistanceConverter
    participant UnitOfEnergyDistance

    User->>EnergyDistanceConverter: Convert energy distance units
    EnergyDistanceConverter->>UnitOfEnergyDistance: Select specific unit
    UnitOfEnergyDistance-->>EnergyDistanceConverter: Return converted value
    EnergyDistanceConverter-->>User: Provide converted 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 7d89983 and 387be50.

📒 Files selected for processing (1)
  • blog/2025-01-31-energy-distance-units.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • blog/2025-01-31-energy-distance-units.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
🪧 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.

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 (2)
blog/2025-01-31-energy-distance-units.md (2)

4-4: Update title to use sentence-style capitalization.

-title: "Energy by distance units"
+title: "Energy by distance units"

22-22: Fix typo in the sentence.

-Implementing `EnergyDistanceConverter` has also resulted in support for inverse units in `BaseUnitConverter`. This simplifies adding new units tha are inverses of one another, e.g., kWh/100km and km/kWh.
+Implementing `EnergyDistanceConverter` has also resulted in support for inverse units in `BaseUnitConverter`. This simplifies adding new units that are inverses of one another, e.g., kWh/100km and km/kWh.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c8914f and 1319cfb.

📒 Files selected for processing (1)
  • blog/2025-01-31-energy-distance-units.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
blog/2025-01-31-energy-distance-units.md (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🔇 Additional comments (1)
blog/2025-01-31-energy-distance-units.md (1)

7-17: LGTM! Clear and well-structured summary.

The summary effectively communicates the new device class and its capabilities while maintaining proper technical documentation standards.

@home-assistant
Copy link

home-assistant bot commented Feb 1, 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.

@home-assistant home-assistant bot marked this pull request as draft February 1, 2025 23:59
@jschlyter jschlyter marked this pull request as ready for review February 2, 2025 07:48
@home-assistant home-assistant bot requested a review from abmantis February 2, 2025 07:48
Copy link
Contributor

@abmantis abmantis left a comment

Choose a reason for hiding this comment

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

Thank you!

@abmantis abmantis merged commit d80e4a1 into home-assistant:master Feb 2, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants