Reorder and apply config suggestions #36087
Conversation
home-assistant
bot
added
current
|
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 |
home-assistant
bot
added
the
needs-rebase
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
home-assistant
bot
removed
the
needs-rebase
|
@klaasnicolaas for reference, borrowed these from Reolink and Subaru :) |
|
@CoMPaTech then they will also have to be adjusted there 😉 ./Klaas |
I'll add a note 2 self to PR them tomorrow :) |
|
@klaasnicolaas just wondering if I miss something, but the preview generates no |
📝 WalkthroughWalkthroughThe pull request introduces significant updates to the Plugwise integration documentation. Notable additions include a new section on configuration prerequisites, detailing how to find the IP address of the Smile device, and a section on further configuration for managing thermostat schedules. The "Entities" section has been reorganized and expanded to clarify device representation. Additionally, practical examples for various actions, including YAML script examples for controlling devices, have been included to enhance clarity and usability for users. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant PlugwiseApp
participant PlugwiseIntegration
participant Device
User->>PlugwiseApp: Find IP address of Smile device
PlugwiseApp-->>User: Provide IP address
User->>PlugwiseIntegration: Configure integration with IP, Username, Password
PlugwiseIntegration-->>Device: Setup connection
User->>PlugwiseIntegration: Manage thermostat schedules
PlugwiseIntegration-->>Device: Update schedules
User->>PlugwiseIntegration: Execute actions (e.g., reboot)
PlugwiseIntegration-->>Device: Perform actions
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: 0
🧹 Outside diff range and nitpick comments (3)
source/_integrations/plugwise.markdown (3)
52-63: Fix minor grammatical and formatting issuesPlease address the following:
- Line 52: "it's password" should be "its password" (possessive form)
- Line 58: Fix the extra space in "Network **"
-The Plugwise Smile(s) present in your network will be automatically detected via Zeroconf discovery and will be shown on the Integrations-page. All you need is the Smile ID as it's password +The Plugwise Smile(s) present in your network will be automatically detected via Zeroconf discovery and will be shown on the Integrations-page. All you need is the Smile ID as its password🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...(ITS_PREMIUM)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...et up Plugwise when a Smile is not auto-discovered you can use this My Button: {% include...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~58-~58: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...(RB_LY_COMMA)
[uncategorized] ~58-~58: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...(COMMA_COMPOUND_SENTENCE)
🪛 Markdownlint (0.35.0)
58-58: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
67-71: Consider improving the formatting of the schedule management sectionThe content is accurate and helpful, but could be more readable with bullet points or a structured list.
Consider restructuring like this:
-For a thermostat, the active schedule can be deactivated or reactivated via the climate card. Please note, that when no schedule is active, one must first be activated in the Plugwise App. Once that has been done the Plugwise Integration can manage future operations. - -Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options. +For thermostat schedule management: + +* The active schedule can be deactivated or reactivated via the climate card +* When no schedule is active, you must first activate one in the Plugwise App +* Once activated, the Plugwise Integration can manage future operations + +Schedule modes: +* Auto: Schedule is active +* Heat: Schedule is not active + +{% note %} +Only schedules with two or more schedule points will be shown as select options. +{% endnote %}🧰 Tools
🪛 LanguageTool
[uncategorized] ~69-~69: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~70-~70: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
Line range hint
82-249: LGTM! Comprehensive action documentation with clear examples.The examples are well-structured and provide clear guidance for users. Consider adding a brief description of expected behavior or response for each action example to make it even more helpful.
For example:
script: force_adam_update: sequence: - action: homeassistant.update_entity target: entity_id: climate.anna +# Expected result: The Smile data will be immediately refreshed🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...(ITS_PREMIUM)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...et up Plugwise when a Smile is not auto-discovered you can use this My Button: {% include...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~58-~58: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...(RB_LY_COMMA)
[uncategorized] ~58-~58: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~65-~65: Possible missing comma found.
Context: ....e., if you have an Adam setup and a P1 DSMR you'll have to add two integrations). ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~69-~69: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~70-~70: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
58-58: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...
(ITS_PREMIUM)
[uncategorized] ~52-~52: Possible missing comma found.
Context: ...et up Plugwise when a Smile is not auto-discovered you can use this My Button: {% include...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~58-~58: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...
(RB_LY_COMMA)
[uncategorized] ~58-~58: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~65-~65: Possible missing comma found.
Context: ....e., if you have an Adam setup and a P1 DSMR you'll have to add two integrations). ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~69-~69: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~70-~70: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
source/_integrations/plugwise.markdown
58-58: null
Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
🔇 Additional comments (2)
source/_integrations/plugwise.markdown (2)
46-50: LGTM! Clear and important setup guidance.
The warning about Anna and Adam integration configuration is well-placed and crucial for proper setup.
73-80: LGTM! Clear and comprehensive entity documentation.
The section provides excellent clarity on how different Plugwise devices are represented as entities in Home Assistant.
|
You might want to put that sentence above the
Not really necessary, currently going through all integrations to get this right at once. ./Klaas |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
source/_integrations/plugwise.markdown (2)
52-52: Fix grammatical errorChange "it's password" to "its password" as this is the possessive form.
-The Plugwise Smile(s) present in your network will be automatically discovered via Zeroconf discovery and will be shown on the Integrations-page. All you need is the Smile ID as it's password, which is an 8 character string printed on the sticker on the bottom of you Smile. +The Plugwise Smile(s) present in your network will be automatically discovered via Zeroconf discovery and will be shown on the Integrations-page. All you need is the Smile ID as its password, which is an 8 character string printed on the sticker on the bottom of your Smile.🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...(ITS_PREMIUM)
69-74: Consider restructuring for better clarityThe information about thermostat scheduling is valuable but could be more structured. Consider:
- Separating the Auto/Heat mode explanation into a bulleted list
- Adding a note about the minimum requirement of "two or more schedule points" earlier in the section
### Further configuration For a thermostat, the active schedule can be deactivated or reactivated via the climate card. Please note, that when no schedule is active, one must first be activated in the Plugwise App. Once that has been done the Plugwise Integration can manage future operations. -Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options. +The thermostat has two main modes: +- **Auto**: Schedule is active +- **Heat**: Schedule is not active + +The active thermostat schedule can be changed via the connected thermostat select-entity. Important: Only schedules with two or more schedule points will be available as options.🧰 Tools
🪛 LanguageTool
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...
(ITS_PREMIUM)
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...
(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~67-~67: Possible missing comma found.
Context: ....e., if you have an Adam setup and a P1 DSMR you'll have to add two integrations). ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
source/_integrations/plugwise.markdown
60-60: null
Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
🔇 Additional comments (4)
source/_integrations/plugwise.markdown (4)
46-50: LGTM! Well-structured warning section
The warning about Anna and Adam configuration is clear, properly formatted, and strategically placed at the beginning of the documentation.
58-65: LGTM! Clear configuration instructions
The configuration template is well-structured with clear descriptions for each field. The instructions for finding the IP address are particularly helpful.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...
(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...
(COMMA_COMPOUND_SENTENCE)
🪛 Markdownlint (0.35.0)
60-60: null
Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
75-82: LGTM! Clear and comprehensive entities documentation
The entities section effectively explains:
- Device discovery and representation
- Entity organization and hierarchy
- Assignment of measurements to specific entities
The examples of different setups (Adam with Lisa/Tom) make the concepts more tangible for users.
Line range hint 83-282: LGTM! Excellent action documentation
The Actions section is comprehensive and well-structured:
- Clear YAML examples for each action
- Detailed explanations of HVAC modes and their implications
- Proper formatting of code blocks
- Complete coverage of all available actions
This will be very helpful for users implementing automation with Plugwise devices.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...
(ITS_PREMIUM)
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...
(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~67-~67: Possible missing comma found.
Context: ....e., if you have an Adam setup and a P1 DSMR you'll have to add two integrations). ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
60-60: null
Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
source/_integrations/plugwise.markdown (4)
52-52: Fix grammatical error: "it's" should be "its"The possessive form should be "its" rather than "it's" (which means "it is").
-The Plugwise Smile(s) present in your network will be automatically discovered via Zeroconf discovery and will be shown on the Integrations-page. All you need is the Smile ID as it's password, which is an 8 character string printed on the sticker on the bottom of you Smile. +The Plugwise Smile(s) present in your network will be automatically discovered via Zeroconf discovery and will be shown on the Integrations-page. All you need is the Smile ID as its password, which is an 8 character string printed on the sticker on the bottom of your Smile.🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...(ITS_PREMIUM)
60-60: Fix formatting in Network sectionRemove the extra space after "Network" in the description.
- description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (☰) -> **System** -> **Network **. If you are looking for a different device in the Plugwise App, on the main screen first select **Gateways** -> the Smile of your choice, and then follow the previous instruction. Normally the Smile(s) are automatically discovered and you don't have to provide the hostname or IP address." + description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (☰) -> **System** -> **Network**. If you are looking for a different device in the Plugwise App, on the main screen first select **Gateways** -> the Smile of your choice, and then follow the previous instruction. Normally the Smile(s) are automatically discovered and you don't have to provide the hostname or IP address."🧰 Tools
🪛 LanguageTool
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...(COMMA_COMPOUND_SENTENCE)
🪛 Markdownlint (0.35.0)
60-60: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
72-73: Improve clarity of UI mode descriptionsConsider making the mode descriptions more precise and consistent with the UI.
-Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. +The "Auto" mode indicates that a schedule is active, while "Heat" mode indicates manual control (no active schedule). You can change the active thermostat schedule through the thermostat's select entity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
Line range hint
89-93: Consider more descriptive and consistent script namesThe script names could be more descriptive and follow a consistent pattern.
For example:
- force_adam_update: + plugwise_force_smile_update: - reboot_gateway: + plugwise_reboot_gateway: - lisa_reactivate_last_schedule: + plugwise_lisa_activate_schedule: - lisa_change_schedule: + plugwise_lisa_set_schedule: - change_max_boiler_tempeture_setpoint: + plugwise_set_max_boiler_temperature: - anna_set_predefined_temperature: + plugwise_anna_set_temperature: - anna_activate_preset_asleep: + plugwise_anna_set_preset_asleep:This naming convention:
- Adds the integration name as a prefix
- Uses consistent verbs (set, activate)
- Provides clearer descriptions of the action
Also applies to: 134-138, 147-151, 160-164, 173-177, 186-190, 199-203
🧰 Tools
🪛 LanguageTool
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...(ITS_PREMIUM)
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
60-60: null
Spaces inside emphasis markers(MD037, no-space-in-emphasis)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[uncategorized] ~52-~52: Did you mean “its” (the possessive pronoun)?
Context: ...s-page. All you need is the Smile ID as it's password, which is an 8 character strin...
(ITS_PREMIUM)
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...
(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
source/_integrations/plugwise.markdown
60-60: null
Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
🔇 Additional comments (2)
source/_integrations/plugwise.markdown (2)
48-50: LGTM! Clear and important warning.
The warning effectively prevents users from misconfiguring their setup when they have both Anna and Adam devices.
77-82: LGTM! Clear entity descriptions.
The section effectively explains the entity structure and provides good examples of what users should expect to see in their Home Assistant instance.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
source/_integrations/plugwise.markdown (3)
52-52: Improve readability with proper punctuationConsider restructuring the sentence for better clarity.
-The Plugwise Smile(s) present in your network will be automatically discovered via Zeroconf discovery and will be shown on the Integrations-page. All you need is the Smile ID as its password, which is an 8 character string printed on the sticker on the bottom of you Smile. Repeat this for each individual Smile. +The Plugwise Smile(s) present in your network will be automatically discovered via Zeroconf discovery and will be shown on the Integrations page. All you need is the Smile ID as its password, which is an 8-character string printed on the sticker on the bottom of your Smile. Repeat this for each individual Smile.
60-60: Improve sentence structure with proper punctuationAdd appropriate commas for better readability.
- description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (☰) -> **System** -> **Network**. If you are looking for a different device in the Plugwise App, on the main screen first select **Gateways** -> the Smile of your choice, and then follow the previous instruction. Normally the Smile(s) are automatically discovered and you don't have to provide the hostname or IP address." + description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (☰) -> **System** -> **Network**. If you are looking for a different device in the Plugwise App, on the main screen first select **Gateways** -> the Smile of your choice, and then follow the previous instruction. Normally, the Smile(s) are automatically discovered, and you don't have to provide the hostname or IP address."🧰 Tools
🪛 LanguageTool
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...(COMMA_COMPOUND_SENTENCE)
71-73: Improve formatting and clarity of mode descriptionsFormat technical terms as code and clarify the mode descriptions.
-Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options. +`Auto` means the schedule is active, while `Heat` means it's not active. The active thermostat schedule can be changed via the connected thermostat select entity. Please note that only schedules with two or more schedule points will be shown as select options.🧰 Tools
🪛 LanguageTool
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...
(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🔇 Additional comments (2)
source/_integrations/plugwise.markdown (2)
77-81: LGTM! Clear and comprehensive entity documentation
The entities section provides a clear explanation of how different Plugwise devices are represented in Home Assistant, with good examples and proper organization of information.
Line range hint 84-269: LGTM! Well-documented actions with clear examples
The actions section provides comprehensive documentation with clear YAML examples for each operation. The examples follow best practices and include helpful comments.
🧰 Tools
🪛 LanguageTool
[typographical] ~60-~60: Consider adding a comma after ‘Normally’ for more clarity.
Context: ...d then follow the previous instruction. Normally the Smile(s) are automatically discover...
(RB_LY_COMMA)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he Smile(s) are automatically discovered and you don't have to provide the hostname ...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
CoMPaTech
force-pushed
the
plugwise-quality2
branch
from
0a55e91
to
8a8d87d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
source/_integrations/plugwise.markdown (2)
58-65: Add missing commas in configuration descriptions.The configuration descriptions are clear but could benefit from some minor grammatical improvements.
Apply these changes:
description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (☰) -> **System** -> **Network**. If you are looking for a different device in the Plugwise App, on the main screen first select **Gateways** -> the Smile of your choice, and then follow the previous instruction. Normally, the Smile(s) are automatically discovered, and you don't have to provide the hostname or IP address." - description: "Username to log in to the Smile. This should be just 'smile' - or 'stretch' for a Stretch'." + description: "Username to log in to the Smile. This should be just 'smile', or 'stretch' for a Stretch."
69-73: Improve clarity of thermostat configuration section.The section about thermostat configuration could be clearer with better formatting and terminology.
Consider restructuring as follows:
### Further configuration -For a thermostat, the active schedule can be deactivated or reactivated via the climate card. Please note, that when no schedule is active, one must first be activated in the Plugwise App. Once that has been done the Plugwise Integration can manage future operations. +For a thermostat, the active schedule can be deactivated or reactivated via the climate card. Please note that when no schedule is active, one must first be activated in the Plugwise App. Once that has been done, the Plugwise Integration can manage future operations. -Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options. +- **Auto**: Schedule is active +- **Heat**: Schedule is not active + +The active thermostat schedule can be changed via the connected thermostat select-entity. Note: Only schedules with two or more schedule points will be shown as select options.🧰 Tools
🪛 LanguageTool
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[uncategorized] ~67-~67: Possible missing comma found.
Context: ....e., if you have an Adam setup and a P1 DSMR you'll have to add two integrations). ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🔇 Additional comments (3)
source/_integrations/plugwise.markdown (3)
48-50: LGTM! Critical warning about Anna and Adam configuration.
The warning about not configuring Anna when Adam is present is crucial for preventing integration conflicts.
75-82: LGTM! Clear explanation of entity hierarchy.
The entities section effectively explains how different Plugwise devices are represented in Home Assistant and their relationships.
Line range hint 84-256: LGTM! Comprehensive action examples with clear documentation.
The actions section provides well-structured YAML examples with clear explanations for each operation. The examples cover all major functionality and follow consistent formatting.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~67-~67: Possible missing comma found.
Context: ....e., if you have an Adam setup and a P1 DSMR you'll have to add two integrations). ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
|
Co-authored-by: Klaas Schoute <[email protected]>
Co-authored-by: Klaas Schoute <[email protected]>
Co-authored-by: Klaas Schoute <[email protected]>
CoMPaTech
force-pushed
the
plugwise-quality2
branch
from
8a8d87d
to
22bfdfd
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
source/_integrations/plugwise.markdown (4)
60-60: Minor grammar improvements neededAdd commas for better readability:
- Line 60: "...in the Plugwise App, on the main screen first select..."
- Line 71: "...in the Plugwise App. Once that has been done, the Plugwise Integration..."
Also applies to: 71-71
🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
71-73: Enhance clarity of thermostat modesConsider restructuring the mode descriptions for better clarity:
-Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options. +The thermostat has two main modes: +- `Auto`: Schedule is active +- `Heat`: Schedule is not active + +The active thermostat schedule can be changed via the connected thermostat select-entity. Note: Only schedules with two or more schedule points will be shown as select options.🧰 Tools
🪛 LanguageTool
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
Line range hint
156-162: Consider enhancing YAML examples with outcome descriptionsThe script examples would be more helpful with comments explaining the expected outcomes. For example:
# Example script change the temperature script: force_adam_update: + # Forces an immediate data update from the Smile gateway + # Useful when you need the latest state without waiting for the normal refresh interval sequence: - action: homeassistant.update_entity target: entity_id: climate.anna🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
Line range hint
284-287: Consider highlighting Elga cooling mode instructionsThe important instruction about reloading the integration after changing Elga's cooling mode could be more prominent. Consider using the
{% important %}block:-On the Elga, the cooling-mode can only be turned on, or off, via a switch present on the device, not via a toggle in the Plugwise App. -Please make sure to reload the Plugwise integration after the cooling-mode-switch is turned off after being on, or the other way around. This will ensure that the Plugwise integration is being adapted to the change in function of the Elga. +{% important %} +On the Elga, the cooling-mode can only be turned on/off via a physical switch on the device, not via the Plugwise App. +After changing the cooling-mode switch position, you must reload the Plugwise integration to ensure proper functionality. +{% endimportant %}🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🔇 Additional comments (2)
source/_integrations/plugwise.markdown (2)
48-50: LGTM! Clear and important warning about device configuration.
The warning about configuring only Adam when both Anna and Adam are present is crucial for preventing integration issues.
Line range hint 75-83: LGTM! Clear and comprehensive entity documentation.
The section effectively explains how different Plugwise entities are represented in Home Assistant, with good examples for various device configurations.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: A comma might be missing here.
Context: ...device in the Plugwise App, on the main screen first select Gateways -> the Smile ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~71-~71: Possible missing comma found.
Context: ...in the Plugwise App. Once that has been done the Plugwise Integration can manage fut...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~72-~72: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
source/_integrations/plugwise.markdown (2)
69-71: Improve formatting and grammar in the schedule explanation.The explanation about schedule states could be clearer with better formatting and grammar:
-Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options. +`Auto` means the schedule is active, while `Heat` means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note that only schedules with two or more schedule points will be shown as select options.🧰 Tools
🪛 LanguageTool
[uncategorized] ~70-~70: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
Line range hint
272-284: Consider highlighting the Elga cooling mode instruction.The important instruction about reloading the integration after changing the Elga cooling mode switch could be more prominent.
-On the Elga, the cooling-mode can only be turned on, or off, via a switch present on the device, not via a toggle in the Plugwise App. -Please make sure to reload the Plugwise integration after the cooling-mode-switch is turned off after being on, or the other way around. This will ensure that the Plugwise integration is being adapted to the change in function of the Elga. +{% important %} +For Elga devices: +- The cooling mode can only be toggled via a physical switch on the device (not through the Plugwise App) +- After changing the cooling mode switch position, you must reload the Plugwise integration for the changes to take effect +{% endimportant %}🧰 Tools
🪛 LanguageTool
[uncategorized] ~70-~70: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[uncategorized] ~70-~70: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🔇 Additional comments (3)
source/_integrations/plugwise.markdown (3)
48-50: LGTM! Critical warning about Anna and Adam configuration.
The warning message effectively prevents users from creating duplicate configurations when both Anna and Adam devices are present.
56-63: LGTM! Clear and comprehensive configuration instructions.
The configuration template provides detailed descriptions for each field, including helpful instructions for locating the required information.
67-71: LGTM! Comprehensive action examples with clear documentation.
The YAML examples are well-structured and cover all major use cases with clear explanations.
Also applies to: 156-271
🧰 Tools
🪛 LanguageTool
[uncategorized] ~70-~70: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
source/_integrations/plugwise.markdown (2)
56-63: Improve readability of the host descriptionThe host description is comprehensive but could be more readable with bullet points.
Consider restructuring the host description like this:
Host: - description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it in your router or in the Plugwise app using the **Settings** icon (☰) -> **System** -> **Network**. If you are looking for a different device in the Plugwise App, on the main screen first select **Gateways** -> the Smile of your choice, and then follow the previous instruction. Normally, the Smile(s) are automatically discovered, and you don't have to provide the hostname or IP address." + description: "The hostname or IP address of your Smile. For example: `192.168.1.25`. You can find it: + - In your router + - In the Plugwise app: + 1. Using the **Settings** icon (☰) -> **System** -> **Network** + 2. For a different device: **Gateways** -> select Smile -> follow step 1 + + Note: Normally, the Smile(s) are automatically discovered, and you don't have to provide the hostname or IP address."
67-69: Improve formatting and fix hyphen in "Auto"The explanation about schedule management could be clearer with better formatting and a hyphen fix.
Consider this restructuring:
-For a thermostat, the active schedule can be deactivated or reactivated via the climate card. Please note, that when no schedule is active, one must first be activated in the Plugwise App. Once that has been done the Plugwise Integration can manage future operations. - -Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options. +For a thermostat: +- The active schedule can be deactivated or reactivated via the climate card +- When no schedule is active, one must first be activated in the Plugwise App +- Once activated, the Plugwise Integration can manage future operations + +Schedule states: +- "Auto" means the schedule is active +- "Heat" means it's not active + +The active thermostat schedule can be changed via the connected thermostat select-entity. +Note: Only schedules with two or more schedule points will be shown as select options.🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...(AUTO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/plugwise.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/plugwise.markdown
[uncategorized] ~68-~68: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🔇 Additional comments (2)
source/_integrations/plugwise.markdown (2)
48-50: LGTM! Critical warning for users with both Anna and Adam devices.
The warning message effectively prevents users from creating duplicate configurations.
Line range hint 71-371: LGTM! Well-structured documentation with clear examples.
The documentation provides comprehensive coverage of:
- Entity descriptions
- Data update intervals
- Integration removal process
- Action examples with YAML
- Supported devices and their versions
🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...egration can manage future operations. Auto means the schedule is active, Heat means it's...
(AUTO_HYPHEN)
🪛 Markdownlint (0.35.0)
43-43: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
44-44: Expected: 0; Actual: 1
Unordered list indentation
(MD007, ul-indent)
|
Cleaned up some with follow-ups prepared to further improve our quality-scale benchmarking Follow-up Core PR for: complete docs-installation-instructions and partially complete both docs-installation-parameters and docs-known-limitations |
|
Please be aware of the updates already merged into the |
Proposed change
Update (and re-order) configuration (and entities) section.
Re-work configuration section as per indications for #36055 (i.e. ingest flows)
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation