Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for new service renault.ac_set_schedules #34520

Closed
wants to merge 102 commits into from

Conversation

vhkristof
Copy link

@vhkristof vhkristof commented Sep 1, 2024

Proposed change

This PR adds documentation for the new service that is implemented by home-assistant/core#125006

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features

    • Updated the ruby-lsp gem to version 0.17.17, potentially introducing new features and improvements.
    • Added a new action renault.ac_set_schedules for updating vehicle air conditioning schedules.
    • Enhanced documentation for the Philips Hue integration with new instructions for V1 bridge users.
  • Bug Fixes

    • Clarified configuration requirements for various integrations, improving user guidance and reducing potential errors.
  • Documentation

    • Improved clarity and consistency across multiple integration documents, including updates to links and formatting for better navigation.
    • Added new sections and details in documentation to enhance user understanding of integrations and their functionalities.
  • Chores

    • Minor formatting adjustments throughout documentation to enhance readability and clarity.

c0ffeeca7 and others added 30 commits August 8, 2024 09:49
…ant#34193)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
* Clarification for raw tip voltage sensor, add ha category

* add comma
…t#34217)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…34218)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…34216)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Closing quote missing from the template
home-assistant#34244)

* Update IMAP docs on use of App passwords and removed Microsoft support

* Suggested update

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Tiny tweak

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <[email protected]>
…e-assistant#34251)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…34250)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…#34252)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Link to all entities that is support in group

Link to all entities that are currently supported in a group

* tiny tweak

---------

Co-authored-by: c0ffeeca7 <[email protected]>
…tant#34257)

* Cleanup mqtt publish action template option documentation

* Missed instance
Copy link

netlify bot commented Sep 1, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 65fdad7
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66d43372b683dc0008cd8a0d
😎 Deploy Preview https://deploy-preview-34520--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Sep 1, 2024

Walkthrough

Walkthrough

The recent changes encompass updates to various documentation files and configuration settings across the Home Assistant platform. These updates include version increments for libraries, enhancements to integration documentation, modifications to action handling, and the introduction of new features. Additionally, several links have been updated to reflect a reorganization of documentation sections, improving navigation and clarity for users.

Changes

File(s) Change Summary
Gemfile, package.json Updated versions of ruby-lsp and textlint libraries.
_config.yml Updated current_patch_version from 0 to 3 and date_released from 2024-08-07 to 2024-08-25.
plugins/details.rb Refactored HTML and JavaScript for collapsible details using native <details> and <summary> elements.
source/_data/glossary.yml Added new term "Custom integration" and updated links for "Integrations" and "Service".
source/_docs/automation/trigger.markdown Clarified conditions for numeric value comparisons in automation triggers.
source/_docs/blueprint/schema.markdown Updated min_version description and expanded input section documentation.
source/_docs/blueprint/tutorial.markdown Updated URL references for turn_on and turn_off actions.
source/_docs/configuration/templating.markdown Clarified today_at(value) function defaults to midnight.
source/_docs/locked_out.md Restructured password reset instructions for Home Assistant Yellow and Green devices.
source/_docs/scripts.markdown Updated actions page link from /docs/scripts/service-calls/ to /docs/scripts/perform-actions/.
source/_integrations/androidtv_remote.markdown Refactored action handling for buttons to streamline configuration.
source/_integrations/aranet.markdown Added "Aranet Radiation" sensor to supported devices list.
source/_integrations/bluetooth.markdown Added related documentation links for Bluetooth integration.
source/_integrations/calendar.markdown Updated action links from service calls to perform actions section.
source/_integrations/config.markdown Added related documentation links and clarified configuration.yaml reference.
source/_integrations/conversation.markdown Updated URL for response data handling reference.
source/_integrations/device_tracker.markdown Clarified configuration context by explicitly mentioning configuration.yaml.
source/_integrations/dhcp.markdown Clarified manual enabling of the integration in configuration.yaml.
source/_integrations/easyenergy.markdown Updated action links from service calls to perform actions section.
source/_integrations/emulated_hue.markdown Enhanced configuration sample description for clarity.
source/_integrations/energyzero.markdown Updated action links from service calls to perform actions section.
source/_integrations/enmax.markdown Added "Limitations" section regarding data publishing frequency.
source/_integrations/fan.template.markdown Updated formatting of configuration.yaml reference.
source/_integrations/flux.markdown Added default values for start_time and stop_time fields in configuration schema.
source/_integrations/frontend.markdown Enhanced clarity and consistency in configuration file references.
source/_integrations/generic_hygrostat.markdown Improved clarity in configuration instructions.
source/_integrations/google_generative_ai_conversation.markdown Updated documentation link for handling response data.
source/_integrations/group.markdown Refined documentation for grouping entities and updated terminology.
source/_integrations/history_stats.markdown Updated today_at() function calls to include specific time argument.
source/_integrations/homeassistant.markdown Enhanced formatting and presentation of documentation.
source/_integrations/homeassistant_alerts.markdown Clarified configuration file reference.
source/_integrations/http.markdown Clarified configuration entry location in configuration.yaml.
source/_integrations/hue.markdown Added instructions for creating scripts for V1 Hue bridges.
source/_integrations/imap.markdown Updated sections regarding App Passwords and Microsoft 365 IMAP services.
source/_integrations/input_boolean.markdown Minor textual modification for clarity.
source/_integrations/input_datetime.markdown Enhanced formatting for configuration.yaml reference and improved table alignment.
source/_integrations/iron_os.markdown Added minimum requirements and clarified control descriptions.
source/_integrations/knx.markdown Renamed trigger-related variables for clarity.
source/_integrations/light.template.markdown Updated formatting for configuration.yaml reference.
source/_integrations/linear_garage_door.markdown Added warning about app transition and prerequisites.
source/_integrations/logbook.markdown Added related documentation links and clarified configuration file reference.
source/_integrations/matter.markdown Clarified OTA update functionality for Matter devices.
source/_integrations/motionblinds_ble.markdown Updated documentation link for homeassistant.update_entity action.
source/_integrations/mqtt.markdown Streamlined documentation with YAML examples for publishing actions.
source/_integrations/nws.markdown Updated hyperlinks for response data handling.
source/_integrations/ollama.markdown Introduced experimental feature for controlling Home Assistant.
source/_integrations/openai_conversation.markdown Updated documentation link for handling response data.
source/_integrations/python_script.markdown Updated documentation link for output variable.
source/_integrations/qbittorrent.markdown Updated action links for handling response data.
source/_integrations/renault.markdown Added new action renault.ac_set_schedules for updating AC schedules.
source/_integrations/reolink.markdown Clarified password character restrictions and expanded product descriptions.
source/_integrations/rest_command.markdown Updated hyperlink for handling response data.
source/_integrations/roomba.markdown Clarified default behavior of Roomba's MQTT server connection.
source/_integrations/russound_rio.markdown Added "Supported devices" section to enhance documentation.
source/_integrations/russound_rnet.markdown Added "Supported devices" section to enhance documentation.
source/_integrations/sensor.mqtt.markdown Minor syntax correction in value_template string.
source/_integrations/seventeentrack.markdown Updated template for accessing package tracking data.
source/_integrations/shell_command.markdown Updated documentation link for response_variable.
source/_integrations/shelly.markdown Updated firmware requirements for Shelly generation 3 devices.
source/_integrations/simplefin.markdown Added "Finance" category to integration documentation.
source/_integrations/sleepiq.markdown Added "Prerequisites" section and improved overall structure.
source/_integrations/statistics.markdown Enhanced descriptions of state characteristics for sensor sources.
source/_integrations/swiss_public_transport.markdown Changed configuration parameter from "start station" to "end station."
source/_integrations/system_bridge.markdown Updated URLs for response data handling.
source/_integrations/tailscale.markdown Updated terminology from "API key" to "API access token."
source/_integrations/tellduslive.markdown Added note regarding authorization error message.
source/_integrations/template.markdown Updated links for action response data handling.
source/_integrations/tesla_fleet.markdown Added prerequisite regarding "My Home Assistant" integration.
source/_integrations/tibber.markdown Updated action links and improved table formatting.
source/_integrations/todo.markdown Updated action links and standardized table formatting.
source/_integrations/wake_on_lan.markdown Changed terminology from "switch" to "button" for clarity.
source/_integrations/waze_travel_time.markdown Updated documentation link for response data handling.
source/_integrations/weather.markdown Updated documentation link for response data handling.
source/_integrations/wled.markdown Enhanced documentation with prerequisites and clarified hardware compatibility.
source/_integrations/workday.markdown Updated documentation link for handling response data.
source/_integrations/zha.markdown Updated hyperlink reference for Zigbee binding and unbinding.
source/_posts/2024-08-07-release-20248.markdown Added "Patch releases" section detailing updates and fixes for versions 2024.8.1, 2024.8.2, and 2024.8.3.
source/_posts/2024-08-08-works-with-home-assistant-becomes-part-ohf.markdown Detailed transition of "Works with Home Assistant" program to the Open Home Foundation.

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vhkristof vhkristof changed the title Patch 1 Add documentation for new service renault.ac_set_schedules Sep 1, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (8)
source/_integrations/tailscale.markdown (1)

41-41: Nitpick: Add a hyphen in "top left corner".

Consider adding a hyphen in "top left corner" to improve readability:

-You can find it in the top left corner in the [Tailscale Admin Panel](https://login.tailscale.com/admin/settings/keys)
+You can find it in the top-left corner in the [Tailscale Admin Panel](https://login.tailscale.com/admin/settings/keys)
Tools
LanguageTool

[uncategorized] ~41-~41: Consider adding a hyphen.
Context: ...ilscale network. You can find it in the top left corner in the [Tailscale Admin Panel](h...

(TOP_LEFT_CORNER)

source/_integrations/ollama.markdown (2)

26-27: Experimental feature. Approved with a minor suggestion.

The introduction of the new experimental feature that allows the Ollama integration to control devices and entities through the Assist API is approved. However, please consider adding the missing word "with" to the sentence for better clarity:

-The AI is able to provide you information about your devices and control them.
+The AI is able to provide you with information about your devices and control them.
Tools
LanguageTool

[style] ~26-~26: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...itle="exposed entities page" %}. The AI is able to provide you information about your devi...

(BE_ABLE_TO)


[uncategorized] ~26-~26: Possible missing preposition found.
Context: ...page" %}. The AI is able to provide you information about your devices and control them. T...

(AI_EN_LECTOR_MISSING_PREPOSITION)


Line range hint 45-69: Valuable information and guidelines. Approved with a minor suggestion.

The new section titled "Controlling Home Assistant" provides valuable information and guidelines for users who want to experiment with the new feature. The section's content is clear and well-structured, and the suggestion to use multiple Ollama configurations for handling conversations and controlling Home Assistant separately is a good workaround for the limitations of smaller models.

However, please consider adding the missing comma after "model" in the following sentence for better readability:

-However, you may use multiple Ollama configurations that share the same model but use different prompts:
+However, you may use multiple Ollama configurations that share the same model, but use different prompts:
Tools
LanguageTool

[uncategorized] ~52-~52: A determiner appears to be missing. Consider inserting it.
Context: ...sage (-1 = no limit, 0 = no retention). Default value is -1. {% endconfiguration_basic...

(AI_EN_LECTOR_MISSING_DETERMINER)


[style] ~68-~68: This phrase might be redundant. Consider either removing or replacing the adjective ‘additional’.
Context: ...rsation agent to have a conversation. - Add an additional Ollama integration, using the same model, enab...

(ADD_AN_ADDITIONAL)

source/_integrations/renault.markdown (1)

61-93: LGTM! Just a minor suggestion to improve the table formatting.

The new action renault.ac_set_schedules is well-documented and significantly expands the functionality related to vehicle scheduling, allowing for more comprehensive management of AC settings. The documentation is clear and provides sufficient details for users to understand and utilize the new action effectively.

Based on the static analysis hint, please consider adding an extra cell to the table row at line 67 to ensure consistent column count and avoid missing data:

-  | `vehicle`| yes | device_id of the vehicle |
+  | `vehicle`| yes | device_id of the vehicle | |
Tools
Markdownlint

67-67: Expected: 4; Actual: 3; Too few cells, row will be missing data
Table column count

(MD056, table-column-count)

LanguageTool

[style] ~68-~68: To form a complete sentence, be sure to include a subject or ‘there’.
Context: ...| schedules | yes | Schedule details. Can be a single schedule or a list of sched...

(MISSING_IT_THERE)


[style] ~72-~72: To form a complete sentence, be sure to include a subject.
Context: ...ule_example) | Notes: - schedules can be in the form {'id':1,...} when upda...

(MISSING_IT_THERE)


[grammar] ~72-~72: Do not use the singular ‘a’ before the plural noun ‘schedules’.
Context: ...n the form {'id':1,...} when updating a single schedules, or in the form `[{'id':1,...},{'id':2,...

(VB_A_JJ_NNS)

source/voice_control/thirteen-usd-voice-remote.markdown (1)

98-98: Consider adding a comma before 'and'.

LanguageTool suggests adding a comma before 'and' to separate two independent clauses:

... for Assist to find you're done speaking and it can start processing your command.

While the absence of the comma does not significantly impact the clarity of the instructions, adding it would improve the readability of the sentence.

Apply this diff to add the comma:

- This setting defines how much silence is needed for Assist to find you're done speaking and it can start processing your command.
+ This setting defines how much silence is needed for Assist to find you're done speaking, and it can start processing your command.
Tools
LanguageTool

[uncategorized] ~98-~98: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... for Assist to find you're done speaking and it can start processing your command. ...

(COMMA_COMPOUND_SENTENCE)

source/_integrations/calendar.markdown (1)

Line range hint 160-160: LGTM! But consider adding a note to highlight the change in behavior.

The change modifies the condition evaluation logic to display the entity only if it matches all specified conditions. This is a significant change in behavior that users should be made aware of.

Consider adding a note to highlight this change, for example:

{% note %}
The condition evaluation logic has been updated in this version. The entity will now be displayed only if it matches all specified conditions. Previously, it was displayed if it matched any condition.
{% endnote %}
Tools
LanguageTool

[uncategorized] ~145-~145: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ar {% term entity %} are described below or you can read more about [actions](/docs...

(COMMA_COMPOUND_SENTENCE)

source/_integrations/homeassistant.markdown (1)

215-215: LGTM! Nit: Consider rephrasing.

The change to use the term syntax for configuration.yaml improves the formatting consistency and readability of the documentation.

To address the style hint from LanguageTool, consider rephrasing:

-If you implement `customize`, `customize_domain`, or `customize_glob`, in your {% term "`configuration.yaml`" %} file, you must make sure it is done inside of `homeassistant:` or it will fail.
+If you implement `customize`, `customize_domain`, or `customize_glob`, in your {% term "`configuration.yaml`" %} file, you must make sure it is done inside `homeassistant:` or it will fail.
Tools
LanguageTool

[style] ~215-~215: This phrase is redundant. Consider using “inside”.
Context: ... %} file, you must make sure it is done inside of homeassistant: or it will fail. {% en...

(OUTSIDE_OF)

source/_integrations/matter.markdown (1)

329-330: Approved with a nitpick: The additional context is useful, but consider rephrasing "in future" for consistency.

The expanded mention of the Distributed Compliance Ledger (DCL) provides useful context about its current usage by Eve and Nanoleaf for updates, as well as the expectation of broader future adoption. This additional information is valuable for readers.

For consistency with American English, consider rephrasing "in future" to "in the future":

-It is expected that in future, more and more firmware updates become available through the DCL.
+It is expected that in the future, more and more firmware updates will become available through the DCL.
Tools
LanguageTool

[locale-violation] ~329-~329: The phrase ‘in future’ is British English. Did you mean: “in the future”?
Context: ...to provide updates. It is expected that in future, more and more firmware updates become ...

(IN_FUTURE)


```text
https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos[variant.key]}}/haos_{{ variant.key }}-{{site.data.version_data.hassos[variant.key]}}.img.xz
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove trailing spaces.

Markdownlint reports trailing spaces at line 92. Please remove them for consistency and cleanliness of the document.

Apply this diff to fix the issue:

-    ```    
+    ```
Tools
Markdownlint

92-92: Expected: 0 or 2; Actual: 4
Trailing spaces

(MD009, no-trailing-spaces)

@vhkristof vhkristof closed this Sep 1, 2024
@vhkristof vhkristof deleted the patch-1 branch September 1, 2024 09:48
@vhkristof
Copy link
Author

Closed. Created PR to wrong branch

@github-actions github-actions bot locked and limited conversation to collaborators Sep 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.