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

Added icon_hold_action and icon_double_tap_action for tile card #34682

Conversation

martindybal
Copy link
Contributor

@martindybal martindybal commented Sep 11, 2024

Proposed change

Changes related to this PR home-assistant/frontend#21947

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

Summary by CodeRabbit

  • New Features

    • Introduced two new interactive actions for icon cards: icon_hold_action and icon_double_tap_action, enhancing user engagement and control in the dashboard configuration.
    • Added new sections detailing the states of various entities, including air quality, alarm panels, calendars, cameras, covers, dates, date/time, lawn mowers, locks, media players, notifications, and Z-Wave integrations.
  • Documentation Improvements

    • Enhanced clarity and detail in automation documentation regarding event and state triggers.
    • Improved descriptions of datetime-related functions for better user understanding.
    • Updated links in the template integration documentation for accuracy.
    • Reformatted and clarified existing documentation for better readability and organization across multiple integrations.

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>
Co-authored-by: TheJulianJES <TheJulianJES@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 <38767475+c0ffeeca7@users.noreply.github.com>
…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 <38767475+c0ffeeca7@users.noreply.github.com>
…tant#34257)

* Cleanup mqtt publish action template option documentation

* Missed instance
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch current This PR goes into the current branch labels Sep 12, 2024
@home-assistant home-assistant bot added the next This PR goes into the next branch label Sep 12, 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f36d66d and dcb5d86.

Files selected for processing (9)
  • source/_docs/automation/trigger.markdown (7 hunks)
  • source/_docs/configuration/templating.markdown (3 hunks)
  • source/_integrations/enphase_envoy.markdown (1 hunks)
  • source/_integrations/opentherm_gw.markdown (1 hunks)
  • source/_integrations/seventeentrack.markdown (1 hunks)
  • source/_integrations/shelly.markdown (1 hunks)
  • source/_integrations/smlight.markdown (1 hunks)
  • source/_integrations/template.markdown (2 hunks)
  • source/_integrations/tesla_fleet.markdown (1 hunks)
Files skipped from review due to trivial changes (2)
  • source/_docs/configuration/templating.markdown
  • source/_integrations/template.markdown
Additional context used
LanguageTool
source/_integrations/enphase_envoy.markdown

[uncategorized] ~26-~26: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...dels that only have production metrics (ie. Envoy-C) and newer models that offer bo...

(I_E)


[uncategorized] ~26-~26: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...oth production and consumption metrics (ie. Envoy-S). ## Prerequisites - The Envo...

(I_E)

source/_integrations/opentherm_gw.markdown

[style] ~242-~242: To form a complete sentence, be sure to include a subject.
Context: ...Ground - A permanently low output (0V). Could be used for a power LED. - 2. Vcc - A ...

(MISSING_IT_THERE)


[style] ~243-~243: To form a complete sentence, be sure to include a subject.
Context: .... Vcc - A permanently high output (5V). Can be used as a short-proof power supply f...

(MISSING_IT_THERE)

source/_docs/automation/trigger.markdown

[style] ~362-~362: Consider simply using “of” instead.
Context: ... the state trigger fires when the state of any of given entities changes. The behavio...

(OF_ANY_OF)


[uncategorized] ~362-~362: Possible missing article found.
Context: ... trigger fires when the state of any of given entities changes. The behavior is a...

(AI_HYDRA_LEO_MISSING_THE)


[grammar] ~420-~420: This word is normally spelled as one word.
Context: ...not_from and not_to options are the counter parts of from and to. They can be used to...

(COUNTER_COMPOUNDS)

Markdownlint
source/_docs/automation/trigger.markdown

367-367: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


420-420: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


420-420: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)

Additional comments not posted (12)
source/_integrations/smlight.markdown (1)

36-37: LGTM!

The firmware requirement note is clear and informative. It provides essential guidance to users to ensure compatibility and correct functioning of the integration. The instructions to update using the Web UI are helpful for users with older versions.

source/_integrations/seventeentrack.markdown (1)

65-65: LGTM!

The change in the way the list of packages in transit is accessed is consistent with the AI-generated summary and does not introduce any issues. The functionality remains the same, and the change is localized to this specific code segment.

source/_integrations/tesla_fleet.markdown (1)

30-30: LGTM!

The change clarifies the prerequisites for using the Tesla Fleet API by adding the requirement that the "My Home Assistant" integration must not be disabled. This provides important information for users and is consistent with the documentation style.

source/_integrations/enphase_envoy.markdown (1)

28-35: LGTM!

The new "Prerequisites" section is well-structured and provides clear information about the requirements for using the Enphase Envoy integration. It covers important aspects such as Envoy configuration, network connectivity, firmware version, and additional requirements for newer firmware versions. This will be helpful for users setting up the integration.

source/_integrations/shelly.markdown (1)

319-319: LGTM!

The change clarifies the firmware requirements for both Shelly generation 2 and generation 3 devices to support the creation of virtual components. It provides helpful information to users about the necessary firmware versions for this functionality.

source/_integrations/opentherm_gw.markdown (1)

241-248: LGTM!

The changes to the GPIO mode enumeration, starting from 0 instead of 1, align with the common programming convention of zero-based indexing. This improves clarity and reduces potential confusion for users who are familiar with this convention. The descriptions of the GPIO modes remain accurate and consistent.

Tools
LanguageTool

[style] ~242-~242: To form a complete sentence, be sure to include a subject.
Context: ...Ground - A permanently low output (0V). Could be used for a power LED. - 2. Vcc - A ...

(MISSING_IT_THERE)


[style] ~243-~243: To form a complete sentence, be sure to include a subject.
Context: .... Vcc - A permanently high output (5V). Can be used as a short-proof power supply f...

(MISSING_IT_THERE)

source/_docs/automation/trigger.markdown (6)

90-90: LGTM!

The added sentence and link improve clarity and provide helpful context for event triggers.


297-298: Looks good!

Allowing number and sensor entities to be used in the above and below thresholds is a helpful addition that expands the flexibility of numeric state triggers.


362-374: Great additions for clarity and guidance!

The detailed explanations of state trigger behavior, the note about the for option, and the tip about displayed vs. actual states all provide valuable information for users configuring automations. Well done!

Tools
LanguageTool

[style] ~362-~362: Consider simply using “of” instead.
Context: ... the state trigger fires when the state of any of given entities changes. The behavio...

(OF_ANY_OF)


[uncategorized] ~362-~362: Possible missing article found.
Context: ... trigger fires when the state of any of given entities changes. The behavior is a...

(AI_HYDRA_LEO_MISSING_THE)

Markdownlint

367-367: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


410-410: Nice example!

The added code block effectively demonstrates how to use to: null to trigger on all state changes while ignoring attribute changes. This will be useful for users configuring state triggers.


420-420: Helpful clarification!

The explanation of not_from and not_to as counterparts to from and to is a useful addition that will help users better understand how to configure state triggers for their specific needs.

Tools
LanguageTool

[grammar] ~420-~420: This word is normally spelled as one word.
Context: ...not_from and not_to options are the counter parts of from and to. They can be used to...

(COUNTER_COMPOUNDS)

Markdownlint

420-420: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


420-420: Expected: underscore; Actual: asterisk
Emphasis style

(MD049, emphasis-style)


438-439: Good clarification!

The explanation of how the attribute option narrows the state trigger to only fire on changes to the specified attribute is an important detail for users to understand. Well written and accurate.

@@ -23,7 +23,16 @@ ha_platforms:
ha_integration_type: integration
---

An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). Firmware version 3.9 or newer is required.
An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S).
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the abbreviation "i.e.".

The static analysis tool correctly points out that the abbreviation "i.e." (that is) should be followed by two periods. Please update the two occurrences of "i.e." in this line to include the correct punctuation.

Apply this diff to fix the abbreviation:

-An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S).
+An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (i.e., Envoy-C) and newer models that offer both production and consumption metrics (i.e., Envoy-S).
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S).
An integration for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. This integration works with older models that only have production metrics (i.e., Envoy-C) and newer models that offer both production and consumption metrics (i.e., Envoy-S).
Tools
LanguageTool

[uncategorized] ~26-~26: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...dels that only have production metrics (ie. Envoy-C) and newer models that offer bo...

(I_E)


[uncategorized] ~26-~26: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...oth production and consumption metrics (ie. Envoy-S). ## Prerequisites - The Envo...

(I_E)

@martindybal martindybal requested a review from a team as a code owner September 12, 2024 16:51
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: 0

Outside diff range and nitpick comments (3)
source/_integrations/lock.markdown (2)

36-42: Documentation looks good, but please remove trailing spaces.

The documentation for the lock.lock action is clear and includes a description of the required data attribute. However, please remove the trailing spaces at line 36 to adhere to the style guide.

Apply this diff to remove the trailing spaces:

-### Action `lock.lock` 
+### Action `lock.lock`
Tools
Markdownlint

36-36: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


53-59: Documentation looks good, but please remove trailing spaces.

The documentation for the lock.unlock action is clear and includes a description of the required data attribute. However, please remove the trailing spaces at line 53 to adhere to the style guide.

Apply this diff to remove the trailing spaces:

-### Action `lock.unlock` 
+### Action `lock.unlock`
Tools
Markdownlint

53-53: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

source/_integrations/media_player.markdown (1)

23-33: Excellent addition of media player states documentation!

The newly added section provides a clear and comprehensive overview of the various states a media player can have. The state descriptions are concise and informative, which will greatly help users understand the media player's operational status.

Please hyphenate the compound adjective "low power" in the "Standby" state description for better readability:

-Standby: The media player is in a low power state, accepting commands.
+Standby: The media player is in a low-power state, accepting commands.
Tools
LanguageTool

[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Standby: The media player is in a low power state, accepting commands. - **Bufferin...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dcb5d86 and 1f5ea87.

Files ignored due to path filters (4)
  • Gemfile.lock is excluded by !**/*.lock
  • source/images/integrations/date/state_date.png is excluded by !**/*.png
  • source/images/integrations/datetime/state_datetime.png is excluded by !**/*.png
  • source/images/integrations/notify/state_notify.png is excluded by !**/*.png
Files selected for processing (14)
  • sass/homeassistant/base/_navigation.scss (2 hunks)
  • source/_includes/integrations/restart_ha_after_config_inclusion.md (1 hunks)
  • source/_integrations/air_quality.markdown (1 hunks)
  • source/_integrations/alarm_control_panel.markdown (1 hunks)
  • source/_integrations/calendar.markdown (4 hunks)
  • source/_integrations/camera.markdown (5 hunks)
  • source/_integrations/cover.markdown (4 hunks)
  • source/_integrations/date.markdown (2 hunks)
  • source/_integrations/datetime.markdown (2 hunks)
  • source/_integrations/lawn_mower.markdown (2 hunks)
  • source/_integrations/lock.markdown (4 hunks)
  • source/_integrations/media_player.markdown (2 hunks)
  • source/_integrations/notify.markdown (2 hunks)
  • source/_integrations/zwave_js.markdown (5 hunks)
Files skipped from review due to trivial changes (2)
  • source/_integrations/camera.markdown
  • source/_integrations/cover.markdown
Additional context used
Markdownlint
source/_includes/integrations/restart_ha_after_config_inclusion.md

1-1: null
First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

source/_integrations/lock.markdown

36-36: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)


53-53: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

LanguageTool
source/_integrations/alarm_control_panel.markdown

[style] ~47-~47: ‘in the night’ might be wordy. Consider a shorter alternative.
Context: ...
code (optional) | Arm the alarm in the night mode. | | alarm_arm_vacation ...

(EN_WORDINESS_PREMIUM_IN_THE_NIGHT)

source/_integrations/notify.markdown

[grammar] ~20-~20: The verb ‘notify’ does not usually follow articles like ‘a’. Check that ‘notify’ is spelled correctly; using ‘notify’ as a noun may be non-standard.
Context: ...lock_integration.md %} ## The state of a notify entity The state of a notify entity is...

(A_INFINITIVE)

source/_integrations/calendar.markdown

[style] ~38-~38: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of a calendar entity The state shows whether or not there is an active event: - On: The ca...

(WHETHER)


[uncategorized] ~151-~151: 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)


[uncategorized] ~207-~207: Possible missing comma found.
Context: ... | 2019-03-10 20:00:00 | | end_date_time | yes ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~208-~208: Possible missing comma found.
Context: .... | 2019-03-10 23:00:00 | | duration | yes ...

(AI_HYDRA_LEO_MISSING_COMMA)

source/_integrations/media_player.markdown

[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Standby: The media player is in a low power state, accepting commands. - **Bufferin...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

Additional comments not posted (31)
source/_includes/integrations/restart_ha_after_config_inclusion.md (1)

1-1: LGTM!

The changes in this file are minor formatting adjustments that do not alter the content or functionality of the documentation. The text structure and instructions for restarting Home Assistant after modifying the configuration.yaml file remain unchanged, preserving the original meaning and intent.

The Markdownlint warning about the first line not being a top-level heading is a false positive because this file is likely an include file that is intended to be included in other documentation files, and not a standalone document that requires a top-level heading.

Tools
Markdownlint

1-1: null
First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

source/_integrations/air_quality.markdown (1)

30-33: LGTM!

The new section provides a clear and concise description of the state of an air quality entity. The example helps to illustrate the concept and enhances the documentation. Great job!

source/_integrations/date.markdown (2)

20-28: LGTM!

The new section "The state of a date entity" provides a clear explanation of the actual date value represented by a date entity. The included image enhances the understanding by visually demonstrating the state of a date in developer tools.


39-42: LGTM!

The formatting adjustments to the data attributes table in the "Date actions" section improve the clarity and presentation of the information.

source/_integrations/datetime.markdown (3)

20-28: LGTM!

The new section provides clear information about the state format of date/time entities. The image and its alt text effectively illustrate the state format.


40-42: LGTM!

The formatting changes to the "datetime actions" table improve its readability and consistency.


Line range hint 1-42: Overall, the changes look great!

The new section, image, and formatting improvements enhance the clarity and usability of the Date/Time integration documentation. The changes adhere to the Home Assistant documentation standards. Well done!

Tools
LanguageTool

[style] ~18-~18: To make your writing clearer, consider a more direct alternative.
Context: ...ay to create a Date/Time entity, please take a look at the [Date/Time helper](/integra...

(TAKE_A_LOOK)

source/_integrations/lawn_mower.markdown (4)

14-14: LGTM!

The introduction accurately describes the purpose of the lawn mower integration.


18-26: Excellent addition!

The new section provides a clear and comprehensive overview of the different states a lawn mower entity can have. The descriptions are concise and easy to understand, which will greatly benefit users in interpreting the status of their lawn mowers.


38-40: LGTM!

The formatting improvements to the data attribute table for the lawn_mower.start_mowing action enhance readability and consistency. The descriptions remain clear and accurate.


46-48: LGTM!

The formatting improvements to the data attribute tables for the lawn_mower.pause and lawn_mower.dock actions are consistent with the changes made to the lawn_mower.start_mowing action table. The enhanced readability and consistency, along with the clear and accurate descriptions, make these tables more user-friendly.

Also applies to: 54-56

source/_integrations/lock.markdown (3)

21-31: Great addition to improve clarity!

The new section "The state of a lock entity" provides clear definitions for the various states a lock entity can have, which enhances the understanding of the lock's operational status. The content is well-organized and the formatting is consistent.


Line range hint 70-75: Clear instructions on using the lock actions!

The instructions on how to use the lock actions in the frontend are clear and include a sample JSON payload for the data field. The content is well-organized and the formatting is consistent.


79-80: Documentation for the entity_id data attribute looks good!

The documentation for the optional entity_id data attribute is clear and includes a description of its usage. The content is well-organized and the formatting is consistent.

source/_integrations/alarm_control_panel.markdown (2)

24-37: LGTM!

The new section provides a clear and concise overview of the various states an alarm panel entity can have. This information is helpful for users to understand the functionality of the alarm panel. The content and formatting look good.


39-51: The reformatted Actions section looks great!

The table format improves the readability and organization of the information. The action descriptions are clear and concise.

Regarding the static analysis hint about potential wordiness in the phrase "Arm the alarm in the night mode," I believe it's a false positive. The phrase is a standard way to describe this specific action and does not require rephrasing.

Tools
LanguageTool

[style] ~47-~47: ‘in the night’ might be wordy. Consider a shorter alternative.
Context: ...
code (optional) | Arm the alarm in the night mode. | | alarm_arm_vacation ...

(EN_WORDINESS_PREMIUM_IN_THE_NIGHT)

sass/homeassistant/base/_navigation.scss (2)

187-189: LGTM!

The changes to the .toggle::after pseudo-element improve the layout and alignment of the content within the navigation toggle. Using display: flex along with justify-content: center and align-items: center ensures the content is centered both horizontally and vertically, enhancing the visual presentation.


206-206: Looks good!

The addition of padding-bottom: 2px to the #toggle:checked + .toggle::after selector is a minor change that likely affects the spacing of the content when the toggle is in the checked state. This change is unlikely to introduce any issues or inconsistencies.

source/_integrations/notify.markdown (2)

20-27: LGTM!

The new section "The state of a notify entity" provides a clear and concise explanation of what the state represents. The inclusion of the screenshot is helpful for visual learners. Great work on enhancing the documentation!

Tools
LanguageTool

[grammar] ~20-~20: The verb ‘notify’ does not usually follow articles like ‘a’. Check that ‘notify’ is spelled correctly; using ‘notify’ as a noun may be non-standard.
Context: ...lock_integration.md %} ## The state of a notify entity The state of a notify entity is...

(A_INFINITIVE)


33-38: Looks good!

The formatting changes to the data attribute table enhance its visual organization and clarity. The improved alignment makes it easier to read and understand the information presented. Nice work on refining the table structure!

source/_integrations/calendar.markdown (4)

36-42: LGTM!

The new section provides clear and concise information about the possible states of a calendar entity. This is relevant and useful for users to understand the behavior of calendar entities.

Tools
LanguageTool

[style] ~38-~38: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...e of a calendar entity The state shows whether or not there is an active event: - On: The ca...

(WHETHER)


151-166: LGTM!

The description of the calendar.create_event action and its data attributes is clear and well-formatted.

Skipping the static analysis hint about adding a comma before 'or' at line 151 as it's a false positive. The two independent clauses are closely connected and short, so a comma is not necessary.

Tools
LanguageTool

[uncategorized] ~151-~151: 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)


