Add description of enphase_envoy get_firmware, get_last_data, get_current_data and post_data actions #36740
Conversation
…rent_data and post_data actions
home-assistant
bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the Enphase Envoy integration documentation by introducing four new actions: Changes
Sequence DiagramsequenceDiagram
participant User
participant HomeAssistant
participant EnphaseEnvoy
User->>HomeAssistant: Request firmware version
HomeAssistant->>EnphaseEnvoy: Get firmware
EnphaseEnvoy-->>HomeAssistant: Return firmware versions
HomeAssistant-->>User: Display firmware info
User->>HomeAssistant: Request current data
HomeAssistant->>EnphaseEnvoy: Get current data
EnphaseEnvoy-->>HomeAssistant: Return device data
HomeAssistant-->>User: Display device data
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
🧹 Nitpick comments (5)
source/_integrations/enphase_envoy.markdown (5)
194-202: Fix formatting in the actions listRemove the extra space after the colon.
-Available actions are: - +Available actions are:🧰 Tools
🪛 LanguageTool
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ...ailable actions are: -switch.turn_on,switch.turn_off,switch.toggle- [`...(UNLIKELY_OPENING_PUNCTUATION)
348-348: Fix grammatical error in noteReplace "then" with "than" in the comparison.
-Do not schedule or execute it at intervals less then the default collection time of 1 minute. +Do not schedule or execute it at intervals less than the default collection time of 1 minute.🧰 Tools
🪛 LanguageTool
[grammar] ~348-~348: Comparison requires “than”, not ‘then’ nor ‘as’.
Context: ...chedule or execute it at intervals less then the default collection time of 1 minute...(COMP_THAN)
493-493: Fix grammatical errors in the descriptionThere are two grammar issues to fix:
- Add a comma before "however"
- Use correct past participle "sent" instead of "send"
-This action however, has the endpoint as required, no *give me all data* option. Also, a GET request is send to the envoy for each action call. +This action, however, has the endpoint as required, no *give me all data* option. Also, a GET request is sent to the envoy for each action call.🧰 Tools
🪛 LanguageTool
[formatting] ~493-~493: Consider inserting a comma before ‘however’.
Context: ...xes to select data to be returned. This action however, has the endpoint as required, no *give ...(HOWEVER_MISSING_COMMA)
[grammar] ~493-~493: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...ll data* option. Also, a GET request is send to the envoy for each action call. In ...(BEEN_PART_AGREEMENT)
498-498: Fix grammatical error in noteReplace "then" with "than" in the comparison.
-Be careful with scheduling it at intervals less then the default collection time of 1 minute. +Be careful with scheduling it at intervals less than the default collection time of 1 minute.🧰 Tools
🪛 LanguageTool
[grammar] ~498-~498: Comparison requires “than”, not ‘then’ nor ‘as’.
Context: ...ul with scheduling it at intervals less then the default collection time of 1 minute...(COMP_THAN)
507-508: Fix JSON terminology and grammarThere are several issues to address:
- Correct the spelling of "JSON"
- Fix the grammar of "is send"
-This action allows sending data to the envoy. Data must be a JSON string that can pass the json.loads method. The jason data is send to the specified endpoint on the envoy. +This action allows sending data to the envoy. Data must be a JSON string that can pass the JSON.loads method. The JSON data is sent to the specified endpoint on the envoy.🧰 Tools
🪛 LanguageTool
[grammar] ~507-~507: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...he json.loads method. The jason data is send to the specified endpoint on the envoy....(BEEN_PART_AGREEMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
source/images/integrations/enphase_envoy/enphase_envoy_action_getfirmware_dev_ui.pngis excluded by!**/*.png
📒 Files selected for processing (1)
source/_integrations/enphase_envoy.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/enphase_envoy.markdown
[uncategorized] ~196-~196: Loose punctuation mark.
Context: ...ailable actions are: - switch.turn_on, switch.turn_off, switch.toggle - [`...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~348-~348: Comparison requires “than”, not ‘then’ nor ‘as’.
Context: ...chedule or execute it at intervals less then the default collection time of 1 minute...
(COMP_THAN)
[grammar] ~461-~461: This noun normally spelled as one word.
Context: ...dpoints are accessible using an Enphase Home Owner account. | Data attribute | Optional |...
(OWNER_COMPOUNDS)
[formatting] ~493-~493: Consider inserting a comma before ‘however’.
Context: ...xes to select data to be returned. This action however, has the endpoint as required, no *give ...
(HOWEVER_MISSING_COMMA)
[grammar] ~493-~493: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...ll data* option. Also, a GET request is send to the envoy for each action call. In ...
(BEEN_PART_AGREEMENT)
[grammar] ~498-~498: Comparison requires “than”, not ‘then’ nor ‘as’.
Context: ...ul with scheduling it at intervals less then the default collection time of 1 minute...
(COMP_THAN)
[grammar] ~507-~507: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...he json.loads method. The jason data is send to the specified endpoint on the envoy....
(BEEN_PART_AGREEMENT)
🪛 Markdownlint (0.37.0)
source/_integrations/enphase_envoy.markdown
316-316: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
316-316: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
434-434: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
434-434: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
495-495: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
495-495: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
565-565: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
565-565: Expected: asterisk; Actual: underscore
Emphasis style
(MD049, emphasis-style)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/enphase_envoy.markdown
[error] 516-516: Incorrect usage of the term: "json", use "JSON" instead
🔇 Additional comments (1)
source/_integrations/enphase_envoy.markdown (1)
285-570: Documentation looks great!The documentation for the new actions is comprehensive, well-structured, and includes clear examples and appropriate warnings. The explanations are thorough and will help users understand how to use these new features effectively.
🧰 Tools
🪛 LanguageTool
[grammar] ~348-~348: Comparison requires “than”, not ‘then’ nor ‘as’.
Context: ...chedule or execute it at intervals less then the default collection time of 1 minute...(COMP_THAN)
[grammar] ~461-~461: This noun normally spelled as one word.
Context: ...dpoints are accessible using an Enphase Home Owner account. | Data attribute | Optional |...(OWNER_COMPOUNDS)
[formatting] ~493-~493: Consider inserting a comma before ‘however’.
Context: ...xes to select data to be returned. This action however, has the endpoint as required, no *give ...(HOWEVER_MISSING_COMMA)
[grammar] ~493-~493: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...ll data* option. Also, a GET request is send to the envoy for each action call. In ...(BEEN_PART_AGREEMENT)
[grammar] ~498-~498: Comparison requires “than”, not ‘then’ nor ‘as’.
Context: ...ul with scheduling it at intervals less then the default collection time of 1 minute...(COMP_THAN)
[grammar] ~507-~507: Consider using either the past participle “sent” or the present participle “sending” here.
Context: ...he json.loads method. The jason data is send to the specified endpoint on the envoy....(BEEN_PART_AGREEMENT)
🪛 Markdownlint (0.37.0)
316-316: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
316-316: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
434-434: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
434-434: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
495-495: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
495-495: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
565-565: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
565-565: Expected: asterisk; Actual: underscore
Emphasis style(MD049, emphasis-style)
🪛 GitHub Actions: home-assistant.io Test
[error] 516-516: Incorrect usage of the term: "json", use "JSON" instead
home-assistant
bot
added
has-parent
Proposed change
Enphase Envoy integrations gets 4 services/actions added:
This PR documents the new actions/services.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit