enphase envoy docs quality improvement phase 2 #36272
Conversation
catsmanac
requested review from
bdraco,
cgarwood and
joostlek
as code owners
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces significant updates to the documentation for the Enphase Envoy integration with Home Assistant. New sections titled "Reconfigure," "Firmware changes," and "Periodic network connection issues" have been added, detailing the process for updating configurations and addressing known issues. The description for the "Username" field has been expanded, and the "Capabilities" section has been revised for clarity. The troubleshooting section has been enhanced, and the overall structure of the document has been improved for better readability. Changes
Finishing Touches
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/enphase_envoy.markdown (3)
62-63: Fix hyphenation in compound adjective.The compound adjective "1 year" should be hyphenated when it modifies "valid token".
- description: "For firmware version 7.0 and later, enter your Enlighten cloud username. The Enlighten cloud username (and password) will be used to obtain a 1 year valid token from the enphase web-site when first configured or upon expiry. + description: "For firmware version 7.0 and later, enter your Enlighten cloud username. The Enlighten cloud username (and password) will be used to obtain a 1-year valid token from the enphase web-site when first configured or upon expiry.🧰 Tools
🪛 LanguageTool
[uncategorized] ~62-~62: When a number forms part of an adjectival compound, use a hyphen.
Context: ...(and password) will be used to obtain a 1 year valid token from the enphase web-site w...(MISSING_HYPHEN)
97-98: Fix grammar and punctuation in product names note.There are two issues in this section:
- "may known" should be "may know"
- Missing comma in the documentation statement
-- You may known referred product names under other names from the past or future. -- In this documentation the term SN is used for a device serial-number placeholder. +- You may know referred product names under other names from the past or future. +- In this documentation, the term SN is used for a device serial-number placeholder.🧰 Tools
🪛 LanguageTool
[grammar] ~97-~97: A verb or adverb may be misspelled or missing.
Context: ...mpatible generators. {% note %} - You may known referred product names under other name...(PRP_MD_NN)
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...ames from the past or future. - In this documentation the term SN is used for a device serial...(DURING_THAT_TIME_COMMA)
616-617: LGTM! Critical limitation is well documented.The documentation clearly explains the limitation of battery controls in firmware 8.2.4225. This is crucial information for users.
Consider adding a note about whether this is a temporary or permanent limitation, if that information is available.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (9)
source/images/integrations/enphase_envoy/enphase_envoy_aggr_iq_battery.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_consumption.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_ct_model.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_dry_contact.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_encharge.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_enpower.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_inverter_device.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_production_reset.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_solar_production.pngis excluded by!**/*.png
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[uncategorized] ~62-~62: When a number forms part of an adjectival compound, use a hyphen.
Context: ...(and password) will be used to obtain a 1 year valid token from the enphase web-site w...
(MISSING_HYPHEN)
[grammar] ~97-~97: A verb or adverb may be misspelled or missing.
Context: ...mpatible generators. {% note %} - You may known referred product names under other name...
(PRP_MD_NN)
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...ames from the past or future. - In this documentation the term SN is used for a device serial...
(DURING_THAT_TIME_COMMA)
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~175-~175: A comma may be missing after the conjunctive/linking adverb ‘Likewise’.
Context: ...ion data](#aggregated-production-data). Likewise the installed consumption CT will be th...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~181-~181: “then” (at that time, later on) seems less likely than “than” (as in: greater than).
Context: ... no phase entities are created. If more then 1 phase are configured and measured, in...
(AI_HYDRA_LEO_CP_THEN_THAN)
[misspelling] ~196-~196: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Net-consumption CT sensor entit...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~205-~205: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Storage CT sensor entities - *...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~214-~214: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. For storage CT energy entities refer ...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~240-~240: Possible missing preposition found.
Context: ... configurations can provide integration entity data. - IQ Batteries: current Enph...
(AI_HYDRA_LEO_MISSING_OF)
[typographical] ~275-~275: It appears that a comma is missing.
Context: ...Individual IQ battery data For each IQ Battery an Encharge device is created, linked t...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~362-~362: When a number forms part of an adjectival compound, use a hyphen.
Context: ...API of the Envoy is used. Only when the 1 year valid token is to expire, 1 month befor...
(MISSING_HYPHEN)
[uncategorized] ~364-~364: Possible missing comma found.
Context: ...l entities of the Envoy and the related devices like the inverters; there is no need to...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~376-~376: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~421-~421: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~422-~422: Possible missing comma found.
Context: ...ates, value changes over Home Assistant outages nor changing UOM to a preferred one. Ex...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~424-~424: Possible missing comma found.
Context: ...in various community topics. {% tip %} Alternatively this can be done splitting **Envoy <ab...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~438-~438: Possible typo: you repeated a word
Context: ... Energy going into the battery, use the the **Envoy <abbr title="Envoy serial numbe...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~439-~439: Possible typo: you repeated a word
Context: ...nergy coming out off the battery**, use the the **Envoy <abbr title="Envoy serial numbe...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~443-~443: Possible missing preposition found.
Context: ...lled, only the current Power in and out individual batteries, or the current aggregated ba...
(AI_HYDRA_LEO_MISSING_OF)
[grammar] ~443-~443: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[uncategorized] ~447-~447: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. {% details "Concept to sp...
(AI_HYDRA_LEO_CP_OFF_OF)
[duplication] ~451-~451: Possible typo: you repeated a word
Context: ...y and add negative changes to a battery_discharge discharge entity. {% raw %} ```yaml - trigger:...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~484-~484: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~521-~521: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ta) is available. These can be used for high level individual devices if of interest. ## ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[formatting] ~620-~620: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~626-~626: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[uncategorized] ~644-~644: Possible missing comma found.
Context: ... enddetails %} ### Summed Voltage The Envoy Metered in multiphase setup, sums the v...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~654-~654: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...
(EN_WORDINESS_PREMIUM_IN_BRIEF)
🔇 Additional comments (1)
source/_integrations/enphase_envoy.markdown (1)
654-655: LGTM! Clear troubleshooting guidance.
The troubleshooting information about single network connectivity is clear and helps users avoid common connectivity issues.
🧰 Tools
🪛 LanguageTool
[style] ~654-~654: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...
(EN_WORDINESS_PREMIUM_IN_BRIEF)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/enphase_envoy.markdown (1)
62-62: Consider these minor grammatical improvements.A few small fixes would improve readability:
- Line 62: Change "1 year valid token" to "1-year-valid token"
- Line 97: Fix "may known" to "may know"
- Line 181: Change "more then" to "more than"
- Lines 438-439: Remove duplicate "the" in "use the the"
- Line 451: Remove duplicate "discharge" in "battery_discharge discharge"
Also applies to: 97-97, 181-181, 438-438, 439-439, 451-451
🧰 Tools
🪛 LanguageTool
[uncategorized] ~62-~62: When a number forms part of an adjectival compound, use a hyphen.
Context: ...(and password) will be used to obtain a 1 year valid token from the enphase web-site w...(MISSING_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[uncategorized] ~62-~62: When a number forms part of an adjectival compound, use a hyphen.
Context: ...(and password) will be used to obtain a 1 year valid token from the enphase web-site w...
(MISSING_HYPHEN)
[grammar] ~97-~97: A verb or adverb may be misspelled or missing.
Context: ...mpatible generators. {% note %} - You may known referred product names under other name...
(PRP_MD_NN)
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...ames from the past or future. - In this documentation the term SN is used for a device serial...
(DURING_THAT_TIME_COMMA)
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~157-~157: “of” seems less likely than “or” (‘either … or’).
Context: ...n and/or storage measurements in single of multiple phase setups. Below diagram s...
(AI_HYDRA_LEO_CP_OF_OR)
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single of multiple phase setups. Below diagram shows CT installation positions...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~175-~175: A comma may be missing after the conjunctive/linking adverb ‘Likewise’.
Context: ...ion data](#aggregated-production-data). Likewise the installed consumption CT will be th...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...
(EN_COMPOUNDS_MULTI_PHASE)
[grammar] ~181-~181: Comparison requires “than”, not ‘then’ nor ‘as’.
Context: ... no phase entities are created. If more then 1 phase are configured and measured, in...
(COMP_THAN)
[misspelling] ~196-~196: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Net-consumption CT sensor entit...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~205-~205: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Storage CT sensor entities - *...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~214-~214: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. For storage CT energy entities refer ...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~240-~240: Possible missing preposition found.
Context: ... configurations can provide integration entity data. - IQ Batteries: current Enph...
(AI_HYDRA_LEO_MISSING_OF)
[typographical] ~275-~275: It appears that a comma is missing.
Context: ...Individual IQ battery data For each IQ Battery an Encharge device is created, linked t...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~362-~362: When a number forms part of an adjectival compound, use a hyphen.
Context: ...API of the Envoy is used. Only when the 1 year valid token is to expire, 1 month befor...
(MISSING_HYPHEN)
[uncategorized] ~376-~376: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~421-~421: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~422-~422: Possible missing comma found.
Context: ...ates, value changes over Home Assistant outages nor changing UOM to a preferred one. Ex...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~424-~424: Possible missing comma found.
Context: ...in various community topics. {% tip %} Alternatively this can be done splitting **Envoy <ab...
(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~438-~438: Possible typo: you repeated a word
Context: ... Energy going into the battery, use the the **Envoy <abbr title="Envoy serial numbe...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~439-~439: Possible typo: you repeated a word
Context: ...nergy coming out off the battery**, use the the **Envoy <abbr title="Envoy serial numbe...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~443-~443: Possible missing preposition found.
Context: ...lled, only the current Power in and out individual batteries, or the current aggregated ba...
(AI_HYDRA_LEO_MISSING_OF)
[grammar] ~443-~443: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[uncategorized] ~447-~447: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. {% details "Concept to sp...
(AI_HYDRA_LEO_CP_OFF_OF)
[duplication] ~451-~451: Possible typo: you repeated a word
Context: ...y and add negative changes to a battery_discharge discharge entity. {% raw %} ```yaml - trigger:...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~477-~477: Possible missing article found.
Context: ...e_class: measurement ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~484-~484: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. This method does not accou...
(AI_HYDRA_LEO_CP_OFF_OF)
[uncategorized] ~484-~484: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~514-~514: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~521-~521: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ta) is available. These can be used for high level individual devices if of interest. ## ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[formatting] ~620-~620: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~626-~626: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[uncategorized] ~644-~644: Possible missing comma found.
Context: ... enddetails %} ### Summed Voltage The Envoy Metered in multiphase setup, sums the v...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~654-~654: Possible missing comma found.
Context: ...ry to switch back and forth between the interfaces resulting in brief outages every 30 min...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~654-~654: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...
(EN_WORDINESS_PREMIUM_IN_BRIEF)
🔇 Additional comments (3)
source/_integrations/enphase_envoy.markdown (3)
45-46: LGTM! Good clarification of network requirements.
The added network connectivity requirements and cross-reference to troubleshooting help prevent common setup issues.
62-63: LGTM! Clear explanation of credential requirements.
The expanded description clearly explains the purpose of the Enlighten cloud credentials and token lifecycle.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~62-~62: When a number forms part of an adjectival compound, use a hyphen.
Context: ...(and password) will be used to obtain a 1 year valid token from the enphase web-site w...
(MISSING_HYPHEN)
610-617: LGTM! Essential information about firmware limitations.
The added sections about firmware changes and battery control limitations provide crucial information for users, particularly the note about battery controls no longer being available through the local REST API as of firmware 8.2.4225.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
source/_integrations/enphase_envoy.markdown (4)
97-98: Fix typographical issuesA few minor typographical improvements would enhance readability:
- Line 98: Add a comma after "future"
- Line 362: Add a hyphen in "1-year valid token"
-names from the past or future. In this documentation +names from the past or future, In this documentation -Only when the 1 year valid token +Only when the 1-year valid tokenAlso applies to: 362-362
🧰 Tools
🪛 LanguageTool
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...ames from the past or future. - In this documentation the term SN is used for a device serial...(DURING_THAT_TIME_COMMA)
400-418: Improve YAML code block formattingThe YAML configuration examples should include language identifiers for proper syntax highlighting. Add
yamlidentifier to the code blocks:-``` +```yaml - trigger: - platform: stateAlso applies to: 455-474, 492-511
656-658: Enhance CT Active flag troubleshooting guidanceThe troubleshooting information for CT Active flags could be more helpful by:
- Explaining what each status flag indicates
- Providing specific remediation steps for each flag type
- Adding examples of common scenarios
393-423: Add error handling to energy dashboard templatesThe template examples for splitting balanced grid values should include:
- Error handling for unavailable states
- Validation for numeric values
- Handling of Home Assistant restarts
Would you like me to provide an enhanced template example with these improvements?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...ames from the past or future. - In this documentation the term SN is used for a device serial...
(DURING_THAT_TIME_COMMA)
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~175-~175: A comma may be missing after the conjunctive/linking adverb ‘Likewise’.
Context: ...ion data](#aggregated-production-data). Likewise the installed consumption CT will be th...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~196-~196: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Net-consumption CT sensor entit...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~205-~205: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Storage CT sensor entities - *...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~214-~214: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. For storage CT energy entities refer ...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[typographical] ~275-~275: It appears that a comma is missing.
Context: ...Individual IQ battery data For each IQ Battery an Encharge device is created, linked t...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~362-~362: When a number forms part of an adjectival compound, use a hyphen.
Context: ...API of the Envoy is used. Only when the 1 year valid token is to expire, 1 month befor...
(MISSING_HYPHEN)
[grammar] ~443-~443: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[uncategorized] ~521-~521: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ta) is available. These can be used for high level individual devices if of interest. ## ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[formatting] ~620-~620: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~626-~626: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[style] ~654-~654: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...
(EN_WORDINESS_PREMIUM_IN_BRIEF)
|
Holding this one until next is merged to current to prevent conflicts from #35912 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/enphase_envoy.markdown (2)
93-99: LGTM with a minor grammar suggestion.The section effectively introduces the system capabilities and components. Consider adding a comma in the note:
-You may know referred product names under other names from the past or future. +You may know referred product names under other names from the past, or future.🧰 Tools
🪛 LanguageTool
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...ames from the past or future. - In this documentation the term SN is used for a device serial...(DURING_THAT_TIME_COMMA)
688-690: LGTM with a minor style suggestion.The section effectively explains CT status flags. Consider revising "non-zero" to be hyphenated for consistency:
-If the value is non zero, consult the +If the value is non-zero, consult the
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
source/images/integrations/enphase_envoy/enphase_envoy_acb_battery.pngis excluded by!**/*.pngsource/images/integrations/enphase_envoy/enphase_envoy_aggr_acb_iq_battery.pngis excluded by!**/*.png
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...ames from the past or future. - In this documentation the term SN is used for a device serial...
(DURING_THAT_TIME_COMMA)
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~175-~175: A comma may be missing after the conjunctive/linking adverb ‘Likewise’.
Context: ...ion data](#aggregated-production-data). Likewise the installed consumption CT will be th...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~196-~196: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Net-consumption CT sensor entit...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~205-~205: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. ##### Storage CT sensor entities - *...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~214-~214: This expression is normally spelled as one or with a hyphen.
Context: ...flag count](#ct-active-flag-count) when non zero. For storage CT energy entities refer ...
(EN_COMPOUNDS_NON_ZERO)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[typographical] ~276-~276: It appears that a comma is missing.
Context: ...Individual IQ battery data For each IQ Battery an Encharge device is created, linked t...
(DURING_THAT_TIME_COMMA)
[grammar] ~475-~475: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[formatting] ~652-~652: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~658-~658: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[style] ~686-~686: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...
(EN_WORDINESS_PREMIUM_IN_BRIEF)
🔇 Additional comments (5)
source/_integrations/enphase_envoy.markdown (5)
45-45: LGTM! Clear network requirement specification.The addition clearly specifies the IPv4 requirement and helpfully links to the troubleshooting section.
62-63: LGTM! Improved authentication documentation.The expanded description clearly explains the authentication requirements and token lifecycle for different firmware versions.
79-84: LGTM! Well-documented reconfiguration process.The new section clearly explains when and how to use the reconfiguration feature, particularly for credential changes and firmware upgrades.
642-649: LGTM! Critical firmware limitation well documented.The section clearly documents the important limitation regarding battery controls in firmware 8.2.4225+ and its impact on functionality. This is essential information for users.
684-687: LGTM! Clear troubleshooting guidance.The section effectively explains the network interface conflict issue and provides clear guidance on resolution.
🧰 Tools
🪛 LanguageTool
[style] ~686-~686: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...(EN_WORDINESS_PREMIUM_IN_BRIEF)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
source/_integrations/enphase_envoy.markdown (7)
45-45: Improve clarity of network requirement.The network requirement could be clearer about IPv4 being mandatory.
-The <abbr title="IQ Gateway">Envoy</abbr> must be on your local network with IPV4 connectivity from Home Assistant. (Also See troubleshooting, [single network](#single-network)) +The <abbr title="IQ Gateway">Envoy</abbr> must be accessible via IPv4 from Home Assistant on your local network. (Also see troubleshooting, [single network](#single-network))
62-63: Improve token expiration description.The description about token expiration could be clearer.
- description: "For firmware version 7.0 and later, enter your Enlighten cloud username. The Enlighten cloud username (and password) will be used to obtain a 1-year-valid token from the enphase web-site when first configured or upon expiry. + description: "For firmware version 7.0 and later, enter your Enlighten cloud username. The Enlighten cloud username (and password) will be used to obtain a token from the Enphase website. The token is valid for 1 year and will be automatically renewed one month before expiration.
97-98: Fix grammatical issues in note section.The note section contains grammatical errors.
-- You may know referred product names under other names from the past, or future. -- In this documentation the term SN is used for a device serial-number placeholder. +- You may know these products under different names from the past or future. +- In this documentation, the term SN is used as a placeholder for device serial numbers.🧰 Tools
🪛 LanguageTool
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...mes from the past, or future. - In this documentation the term SN is used for a device serial...(DURING_THAT_TIME_COMMA)
175-178: Improve clarity of CT data usage description.The description of CT data usage needs better punctuation and clarity.
-When an Envoy Metered is equipped with a production ct, the ct data will be used to provide the [aggregated solar production data](#aggregated-production-data). Likewise the installed consumption CT will be the source for the [house consumption data](#house-consumption-data). - -Either a net-consumption or a total-consumption is installed. The Envoy will calculate the data for the other one. +When an Envoy Metered is equipped with a production CT, the CT data will be used to provide the [aggregated solar production data](#aggregated-production-data). Likewise, the installed consumption CT will be the source for the [house consumption data](#house-consumption-data). + +Either a net-consumption or a total-consumption CT is installed. The Envoy will calculate the data for the other measurement type.🧰 Tools
🪛 LanguageTool
[uncategorized] ~175-~175: A comma may be missing after the conjunctive/linking adverb ‘Likewise’.
Context: ...ion data](#aggregated-production-data). Likewise the installed consumption CT will be th...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
475-476: Fix grammatical error in battery storage description.There's a subject-verb agreement error in the battery storage description.
-Without a [storage CT](#aggregated-iq-battery-sensor-entities) installed, only the current Power in and out individual batteries, or the current aggregated battery energy content is available. These value are not suited for direct use with the energy dashboard. +Without a [storage CT](#aggregated-iq-battery-sensor-entities) installed, only the current Power in and out of individual batteries, or the current aggregated battery energy content is available. These values are not suited for direct use with the energy dashboard.🧰 Tools
🪛 LanguageTool
[grammar] ~475-~475: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...(THIS_NNS)
642-649: Improve formatting of firmware limitations section.The firmware limitations section needs better formatting and clarity.
-[Envoy firmware](https://enphase.com/installers/resources/documentation/communication?&f[0]=document%3A217) versions come with changing behavior, features and issues. Firmware is pushed to the Envoy by Enphase, while 'not always communicated in detail upfront'. This may result in sudden changes in the Envoy behavior and is always accompanied by an outage while Envoy is being updated. -As of Envoy firmware 8.2.4225, the Envoy no longer supports setting battery modes, enabling/disabling charging from the grid, or changing reserve battery level through the local REST API used by HA. Until a resolution is found, you will need to use the Enphase APP to control these. +[Envoy firmware](https://enphase.com/installers/resources/documentation/communication?&f[0]=document%3A217) versions introduce changes in behavior, features, and potential issues. Firmware updates are automatically pushed to the Envoy by Enphase, sometimes without detailed advance notice. These updates may result in sudden changes in the Envoy behavior and are always accompanied by a brief outage during the update process. +As of Envoy firmware 8.2.4225, the Envoy no longer supports the following operations through the local REST API used by Home Assistant: +- Setting battery modes +- Enabling/disabling charging from the grid +- Changing reserve battery level + +Until a resolution is found, you must use the Enphase App to control these features.
684-687: Improve clarity of single network troubleshooting section.The single network troubleshooting section could be clearer about the impact and solution.
-The Envoy should not be both on your local LAN and local Wi-Fi at the same time. This may cause auto-discovery to switch back and forth between the interfaces resulting in brief outages every 30 minutes. If you experience these frequent brief outages, make sure only 1 interface is used. +The Envoy should not be connected to both your local LAN (Ethernet) and local Wi-Fi simultaneously. Having both connections active can cause auto-discovery to alternate between interfaces, resulting in connection interruptions approximately every 30 minutes. If you experience these periodic connection issues, ensure the Envoy is connected using only one interface (either Ethernet OR Wi-Fi, not both).🧰 Tools
🪛 LanguageTool
[style] ~686-~686: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...(EN_WORDINESS_PREMIUM_IN_BRIEF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[typographical] ~98-~98: It appears that a comma is missing.
Context: ...mes from the past, or future. - In this documentation the term SN is used for a device serial...
(DURING_THAT_TIME_COMMA)
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~175-~175: A comma may be missing after the conjunctive/linking adverb ‘Likewise’.
Context: ...ion data](#aggregated-production-data). Likewise the installed consumption CT will be th...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[typographical] ~276-~276: It appears that a comma is missing.
Context: ...Individual IQ battery data For each IQ Battery an Encharge device is created, linked t...
(DURING_THAT_TIME_COMMA)
[grammar] ~475-~475: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[formatting] ~652-~652: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~658-~658: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[style] ~686-~686: ‘in brief’ might be wordy. Consider a shorter alternative.
Context: ... forth between the interfaces resulting in brief outages every 30 minutes. If you experi...
(EN_WORDINESS_PREMIUM_IN_BRIEF)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/enphase_envoy.markdown (5)
Line range hint
45-63: LGTM! Clear prerequisites and authentication details.The additions provide important clarity around network requirements and token-based authentication. The explanation of the username field's behavior with different firmware versions is particularly helpful.
Consider adding a comma after "For firmware version 7.0 and later" for better readability.
93-357: Excellent documentation of capabilities and sensor entities!The additions provide comprehensive coverage of:
- CT configurations and their implications
- Sensor entity descriptions and behaviors
- Data reporting mechanisms
Consider standardizing the hyphenation of "multi-phase" throughout the document for consistency.
🧰 Tools
🪛 LanguageTool
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~157-~157: “of” seems less likely than “or” (‘either … or’).
Context: ...n and/or storage measurements in single of multiple phase setups. Below diagram s...(AI_HYDRA_LEO_CP_OF_OR)
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single of multiple phase setups. Below diagram shows CT installation positions...(AI_HYDRA_LEO_MISSING_THE)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~216-~216: Possible missing comma found.
Context: ...) when non-zero. For storage CT energy entities refer to [battery sensor](#aggregated-i...(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...(EN_COMPOUNDS_MULTI_PHASE)
[typographical] ~276-~276: It appears that a comma is missing.
Context: ...Individual IQ battery data For each IQ Battery an Encharge device is created, linked t...(DURING_THAT_TIME_COMMA)
[uncategorized] ~319-~319: Possible missing article found.
Context: ...d maximum battery energy content in Wh Below figure shows the 3 Aggregated entities ...(AI_HYDRA_LEO_MISSING_THE)
359-390: Well-documented battery and Enpower functionality!The documentation clearly explains:
- Battery storage capabilities
- Enpower control entities
- Operational limitations
Consider adding a comma after "For each IQ Battery" in line 276 for better readability.
392-553: Comprehensive coverage of data collection and dashboard setup!The documentation effectively explains:
- Data collection intervals and their implications
- Energy dashboard configuration options
- Handling of different CT configurations
Consider adding commas after introductory phrases like "Alternatively" and "Without a storage CT" for better readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~408-~408: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~453-~453: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~454-~454: Possible missing comma found.
Context: ...ates, value changes over Home Assistant outages nor changing UOM to a preferred one. Ex...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~456-~456: Possible missing comma found.
Context: ...in various community topics. {% tip %} Alternatively this can be done splitting **Envoy <ab...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~475-~475: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...(THIS_NNS)
[uncategorized] ~516-~516: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...(AI_HYDRA_LEO_MISSING_COMMA)
642-696: Valuable documentation of limitations and troubleshooting!The documentation effectively covers:
- Firmware-related limitations
- Known issues and their workarounds
- Troubleshooting steps
Consider adding commas after conditional phrases like "In normal state" and "If the value is non-zero" for better readability.
🧰 Tools
🪛 LanguageTool
[formatting] ~658-~658: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...(IN_THAT_CASE_COMMA)
[formatting] ~664-~664: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...(IN_THAT_CASE_COMMA)
[uncategorized] ~669-~669: Possible missing comma found.
Context: ...ut installed CT, running older firmware versions reportedly resets **Lifetime energy pro...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~669-~669: Possible missing comma found.
Context: ...aching 1.2 MWh. For use with the energy dashboard the reset is not an issue. In a recent ...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~682-~682: Possible missing comma found.
Context: ... enddetails %} ### Summed Voltage The Envoy Metered in multiphase setup, sums the v...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~696-~696: Possible missing comma found.
Context: ...status flags that are raised. In normal state the value is zero. If the value is non-...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~157-~157: “of” seems less likely than “or” (‘either … or’).
Context: ...n and/or storage measurements in single of multiple phase setups. Below diagram s...
(AI_HYDRA_LEO_CP_OF_OR)
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single of multiple phase setups. Below diagram shows CT installation positions...
(AI_HYDRA_LEO_MISSING_THE)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~216-~216: Possible missing comma found.
Context: ...) when non-zero. For storage CT energy entities refer to [battery sensor](#aggregated-i...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[typographical] ~276-~276: It appears that a comma is missing.
Context: ...Individual IQ battery data For each IQ Battery an Encharge device is created, linked t...
(DURING_THAT_TIME_COMMA)
[uncategorized] ~319-~319: Possible missing article found.
Context: ...d maximum battery energy content in Wh Below figure shows the 3 Aggregated entities ...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~408-~408: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~453-~453: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~454-~454: Possible missing comma found.
Context: ...ates, value changes over Home Assistant outages nor changing UOM to a preferred one. Ex...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~456-~456: Possible missing comma found.
Context: ...in various community topics. {% tip %} Alternatively this can be done splitting **Envoy <ab...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~475-~475: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[uncategorized] ~516-~516: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...
(AI_HYDRA_LEO_MISSING_COMMA)
[formatting] ~658-~658: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~664-~664: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[uncategorized] ~669-~669: Possible missing comma found.
Context: ...ut installed CT, running older firmware versions reportedly resets **Lifetime energy pro...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~669-~669: Possible missing comma found.
Context: ...aching 1.2 MWh. For use with the energy dashboard the reset is not an issue. In a recent ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~682-~682: Possible missing comma found.
Context: ... enddetails %} ### Summed Voltage The Envoy Metered in multiphase setup, sums the v...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~696-~696: Possible missing comma found.
Context: ...status flags that are raised. In normal state the value is zero. If the value is non-...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (1)
source/_integrations/enphase_envoy.markdown (1)
Line range hint
593-642: Well-structured documentation of available actions!The documentation clearly explains:
- Available actions and their parameters
- Usage examples
- Limitations and considerations
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/enphase_envoy.markdown (2)
642-655: LGTM! Important firmware limitations documented.The section clearly documents the significant limitations introduced in firmware 8.2.4225, particularly regarding battery controls.
Consider adding a warning note box (using the
{% warning %}tag) around the battery control limitations to make them more visually prominent, as these are significant changes that affect core functionality.
121-121: Consider standardizing hyphenation.For consistency, consider standardizing the spelling of "multi-phase" to "multiphase" throughout the document, as it's commonly written as one word.
Also applies to: 153-153, 181-181, 226-226, 236-236, 553-553, 682-682, 686-686
🧰 Tools
🪛 LanguageTool
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...(EN_COMPOUNDS_MULTI_PHASE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[misspelling] ~121-~121: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~153-~153: This word is normally spelled as one.
Context: .../figcaption> When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~181-~181: This word is normally spelled as one.
Context: ...">CT in multi-phase enabled configurations, both aggregated...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~226-~226: This word is normally spelled as one.
Context: ...efault display in MWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~236-~236: This word is normally spelled as one.
Context: ...efault display in kWh. When used with [multi-phase CT phase data](#ct-aggregate-and-phase-...
(EN_COMPOUNDS_MULTI_PHASE)
[grammar] ~475-~475: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[misspelling] ~553-~553: This word is normally spelled as one.
Context: ...ergy or power measurement devices, with multi-phase CT installed, [energy consumption for p...
(EN_COMPOUNDS_MULTI_PHASE)
[formatting] ~658-~658: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~664-~664: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[misspelling] ~682-~682: This word is normally spelled as one.
Context: ...## Summed Voltage The Envoy Metered in multi-phase setup, sums the voltages of the phases ...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~686-~686: This word is normally spelled as one.
Context: ...ed value. ### Balancing grid meter In multi-phase installations with batteries, in countr...
(EN_COMPOUNDS_MULTI_PHASE)
[misspelling] ~686-~686: This word is normally spelled as one.
Context: ...ases, the net result is zero. The Envoy multi-phase net-consumption CTs, however, will repo...
(EN_COMPOUNDS_MULTI_PHASE)
🔇 Additional comments (5)
source/_integrations/enphase_envoy.markdown (5)
45-45: LGTM! Important network connectivity prerequisite added.Good addition of the single network connectivity requirement with a helpful cross-reference to the troubleshooting section.
62-63: LGTM! Clear explanation of username requirements.The expanded description effectively explains the token-based authentication process and differentiates between firmware versions.
79-83: LGTM! Well-structured reconfiguration documentation.The new section provides clear guidance on when and how to use the reconfiguration option, particularly for credential changes and firmware upgrades.
93-99: LGTM! Enhanced capabilities documentation.The expanded capabilities section provides clear information about device compatibility and includes helpful terminology clarification.
690-693: LGTM! Clear network troubleshooting guidance.The troubleshooting section effectively explains the network connectivity issue and provides a clear solution.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/enphase_envoy.markdown (3)
157-158: Consider these grammatical improvements.A few minor adjustments would enhance readability:
-measurements in single of multiple phase setups. +measurements in single or multiple phase setups. -These value are not suited for direct use +These values are not suited for direct use -Next each entity needs +Next, each entity needs -Energy coming out off the battery +Energy coming out of the batteryAlso applies to: 475-475, 479-479, 516-516
🧰 Tools
🪛 LanguageTool
[uncategorized] ~157-~157: “of” seems less likely than “or” (‘either … or’).
Context: ...n and/or storage measurements in single of multiple phase setups. Below diagram s...(AI_HYDRA_LEO_CP_OF_OR)
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single of multiple phase setups. Below diagram shows CT installation positions...(AI_HYDRA_LEO_MISSING_THE)
477-548: Consider enhancing error handling in code examples.While the code examples are technically correct, consider adding notes about handling these edge cases:
- State transitions during Home Assistant restarts
- Network connectivity issues
- Invalid or unexpected values
- Rate limiting considerations
This would help users implement more robust solutions.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~479-~479: Possible missing comma found.
Context: ...resenting total power in and power out. Next each entity needs to be integrated into...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~479-~479: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. {% details "Concept to sp...(AI_HYDRA_LEO_CP_OFF_OF)
[uncategorized] ~509-~509: Possible missing article found.
Context: ...e_class: measurement ``` {% endraw %} Above example does not address handling `unav...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~516-~516: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. This method does not accou...(AI_HYDRA_LEO_CP_OFF_OF)
[uncategorized] ~516-~516: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~546-~546: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...(AI_HYDRA_LEO_MISSING_THE)
658-658: Consider these formatting improvements.Add commas after introductory phrases to improve readability:
-In this case best use a utility meter +In this case, best use a utility meter -For use with the energy dashboard the reset is not an issue +For use with the energy dashboard, the reset is not an issue -running older firmware versions reportedly resets +running older firmware versions, reportedly resetsAlso applies to: 664-664, 669-669
🧰 Tools
🪛 LanguageTool
[formatting] ~658-~658: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...(IN_THAT_CASE_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[uncategorized] ~157-~157: “of” seems less likely than “or” (‘either … or’).
Context: ...n and/or storage measurements in single of multiple phase setups. Below diagram s...
(AI_HYDRA_LEO_CP_OF_OR)
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single of multiple phase setups. Below diagram shows CT installation positions...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~216-~216: Possible missing comma found.
Context: ...) when non-zero. For storage CT energy entities refer to [battery sensor](#aggregated-i...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~240-~240: Possible missing preposition found.
Context: ... configurations can provide integration entity data. - AC-Batteries: first genera...
(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~319-~319: Possible missing article found.
Context: ...d maximum battery energy content in Wh Below figure shows the 3 Aggregated entities ...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~396-~396: Possible missing comma found.
Context: ...l entities of the Envoy and the related devices like the inverters; there is no need to...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~408-~408: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~453-~453: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~454-~454: Possible missing comma found.
Context: ...ates, value changes over Home Assistant outages nor changing UOM to a preferred one. Ex...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~475-~475: The plural determiner ‘these’ does not agree with the singular noun ‘value’.
Context: ...ed battery energy content is available. These value are not suited for direct use with the ...
(THIS_NNS)
[uncategorized] ~479-~479: Possible missing comma found.
Context: ...resenting total power in and power out. Next each entity needs to be integrated into...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~479-~479: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. {% details "Concept to sp...
(AI_HYDRA_LEO_CP_OFF_OF)
[uncategorized] ~509-~509: Possible missing article found.
Context: ...e_class: measurement ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~516-~516: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. This method does not accou...
(AI_HYDRA_LEO_CP_OFF_OF)
[uncategorized] ~516-~516: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~546-~546: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[formatting] ~658-~658: Consider inserting a comma after an introductory phrase for better readability.
Context: ...of up to 15 minutes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[formatting] ~664-~664: Consider inserting a comma after an introductory phrase for better readability.
Context: ...d unexpected spikes have been reported. In this case best use a utility meter with the `Life...
(IN_THAT_CASE_COMMA)
[uncategorized] ~669-~669: Possible missing comma found.
Context: ...ut installed CT, running older firmware versions reportedly resets **Lifetime energy pro...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~669-~669: Possible missing comma found.
Context: ...aching 1.2 MWh. For use with the energy dashboard the reset is not an issue. In a recent ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~682-~682: Possible missing comma found.
Context: ... enddetails %} ### Summed Voltage The Envoy Metered in multiphase setup, sums the v...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (3)
source/_integrations/enphase_envoy.markdown (3)
45-45: LGTM! Clear prerequisites and authentication details.The additions provide valuable clarification about:
- Network connectivity requirements with a helpful reference to troubleshooting
- Token-based authentication process for firmware 7.0+
Also applies to: 62-63
93-357: LGTM! Comprehensive capabilities documentation.The section provides clear and detailed documentation of:
- Device communication capabilities
- Data reporting for various components
- Entity descriptions and their purposes
🧰 Tools
🪛 LanguageTool
[uncategorized] ~157-~157: “of” seems less likely than “or” (‘either … or’).
Context: ...n and/or storage measurements in single of multiple phase setups. Below diagram s...(AI_HYDRA_LEO_CP_OF_OR)
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single of multiple phase setups. Below diagram shows CT installation positions...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~216-~216: Possible missing comma found.
Context: ...) when non-zero. For storage CT energy entities refer to [battery sensor](#aggregated-i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~240-~240: Possible missing preposition found.
Context: ... configurations can provide integration entity data. - AC-Batteries: first genera...(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~319-~319: Possible missing article found.
Context: ...d maximum battery energy content in Wh Below figure shows the 3 Aggregated entities ...(AI_HYDRA_LEO_MISSING_THE)
690-696: LGTM! Clear troubleshooting guidance.The additions provide valuable troubleshooting information:
- Clear explanation of network connectivity requirements
- Helpful guidance on interpreting CT status flags
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/enphase_envoy.markdown (1)
158-158: Minor grammatical improvements neededConsider adding the article "The" before instances of "Below diagram/figure" to improve readability:
- Line 158: "The below diagram shows..."
- Line 319: "The below figure shows..."
- Lines 453, 509, 546: "The above example does not..."
Also applies to: 319-319, 453-453, 509-509, 546-546
🧰 Tools
🪛 LanguageTool
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single or multiple phase setups. Below diagram shows CT installation positions...(AI_HYDRA_LEO_MISSING_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single or multiple phase setups. Below diagram shows CT installation positions...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~216-~216: Possible missing comma found.
Context: ...) when non-zero. For storage CT energy entities refer to [battery sensor](#aggregated-i...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~319-~319: Possible missing article found.
Context: ...d maximum battery energy content in Wh Below figure shows the 3 Aggregated entities ...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~396-~396: Possible missing comma found.
Context: ...l entities of the Envoy and the related devices like the inverters; there is no need to...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~408-~408: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~453-~453: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~454-~454: Possible missing comma found.
Context: ...ates, value changes over Home Assistant outages nor changing UOM to a preferred one. Ex...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~509-~509: Possible missing article found.
Context: ...e_class: measurement ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~546-~546: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...
(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~658-~658: A determiner may be missing.
Context: ...minutes have been reported. In this case, best use a utility meter with the `Lifetime ...
(THE_SUPERLATIVE)
[grammar] ~664-~664: A determiner may be missing.
Context: ... spikes have been reported. In this case, best use a utility meter with the `Lifetime ...
(THE_SUPERLATIVE)
🔇 Additional comments (3)
source/_integrations/enphase_envoy.markdown (3)
79-84: Well-structured addition of the reconfiguration section!The new section clearly explains when and how to use the reconfigure option, particularly for token-based authentication changes.
642-655: Clear documentation of firmware limitations!The firmware changes section effectively communicates the critical limitation regarding battery controls in firmware 8.2.4225+. This helps users understand current limitations and sets appropriate expectations.
Line range hint
1-696: Documentation follows Home Assistant standards excellently!The documentation consistently uses:
- Proper Home Assistant terminology and formatting
- Standard sections and structure
- Clear examples and explanations
🧰 Tools
🪛 LanguageTool
[uncategorized] ~158-~158: Possible missing article found.
Context: ...ts in single or multiple phase setups. Below diagram shows CT installation positions...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~216-~216: Possible missing comma found.
Context: ...) when non-zero. For storage CT energy entities refer to [battery sensor](#aggregated-i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~319-~319: Possible missing article found.
Context: ...d maximum battery energy content in Wh Below figure shows the 3 Aggregated entities ...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~396-~396: Possible missing comma found.
Context: ...l entities of the Envoy and the related devices like the inverters; there is no need to...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~408-~408: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~453-~453: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~454-~454: Possible missing comma found.
Context: ...ates, value changes over Home Assistant outages nor changing UOM to a preferred one. Ex...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~509-~509: Possible missing article found.
Context: ...e_class: measurement ``` {% endraw %} Above example does not address handling `unav...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~546-~546: Possible missing article found.
Context: ...ss: total_increasing ``` {% endraw %} Above example does not address handling `unav...(AI_HYDRA_LEO_MISSING_THE)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/enphase_envoy.markdown (2)
93-99: Fix grammatical error in product naming note.The product naming note is informative but contains a grammatical error.
Apply this change to improve readability:
-You may know referred product names under other names from the past or future. +You may know these product names under other names from the past or future.
402-553: Consider adding reliability notes for templates.The energy dashboard section is comprehensive, but consider adding notes about:
- Template reliability during Home Assistant restarts
- Data persistence considerations
- Error handling recommendations
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[grammar] ~658-~658: A determiner may be missing.
Context: ...minutes have been reported. In this case, best use a utility meter with the `Lifetime ...
(THE_SUPERLATIVE)
[grammar] ~664-~664: A determiner may be missing.
Context: ... spikes have been reported. In this case, best use a utility meter with the `Lifetime ...
(THE_SUPERLATIVE)
🔇 Additional comments (7)
source/_integrations/enphase_envoy.markdown (7)
45-47: LGTM! Clear prerequisites documentation.The prerequisites section is well-structured and provides clear requirements, with helpful cross-references to related sections.
62-63: LGTM! Clear authentication documentation.The username field description clearly explains the token-based authentication process and validity period.
137-357: LGTM! Comprehensive sensor entities documentation.The sensor entities documentation is thorough and well-organized, with clear descriptions, helpful figures, and proper cross-referencing.
392-396: LGTM! Clear polling interval documentation.The data polling section provides clear guidance on default and custom polling intervals, with important considerations about resource usage.
593-593: LGTM! Clear action documentation.The action documentation clearly describes parameters and includes helpful examples.
642-686: LGTM! Comprehensive known issues documentation.The known issues section clearly documents firmware-related changes, limitations, and workarounds.
🧰 Tools
🪛 LanguageTool
[grammar] ~658-~658: A determiner may be missing.
Context: ...minutes have been reported. In this case, best use a utility meter with the `Lifetime ...(THE_SUPERLATIVE)
[grammar] ~664-~664: A determiner may be missing.
Context: ... spikes have been reported. In this case, best use a utility meter with the `Lifetime ...(THE_SUPERLATIVE)
690-696: LGTM! Clear troubleshooting guidance.The troubleshooting section provides clear, actionable steps for resolving common issues.
|
I'm done for now, ready for human review. |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
|
Thank you for this nice addition to the docs! |
Thanks for your review, sorry for making this so large, kept going too long when I started to visualize the end-picture. I'll try doing better next time. Let me know if I should split this one. |
|
|
||
| ## Troubleshooting | ||
|
|
||
| - The Envoy should not be both on your local LAN and local Wi-Fi at the same time. This may cause auto-discovery to switch back and forth between the interfaces resulting in brief outages every 30 minutes. If you experience these frequent brief outages, make sure only 1 interface is used. | ||
| ### Single network |
There was a problem hiding this comment.
| ### Single network | |
| ### Periodic network connection issues |
I think the title of a troubleshooting item should describe the symptom people are noticing so that it can be found more easily. Feel free to rephrase if you can think of a better description.
There was a problem hiding this comment.
Excellent proposal! Applied
|
|
||
| The Envoy should not be both on your local LAN (Ethernet) and local Wi-Fi simultaneously. Having both connections active can cause auto-discovery to alternate between interfaces, resulting in connection interruptions approximately every 30 minutes. If you experience these periodic connection issues, ensure the Envoy is connected using only one interface (either Ethernet OR Wi-Fi, not both). | ||
|
|
||
| ### CT Active flag count |
There was a problem hiding this comment.
| ### CT Active flag count | |
| ### CT Active flag count is non-zero |
|
I see that the PR is still in Draft mode. are you planning more changes? |
|
Thanks for your review. No, I'm done with this one, more changes are in Next along with a code change PR. Think I forgot to press the ready for review. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
source/_integrations/enphase_envoy.markdown (2)
642-655: Important firmware limitation information!The sections clearly document firmware-related changes and limitations, particularly the battery control restrictions in firmware 8.2.4225.
Consider adding a note about how users can check their current firmware version to help them determine if they're affected by these limitations.
516-516: Fix grammatical errorChange "out off the battery" to "out of the battery" for correct grammar.
-coming out off the battery. This method does not account +coming out of the battery. This method does not account🧰 Tools
🪛 LanguageTool
[uncategorized] ~516-~516: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. This method does not accou...(AI_HYDRA_LEO_CP_OFF_OF)
[uncategorized] ~516-~516: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(6 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/enphase_envoy.markdown
45-45: null
Link fragments should be valid
(MD051, link-fragments)
196-196: null
Link fragments should be valid
(MD051, link-fragments)
205-205: null
Link fragments should be valid
(MD051, link-fragments)
214-214: null
Link fragments should be valid
(MD051, link-fragments)
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[uncategorized] ~216-~216: Possible missing comma found.
Context: ...) when non-zero. For storage CT energy entities refer to [battery sensor](#aggregated-i...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~408-~408: Possible missing comma found.
Context: ...r> Lifetime energy production** entity. Overall this has proven to be more stable as th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~516-~516: “off” (as in: go/turn off, off the coast) seems less likely than “of”.
Context: ... into the battery and Energy coming out off the battery. This method does not accou...
(AI_HYDRA_LEO_CP_OFF_OF)
[uncategorized] ~516-~516: Possible missing comma found.
Context: ... method does not account for conversion losses as Energy content changes do not exactl...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~658-~658: A determiner may be missing.
Context: ...minutes have been reported. In this case, best use a utility meter with the `Lifetime ...
(THE_SUPERLATIVE)
[grammar] ~664-~664: A determiner may be missing.
Context: ... spikes have been reported. In this case, best use a utility meter with the `Lifetime ...
(THE_SUPERLATIVE)
🔇 Additional comments (6)
source/_integrations/enphase_envoy.markdown (6)
45-47: Well-structured prerequisites!The added network connectivity requirement with troubleshooting reference and firmware version requirements improve clarity for users.
🧰 Tools
🪛 Markdownlint (0.37.0)
45-45: null
Link fragments should be valid(MD051, link-fragments)
62-63: Clear authentication requirements!The expanded description clearly explains the username requirements and token handling for different firmware versions.
79-84: Comprehensive reconfiguration guidance!The new section effectively explains when and how to update the configuration, particularly for firmware-related changes.
93-99: Clear capability description and naming conventions!The expanded capabilities section and note about product naming improve documentation clarity.
690-693: Clear network troubleshooting guidance!The section effectively explains the cause of periodic connection issues and provides a clear solution.
694-696: Helpful CT troubleshooting information!The section provides clear guidance on diagnosing CT status flag issues using the diagnostic report.
| - **Envoy <abbr title="Envoy serial number">SN</abbr> Production CT current**: Current in A. | ||
| - **Envoy <abbr title="Envoy serial number">SN</abbr> Powerfactor production CT**: Powerfactor, ratio of active to apparent power. | ||
| - **Envoy <abbr title="Envoy serial number">SN</abbr> Metering status production CT**: Status of the metering process: `normal`, `not-metering`, `check-wiring`. | ||
| - **Envoy <abbr title="Envoy serial number">SN</abbr> Meter status flags active production CT**: Count of CT status flags active. See troubleshooting [CT Active flag count](#ct-active-flag-count) when non-zero. |
There was a problem hiding this comment.
💡 Codebase verification
Incorrect link fragments need updating
The link fragments #ct-active-flag-count should be updated to #ct-active-flag-count-is-non-zero to match the actual section title "CT Active flag count is non-zero".
- Line 196: Update
#ct-active-flag-count→#ct-active-flag-count-is-non-zero - Line 205: Update
#ct-active-flag-count→#ct-active-flag-count-is-non-zero - Line 214: Update
#ct-active-flag-count→#ct-active-flag-count-is-non-zero
🔗 Analysis chain
Verify link fragment references
The following link fragments may be invalid:
- Line 196:
#ct-active-flag-count - Line 205:
#ct-active-flag-count - Line 214:
#ct-active-flag-count
Please verify these links point to the correct sections.
Also applies to: 205-205, 214-214
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the referenced sections exist in the file
rg -i "^#+.*ct.*active.*flag.*count" source/_integrations/enphase_envoy.markdown
Length of output: 119
Script:
#!/bin/bash
# Get more context around the section and check for similar sections
rg -B 1 -A 3 "^#+.*CT.*Active.*flag.*count" source/_integrations/enphase_envoy.markdown
Length of output: 642
Script:
#!/bin/bash
# Check if the diagnostics section exists
rg -i "^#+.*diagnostics.*$" source/_integrations/enphase_envoy.markdown
Length of output: 121
🧰 Tools
🪛 Markdownlint (0.37.0)
196-196: null
Link fragments should be valid
(MD051, link-fragments)
Proposed change
Update Enphase Envoy documentation with missing integration quality scale standard items for documentation.
More specifically this PR adds, rewords and re-organizes the documentation to meet docs requirements:
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit