Disable software version sensors by default

[jschlyter]

The software version and released sensors seems to report nothing useful, disable them by default.

Summary by CodeRabbit

• New Features

  • Added a new attribute to several sensor descriptions to control their automatic registration in the entity registry.
  • Sensors affected include: software_version, software_version_release, internal_vehicle_id, api_status_code_data, api_status_code_auth, and api_token_expires_at.

• Bug Fixes

  • No existing functionality was disrupted; the sensor system remains stable.

[coderabbitai]

Walkthrough

The pull request introduces a configuration change to the Polestar API sensor component, specifically modifying the PolestarSensorDescription class. The primary modification involves adding the entity_registry_enabled_default attribute set to False for several specific sensor descriptions. This change affects how certain sensors are registered in the entity registry by default, preventing their automatic registration while maintaining the existing sensor functionality and logic.

Changes

File	Change Summary
custom_components/polestar_api/sensor.py	Added entity_registry_enabled_default=False for sensors: - software_version - software_version_release - internal_vehicle_id - api_status_code_data - api_status_code_auth - api_token_expires_at

Poem

🚗 In the world of Polestar's digital dance,
Sensors hide, with a registry's glance
Some secrets kept, some data shy
Not every sensor wants to catch the eye! 🐰
Silent watchers, registry's delight
Disabled by default, out of sight

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 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 920e7c9 and 82ab19a.

📒 Files selected for processing (1)

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

🔇 Additional comments (3)

custom_components/polestar_api/sensor.py (3)

171-171: LGTM: Software version sensors disabled by default

The changes appropriately disable the software version sensors by default, which aligns with the PR objective as this information is relatively static and doesn't require constant monitoring. Users can still enable these sensors manually if needed.

Also applies to: 180-180

---

Line range hint 193-193: LGTM: Internal vehicle ID sensor disabled by default

Disabling the internal vehicle ID sensor by default is appropriate as it's static information primarily used for diagnostic purposes. Users can enable it when needed for troubleshooting.

---

Line range hint 245-245: LGTM: API diagnostic sensors disabled by default

Disabling the API status and token sensors by default is consistent with their diagnostic nature. These sensors are already properly categorized as diagnostic entities and can be enabled when needed for troubleshooting.

Let's verify that the Home Assistant frontend still shows these entities in the diagnostic section and allows easy enabling:

Also applies to: 254-254, 263-263

✅ Verification successful

LGTM: Diagnostic sensors properly implemented with standard Home Assistant patterns

The verification confirms that:

1. The diagnostic sensors (API status codes and token expiration) are properly implemented with entity_category=EntityCategory.DIAGNOSTIC
2. They follow Home Assistant's standard pattern by being disabled by default (entity_registry_enabled_default=False)
3. The implementation is consistent with other diagnostic sensors in the codebase
4. Users can still enable these sensors through the Home Assistant UI when needed for troubleshooting

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if other diagnostic sensors in the codebase follow similar patterns

# Look for other diagnostic sensors in the codebase
rg "entity_category=EntityCategory.DIAGNOSTIC" --type python

# Check for any documentation about diagnostic sensors
fd -t f "README" -X grep -l "diagnostic"

Length of output: 130

---

Script:

#!/bin/bash
# Let's try different approaches to find diagnostic sensors and entity categories

# Search for EntityCategory.DIAGNOSTIC with proper spacing and quotes
rg "entity_category\s*=\s*EntityCategory\.DIAGNOSTIC"

# Search for diagnostic entity imports
rg "from homeassistant\.components\.sensor import EntityCategory"

# Look for entity_category in the sensor file
cat "custom_components/polestar_api/sensor.py"

Length of output: 16300

---

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.