Add Installer login, Add ManualCharge Switch #36472
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the documentation for the Kostal Plenticore solar inverter integration in Home Assistant. It introduces a new section on "Installer Access," detailing how users can gain access to additional settings through a Master key and Service Code. A new sensor, "Battery Manual Charge," is also added, which is accessible under specific conditions when using installer credentials. The documentation clarifies the default behavior of sensors and provides instructions for enabling them. Changes
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: 2
🧹 Nitpick comments (1)
source/_integrations/kostal_plenticore.markdown (1)
24-24: Consider reorganizing installer-related documentation.To improve documentation structure and readability, consider:
- Creating a dedicated "Installer Features" section
- Moving all installer-related content under this section
- Cross-referencing between related sections
This would help users better understand which features require installer access and their relationships.
Also applies to: 151-151
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/kostal_plenticore.markdown (3)
25-42: Enhance technical details for installer access documentation.While the warning section effectively communicates the risks, the documentation would benefit from additional technical details:
- Where in the Home Assistant UI users can enter installer credentials
- Expected format of the Master key and Service Code
- Step-by-step process for enabling installer access
Consider adding a new subsection with these technical details:
For information about obtaining installer credentials, please consult your device documentation or contact a certified installer. + +### Enabling Installer Access + +1. Navigate to [specify location in HA UI] +2. Enter your Master key (format: [specify format]) +3. Enter your Service Code (format: [specify format]) +4. [Additional steps if any]🧰 Tools
🪛 Markdownlint (0.37.0)
25-25: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
29-29: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
30-30: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
31-31: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
32-32: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
34-34: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
35-35: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
37-37: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-39: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
31-31: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
40-40: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
169-169: Expand Battery Manual Charge documentation with technical details.The current description covers the basics but would benefit from additional technical information:
- Available states/values for this setting
- Relationship with other battery settings (e.g., Battery Strategy, Battery Smart Control)
- Typical maintenance scenarios when this should be used
- Duration limits or automatic safety cutoffs
Consider expanding the description:
-| Battery Manual Charge | | RW | Enables manual charging of the battery for service purposes. This feature: <br>- Requires installer login credentials<br>- Allows forcing battery charging regardless of normal charging rules<br>- Should only be used for maintenance/service purposes<br>- May impact battery longevity if used incorrectly | +| Battery Manual Charge | | RW | Enables manual charging of the battery for service purposes. This feature: <br>- Requires installer login credentials<br>- Allows forcing battery charging regardless of normal charging rules<br>- Available states: [list states]<br>- Automatically disables after [duration] or when [condition]<br>- Typical use cases:<br> * Battery maintenance<br> * Capacity testing<br> * [other scenarios]<br>- Interacts with:<br> * Battery Strategy setting<br> * Battery Smart Control setting<br>- Should only be used for maintenance/service purposes<br>- May impact battery longevity if used incorrectly |
25-42: Fix markdown formatting issues.There are several minor formatting issues in the new sections:
- Remove trailing spaces at the end of lines
- Add blank lines around lists
Apply these formatting fixes:
-## Installer Access +## Installer Access -The integration supports installer-level access using a Master key and Service Code. This enables access to additional settings that are normally restricted to certified installers. +The integration supports installer-level access using a Master key and Service Code. This enables access to additional settings that are normally restricted to certified installers. -{% warning %} +{% warning %} + -Using installer credentials: +Using installer credentials: + - Should only be done if you fully understand the implications - May void your warranty - Could potentially damage your device if settings are incorrectly configured - Should be done with extreme caution + {% endwarning %}🧰 Tools
🪛 Markdownlint (0.37.0)
25-25: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
29-29: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
30-30: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
31-31: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
32-32: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
34-34: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
35-35: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
37-37: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
39-39: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
31-31: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
40-40: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/kostal_plenticore.markdown(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/kostal_plenticore.markdown
25-25: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
29-29: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
30-30: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
31-31: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
32-32: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
34-34: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
35-35: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
37-37: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
39-39: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
31-31: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
40-40: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/kostal_plenticore.markdown (1)
33-45: Fix markdown formatting inconsistenciesRemove trailing spaces at the end of lines to maintain consistent formatting.
-Using installer credentials: +Using installer credentials: -- Should only be done if you fully understand the implications -- May void your warranty -- Could potentially damage your device if settings are incorrectly configured -- Should be done with extreme caution +- Should only be done if you fully understand the implications +- May void your warranty +- Could potentially damage your device if settings are incorrectly configured +- Should be done with extreme caution🧰 Tools
🪛 LanguageTool
[style] ~33-~33: To form a complete sentence, be sure to include a subject.
Context: ...ing %} Using installer credentials: - Should only be done if you fully understand th...(MISSING_IT_THERE)
🪛 Markdownlint (0.37.0)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
34-34: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
35-35: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
36-36: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
38-38: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
42-42: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
44-44: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
45-45: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
45-45: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/kostal_plenticore.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/kostal_plenticore.markdown
[style] ~33-~33: To form a complete sentence, be sure to include a subject.
Context: ...ing %} Using installer credentials: - Should only be done if you fully understand th...
(MISSING_IT_THERE)
🪛 Markdownlint (0.37.0)
source/_integrations/kostal_plenticore.markdown
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
34-34: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
35-35: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
36-36: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
38-38: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
42-42: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
44-44: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
45-45: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
45-45: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🔇 Additional comments (1)
source/_integrations/kostal_plenticore.markdown (1)
174-174: 🛠️ Refactor suggestion
Expand Battery Manual Charge documentation with technical details
The current documentation needs more technical details about this critical feature:
-| Battery Manual Charge | | RW | Enables manual charging of the battery for service purposes. This feature: <br>- Requires installer login credentials<br>- Allows forcing battery charging regardless of normal charging rules<br>- Should only be used for maintenance/service purposes<br>- May impact battery longevity if used incorrectly |
+| Battery Manual Charge | | RW | Enables manual charging of the battery for service purposes. This feature: <br>- Requires installer login credentials<br>- Available states: [list all possible states]<br>- Charging behavior:<br> • Overrides normal charging rules<br> • [Describe charging parameters]<br> • [Describe any limits/thresholds]<br>- Safety considerations:<br> • Automatic timeout: [specify duration]<br> • Temperature monitoring: [describe limits]<br> • Emergency cutoff: [describe conditions]<br>- Monitoring requirements:<br> • Recommended sensors to monitor<br> • Warning indicators<br> • Logging requirements |Likely invalid or redundant comment.
| ## Installer Access | ||
|
|
||
| The integration supports installer-level access using a Master key and Service Code. This enables access to additional settings that are normally restricted to certified installers. | ||
|
|
||
| {% warning %} | ||
|
|
||
| Using installer credentials: | ||
|
|
||
| - Should only be done if you fully understand the implications | ||
| - May void your warranty | ||
| - Could potentially damage your device if settings are incorrectly configured | ||
| - Should be done with extreme caution | ||
|
|
||
| {% endwarning %} | ||
|
|
||
| To enable installer access, set your Master Key as the password and fill in the Service Code in the configuration when adding the integration. | ||
|
|
||
| ### Additional Settings with Installer Access | ||
|
|
||
| The following settings become available when using installer credentials: | ||
| - Battery Manual Charge | ||
|
|
||
| For information about obtaining installer credentials, please consult your device documentation or contact a certified installer. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance installer access documentation with additional critical details
While the current documentation provides a good foundation, please add the following essential information:
- What is a Master key and how does it differ from a regular password?
- Format/requirements for the Service Code
- Complete list of settings that become accessible with installer credentials
- Impact on system behavior when using installer access
- Any logging or monitoring considerations
To enable installer access, set your Master Key as the password and fill in the Service Code in the configuration when adding the integration.
### Additional Settings with Installer Access
The following settings become available when using installer credentials:
-Battery Manual Charge
+- Battery Manual Charge: Enables service-level battery charging operations
+- [List other installer-only settings with descriptions]
+
+### Technical Details
+
+- Master Key: [Explain what it is and its format]
+- Service Code: [Explain format and requirements]
+
+### System Impact
+
+When using installer access:
+- System behavior changes: [List specific changes]
+- Additional logging: [Describe any special logging]
+- Monitoring considerations: [Any special monitoring needs]Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[style] ~33-~33: To form a complete sentence, be sure to include a subject.
Context: ...ing %} Using installer credentials: - Should only be done if you fully understand th...
(MISSING_IT_THERE)
🪛 Markdownlint (0.37.0)
33-33: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
34-34: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
35-35: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
36-36: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
38-38: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
40-40: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
42-42: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
44-44: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
45-45: Expected: 0 or 2; Actual: 1
Trailing spaces
(MD009, no-trailing-spaces)
45-45: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
Proposed change
This change makes it possible to use a installer login with kostal plenticore. It enables access to more settings that are not available from the normal login. The change also adds the ManualCharge Switch which activates Service Charging. This Switch can only be set when the installer login is active.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation