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

Fix device class for sensor estimated_fully_charged_time #308

Conversation

jschlyter
Copy link
Contributor

@jschlyter jschlyter commented Feb 5, 2025

estimated_fully_charged_time should be a timestamp (datetime), not a string. Fix and bump version.

Summary by CodeRabbit

  • Chores

    • Updated the API component version to 1.14.1.
  • New Features

    • Enhanced the display of the estimated fully charged time sensor by adjusting its data classification, now presenting the information as a timestamp for improved clarity.

@jschlyter jschlyter requested a review from BJReplay February 5, 2025 06:57
Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

This pull request updates the Polestar API component by changing the version number in the manifest file from "1.14.0" to "1.14.1". Additionally, adjustments were made to the PolestarSensorDescription class in the sensor module: the state_class property and the data_state_fn lambda were removed, and the device_class for the estimated_fully_charged_time sensor was changed from SensorDeviceClass.DURATION to SensorDeviceClass.TIMESTAMP. No further functional changes were introduced.

Changes

Files Change Summary
custom_components/.../manifest.json Updated version number from "1.14.0" to "1.14.1".
custom_components/.../sensor.py For PolestarSensorDescription (key: "estimated_fully_charged_time"): removed state_class, changed device_class from DURATION to TIMESTAMP, removed data_state_fn.

Possibly related PRs

Suggested reviewers

  • BJReplay

Poem

I'm a rabbit with a hop in my stride,
Code carrots updated, version refined.
No more old state, a new class we greet,
Sensor tweaks make every leap extra sweet.
With every nibble of code, my joy won't hide—
Happy hops to changes, on this coding ride! 🐰

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 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 b8a4934 and 79b29b6.

📒 Files selected for processing (2)
  • custom_components/polestar_api/manifest.json (1 hunks)
  • custom_components/polestar_api/sensor.py (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • custom_components/polestar_api/manifest.json
🔇 Additional comments (1)
custom_components/polestar_api/sensor.py (1)

258-264: LGTM! The changes align with the PR objectives.

The modification of device_class to SensorDeviceClass.TIMESTAMP correctly reflects that estimated_fully_charged_time should be handled as a datetime value rather than a duration.

Please ensure that the estimated_fully_charged attribute from the Polestar API is provided in a format compatible with Home Assistant's timestamp handling (ISO 8601 format). Run this script to verify the data format:

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 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.

@jschlyter jschlyter marked this pull request as ready for review February 5, 2025 06:57
@jschlyter jschlyter requested a review from a team as a code owner February 5, 2025 06:57
Copy link
Contributor

@BJReplay BJReplay left a comment

Choose a reason for hiding this comment

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

lgtm.

I noticed it was saying 300 minutes when charging on a granny charger today.

@jschlyter jschlyter merged commit 730c8d0 into pypolestar:main Feb 5, 2025
4 checks passed
@jschlyter jschlyter deleted the estimated_fully_charged_time_device_class branch February 5, 2025 07:41
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