Improve Peblar documentation #38839
Improve Peblar documentation #38839
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe Peblar integration documentation was expanded with new "Use cases" and "Prerequisites" sections. Existing sections such as "Supported devices," "Supported functionality," and polling intervals were rephrased and reformatted for clarity and readability. Sensor descriptions were grouped more logically, and the "Known limitations" section was converted into a bulleted list. A new "Troubleshooting" section was added with basic resolution steps. Minor wording, grammar, and formatting improvements were applied throughout. No changes were made to the integration’s code, functionality, or control flow. Changes
Sequence Diagram(s)No sequence diagram is generated as all changes are limited to documentation content and do not affect control flow or feature implementation. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (11)
source/_integrations/peblar.markdown (11)
28-28: Consider splitting the opening sentence for readability.
The intro is very long and packs multiple ideas. Try breaking after “real-time” and starting a new sentence at “Track energy consumption…”.
34-34: Avoid repeating the full product name.
Since the section header already makes clear we’re talking about Peblar chargers, you could simplify to:The following models are supported by this integration:
44-47: Ensure consistent punctuation in list items.
Each bullet should end with a period:- Your Peblar charger is connected to your home network + Your Peblar charger is connected to your home network. - You have the password used to access the charger's local web interface + You have the password used to access the charger's local web interface.🧰 Tools
🪛 LanguageTool
[uncategorized] ~46-~46: A period might be missing here.
Context: ... used to access the charger's local web interface {% include integrations/config_flow.md...(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
56-56: Use consistent terminology.
Change “Peblar device” to “Peblar charger” for uniformity:- description: The password used to log in to the Peblar device's local web interface. + description: The password used to log in to the Peblar charger’s local web interface.
63-63: Streamline wording.
Instead of “exposes a variety of entities,” consider “exposes multiple entities” for conciseness.🧰 Tools
🪛 LanguageTool
[style] ~63-~63: Consider using a synonym to be more concise.
Context: ...ionality to your smart home. It exposes a variety of entities that let you monitor, control,...(A_VARIETY_OF)
70-71: Split sentences around “otherwise.”
Using “otherwise” as a conjunction can be confusing. For example:- …an error has been detected, otherwise, it is off. + …an error has been detected. Otherwise, it is off. - …a warning has been raised, otherwise, it is off. + …a warning has been raised. Otherwise, it is off.🧰 Tools
🪛 LanguageTool
[typographical] ~70-~70: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}:on) an error has been detected, otherwise, it is off ({% term state %}:off). - ...(THUS_SENTENCE)
[typographical] ~71-~71: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}:on) a warning has been raised, otherwise, it is off ({% term state %}:off). I...(THUS_SENTENCE)
102-102: Correct verb tense.
Change “is depending on” to “depends on”:- and the maximum value is depending on your charger's configuration. + and the maximum value depends on your charger's configuration.🧰 Tools
🪛 LanguageTool
[uncategorized] ~102-~102: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configuration. The va...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
130-133: Fix markdown escaping on nested list.
The\*\*escapes make the lines harder to read. Use plain bold for the sensor names:- - **Current Phase 1**\*\*: The current … + - **Current Phase 1**: The current …
150-150: Use hyphens for compound adjectives.
Change “low power factor” to “low-power-factor” when it modifies a noun:- limited due to a low power factor in the electrical installation. + limited due to a low-power-factor in the electrical installation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~150-~150: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...: The current limit is limited due to a low power factor in the electrical installation. ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
152-152: Simplify verb usage.
Replace “the charger is using” with “the charger uses”:- the charger is using to charge your electric vehicle. + the charger uses to charge your electric vehicle.🧰 Tools
🪛 LanguageTool
[uncategorized] ~152-~152: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...ower consumption (in Watts) the charger is using to charge your electric vehicle. This...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
159-159: Rephrase the “not recommended” construction.
Move the gerund to the front for clarity:- While possible, it is **not** recommended to use this sensor in the Home Assistant energy dashboard. + While possible, using this sensor in the Home Assistant energy dashboard is **not** recommended.🧰 Tools
🪛 LanguageTool
[grammar] ~159-~159: The verb ‘recommended’ is used with the gerund form.
Context: ...n starts. While possible, it is not recommended to use this sensor in the Home Assistant energ...(ADMIT_ENJOY_VB)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/peblar.markdown(9 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/peblar.markdown
[grammar] ~36-~36: This phrase is duplicated. You should probably use “Peblar Home” only once.
Context: ...s are supported by this integration: - Peblar Home - Peblar Home Plus - Peblar Business ## Prerequisite...
(PHRASE_REPETITION)
[uncategorized] ~46-~46: A period might be missing here.
Context: ... used to access the charger's local web interface {% include integrations/config_flow.md...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[style] ~63-~63: Consider using a synonym to be more concise.
Context: ...ionality to your smart home. It exposes a variety of entities that let you monitor, control,...
(A_VARIETY_OF)
[typographical] ~70-~70: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}: on) an error has been detected, otherwise, it is off ({% term state %}: off). - ...
(THUS_SENTENCE)
[typographical] ~71-~71: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}: on) a warning has been raised, otherwise, it is off ({% term state %}: off). I...
(THUS_SENTENCE)
[uncategorized] ~102-~102: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configuration. The va...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~150-~150: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...: The current limit is limited due to a low power factor in the electrical installation. ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~152-~152: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...ower consumption (in Watts) the charger is using to charge your electric vehicle. This...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[grammar] ~159-~159: The verb ‘recommended’ is used with the gerund form.
Context: ...n starts. While possible, it is not recommended to use this sensor in the Home Assistant energ...
(ADMIT_ENJOY_VB)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (7)
source/_integrations/peblar.markdown (7)
40-40: Section header follows HA guidelines and needs no change.
42-42: Clear and concise introduction to the prerequisites section.
59-59: The note on adjusting the configuration later is clear and accurate.
100-100: This description clearly explains the number entity and its units.
228-228: Friendly call-to-action to contribute examples aligns well with community guidelines.
249-250: The update notification message is clear and uses proper imperative tone.
279-280: The issue-detected notification is concise and instructive.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/peblar.markdown (1)
127-131: Duplicate descriptions for Fast solar vs. Smart solar.
Both modes share identical text except for the verb. Clarify their difference or merge them if they truly behave the same.
🧹 Nitpick comments (7)
source/_integrations/peblar.markdown (7)
78-78: Consider refining for conciseness.
The phrase “exposes a variety of entities” could be shortened for clarity.
For example:- The Peblar integration brings comprehensive EV charging functionality to your smart home. It exposes a variety of entities that let you monitor, control, and automate your charging sessions. + The Peblar integration brings comprehensive EV charging functionality to your smart home by exposing entities to monitor, control, and automate your charging sessions.🧰 Tools
🪛 LanguageTool
[style] ~78-~78: Consider using a synonym to be more concise.
Context: ...ionality to your smart home. It exposes a variety of entities that let you monitor, control,...(A_VARIETY_OF)
85-86: Rephrase “otherwise” for correctness.
Using “otherwise” as a conjunction can be confusing. Consider:- If this sensor is on (state: `on`) an error has been detected, otherwise, it is off (state: `off`). + If this sensor is on (state: `on`), an error has been detected. If it is off (state: `off`), no error is present.🧰 Tools
🪛 LanguageTool
[typographical] ~85-~85: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}:on) an error has been detected, otherwise, it is off ({% term state %}:off). - ...(THUS_SENTENCE)
[typographical] ~86-~86: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}:on) a warning has been raised, otherwise, it is off ({% term state %}:off). I...(THUS_SENTENCE)
117-117: Tighten phrasing for clarity.
“The maximum value is depending on” is awkward. For example:- The minimum value for this entity is 6A, and the maximum value is depending on your charger's configuration. + The minimum value is 6 A, and the maximum value depends on your charger’s configuration.🧰 Tools
🪛 LanguageTool
[uncategorized] ~117-~117: Possible missing comma found.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configurati...(AI_HYDRA_LEO_MISSING_COMMA)
145-167: Sensor list improvements + minor style tweaks.
The grouping is much clearer. A couple of additional suggestions:
- Compound adjective hyphenation:
- dynamic load balancing feature + dynamic-load-balancing feature
- Recommended usage phrasing:
- While possible, it is **not** recommended to use this sensor in the Home Assistant energy dashboard. + While possible, we **do not** recommend using this sensor in the Home Assistant energy dashboard.🧰 Tools
🪛 LanguageTool
[uncategorized] ~165-~165: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...: The current limit is limited due to a low power factor in the electrical installation. ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
243-243: Consider removing the emoji.
The heart adds friendliness but may be inconsistent with the rest of the documentation tone.
264-265: YAML multi-line message formatting.
You can combine these two lines into one for brevity or ensure consistent indentation:- message: > - Please log in to the charger's local web interface to install - the update. + message: > + Please log in to the charger's local web interface to install the update.
294-296: Consistent multi-line notification text.
Similarly, merge or properly indent these lines:- message: > - An issue with your Peblar charger has been detected. - Please check the charger's local web interface for more information. + message: > + An issue with your Peblar charger has been detected. Please check the charger's local web interface for more information.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/peblar.markdown(9 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/peblar.markdown
[grammar] ~51-~51: This phrase is duplicated. You should probably use “Peblar Home” only once.
Context: ...s are supported by this integration: - Peblar Home - Peblar Home Plus - Peblar Business ## Prerequisite...
(PHRASE_REPETITION)
[style] ~78-~78: Consider using a synonym to be more concise.
Context: ...ionality to your smart home. It exposes a variety of entities that let you monitor, control,...
(A_VARIETY_OF)
[typographical] ~85-~85: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}: on) an error has been detected, otherwise, it is off ({% term state %}: off). - ...
(THUS_SENTENCE)
[typographical] ~86-~86: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}: on) a warning has been raised, otherwise, it is off ({% term state %}: off). I...
(THUS_SENTENCE)
[uncategorized] ~117-~117: Possible missing comma found.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configurati...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~165-~165: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...: The current limit is limited due to a low power factor in the electrical installation. ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~174-~174: The verb ‘recommended’ is used with the gerund form.
Context: ...n starts. While possible, it is not recommended to use this sensor in the Home Assistant energ...
(ADMIT_ENJOY_VB)
🔇 Additional comments (12)
source/_integrations/peblar.markdown (12)
28-28: Introduction is clear and concise.
Great rewrite of the intro to emphasize real-time monitoring, control, and energy dashboard integration.
32-32: Header update is straightforward.
The new “Use cases” section header aligns well with Home Assistant docs.
34-34: Use cases description reads well.
The opening sentence clearly explains the integration’s benefits.
36-38: Primary use case bullets are on point.
Each bullet concisely highlights a core scenario.
39-44: Sub-bullets under automations are comprehensive.
Nice set of examples illustrating smart-charging automations.
45-45: Remote control bullet is clear.
Users will appreciate knowing they can start/stop charging from anywhere.
49-49: Supported devices list is correct.
All supported Peblar models are clearly enumerated.
55-61: Prerequisites section is well structured.
The network, hostname/IP, and password requirements are clearly laid out.
71-71: Configuration description is accurate.
The password field explanation is clear and concise.
74-74: Additional configuration note is helpful.
Users now know they can reconfigure via the UI.
115-115: Charge limit entity description is clear.
This sentence effectively explains the purpose of the number entity.
123-123: Select entity intro is solid.
The new sentence clearly describes the Smart charging select.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
source/_integrations/peblar.markdown (2)
28-28: Applied previous suggestion
The introduction now matches the suggestion from the previous review, improving clarity and readability.
128-129: Duplicate option descriptions
The Fast solar and Smart solar modes currently share identical descriptions. Please clarify how they differ or merge them if they behave the same.
🧹 Nitpick comments (7)
source/_integrations/peblar.markdown (7)
39-43: Add periods to nested list items
To maintain consistency, each nested bullet under “Create smart charging automations” should end with a period.- - Receiving notifications when your vehicle completes charging + - Receiving notifications when your vehicle completes charging. - - Automatically adjusting charging modes based on solar production forecasts + - Automatically adjusting charging modes based on solar production forecasts. - - Getting alerts when the charger detects errors or issues + - Getting alerts when the charger detects errors or issues. - - Scheduling charging during off-peak electricity hours + - Scheduling charging during off-peak electricity hours. - - Optimizing charging based on electricity prices and your travel schedule + - Optimizing charging based on electricity prices and your travel schedule.
59-61: Terminate prerequisite bullets with periods
Each bullet in the Prerequisites section should end with a period for consistency.- - Your Peblar charger is connected to your home network + - Your Peblar charger is connected to your home network. - - You know the hostname or IP address of the charger on your network + - You know the hostname or IP address of the charger on your network. - - You have the password used to access the charger's local web interface + - You have the password used to access the charger's local web interface.🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: A period might be missing here.
Context: ... used to access the charger's local web interface {% include integrations/config_flow.md...(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
78-78: Simplify "exposes a variety of" phrasing
Consider using a more concise phrase to improve readability. For example:- It exposes a variety of entities that let you monitor, control, and automate your charging sessions. + It provides entities to monitor, control, and automate your charging sessions.🧰 Tools
🪛 LanguageTool
[style] ~78-~78: Consider using a synonym to be more concise.
Context: ...ionality to your smart home. It exposes a variety of entities that let you monitor, control,...(A_VARIETY_OF)
85-86: Break run-on sentences in sensor descriptions
Separate each description into two sentences to avoid overusing “otherwise” as a conjunction. For example:- If this sensor is on ({% term state %}: `on`) an error has been detected, otherwise, it is off ({% term state %}: `off`). + If this sensor is on ({% term state %}: `on`), an error has been detected. Otherwise, it is off ({% term state %}: `off`).Apply the same pattern to Active warning.
🧰 Tools
🪛 LanguageTool
[typographical] ~85-~85: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}:on) an error has been detected, otherwise, it is off ({% term state %}:off). - ...(THUS_SENTENCE)
[typographical] ~86-~86: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}:on) a warning has been raised, otherwise, it is off ({% term state %}:off). I...(THUS_SENTENCE)
117-117: Correct verb tense for maximum value description
“The maximum value is depending on” reads awkwardly. Change to:- The minimum value for this entity is 6A, and the maximum value is depending on your charger's configuration. + The minimum value for this entity is 6A, and the maximum value depends on your charger's configuration.🧰 Tools
🪛 LanguageTool
[uncategorized] ~117-~117: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configuration. The va...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
167-167: Revise power consumption wording
The phrase “the charger is using to charge your electric vehicle” could be simplified for clarity. For example:- The power consumption (in Watts) the charger is using to charge your electric vehicle. + The power consumption (in watts) consumed by the charger to charge your electric vehicle.🧰 Tools
🪛 LanguageTool
[uncategorized] ~167-~167: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...ower consumption (in Watts) the charger is using to charge your electric vehicle. This...(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
183-183: Clarify voltage description
Rewrite to improve clarity. For example:- The voltage the charger is using to charge. + The voltage (in volts) used by the charger for charging.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/peblar.markdown(9 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/peblar.markdown
[grammar] ~51-~51: This phrase is duplicated. You should probably use “Peblar Home” only once.
Context: ...s are supported by this integration: - Peblar Home - Peblar Home Plus - Peblar Business ## Prerequisite...
(PHRASE_REPETITION)
[uncategorized] ~61-~61: A period might be missing here.
Context: ... used to access the charger's local web interface {% include integrations/config_flow.md...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[style] ~78-~78: Consider using a synonym to be more concise.
Context: ...ionality to your smart home. It exposes a variety of entities that let you monitor, control,...
(A_VARIETY_OF)
[typographical] ~85-~85: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}: on) an error has been detected, otherwise, it is off ({% term state %}: off). - ...
(THUS_SENTENCE)
[typographical] ~86-~86: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}: on) a warning has been raised, otherwise, it is off ({% term state %}: off). I...
(THUS_SENTENCE)
[uncategorized] ~117-~117: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configuration. The va...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[uncategorized] ~165-~165: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...: The current limit is limited due to a low power factor in the electrical installation. ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~167-~167: This verb may not be in the correct tense. Consider changing the tense to fit the context better.
Context: ...ower consumption (in Watts) the charger is using to charge your electric vehicle. This...
(AI_EN_LECTOR_REPLACEMENT_VERB_TENSE)
[grammar] ~174-~174: The verb ‘recommended’ is used with the gerund form.
Context: ...n starts. While possible, it is not recommended to use this sensor in the Home Assistant energ...
(ADMIT_ENJOY_VB)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
source/_integrations/peblar.markdown (2)
78-78: Review entity overview header
This line duplicates information already presented in the integration description and Use cases section. Consider simplifying or removing to avoid redundancy.
127-129: Clarify duplicate Smart solar modes
The descriptions for Fast solar and Smart solar are identical, which may confuse users. Please clarify the behavioral difference between these modes or merge them if they function the same.
🧹 Nitpick comments (6)
source/_integrations/peblar.markdown (6)
28-28: Refine integration description for conciseness
The opening two sentences are a bit repetitive with “integrates” and “integrating.” Consider merging them into one sentence to improve flow.-The Peblar {% term integration %} integrates the [Peblar Rocksolid EV Charger] into your smart home ecosystem. It enables real-time monitoring of charging status, tracking energy consumption, controlling charging behavior, and integrating EV charging data into the Home Assistant energy dashboard. +The Peblar {% term integration %} brings the [Peblar Rocksolid EV Charger] into your smart home ecosystem, enabling real-time monitoring of charging status, energy consumption, charging control, and EV data integration into the Home Assistant energy dashboard.
36-45: Standardize bullet formatting
To align with Home Assistant style, replace the dash after the bolded feature name with a colon. Example diff for the first item:- - **Monitor your EV charging in real time** - Track charging status, current power draw, and session energy consumption directly from your dashboard. + - **Monitor your EV charging in real time**: Track charging status, current power draw, and session energy consumption directly from your dashboard.Apply the same change for Optimize…, Stay up to date…, Control charging remotely, and Create smart charging automations.
74-74: Refine configuration note punctuation
Consider replacing the comma with a semicolon for readability:-The above configuration can also be adjusted later via {% my integrations title="**Settings** > **Devices & services**" %}, click {% icon "mdi:dots-vertical" %} and select **Reconfigure**. +The above configuration can also be adjusted later via {% my integrations title="**Settings** > **Devices & services**" %}; click {% icon "mdi:dots-vertical" %} and select **Reconfigure**.
85-86: Split complex sentences for clarity
The use of “otherwise” as a conjunction can be split into two sentences for readability. Example diff:-If this sensor is on ({% term state %}: `on`) an error has been detected, otherwise, it is off ({% term state %}: `off`). +If this sensor is on ({% term state %}: `on`), an error has been detected. If it is off ({% term state %}: `off`), no error is present. -If this sensor is on ({% term state %}: `on`) a warning has been raised, otherwise, it is off ({% term state %}: `off`). +If this sensor is on ({% term state %}: `on`), a warning has been raised. If it is off ({% term state %}: `off`), no warning is present.🧰 Tools
🪛 LanguageTool
[typographical] ~85-~85: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}:on) an error has been detected, otherwise, it is off ({% term state %}:off). - ...(THUS_SENTENCE)
[typographical] ~86-~86: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}:on) a warning has been raised, otherwise, it is off ({% term state %}:off). I...(THUS_SENTENCE)
115-117: Correct grammatical tense
Change “is depending” to “depends” for grammatical accuracy:-The minimum value for this entity is 6A, and the maximum value is depending on your charger's configuration. +The minimum value for this entity is 6A, and the maximum value depends on your charger's configuration.🧰 Tools
🪛 LanguageTool
[uncategorized] ~117-~117: Possible missing comma found.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configurati...(AI_HYDRA_LEO_MISSING_COMMA)
264-265: Merge YAML notification message lines
The message is split into two lines, breaking the sentence. Combine into one line for clarity:- Please log in to the charger's local web interface to install - the update. + Please log in to the charger's local web interface to install the update.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/peblar.markdown(9 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/peblar.markdown
[grammar] ~51-~51: This phrase is duplicated. You should probably use “Peblar Home” only once.
Context: ...s are supported by this integration: - Peblar Home - Peblar Home Plus - Peblar Business ## Prerequisite...
(PHRASE_REPETITION)
[typographical] ~85-~85: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ... term state %}: on) an error has been detected, otherwise, it is off ({% term state %}: off). - ...
(THUS_SENTENCE)
[typographical] ~86-~86: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...term state %}: on) a warning has been raised, otherwise, it is off ({% term state %}: off). I...
(THUS_SENTENCE)
[uncategorized] ~117-~117: Possible missing comma found.
Context: ...his entity is 6A, and the maximum value is depending on your charger's configurati...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~165-~165: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...: The current limit is limited due to a low power factor in the electrical installation. ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~174-~174: The verb ‘recommended’ is used with the gerund form.
Context: ...n starts. While possible, it is not recommended to use this sensor in the Home Assistant energ...
(ADMIT_ENJOY_VB)
🔇 Additional comments (8)
source/_integrations/peblar.markdown (8)
32-34: Use cases section heading and introduction
The new “Use cases” heading and its introductory sentence are clear and follow Home Assistant documentation style. The purpose and benefits are well communicated.
49-49: Supported devices introduction
The revised sentence “The following Peblar Rocksolid EV chargers are supported by this integration:” is concise and clear.
55-61: Prerequisites section
The new prerequisites list is well structured and clearly sets expectations before setup.
71-71: Password description
The description for the password parameter is clear and correctly formatted.
102-103: Buttons section descriptions
The “Identify” and “Restart” button descriptions are clear and informative. Good use of concise, action-oriented language.
123-123: Smart charging entity description
The sentence accurately describes the Smart charging select and aligns with the rest of the documentation.
243-243: Encourage community contributions
The friendly tone and call-to-action fit well with the Home Assistant community spirit. No changes needed.
295-296: Second automation example message
The notification steps are clear and correctly formatted, guiding users to check the web interface.
Proposed change
Improves the Peblar documentation to follow standards. This is written by GitHub Copilot using the Claude 3.7 Sonnet model and the Copilot instructions from #38837
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit