Add tone,volume & duration selector to more-info dialog for sirens #22786

MindFreeze · 2024-11-12T11:09:45Z

Proposed change

Select the tone to use when manually starting the siren. Needed for zwave-js/certification-backlog#16

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (thank you!)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example configuration

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue or discussion:
Link to documentation pull request:

Checklist

The code change is tested and works locally.
There is no commented out code in this PR.
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

coderabbitai · 2024-11-12T11:09:54Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 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.

piitaya · 2024-11-12T12:12:29Z

I don't think we can add it as a select because it's not persisted in the state machine, . For all other entities, the selected item is saved (presets, modes, etc...). That would lead to confusion for the user as this option is only used when turning on the siren.

I let the UX team decide on this point.

MindFreeze · 2024-11-12T12:18:40Z

I don't think we can add it as a select because it's not persisted in the state machine. For all other entities, the selected item is saved. That would lead to confusion for the user as this option is only used when turning on the siren.

I let the UX team decide on this point.

I had the same thought but couldn't think of a better UX. An input modal is weird on top of another modal and the input is not required. We could distinguish it with design somehow, I guess.

src/dialogs/more-info/controls/more-info-siren.ts

src/dialogs/more-info/components/siren/ha-more-info-siren-advanced-controls.ts

wendevlin · 2024-11-14T15:51:52Z

src/dialogs/more-info/components/siren/ha-more-info-siren-advanced-controls.ts

+                  <ha-textfield
+                    type="number"
+                    .label=${this.hass.localize("ui.components.siren.duration")}
+                    .value=${this._duration}
+                    @change=${this._handleDurationChange}
+                  ></ha-textfield>


We should show somewhere the unit of the time as information.
And maybe just prefil 10 seconds as default?

I don't know the unit of. It isn't documented anywhere.
Don't want to set defaults as the device will play the full duration of the tone only if no duration is set

😆 ok, maybe someone else knows? I would assume seconds.

I don't know the unit of. It isn't documented anywhere. Don't want to set defaults as the device will play the full duration of the tone only if no duration is set

What do you think about adding (optional) to the optional fields label :

Volume (optional)

Duration (optional)

But they are all optional

home-assistant · 2024-11-14T15:54:56Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

src/dialogs/more-info/components/siren/ha-more-info-siren-advanced-controls.ts

wendevlin · 2024-11-18T08:08:03Z

src/dialogs/more-info/components/siren/ha-more-info-siren-advanced-controls.ts

+                  <ha-textfield
+                    type="number"
+                    .label=${this.hass.localize("ui.components.siren.duration")}
+                    .value=${this._duration}
+                    @change=${this._handleDurationChange}
+                  ></ha-textfield>


😆 ok, maybe someone else knows? I would assume seconds.

MindFreeze · 2024-11-19T10:44:08Z

The zwave mock I have has its duration in seconds and the ZHA code is written for seconds so I will assume it's in seconds. There is some deconz siren code that does *10 to the duration before passing it to the device but that makes no sense for any time unit so 🤷‍♂️

MindFreeze added 2 commits November 11, 2024 15:57

Add tone selector to more-info for sirens

ed12bb6

add selected tone to service call

0786ab4

home-assistant bot added the cla-signed label Nov 12, 2024

MindFreeze marked this pull request as ready for review November 12, 2024 11:19

MindFreeze added Needs UX Pull requests requiring a review from the Home Assistant design team and removed Needs UX Pull requests requiring a review from the Home Assistant design team labels Nov 12, 2024

MindFreeze marked this pull request as draft November 13, 2024 18:35

MindFreeze added 2 commits November 14, 2024 13:54

Merge branch 'dev' into siren_tone

4ee0631

rework the tone into an advanced controls dialog

0678403

MindFreeze changed the title ~~Add tone selector to more-info dialog for sirens~~ Add tone,volume & duration selector to more-info dialog for sirens Nov 14, 2024

MindFreeze marked this pull request as ready for review November 14, 2024 14:49

MindFreeze enabled auto-merge (squash) November 14, 2024 14:59

wendevlin requested changes Nov 14, 2024

View reviewed changes

home-assistant bot marked this pull request as draft November 14, 2024 15:54

auto-merge was automatically disabled November 14, 2024 15:54
Pull request was converted to draft

MindFreeze added 2 commits November 18, 2024 09:16

tweaks from PR comments

db83efe

Merge remote-tracking branch 'origin/dev' into siren_tone

1be8b3e

MindFreeze marked this pull request as ready for review November 18, 2024 07:17

home-assistant bot requested a review from wendevlin November 18, 2024 07:17

wendevlin requested changes Nov 18, 2024

View reviewed changes

home-assistant bot marked this pull request as draft November 18, 2024 08:08

MindFreeze added 3 commits November 19, 2024 12:32

fix % conversion

c3fb587

Merge branch 'dev' into siren_tone

ca53ab5

assume duration is in seconds

9d6292c

MindFreeze marked this pull request as ready for review November 19, 2024 10:44

home-assistant bot requested a review from wendevlin November 19, 2024 10:44

wendevlin approved these changes Nov 19, 2024

View reviewed changes

wendevlin merged commit c9cad25 into dev Nov 19, 2024
15 checks passed

wendevlin deleted the siren_tone branch November 19, 2024 10:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add tone,volume & duration selector to more-info dialog for sirens #22786

Add tone,volume & duration selector to more-info dialog for sirens #22786

MindFreeze commented Nov 12, 2024 •

edited

Loading

coderabbitai bot commented Nov 12, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

piitaya commented Nov 12, 2024 •

edited

Loading

MindFreeze commented Nov 12, 2024

wendevlin Nov 14, 2024

MindFreeze Nov 18, 2024

wendevlin Nov 18, 2024

piitaya Nov 18, 2024

MindFreeze Nov 19, 2024

home-assistant bot commented Nov 14, 2024

wendevlin Nov 18, 2024

MindFreeze commented Nov 19, 2024

Add tone,volume & duration selector to more-info dialog for sirens #22786

Add tone,volume & duration selector to more-info dialog for sirens #22786

Conversation

MindFreeze commented Nov 12, 2024 • edited Loading

Proposed change

Type of change

Example configuration

Additional information

Checklist

coderabbitai bot commented Nov 12, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

piitaya commented Nov 12, 2024 • edited Loading

MindFreeze commented Nov 12, 2024

wendevlin Nov 14, 2024

Choose a reason for hiding this comment

MindFreeze Nov 18, 2024

Choose a reason for hiding this comment

wendevlin Nov 18, 2024

Choose a reason for hiding this comment

piitaya Nov 18, 2024

Choose a reason for hiding this comment

MindFreeze Nov 19, 2024

Choose a reason for hiding this comment

home-assistant bot commented Nov 14, 2024

wendevlin Nov 18, 2024

Choose a reason for hiding this comment

MindFreeze commented Nov 19, 2024

MindFreeze commented Nov 12, 2024 •

edited

Loading

coderabbitai bot commented Nov 12, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

piitaya commented Nov 12, 2024 •

edited

Loading