Documentation for new victron_ble integration #39829
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
Adds documentation for the new victron_ble integration, guiding users through setup, configuration, and removal.
- Introduces
victron_ble.markdownwith frontmatter and integration overview - Details prerequisites for obtaining the device encryption key
- Outlines removal steps and data update behavior
Comments suppressed due to low confidence (2)
source/_integrations/victron_ble.markdown:28
- Use the correct casing for OS names according to brand guidelines: change [IOS] to [iOS] and [OSX] to [macOS].
The simplest method is to use the VictronConnect app ([Android](https://play.google.com/store/apps/details?id=com.victronenergy.victronconnect), [IOS](https://apps.apple.com/us/app/victron-connect/id943840744), [Linux](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app), [OSX](https://apps.apple.com/us/app/victronconnect/id1084677271?ls=1&mt=12), [Windows](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app)):
source/_integrations/victron_ble.markdown:28
- [nitpick] Convert the inline list of OS links into a bullet list for better readability, since the items are non-sequential.
The simplest method is to use the VictronConnect app ([Android](https://play.google.com/store/apps/details?id=com.victronenergy.victronconnect), [IOS](https://apps.apple.com/us/app/victron-connect/id943840744), [Linux](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app), [OSX](https://apps.apple.com/us/app/victronconnect/id1084677271?ls=1&mt=12), [Windows](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app)):
📝 Walkthrough""" WalkthroughA new documentation file for the Victron BLE integration has been added. This file details the setup, requirements, and usage instructions for integrating Victron Energy Bluetooth Low Energy devices with Home Assistant, including steps to obtain necessary encryption keys and information on supported features. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant VictronDevice
participant VictronConnectApp
User->>HomeAssistant: Initiate Victron BLE integration setup
HomeAssistant->>User: Prompt for encryption key
User->>VictronConnectApp: Retrieve device encryption key
VictronConnectApp-->>User: Provide encryption key
User->>HomeAssistant: Enter encryption key
HomeAssistant->>VictronDevice: Discover via BLE (Bluetooth integration required)
VictronDevice-->>HomeAssistant: Broadcast sensor data (local push)
HomeAssistant->>User: Display device and sensor states
""" 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
source/_integrations/victron_ble.markdown (2)
30-30: Grammar nit: “setup” → “set up” (verb form)-Install the **VictronConnect** app, ideally on the device you are using to setup this integration +Install the **VictronConnect** app, ideally on the device you are using to set up this integration
46-47: Add a single trailing newline to satisfy MD047The file currently has no newline at EOF, triggering markdown-lint.
Simply add\nafter line 47.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/victron_ble.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/victron_ble.markdown
[grammar] ~30-~30: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... ideally on the device you are using to setup this integration so you can simply cut ...
(NOUN_VERB_CONFUSION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/victron_ble.markdown
47-47: Files should end with a single newline character
(MD047, single-trailing-newline)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/victron_ble.markdown
[error] 28-28: textlint: Incorrect term: “OSX”, use “MacOS” instead (terminology)
⏰ 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
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/victron_ble.markdown (1)
28-35: Insert a blank line before the ordered list + use the verb “set up”Markdown-lint flags this block for missing blank lines around the list (MD032) and for the noun/verb confusion “setup” (LanguageTool). Apply the diff below to resolve both issues:
-The simplest method is to use the VictronConnect app ([Android](https://play.google.com/store/apps/details?id=com.victronenergy.victronconnect), [iOS](https://apps.apple.com/us/app/victron-connect/id943840744), [Linux](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app), [macOS](https://apps.apple.com/us/app/victronconnect/id1084677271?ls=1&mt=12), [Windows](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app)): -1. Install the **VictronConnect** app, ideally on the device you are using to setup this integration so you can simply cut and paste the key. +The simplest method is to use the VictronConnect app ([Android](https://play.google.com/store/apps/details?id=com.victronenergy.victronconnect), [iOS](https://apps.apple.com/us/app/victron-connect/id943840744), [Linux](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app), [macOS](https://apps.apple.com/us/app/victronconnect/id1084677271?ls=1&mt=12), [Windows](https://www.victronenergy.com/support-and-downloads/software#victronconnect-app)): + +1. Install the **VictronConnect** app, ideally on the device you are using to set up this integration so you can simply cut and paste the key.
🧹 Nitpick comments (1)
source/_integrations/victron_ble.markdown (1)
46-46: Ensure file ends with a single trailing newline
markdownlint(MD047) expects exactly one newline at EOF. Add a newline character after the final period to satisfy this rule.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/victron_ble.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/victron_ble.markdown
[grammar] ~29-~29: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... ideally on the device you are using to setup this integration so you can simply cut ...
(NOUN_VERB_CONFUSION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/victron_ble.markdown
29-29: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
46-46: Files should end with a single newline character
(MD047, single-trailing-newline)
⏰ 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
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/victron_ble.markdown (3)
18-18: Avoid “BLE protocol” redundancy & expand acronym on first use“BLE” already contains “Protocol”; expand on first mention for clarity and drop the extra word.
-Integrates Victron Energy devices that support the BLE protocol into Home Assistant. +Integrates Victron Energy devices that support Bluetooth Low Energy (BLE) into Home Assistant.
28-29: Insert a blank line before the ordered list to satisfy MD032Markdown-lint is flagging
blanks-around-lists. Add an empty line after the colon.-...VictronConnect app (...): -1. Install the **VictronConnect** app, ideally on the device you are using to set up this integration so you can simply cut and paste the key. +...VictronConnect app (...): + +1. Install the **VictronConnect** app, ideally on the device you are using to set up this integration so you can simply cut and paste the key.
45-46: Ensure file ends with a single trailing newline (MD047)Add one newline character at EOF to keep tooling and linters happy.
-as often as the updates are received. + +as often as the updates are received. +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/victron_ble.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/victron_ble.markdown
29-29: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
46-46: Files should end with a single newline character
(MD047, single-trailing-newline)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/victron_ble.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/victron_ble.markdown
29-29: Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
⏰ 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 (1)
source/_integrations/victron_ble.markdown (1)
7-8: Double-check the target release identifier
ha_release: '2025.8'assumes the August 2025 version exists and will include this integration. Please verify the correct release tag (e.g.,2025.7or2025.9) before merge to avoid broken links in the generated docs.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
|
||
| ## Adding a device | ||
|
|
||
| To configure a discovered device, you will need to supply the per-device encryption key. For more information, see these [instructions](https://github.com/keshavdv/victron-ble/tree/main#fetching-keys). |
There was a problem hiding this comment.
does it mean without the app, I cannot use the integration in Home Assistant?
Proposed change
Add documentation for a new integration,
victron_ble.Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Uses existing brands: home-assistant/brands#4182
Checklist
currentbranch.nextbranch.Summary by CodeRabbit