Rework BMW docs for new quality scale #36083
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough📝 WalkthroughWalkthroughThe documentation for the BMW Connected Drive integration has been updated to reflect its rebranding to MyBMW. Key enhancements include the addition of prerequisites for account setup, detailed configuration instructions, explicit data update intervals, and a new section for custom polling intervals. The overview of available platforms has been expanded, and the troubleshooting section has been improved with common issues and recovery steps. Limitations regarding entity availability and charging functionalities have also been documented, resulting in a more structured and informative guide for users. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant MyBMW
participant Vehicle
User->>MyBMW: Authenticate with username and password
MyBMW-->>User: Provide access token
User->>MyBMW: Request vehicle data
MyBMW-->>Vehicle: Pull data from MyBMW/MINI servers
Vehicle-->>MyBMW: Send vehicle status
MyBMW-->>User: Deliver vehicle data
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? 🪧 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: 4
🧹 Outside diff range and nitpick comments (2)
source/_integrations/bmw_connected_drive.markdown (2)
213-213: Add blank line before headingAdd a blank line before the "Troubleshooting" heading to follow markdown formatting guidelines.
+ ## Troubleshooting🧰 Tools
🪛 Markdownlint (0.35.0)
213-213: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
232-232: Add blank line before headingAdd a blank line before the "Known limitations" heading to follow markdown formatting guidelines.
+ ## Known limitations🧰 Tools
🪛 Markdownlint (0.35.0)
232-232: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines(MD022, blanks-around-headings)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/bmw_connected_drive.markdown(4 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
source/_integrations/bmw_connected_drive.markdown
125-125: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
213-213: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
232-232: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
217-217: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
233-233: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🪛 LanguageTool
source/_integrations/bmw_connected_drive.markdown
[grammar] ~204-~204: The verb after “to” should be in the base form as part of the to-infinitive. A verb can take many forms, but the base form is always used in the to-infinitive.
Context: ...tion. It is not possible to force it to heating/cooling, the vehicle will decide on its...
(TO_NON_BASE)
[grammar] ~209-~209: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...ing process through Home Assistant. The number entities are created automatically depending on ...
(PLENTY_OF_NOUNS)
[misspelling] ~218-~218: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ... password are correct). - If you cannot login on the website, please deactivate p...
(LOG_IN)
[misspelling] ~219-~219: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...r at least 24 hours. - Once you can login to the website, reconfigure/reauthentic...
(LOG_IN)
[grammar] ~233-~233: The verb ‘to depend’ requires the preposition ‘(up)on’.
Context: ...MW X1) you will see different entities, depending of your specific car's features. - Not all...
(DEPEND_ON)
🔇 Additional comments (3)
source/_integrations/bmw_connected_drive.markdown (3)
91-104: Well-documented update behavior
Clear and comprehensive explanation of update intervals and behavior differences between combustion and electric vehicles.
Line range hint 36-239: Well-structured documentation
The documentation is well-organized with clear sections, appropriate use of notes/warnings, and comprehensive coverage of features and troubleshooting.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~114-~114: This expression is usually spelled with a hyphen.
Context: ... %}: - Binary sensors: Doors, windows, condition based services, check control messages, parki...
(BASED_HYPHEN)
Line range hint 36-239: Documentation updates align with PR objectives
The changes successfully update the BMW documentation to reflect the new quality scale while maintaining comprehensive coverage of all features and requirements.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~114-~114: This expression is usually spelled with a hyphen.
Context: ... %}: - Binary sensors: Doors, windows, condition based services, check control messages, parki...
(BASED_HYPHEN)
| required: true | ||
| type: string | ||
| Password: | ||
| description: "Username of your MyBMW/MINI Connected account." |
There was a problem hiding this comment.
Fix password description typo
The password field description incorrectly states "Username of your MyBMW/MINI Connected account" instead of "Password".
- description: "Username of your MyBMW/MINI Connected account."
+ description: "Password of your MyBMW/MINI Connected account."📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| description: "Username of your MyBMW/MINI Connected account." | |
| description: "Password of your MyBMW/MINI Connected account." |
| For `china`, it is mandatory to prefix your username/phone number with `86`, i.e. `8612345678`. | ||
| {% endnote %} | ||
| {% warning %} | ||
| Every platform except **binary sensors** and **sensors** can change the state of your vehicle. Once you change the state in Home Asistant, a command is sent to your car. |
There was a problem hiding this comment.
Fix typo in warning message
There's a typo in "Home Asistant".
-Every platform except **binary sensors** and **sensors** can change the state of your vehicle. Once you change the state in Home Asistant, a command is sent to your car.
+Every platform except **binary sensors** and **sensors** can change the state of your vehicle. Once you change the state in Home Assistant, a command is sent to your car. 📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Every platform except **binary sensors** and **sensors** can change the state of your vehicle. Once you change the state in Home Asistant, a command is sent to your car. | |
| Every platform except **binary sensors** and **sensors** can change the state of your vehicle. Once you change the state in Home Assistant, a command is sent to your car. |
🧰 Tools
🪛 Markdownlint (0.35.0)
125-125: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
|
|
||
| If supported by your vehicle, you can display and toggle remote actions with start/stop functionality. | ||
|
|
||
| Using these selects will impact the state of your vehicle, use them with care! | ||
|
|
||
| - **Climate**: Toggle vehicle climatization. It is not possible to force it to heating/cooling, the vehicle will decide on its own. If turned on, it will run for 30 minutes (as if toggled via the MyBMW app). |
There was a problem hiding this comment.
Fix grammatical error in climate control description
The phrase "to heating/cooling" is grammatically incorrect.
-It is not possible to force it to heating/cooling, the vehicle will decide on its own.
+It is not possible to force it to heat or cool; the vehicle will decide on its own.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Climate**: Toggle vehicle climatization. It is not possible to force it to heating/cooling, the vehicle will decide on its own. If turned on, it will run for 30 minutes (as if toggled via the MyBMW app). | |
| - **Climate**: Toggle vehicle climatization. It is not possible to force it to heat or cool; the vehicle will decide on its own. If turned on, it will run for 30 minutes (as if toggled via the MyBMW app). |
🧰 Tools
🪛 LanguageTool
[grammar] ~204-~204: The verb after “to” should be in the base form as part of the to-infinitive. A verb can take many forms, but the base form is always used in the to-infinitive.
Context: ...tion. It is not possible to force it to heating/cooling, the vehicle will decide on its...
(TO_NON_BASE)
| {% enddetails %} | ||
|
|
||
| ## Known limitations | ||
| - The entities available to Home Assistant depend on your vehicle. Even inside the same model code (e.g. U11 for BMW X1) you will see different entities, depending of your specific car's features. |
There was a problem hiding this comment.
Fix grammatical error in limitations description
The phrase "depending of" should be "depending on".
-The entities available to Home Assistant depend on your vehicle. Even inside the same model code (e.g. U11 for BMW X1) you will see different entities, depending of your specific car's features.
+The entities available to Home Assistant depend on your vehicle. Even inside the same model code (e.g. U11 for BMW X1) you will see different entities, depending on your specific car's features.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - The entities available to Home Assistant depend on your vehicle. Even inside the same model code (e.g. U11 for BMW X1) you will see different entities, depending of your specific car's features. | |
| - The entities available to Home Assistant depend on your vehicle. Even inside the same model code (e.g. U11 for BMW X1) you will see different entities, depending on your specific car's features. |
🧰 Tools
🪛 LanguageTool
[grammar] ~233-~233: The verb ‘to depend’ requires the preposition ‘(up)on’.
Context: ...MW X1) you will see different entities, depending of your specific car's features. - Not all...
(DEPEND_ON)
🪛 Markdownlint (0.35.0)
233-233: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (5)
source/_integrations/bmw_connected_drive.markdown (5)
44-44: Fix grammatical error in prerequisitesThere's a grammatical error in the sentence.
-You need to have an active MyBMW account with a connected car. For MINI vehicles, you register your with MINI Connected. +You need to have an active MyBMW account with a connected car. For MINI vehicles, you register with MINI Connected.
55-56: Remove unnecessary blank lines and non-breaking spacesThe
and extra blank line create unnecessary spacing in the username description.Username: description: | Username of your MyBMW/MINI Connected account. - - **China**: Your username/phone number must be prefixed with `86`, i.e. `8612345678`.
125-125: Fix trailing spaceRemove the trailing space at the end of line 125.
-Every platform except **binary sensors** and **sensors** can change the state of your vehicle. Once you change the state in Home Assistant, a command is sent to your car. +Every platform except **binary sensors** and **sensors** can change the state of your vehicle. Once you change the state in Home Assistant, a command is sent to your car.🧰 Tools
🪛 Markdownlint (0.35.0)
125-125: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
134-134: Add missing commas for better readabilityAdd commas to improve sentence structure.
-The **BMW Connected Drive** integration offers a notification action. Using this action you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination. +The **BMW Connected Drive** integration offers a notification action. Using this action, you can send Points of Interest (POI) to your vehicle. In your vehicle, you can select this POI and the navigation will automatically start using the POI as a destination.🧰 Tools
🪛 LanguageTool
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...ffers a notification action. Using this action you can send Points of Interest (POI) t...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigat...(AI_HYDRA_LEO_MISSING_COMMA)
218-219: Fix "login" vs "log in" usage"Login" is a noun, while "log in" is the correct verb form.
-- If you cannot login on the website, please **deactivate** polling -- Once you can login to the website, reconfigure/reauthenticate +- If you cannot log in to the website, please **deactivate** polling +- Once you can log in to the website, reconfigure/reauthenticate🧰 Tools
🪛 LanguageTool
[misspelling] ~218-~218: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ... password are correct). - If you cannot login on the website, please deactivate p...(LOG_IN)
[uncategorized] ~218-~218: The preposition ‘to’ seems more likely in this position.
Context: ...ord are correct). - If you cannot login on the website, please deactivate poll...(AI_HYDRA_LEO_REPLACE_ON_TO)
[misspelling] ~219-~219: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...r at least 24 hours. - Once you can login to the website, reconfigure/reauthentic...(LOG_IN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/bmw_connected_drive.markdown(4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/bmw_connected_drive.markdown
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...ffers a notification action. Using this action you can send Points of Interest (POI) t...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ...Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigat...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~209-~209: Using ‘plenty’ without ‘of’ is considered to be informal.
Context: ...ing process through Home Assistant. The number entities are created automatically depending on ...
(PLENTY_OF_NOUNS)
[misspelling] ~218-~218: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ... password are correct). - If you cannot login on the website, please deactivate p...
(LOG_IN)
[uncategorized] ~218-~218: The preposition ‘to’ seems more likely in this position.
Context: ...ord are correct). - If you cannot login on the website, please deactivate poll...
(AI_HYDRA_LEO_REPLACE_ON_TO)
[misspelling] ~219-~219: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...r at least 24 hours. - Once you can login to the website, reconfigure/reauthentic...
(LOG_IN)
🪛 Markdownlint (0.35.0)
source/_integrations/bmw_connected_drive.markdown
125-125: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
213-213: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
232-232: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
217-217: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
233-233: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🔇 Additional comments (3)
source/_integrations/bmw_connected_drive.markdown (3)
91-104: LGTM! Clear and informative data update documentation
The update intervals and behavior are well documented with clear distinctions between different regions and vehicle types.
232-235: LGTM! Clear documentation of limitations
The limitations are well documented with appropriate references to external resources for feature requests.
🧰 Tools
🪛 Markdownlint (0.35.0)
232-232: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
(MD022, blanks-around-headings)
233-233: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
236-242: LGTM! Clear removal instructions and appropriate disclaimer
The removal process and disclaimer are properly documented.
| options: china, north_america, rest_of_world | ||
| Captcha token (second step, only for North America and Rest of World): | ||
| description: | | ||
| The **North America** and **Rest of World** regions require a captcha challenge to be solved, i.e. you need to verify that you are not a robot. |
There was a problem hiding this comment.
| The **North America** and **Rest of World** regions require a captcha challenge to be solved, i.e. you need to verify that you are not a robot. | |
| The **North America** and **Rest of World** regions require a captcha challenge to be solved. For example, you need to verify that you are not a robot. |
| This will only refresh data from the BMW/MINI servers and **not** from your car. | ||
|
|
||
| - Combustion engine cars typically only update data from car to server when the car is parked and the engine is shut off. | ||
| - Electric vehicles typically only update while the vehicle is parked and turned off or while charging |
There was a problem hiding this comment.
| - Electric vehicles typically only update while the vehicle is parked and turned off or while charging | |
| - Electric vehicles typically only update while the vehicle is parked and turned off or while they are charging. |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
|
To your question: It belongs on the |
Co-authored-by: c0ffeeca7 <[email protected]>
Thanks! I'd probably still keep it on |
Proposed change
Rework BMW docs for quality scale.
This contains the changes from #36032, so I wasn't sure if it should be based against
nextorcurrent, but as it will get merged intocurrentwith 2024.12, I hope this is correct.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit