Enable long-term statistics for odometers

[jschlyter]

Use SensorStateClass.TOTAL_INCREASING for odometer and trip_meters as they never decrease. The two trip meters can decrease in case of a new cycle.

See also https://developers.home-assistant.io/docs/core/entity/sensor/#long-term-statistics

Closes #286

Summary by CodeRabbit

• Bug Fixes
  • Updated sensor state classification for odometer and trip meter sensors to correctly represent cumulative values.

[coderabbitai]

Walkthrough

The pull request modifies the state_class attribute for three Polestar sensor descriptions in the custom_components/polestar_api/sensor.py file. Specifically, the sensors for current odometer and trip meters are updated from SensorStateClass.MEASUREMENT to SensorStateClass.TOTAL and SensorStateClass.TOTAL_INCREASING. This change affects how these sensors report their state, indicating they represent cumulative values that only increase over time.

Changes

File	Change Summary
custom_components/polestar_api/sensor.py	Updated state_class for three sensors: - current_odometer: changed from MEASUREMENT to TOTAL - current_trip_meter_automatic: changed from MEASUREMENT to TOTAL_INCREASING - current_trip_meter_manual: changed from MEASUREMENT to TOTAL_INCREASING

Assessment against linked issues

Objective	Addressed	Explanation
Support statistics for odometer sensor [#286]	✅
Enable sensor selection in statistics graph card [#286]	✅

Poem

🚗 Kilometers roll, sensors now wise,

Tracking journeys with increasing rise,

From measurement to total's embrace,

Statistics dance with mathematical grace,

Polestar's data, a rabbit's delight! 🐰📊

---

📜 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 a1ed5ef and 56d0fab.

📒 Files selected for processing (1)

• custom_components/polestar_api/sensor.py (3 hunks)

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

• custom_components/polestar_api/sensor.py

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

custom_components/polestar_api/sensor.py (1)

Line range hint 70-96: Consider separating odometer and trip meter state classes.

While using SensorStateClass.TOTAL_INCREASING is perfect for the odometer as it truly represents a continuously increasing value, the trip meters might benefit from a different approach:

1. Keep the odometer as TOTAL_INCREASING for proper long-term statistics
2. Consider reverting trip meters to MEASUREMENT since they can reset
3. If trip meter statistics are needed, consider implementing separate total distance sensors that track cumulative trip distances over time

This separation would provide more accurate historical data tracking while maintaining the ability to reset trip meters without affecting statistics.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d5eebce and a1ed5ef.

📒 Files selected for processing (1)

• custom_components/polestar_api/sensor.py (3 hunks)

🔇 Additional comments (3)

custom_components/polestar_api/sensor.py (3)

70-70: LGTM! Appropriate state class for odometer readings.

The change to SensorStateClass.TOTAL_INCREASING is correct as odometer values should only increase over time. This enables proper long-term statistics tracking in Home Assistant.

---

87-87: Verify if TOTAL_INCREASING is appropriate for trip meters.

According to the PR description, trip meters may decrease when starting a new cycle. Using SensorStateClass.TOTAL_INCREASING might lead to incorrect historical data tracking when the trip meter resets.

Consider keeping SensorStateClass.MEASUREMENT for trip meters since they can reset to zero. Alternatively, please confirm if there's a specific reason for treating trip meters as continuously increasing values.

---

96-96: Verify if TOTAL_INCREASING is appropriate for manual trip meters.

Similar to the automatic trip meter, the manual trip meter can be reset by the user. Using SensorStateClass.TOTAL_INCREASING might not accurately represent the behavior of a resettable trip meter.

Consider keeping SensorStateClass.MEASUREMENT for manual trip meters since they can be manually reset to zero. Alternatively, please confirm if there's a specific reason for treating trip meters as continuously increasing values.