Pihole v6 #39933
Pihole v6 #39933
Conversation
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming 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
This PR updates documentation across multiple integrations to improve clarity, add new integration content (e.g., Zooz, AI Task), and revise the Pi-hole integration for API v6.
- Revamped Pi-hole docs for version 6 with new SSL and API key fields and updated instructions
- Removed deprecated attributes (e.g., Velbus
interface), refined step-by-step instructions (e.g., Z-Wave JS), and added new integration guides (e.g., Zooz, AI Task, Nord Pool date actions) - Standardized UI string formatting and phrasing in multiple integrations (e.g., Telegram Bot, Qbus, Yalex BLE)
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| source/_integrations/zwave_js.markdown | Simplified reset and diagnostics steps numbering and formatting |
| source/_integrations/zooz.markdown | Added Zooz integration guide |
| source/_integrations/zabbix.markdown | Added publish_string_states parameter |
| source/_integrations/yalexs_ble.markdown | Refined device list, added deadlock support, updated cloud key instructions |
| source/_integrations/velbus.markdown | Removed deprecated interface data attribute |
| source/_integrations/template.markdown | Enhanced state descriptions for sensors and locks |
| source/_integrations/telegram_bot.markdown | Updated authentication parameter descriptions |
| source/_integrations/russound_rio.markdown | Added "Playing media" examples |
| source/_integrations/qbus.markdown | Updated entity lists with Cover and Hub |
| source/_integrations/playstation_network.markdown | Added sensor and binary_sensor sections |
| source/_integrations/pi_hole.markdown | Updated fields for API v6, SSL, and certificate handling |
| source/_integrations/nordpool.markdown | Added "Get price indices for date" action |
| source/_integrations/modbus.markdown | Default slave address note updated |
| source/_integrations/media_player.markdown | Removed Standby state from list |
| source/_integrations/kostal_plenticore.markdown | Added installer access sensors and manual charge section |
| source/_integrations/compensation.markdown | Reordered and added configuration options |
| source/_integrations/ai_task.markdown | Introduced AI Task integration guide |
| source/_docs/z-wave/controllers.markdown | Renamed controllers to adapters and updated recommendations |
| source/_docs/blueprint/selectors.markdown | Added translation_key selector parameter |
| source/_docs/automation/trigger.markdown | Introduced weekday filtering for time triggers |
Comments suppressed due to low confidence (8)
source/_integrations/zwave_js.markdown:289
- For consistency with other docs, change “three-dot” to “three dots” to match UI wording (e.g., “select the three dots menu”).
3. Under **Device info**, select the three-dot {% icon "mdi:dots-vertical" %} menu, then select **Factory reset**.
source/_integrations/zabbix.markdown:68
- Avoid using “i.e.”; replace with “for example” or rephrase: “Also publish string states, for example states that cannot be cast to a numeric value.”
description: Also publish string states, i.e. states which cannot be cast to a numeric value.
source/_integrations/yalexs_ble.markdown:39
- [nitpick] Listing two model numbers in one bullet can be confusing—consider splitting into two entries (e.g.
- YUR/SSDL/1/SILand- YUR/SSDL/1/MBK) or clarifying their relationship.
- YUR/SSDL/1/SIL and MBK (Yale Unity Screen Door Lock - Australia)
source/_integrations/telegram_bot.markdown:155
- Wrap “digest” in backticks for consistency:
digest.
| `username` | yes | Username for a URL which requires HTTP `basic` or `digest` authentication. |
source/_integrations/qbus.markdown:51
- [nitpick] This list item is a fragment; remove the trailing period to follow list style (no period for non-sentence fragments).
- **Climate**: manage thermostats by setting temperature and choosing presets.
source/_integrations/pi_hole.markdown:45
- This is a run-on sentence; split into two or use a semicolon. Also, UI labels should use bold (e.g., Settings > API Tab) instead of italics.
Versions of Pi-hole before version 6 (released in Feb 2025) use an API Key if the Pi-hole was password protected, this can be found in _Settings > API Tab_ and clicking **Show API token**
source/_integrations/media_player.markdown:31
- Standby state was removed from the supported states list—verify in code that the ‘standby’ state is no longer valid before deleting it from documentation.
- **Paused**: The media player has an active media and is currently paused
source/_integrations/ai_task.markdown:32
- Use consistent terminology: replace “LLM task” with “AI task” to match the integration’s name and other references.
| `entity_id` | yes | String that points at an `entity_id` of an LLM task entity. If not specified, uses the default LLM task. |
| | `Location` | the path to the admin page. | /admin | | ||
| | `Location` | the path to the admin page. In the version 6 API this will be ignored. | /admin | | ||
| | `API Key or App Password` | This can be found in your Pi-hole's **Settings** > **API (expert mode)**. | `585a2fe...` | | ||
| | `Uses an SSL certificate` | Whether your Pi-hole has an Certificate, typically true for `https` connections and false for `http`. | {% icon "openmoji:check-mark" %} | |
There was a problem hiding this comment.
Fix grammar: “has a Certificate” should be “has a certificate” (lowercase) or rephrase to “Whether your Pi-hole uses an SSL certificate.”
| | `Uses an SSL certificate` | Whether your Pi-hole has an Certificate, typically true for `https` connections and false for `http`. | {% icon "openmoji:check-mark" %} | | |
| | `Uses an SSL certificate` | Whether your Pi-hole uses an SSL certificate, typically true for `https` connections and false for `http`. | {% icon "openmoji:check-mark" %} | |
Copilot uses AI. Check for mistakes.
| attribute: | ||
| description: Attribute from the source to monitor/compensate. When omitted, the state value of the source will be used. | ||
| required: false | ||
| type: string | ||
| data_points: | ||
| description: "The collection of data point conversions with the format `[uncompensated_value, compensated_value]`. e.g., `[1.0, 2.1]`. The number of required data points is equal to the polynomial `degree` + 1. For example, a linear compensation (with `degree: 1`) requires at least 2 data points." | ||
| required: true | ||
| type: list |
There was a problem hiding this comment.
[nitpick] The configuration options are no longer in alphabetical or logical order; consider grouping required fields first and then optional fields alphabetically for consistency.
| attribute: | |
| description: Attribute from the source to monitor/compensate. When omitted, the state value of the source will be used. | |
| required: false | |
| type: string | |
| data_points: | |
| description: "The collection of data point conversions with the format `[uncompensated_value, compensated_value]`. e.g., `[1.0, 2.1]`. The number of required data points is equal to the polynomial `degree` + 1. For example, a linear compensation (with `degree: 1`) requires at least 2 data points." | |
| required: true | |
| type: list | |
| data_points: | |
| description: "The collection of data point conversions with the format `[uncompensated_value, compensated_value]`. e.g., `[1.0, 2.1]`. The number of required data points is equal to the polynomial `degree` + 1. For example, a linear compensation (with `degree: 1`) requires at least 2 data points." | |
| required: true | |
| type: list | |
| attribute: | |
| description: Attribute from the source to monitor/compensate. When omitted, the state value of the source will be used. | |
| required: false | |
| type: string |
Copilot uses AI. Check for mistakes.
|
Caution Review failedFailed to post review comments. Configuration used: CodeRabbit UI 📒 Files selected for processing (20)
💤 Files with no reviewable changes (2)
🧰 Additional context used🪛 LanguageToolsource/_integrations/zooz.markdown[grammar] ~16-~16: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~18-~18: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) source/_integrations/qbus.markdown[grammar] ~55-~55: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) source/_integrations/kostal_plenticore.markdown[style] ~33-~33: To form a complete sentence, be sure to include a subject. (MISSING_IT_THERE) [grammar] ~33-~33: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~34-~34: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~35-~35: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~36-~36: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~38-~38: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~40-~40: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~173-~173: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~177-~177: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~197-~197: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~201-~201: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) source/_docs/z-wave/controllers.markdown[grammar] ~9-~9: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~11-~11: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~13-~13: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~15-~15: Know when to use “that” and “which” (QB_NEW_EN_OTHER_ERROR_IDS_3) [grammar] ~15-~15: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~47-~47: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~49-~49: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~51-~51: Use colons correctly (QB_NEW_EN_OTHER_ERROR_IDS_30) [grammar] ~57-~57: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~59-~59: Use colons correctly (QB_NEW_EN_OTHER_ERROR_IDS_30) [grammar] ~69-~69: Use colons correctly (QB_NEW_EN_OTHER_ERROR_IDS_30) [grammar] ~71-~71: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~74-~74: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~79-~79: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~81-~81: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~83-~83: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~87-~87: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~88-~88: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~90-~90: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~92-~92: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~94-~94: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~96-~96: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~96-~96: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) source/_integrations/pi_hole.markdown[grammar] ~27-~27: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~29-~29: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~36-~36: Use a comma after introductory words or phrases (QB_NEW_EN_OTHER_ERROR_IDS_19) [grammar] ~38-~38: Use articles correctly (QB_NEW_EN_OTHER_ERROR_IDS_11) [grammar] ~39-~39: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~41-~41: Add a comma (QB_NEW_EN_OTHER_ERROR_IDS_22) [grammar] ~41-~41: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~43-~43: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~45-~45: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~45-~45: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~58-~58: Use proper spacing conventions. (QB_NEW_EN_OTHER_ERROR_IDS_000007) source/_integrations/nordpool.markdown[grammar] ~167-~167: Use articles correctly (QB_NEW_EN_OTHER_ERROR_IDS_11) [grammar] ~169-~169: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~171-~171: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~171-~171: Use a comma after introductory words or phrases (QB_NEW_EN_OTHER_ERROR_IDS_19) [grammar] ~171-~171: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~179-~179: Use a comma after introductory words or phrases (QB_NEW_EN_OTHER_ERROR_IDS_19) [grammar] ~184-~184: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~186-~186: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~188-~188: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~190-~190: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~192-~192: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~194-~194: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~198-~198: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~200-~200: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~202-~202: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~215-~215: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) source/_docs/blueprint/selectors.markdown[grammar] ~1147-~1147: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) source/_integrations/russound_rio.markdown[grammar] ~71-~71: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~73-~73: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~77-~77: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~77-~77: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~88-~88: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~100-~100: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) source/_docs/automation/trigger.markdown[grammar] ~828-~828: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~830-~830: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~834-~834: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~836-~836: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~838-~838: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~852-~852: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~854-~854: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~871-~871: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~873-~873: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~901-~901: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~903-~903: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) source/_integrations/playstation_network.markdown[grammar] ~66-~66: Use commas correctly (QB_NEW_EN_OTHER_ERROR_IDS_33) [grammar] ~70-~70: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~72-~72: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~74-~74: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) source/_integrations/ai_task.markdown[grammar] ~14-~14: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~16-~16: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~18-~18: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~20-~20: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~22-~22: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~26-~26: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~30-~30: There might be a mistake here. (QB_NEW_EN_OTHER) [grammar] ~30-~30: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~31-~31: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~32-~32: Use the right pronoun (QB_NEW_EN_OTHER_ERROR_IDS_9) [grammar] ~32-~32: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~34-~34: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~36-~36: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~39-~39: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~43-~43: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~45-~45: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~90-~90: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~92-~92: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~94-~94: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) source/_integrations/compensation.markdown[grammar] ~57-~57: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~70-~70: Use apostrophes correctly (QB_NEW_EN_OTHER_ERROR_IDS_17) source/_integrations/yalexs_ble.markdown[grammar] ~54-~54: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~56-~56: There might be a problem here. (QB_NEW_EN_MERGED_MATCH) [grammar] ~84-~84: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~86-~86: Add a comma (QB_NEW_EN_OTHER_ERROR_IDS_22) [grammar] ~86-~86: Add a comma (QB_NEW_EN_OTHER_ERROR_IDS_22) [grammar] ~86-~86: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~88-~88: Use hyphens correctly (QB_NEW_EN_OTHER_ERROR_IDS_29) [grammar] ~88-~88: Correctly pair commas and coordinating conjunctions (QB_NEW_EN_OTHER_ERROR_IDS_14) [grammar] ~88-~88: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) [grammar] ~113-~113: Use correct spacing (QB_NEW_EN_OTHER_ERROR_IDS_5) 🪛 markdownlint-cli2 (0.17.2)source/_integrations/yalexs_ble.markdown113-113: Trailing spaces (MD009, no-trailing-spaces) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
🔇 Additional comments (3)
📝 WalkthroughWalkthroughThis update primarily enhances and clarifies documentation across various Home Assistant integrations and features. Key changes include new documentation for the AI Task and Zooz integrations, expanded configuration and entity descriptions for multiple integrations, terminology updates (e.g., "controller" to "adapter" in Z-Wave docs), and improved explanations or examples for automation triggers, selectors, and integration-specific actions. No code or logic changes are introduced. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant AI_Task_Integration
User->>HomeAssistant: Call ai_task.generate_data (with task_name, instructions, etc.)
HomeAssistant->>AI_Task_Integration: Process generate_data request
AI_Task_Integration-->>HomeAssistant: Return generated data and conversation_id
HomeAssistant-->>User: Provide generated data in response
sequenceDiagram
participant User
participant HomeAssistant
participant NordPoolIntegration
User->>HomeAssistant: Request price indices for date (with optional params)
HomeAssistant->>NordPoolIntegration: Fetch price indices for specified date
NordPoolIntegration-->>HomeAssistant: Return price indices
HomeAssistant-->>User: Provide price indices
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 (
|
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Enhancements
Bug Fixes / Clarifications
Chores