202-209: LGTM!

The description of the calendar.get_events action and its data attributes is clear and well-formatted.

Skipping the static analysis hints about possible missing commas at lines 207 and 208 as they are false positives. The commas are not missing in the table format used to describe the data attributes.

Tools
LanguageTool

[uncategorized] ~207-~207: Possible missing comma found.
Context: ... | 2019-03-10 20:00:00 | | end_date_time | yes ...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~208-~208: Possible missing comma found.
Context: .... | 2019-03-10 23:00:00 | | duration | yes ...

(AI_HYDRA_LEO_MISSING_COMMA)


230-236: LGTM!

The description of the response data fields for the calendar.get_events action is clear and well-formatted.

source/_integrations/zwave_js.markdown (7)

54-55: LGTM!

The new section provides a clear overview of the setup process and what to expect in the following sections.


56-67: Great addition!

The Z-Wave terminology comparison table is a valuable resource for users transitioning from Z-Wave to Home Assistant. It clarifies the differences in terminology and helps users navigate the documentation more effectively.


68-71: LGTM!

The explanation of classic inclusion versus SmartStart is clear and informative. It's helpful to know that Home Assistant supports both methods, providing users with options for adding devices to their Z-Wave network.


358-361: Documentation improvements for zwave_js.refresh_value action.

The updates to the data attributes table enhance clarity and completeness:

  • Clarifies that entity_id is required and can be a single entity or a list.
  • Introduces the refresh_all_values attribute to control the refresh behavior.

These changes will help users better understand and utilize the action.


367-378: Enhanced documentation for zwave_js.set_value action.

The updates to the data attributes table provide better guidance and flexibility:

  • Clarifies that at least one of entity_id, device_id, or area_id must be provided, ensuring proper usage.
  • Introduces the wait_for_result attribute to control whether to wait for a response, with a note about potential performance impact.

These improvements will help users make informed decisions when using the action.


384-395: New zwave_js.multicast_set_value action for advanced use cases.

The introduction of the zwave_js.multicast_set_value action is a great addition for advanced users who need to set the same value on multiple devices simultaneously. The documentation is thorough and clear, providing:

  • Detailed explanations of the data attributes and their requirements.
  • A warning that using this action requires advanced knowledge of Z-Wave, setting appropriate expectations.

This action will be valuable for users with complex Z-Wave setups.


958-968: New section clarifying unsupported Z-Wave functionality.

The addition of the "Unsupported functionality" section is a valuable improvement to the documentation. It:

  • Clearly lists two specific Z-Wave functionalities that are currently not supported in Home Assistant.
  • Provides explanations for why these functionalities are not available, helping users understand the limitations.

This section will help set expectations and prevent confusion when users attempt to use these unsupported features.

@martindybal martindybal deleted the feature/tile-card-icon-hold-and-icon-double-tap branch September 12, 2024 17:20
@home-assistant home-assistant bot removed the in-progress This PR/Issue is currently being worked on label Sep 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Sep 13, 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.