Add autoskope integration documentation #38708
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 31 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughA new documentation file has been introduced for the Autoskope integration with Home Assistant. This file details how users can connect their Autoskope vehicle tracking devices via the Autoskope cloud API, outlines the supported features and entities, explains the configuration process through the Home Assistant UI, and provides troubleshooting tips, limitations, and automation examples. The documentation also covers how to remove the integration and lists the supported Autoskope hardware. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant AutoskopeCloudAPI
User->>HomeAssistant: Configure Autoskope integration (UI)
HomeAssistant->>AutoskopeCloudAPI: Authenticate with username, password, API URL
AutoskopeCloudAPI-->>HomeAssistant: Authentication response
loop Every 60 seconds
HomeAssistant->>AutoskopeCloudAPI: Request vehicle data
AutoskopeCloudAPI-->>HomeAssistant: Return vehicle status/location
HomeAssistant->>User: Update device tracker entities
end
User->>HomeAssistant: Use automations based on vehicle state
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (7)
source/_integrations/autoskope.markdown (7)
18-22: Relocate theconfig_flowinclude under the Configuration section
Per Home Assistant docs conventions, the config flow snippet is typically placed under a dedicated ## Configuration flow or ## Configuration heading, not immediately after the intro. Consider moving lines 22–23 down to just before line 35, and adding:## Configuration flow {% include integrations/config_flow.md %}
33-42: Reduce redundancy between UI flow and configuration details
You note that setup is entirely through the UI flow, then repeat the same fields in the “Configuration” section. Either merge these explanations or clarify that the flow presents these fields.
43-71: Include units in the attribute table
Add a “Unit” column or annotate the example values with units (e.g., V for voltages, m/s or km/h for speed). This improves clarity on what each attribute returns.
73-83: Consider adding network diagnostics to Troubleshooting
You cover authentication and host issues well. Optionally, add a bullet about checking firewall/DNS settings if Home Assistant cannot reach the Autoskope API.
89-92: Tighten “Supported Devices” claim
Saying “all past, present, and future” may set unrealistic expectations. You could list explicitly supported models (V1, V2, V3) or phrase it as “should work with all Autoskope models to date.”
93-179: Streamline automation examples
Five full automations can overwhelm readers. Consider:
- Showing just the trigger/condition blocks and linking to a separate “Automation recipes” page.
- Collapsing boilerplate and highlighting only the integration-specific parts.
181-190: Align Uninstall section with HA conventions
Most integrations use “## Uninstall” rather than “## Removal.” Renaming this heading would improve consistency across docs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/autoskope.markdown(1 hunks)
🔇 Additional comments (2)
source/_integrations/autoskope.markdown (2)
24-32: Installation instructions are clear
The numbered UI setup steps follow HA guidelines and require no changes.
84-88: Known limitations are well explained
Good coverage of polling delay and limited sensor data exposure. No changes needed here.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
source/_integrations/autoskope.markdown (6)
1-16: Quoteha_releasefor consistency in front matter.
YAML interprets unquoted numeric values as numbers, which can lead to unexpected behavior in front matter. To align with other integration docs, wrap the release version in quotes:-ha_release: 2025.5 +ha_release: "2025.5"
18-21: Refine introductory wording to avoid repetition.
The sentence uses "integrate" twice. Consider a slight tweak for clarity:-The **Autoskope** {% term integration %} allows you to integrate your [Autoskope](https://autoskope.de) vehicle tracking devices with Home Assistant. +The **Autoskope** {% term integration %} allows you to connect your [Autoskope](https://autoskope.de) vehicle tracking devices with Home Assistant.
45-70: Enhance Entities section with reference link.
Consider adding a link to the coredevice_trackerintegration docs for users who want deeper insights into device tracker behavior:For more on how device tracker entities work in Home Assistant, see the [device_tracker integration docs](https://www.home-assistant.io/integrations/device_tracker/).
73-76: Clarify polling interval configurability.
You note the integration polls every 60 seconds. If this interval is fixed (not exposed via the UI), mention that explicitly or plan to surface it as a configuration option in a future release.
77-83: Add debug logging tip to Troubleshooting.
Users may need more granularity when diagnosing issues. Consider adding an example to enable debug logging for the Autoskope component:* **Enable Debug Logging:** Add to your `configuration.yaml`: ```yaml logger: default: warning logs: homeassistant.components.autoskope: debug--- `93-179`: **Automation examples are well structured.** The YAML snippets address common use cases. As an optional enhancement, you might include a low-battery notification example: ```yaml alias: Notify if car battery is low trigger: - platform: numeric_state entity_id: device_tracker.my_vehicle_name attribute: battery_voltage below: 3.5 action: - service: notify.mobile_app_your_phone data: message: "Vehicle battery voltage is low." mode: single
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/autoskope.markdown(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (6)
source/_integrations/autoskope.markdown (6)
22-22: Config flow include is correct.
The{% include integrations/config_flow.md %}directive ensures the standard config flow documentation is pulled in.
24-31: Installation steps follow UI guidelines.
The numbered setup instructions align with Home Assistant's documentation style for UI-based integrations.
33-42: Configuration section is clear.
Listing Username, Password, and Host matches the fields required by the integration’s config flow.
84-88: Known Limitations described clearly.
Documenting the 60-second polling delay and limited sensor data sets correct expectations.
89-91: Supported Devices section is fine.
Stating compatibility with all past, present, and future Autoskope hardware reassures users.
181-190: Removal instructions are correct.
The steps to delete the integration via Settings > Devices & Services will automatically clean up entities.
c0ffeeca7
added
the
new-integration
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/autoskope.markdown (4)
18-21: Enhance the introduction with API reference
Consider adding a link or brief mention of the Autoskope cloud API docs to help users dive deeper, for example:
“For details on the underlying Autoskope cloud API endpoints, see the Autoskope API documentation.”
50-65: Attribute table can be enriched
Consider adding a “Unit” column or noting units (e.g., meters forgps_accuracy, km/h or mph forspeed) to help users understand value scales.
68-70: Fix repeated verb in Data update
Reword to remove the duplicated form, e.g.:The integration polls the Autoskope API every 60 seconds to retrieve the latest status and location data…🧰 Tools
🪛 LanguageTool
[grammar] ~70-~70: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...## Data update The integration {% term polling polls %} the Autoskope API every 60 seconds t...(REPEATED_VERBS)
72-89: Troubleshooting section refinements
- Use two-space indentation for nested list items under “Connection failed during setup” instead of three spaces.
- Verify that each
###heading has a blank line above it for consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above(MD022, blanks-around-headings)
79-79: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
80-80: Unordered list indentation
Expected: 2; Actual: 3(MD007, ul-indent)
80-80: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
82-82: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
83-83: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above(MD022, blanks-around-headings)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/autoskope.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/autoskope.markdown
[grammar] ~70-~70: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...## Data update The integration {% term polling polls %} the Autoskope API every 60 seconds t...
(REPEATED_VERBS)
[uncategorized] ~123-~123: You might be missing the article “the” here.
Context: ...ed home." mode: single ### Turn on porch light on arrival after sunset yaml ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~123-~123: A period might be missing here.
Context: ...## Turn on porch light on arrival after sunset ```yaml # filepath: automations.yaml a...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/autoskope.markdown
77-77: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
79-79: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
80-80: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
80-80: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
82-82: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
83-83: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
93-93: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
102-102: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (14)
source/_integrations/autoskope.markdown (14)
1-16: Front matter is well-structured
The YAML metadata (title, description, ha_* keys) follows Home Assistant documentation conventions and accurately describes the Autoskope integration.
22-25: Supported devices description is clear
The note that all past, present, and future hardware is supported covers the scope succinctly.
26-33: Prerequisites listing is complete
The UI-based setup instructions and required credentials (Username,Password,Host) are clearly documented and usefor exampleinstead of abbreviated “e.g.”.
36-36: Config flow inclusion
Great inclusion of the standardconfig_flow.mdsnippet for setup flow.
38-45: Supported functionality overview is concise
The description of thedevice_trackerentity and its states is accurate and easy to follow.
66-66: Future sensor plans noted correctly
The “Note:” about planned sensor entities is helpful for setting expectations.
91-100: Known limitations are well-defined
Users will appreciate the clear callouts on polling delay and limited sensor data with plans for future improvements.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
93-93: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
103-107: Automation examples heading is appropriate
The “Automation examples” section is correctly scoped and introduces the sample scripts clearly.
107-121: Notify when the vehicle arrives home
This YAML example is straightforward and accurately demonstrates state-based triggers.
123-140: Turn on porch light on arrival after sunset
Good use of a sun condition. The code block is clear and follows Home Assistant best practices.🧰 Tools
🪛 LanguageTool
[uncategorized] ~123-~123: You might be missing the article “the” here.
Context: ...ed home." mode: single### Turn on porch light on arrival after sunsetyaml ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~123-~123: A period might be missing here.
Context: ...## Turn on porch light on arrival after sunset ```yaml # filepath: automations.yaml a...(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
142-157: Open garage when arriving near home
Zone-based triggers are well illustrated here.
159-173: Enable Wallbox when car is home
The example correctly reflects switching logic for external devices.
175-189: Arm garage alarm when car leaves home
Excellent demonstration of “from: home” state transitions.
191-198: Removal instructions are complete
Including the standardremove_device_service.mdsnippet and cleanup note ensures users understand how to properly remove the integration.
|
Hi there, @mcisk 👋 Thank you for contributing. Great start for a new integration page. I applied some style tweaks, such as:
You can find more information in the developer documentation on documentation structure of an integration page, and the general style guide |
Hi @c0ffeeca7 , thank you very much for your efforts, I really appreciate it! |
Proposed change
Add new autoskope integration documentation
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit