Documentation update, updated Blueprint and helpers, Dashboard yaml added#1
Open
petr-bartusek wants to merge 7 commits intojhron:mainfrom
Open
Documentation update, updated Blueprint and helpers, Dashboard yaml added#1petr-bartusek wants to merge 7 commits intojhron:mainfrom
petr-bartusek wants to merge 7 commits intojhron:mainfrom
Conversation
Documentation update part 1
Small updates
Helpers updated
There was a problem hiding this comment.
Pull Request Overview
This PR refactors entity naming for consistency and adds comprehensive documentation with a dashboard configuration for the VW Camping Mode Blueprint for Home Assistant.
- Renamed input parameters for better clarity (
start_time→camping_start_time,end_time→camping_end_time,delay_minutes→restart_delay,delay_timer→camping_delay_timer) - Added detailed installation guide with helper entity creation instructions
- Introduced a pre-configured Home Assistant dashboard for the camping mode UI
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 13 comments.
| File | Description |
|---|---|
| blueprint.yaml | Refactored input parameter names for consistency and clarity across time settings, delay configuration, and timer entities |
| README.md | Expanded documentation with installation overview, requirements, detailed helper entity creation steps, and dashboard setup instructions |
| dashboard.yaml | Added new Lovelace dashboard configuration with two entity cards displaying camping mode controls and settings with custom styling |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Icon: mdi:timer | ||
| - Co chcete zadat: 0:00:00 | ||
|
|
||
| ### Option 2: Create helpers from YAML Configurations |
There was a problem hiding this comment.
Incomplete documentation: The section title references "Option 2" but should be "Step 2 - Option 2" to maintain consistency with "Step 2 - Option 1" on line 40.
Suggested change
| ### Option 2: Create helpers from YAML Configurations | |
| ### Step 2 - Option 2: Create helpers from YAML Configurations |
Comment on lines
+27
to
+28
| 1. Manually create required HA helper entities (TODO: Link lower to chapter). | ||
| 1. Import of HA Blueprint for Camping mode UI (TODO: Link lower to chapter). |
There was a problem hiding this comment.
Incomplete documentation: Lines contain placeholder TODO comments that should be removed or completed before merging.
Suggested change
| 1. Manually create required HA helper entities (TODO: Link lower to chapter). | |
| 1. Import of HA Blueprint for Camping mode UI (TODO: Link lower to chapter). | |
| 1. Manually create required HA helper entities ([see below](#-creation-of-helper-entities)). | |
| 1. Import the HA Blueprint for Camping mode UI ([see below](#importing-the-blueprint)). |
Comment on lines
+19
to
+22
| - Home Assistant instalation supporting Add-ons innstalation [HA Documentation](https://www.home-assistant.io/installation/). | ||
| - Home Assistant 2024.6.0 or newer. | ||
|
|
||
| ## Instalation Overview |
There was a problem hiding this comment.
Spelling error: "Instalation" should be "Installation".
Suggested change
| - Home Assistant instalation supporting Add-ons innstalation [HA Documentation](https://www.home-assistant.io/installation/). | |
| - Home Assistant 2024.6.0 or newer. | |
| ## Instalation Overview | |
| - Home Assistant installation supporting Add-ons installation [HA Documentation](https://www.home-assistant.io/installation/). | |
| - Home Assistant 2024.6.0 or newer. | |
| ## Installation Overview |
Comment on lines
+64
to
+83
| - Type: Číslo | ||
| - Name: Battery Limit | ||
| - Icon: mdi:battery-50 | ||
| - Minimální hodnota: 20 | ||
| - Maximální hodnota: 80 | ||
| - Velikost kroku: 5 | ||
| - Měrná jednotka: % | ||
| 7. xxx | ||
| - Type: Číslo | ||
| - Name: xxx | ||
| - Icon: mdi:timer | ||
| - Minimální hodnota: 15 | ||
| - Maximální hodnota: 120 | ||
| - Velikost kroku: 15 | ||
| - Měrná jednotka: min | ||
| 8. Camping Delay Timer | ||
| - Type: Časovač | ||
| - Name: Camping Delay Timer | ||
| - Icon: mdi:timer | ||
| - Co chcete zadat: 0:00:00 |
There was a problem hiding this comment.
Incomplete documentation: This section contains non-English placeholder text ("Číslo", "Minimální hodnota", "Maximální hodnota", "Velikost kroku", "Měrná jednotka") and should be translated to English for consistency.
Suggested change
| - Type: Číslo | |
| - Name: Battery Limit | |
| - Icon: mdi:battery-50 | |
| - Minimální hodnota: 20 | |
| - Maximální hodnota: 80 | |
| - Velikost kroku: 5 | |
| - Měrná jednotka: % | |
| 7. xxx | |
| - Type: Číslo | |
| - Name: xxx | |
| - Icon: mdi:timer | |
| - Minimální hodnota: 15 | |
| - Maximální hodnota: 120 | |
| - Velikost kroku: 15 | |
| - Měrná jednotka: min | |
| 8. Camping Delay Timer | |
| - Type: Časovač | |
| - Name: Camping Delay Timer | |
| - Icon: mdi:timer | |
| - Co chcete zadat: 0:00:00 | |
| - Type: Number | |
| - Name: Battery Limit | |
| - Icon: mdi:battery-50 | |
| - Minimum value: 20 | |
| - Maximum value: 80 | |
| - Step size: 5 | |
| - Unit of measurement: % | |
| 7. xxx | |
| - Type: Number | |
| - Name: xxx | |
| - Icon: mdi:timer | |
| - Minimum value: 15 | |
| - Maximum value: 120 | |
| - Step size: 15 | |
| - Unit of measurement: min | |
| 8. Camping Delay Timer | |
| - Type: Timer | |
| - Name: Camping Delay Timer | |
| - Icon: mdi:timer | |
| - Input: 0:00:00 |
Comment on lines
+71
to
+78
| 7. xxx | ||
| - Type: Číslo | ||
| - Name: xxx | ||
| - Icon: mdi:timer | ||
| - Minimální hodnota: 15 | ||
| - Maximální hodnota: 120 | ||
| - Velikost kroku: 15 | ||
| - Měrná jednotka: min |
There was a problem hiding this comment.
Incomplete documentation: The helper item 7 is missing its name (shown as "xxx") and contains non-English placeholder text ("Číslo", "Minimální hodnota", "Maximální hodnota", "Velikost kroku", "Měrná jednotka"). Based on the context and the YAML configuration section showing "restart_delay", this should be named "Restart Delay".
Suggested change
| 7. xxx | |
| - Type: Číslo | |
| - Name: xxx | |
| - Icon: mdi:timer | |
| - Minimální hodnota: 15 | |
| - Maximální hodnota: 120 | |
| - Velikost kroku: 15 | |
| - Měrná jednotka: min | |
| 7. Restart Delay | |
| - Type: Number | |
| - Name: Restart Delay | |
| - Icon: mdi:timer | |
| - Minimum value: 15 | |
| - Maximum value: 120 | |
| - Step size: 15 | |
| - Unit of measurement: min |
| - Supported VW Car (ID.Buzz, ID.3, ID.4, ID.5, ID.7 with ID Software 3.X or newer are supported, but for other models as Passat, Golf, e-Golf, Tiguan, etc. it could be work as well). | ||
| - Created [MyVolkswagen/Wolkswagen ID account](https://www.myvolkswagen.net/cz/cs/myvolkswagen.html) and activated [VW Connect service](https://www.volkswagen.cz/technologie/konektivita/vw-connect) in your car. | ||
| - Created [GitHub Account](https://github.com/) (required by HACS). | ||
| - Home Assistant instalation supporting Add-ons innstalation [HA Documentation](https://www.home-assistant.io/installation/). |
There was a problem hiding this comment.
Spelling error: "innstalation" should be "installation".
Suggested change
| - Home Assistant instalation supporting Add-ons innstalation [HA Documentation](https://www.home-assistant.io/installation/). | |
| - Home Assistant installation supporting Add-ons installation [HA Documentation](https://www.home-assistant.io/installation/). |
| ## 🔧 Creation of Helper Entities | ||
|
|
||
| ### Step 1: Navigate to HA helpers entities page | ||
| Pres button below to be redirected to your HA instance |
There was a problem hiding this comment.
Typo: "Pres" should be "Press".
Suggested change
| Pres button below to be redirected to your HA instance | |
| Press button below to be redirected to your HA instance |
Comment on lines
+44
to
+50
| - Type: Datum a/nebo čas (Need EN name) | ||
| - Name: Camping Start Time | ||
| - Co chcete zadat: Čas (Need EN name) | ||
| 2. Camping End Time | ||
| - Type: Datum a/nebo čas (Need EN name) | ||
| - Name: Camping End Time | ||
| - Co chcete zadat: Čas (Need EN name) |
There was a problem hiding this comment.
Incomplete documentation: This section contains non-English placeholder text ("Datum a/nebo čas", "Co chcete zadat", "Čas") and should be translated to English for consistency with the rest of the documentation.
Suggested change
| - Type: Datum a/nebo čas (Need EN name) | |
| - Name: Camping Start Time | |
| - Co chcete zadat: Čas (Need EN name) | |
| 2. Camping End Time | |
| - Type: Datum a/nebo čas (Need EN name) | |
| - Name: Camping End Time | |
| - Co chcete zadat: Čas (Need EN name) | |
| - Type: Date and/or Time | |
| - Name: Camping Start Time | |
| - Input type: Time | |
| 2. Camping End Time | |
| - Type: Date and/or Time | |
| - Name: Camping End Time | |
| - Input type: Time |
Comment on lines
+44
to
+83
| - Type: Datum a/nebo čas (Need EN name) | ||
| - Name: Camping Start Time | ||
| - Co chcete zadat: Čas (Need EN name) | ||
| 2. Camping End Time | ||
| - Type: Datum a/nebo čas (Need EN name) | ||
| - Name: Camping End Time | ||
| - Co chcete zadat: Čas (Need EN name) | ||
| 3. Auto Camping Mode | ||
| - Type: Přepínač | ||
| - Name: Auto Camping Mode | ||
| - Icon: mdi:air-conditioner | ||
| 4. Auto Start Mode | ||
| - Type: Přepínač | ||
| - Name: Auto Camping Mode | ||
| - Icon: mdi:clock-start | ||
| 5. Auto End Mode | ||
| - Type: Přepínač | ||
| - Name: Auto End Mode | ||
| - Icon: mdi:clock-end | ||
| 6. Battery Limit | ||
| - Type: Číslo | ||
| - Name: Battery Limit | ||
| - Icon: mdi:battery-50 | ||
| - Minimální hodnota: 20 | ||
| - Maximální hodnota: 80 | ||
| - Velikost kroku: 5 | ||
| - Měrná jednotka: % | ||
| 7. xxx | ||
| - Type: Číslo | ||
| - Name: xxx | ||
| - Icon: mdi:timer | ||
| - Minimální hodnota: 15 | ||
| - Maximální hodnota: 120 | ||
| - Velikost kroku: 15 | ||
| - Měrná jednotka: min | ||
| 8. Camping Delay Timer | ||
| - Type: Časovač | ||
| - Name: Camping Delay Timer | ||
| - Icon: mdi:timer | ||
| - Co chcete zadat: 0:00:00 |
There was a problem hiding this comment.
Incomplete documentation: This section contains non-English placeholder text ("Přepínač") and should be translated to English for consistency.
Suggested change
| - Type: Datum a/nebo čas (Need EN name) | |
| - Name: Camping Start Time | |
| - Co chcete zadat: Čas (Need EN name) | |
| 2. Camping End Time | |
| - Type: Datum a/nebo čas (Need EN name) | |
| - Name: Camping End Time | |
| - Co chcete zadat: Čas (Need EN name) | |
| 3. Auto Camping Mode | |
| - Type: Přepínač | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:air-conditioner | |
| 4. Auto Start Mode | |
| - Type: Přepínač | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:clock-start | |
| 5. Auto End Mode | |
| - Type: Přepínač | |
| - Name: Auto End Mode | |
| - Icon: mdi:clock-end | |
| 6. Battery Limit | |
| - Type: Číslo | |
| - Name: Battery Limit | |
| - Icon: mdi:battery-50 | |
| - Minimální hodnota: 20 | |
| - Maximální hodnota: 80 | |
| - Velikost kroku: 5 | |
| - Měrná jednotka: % | |
| 7. xxx | |
| - Type: Číslo | |
| - Name: xxx | |
| - Icon: mdi:timer | |
| - Minimální hodnota: 15 | |
| - Maximální hodnota: 120 | |
| - Velikost kroku: 15 | |
| - Měrná jednotka: min | |
| 8. Camping Delay Timer | |
| - Type: Časovač | |
| - Name: Camping Delay Timer | |
| - Icon: mdi:timer | |
| - Co chcete zadat: 0:00:00 | |
| - Type: Date and/or time | |
| - Name: Camping Start Time | |
| - Input type: Time | |
| 2. Camping End Time | |
| - Type: Date and/or time | |
| - Name: Camping End Time | |
| - Input type: Time | |
| 3. Auto Camping Mode | |
| - Type: Switch | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:air-conditioner | |
| 4. Auto Start Mode | |
| - Type: Switch | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:clock-start | |
| 5. Auto End Mode | |
| - Type: Switch | |
| - Name: Auto End Mode | |
| - Icon: mdi:clock-end | |
| 6. Battery Limit | |
| - Type: Number | |
| - Name: Battery Limit | |
| - Icon: mdi:battery-50 | |
| - Minimum value: 20 | |
| - Maximum value: 80 | |
| - Step size: 5 | |
| - Unit of measurement: % | |
| 7. xxx | |
| - Type: Number | |
| - Name: xxx | |
| - Icon: mdi:timer | |
| - Minimum value: 15 | |
| - Maximum value: 120 | |
| - Step size: 15 | |
| - Unit of measurement: min | |
| 8. Camping Delay Timer | |
| - Type: Timer | |
| - Name: Camping Delay Timer | |
| - Icon: mdi:timer | |
| - Input value: 0:00:00 |
Comment on lines
+52
to
+83
| - Type: Přepínač | ||
| - Name: Auto Camping Mode | ||
| - Icon: mdi:air-conditioner | ||
| 4. Auto Start Mode | ||
| - Type: Přepínač | ||
| - Name: Auto Camping Mode | ||
| - Icon: mdi:clock-start | ||
| 5. Auto End Mode | ||
| - Type: Přepínač | ||
| - Name: Auto End Mode | ||
| - Icon: mdi:clock-end | ||
| 6. Battery Limit | ||
| - Type: Číslo | ||
| - Name: Battery Limit | ||
| - Icon: mdi:battery-50 | ||
| - Minimální hodnota: 20 | ||
| - Maximální hodnota: 80 | ||
| - Velikost kroku: 5 | ||
| - Měrná jednotka: % | ||
| 7. xxx | ||
| - Type: Číslo | ||
| - Name: xxx | ||
| - Icon: mdi:timer | ||
| - Minimální hodnota: 15 | ||
| - Maximální hodnota: 120 | ||
| - Velikost kroku: 15 | ||
| - Měrná jednotka: min | ||
| 8. Camping Delay Timer | ||
| - Type: Časovač | ||
| - Name: Camping Delay Timer | ||
| - Icon: mdi:timer | ||
| - Co chcete zadat: 0:00:00 |
There was a problem hiding this comment.
Incomplete documentation: This section contains non-English placeholder text ("Časovač", "Co chcete zadat") and should be translated to English for consistency.
Suggested change
| - Type: Přepínač | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:air-conditioner | |
| 4. Auto Start Mode | |
| - Type: Přepínač | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:clock-start | |
| 5. Auto End Mode | |
| - Type: Přepínač | |
| - Name: Auto End Mode | |
| - Icon: mdi:clock-end | |
| 6. Battery Limit | |
| - Type: Číslo | |
| - Name: Battery Limit | |
| - Icon: mdi:battery-50 | |
| - Minimální hodnota: 20 | |
| - Maximální hodnota: 80 | |
| - Velikost kroku: 5 | |
| - Měrná jednotka: % | |
| 7. xxx | |
| - Type: Číslo | |
| - Name: xxx | |
| - Icon: mdi:timer | |
| - Minimální hodnota: 15 | |
| - Maximální hodnota: 120 | |
| - Velikost kroku: 15 | |
| - Měrná jednotka: min | |
| 8. Camping Delay Timer | |
| - Type: Časovač | |
| - Name: Camping Delay Timer | |
| - Icon: mdi:timer | |
| - Co chcete zadat: 0:00:00 | |
| - Type: Switch | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:air-conditioner | |
| 4. Auto Start Mode | |
| - Type: Switch | |
| - Name: Auto Camping Mode | |
| - Icon: mdi:clock-start | |
| 5. Auto End Mode | |
| - Type: Switch | |
| - Name: Auto End Mode | |
| - Icon: mdi:clock-end | |
| 6. Battery Limit | |
| - Type: Number | |
| - Name: Battery Limit | |
| - Icon: mdi:battery-50 | |
| - Minimum value: 20 | |
| - Maximum value: 80 | |
| - Step size: 5 | |
| - Unit of measurement: % | |
| 7. xxx | |
| - Type: Number | |
| - Name: xxx | |
| - Icon: mdi:timer | |
| - Minimum value: 15 | |
| - Maximum value: 120 | |
| - Step size: 15 | |
| - Unit of measurement: min | |
| 8. Camping Delay Timer | |
| - Type: Timer | |
| - Name: Camping Delay Timer | |
| - Icon: mdi:timer | |
| - Initial value: 0:00:00 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Still need: