Add zwave expert UI / Installer settings

[bramkragten]

Proposed change

Adds the very basic first steps for an expert UI for zwave

Core PR home-assistant/core#125327

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

Summary by CodeRabbit

• New Features

  • Introduced new types and interfaces for better management of Z-Wave device capabilities.
  • Added new functions for invoking Z-Wave commands and fetching node capabilities.
  • Implemented a custom web component for controlling multi-level switches in Z-Wave integration.
  • Added a new action in the device actions menu for quick access to node installer settings.
  • Created a new component for managing Z-Wave nodes, enhancing user interaction and device management.

• Documentation

  • Updated translation file to include a new key for "Installer settings," improving localization.

[coderabbitai]

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.

Walkthrough

The changes introduce new types and interfaces for managing Z-Wave JS node and endpoint capabilities, enhancing the existing structure. New functions are added for invoking Z-Wave command class APIs and fetching node capabilities. A custom web component for controlling multi-level switches is introduced, along with a component for managing Z-Wave nodes. Additionally, a new configuration entry for the node installer is added, and a translation key for installer settings is included.

Changes

Files	Change Summary
src/data/zwave_js.ts	New types and interfaces for node and endpoint capabilities; added functions for API interaction.
src/panels/config/devices/device-detail/integration-elements/zwave_js/device-actions.ts	Added a new action for accessing node installer settings in device actions.
src/panels/config/integrations/integration-panels/zwave_js/capability-controls/zwave_js-capability-control-multilevel-switch.ts	Introduced a web component for controlling multi-level switches with user interface elements.
src/panels/config/integrations/integration-panels/zwave_js/zwave_js-config-router.ts	Added a new configuration entry for the node installer in the ZWaveJSConfigRouter class.
src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-installer.ts	Defined a web component for managing Z-Wave nodes, including lifecycle methods and data fetching.
src/translations/en.json	Added a new translation key for "Installer settings."

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[coderabbitai]

Actionable comments posted: 8

Outside diff range, codebase verification and nitpick comments (1)

src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-installer.ts (1)

23-28: Ensure Proper Error Handling for Z-Wave JS Data Functions

The functions fetchZwaveNodeMetadata and fetchZwaveNodeCapabilities are used without explicit error handling in the components. To prevent unhandled promise rejections and ensure data consistency, consider adding error handling mechanisms such as .catch() or try-catch blocks when using these functions. Additionally, review the hass.callWS method to understand its error handling capabilities and ensure that any errors are appropriately managed.

• Files to Review:
  • src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-installer.ts
  • src/panels/config/integrations/integration-panels/zwave_js/zwave_js-node-config.ts

Analysis chain

Check the integration of Z-Wave JS data functions.

The functions fetchZwaveNodeMetadata and fetchZwaveNodeCapabilities are crucial for fetching the necessary data about Z-Wave nodes. It's important to ensure that these functions handle errors appropriately and that their integration into the component's lifecycle is correctly managed to avoid unhandled promises or data inconsistencies.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify error handling in fetchZwaveNodeMetadata and fetchZwaveNodeCapabilities functions.

# Test: Search for error handling in the functions. Expect: Proper error handling mechanisms.
rg --type typescript -A 5 $'fetchZwaveNodeMetadata|fetchZwaveNodeCapabilities'

Length of output: 114

---

Script:

#!/bin/bash
# Corrected command to verify error handling in fetchZwaveNodeMetadata and fetchZwaveNodeCapabilities functions.

# Test: Search for error handling in the functions. Expect: Proper error handling mechanisms.
rg --type ts -A 5 $'fetchZwaveNodeMetadata|fetchZwaveNodeCapabilities'

Length of output: 3718

---

Script:

#!/bin/bash
# Investigate how fetchZwaveNodeMetadata and fetchZwaveNodeCapabilities are used in the components to check for error handling.

# Search for usage of fetchZwaveNodeMetadata and fetchZwaveNodeCapabilities in the codebase.
rg --type ts -A 10 'fetchZwaveNodeMetadata|fetchZwaveNodeCapabilities'

Length of output: 6450

[AlCalzone]

Some feedback at a first glance:

• The command classes for which we offer the functionality need to be filtered:

  • All supported application CCs - @zwave-js/core exposes a method to check if a CC is an application CC: https://github.com/zwave-js/node-zwave-js/blob/d6c390652d082fd99fca097a6be13098aa07a048/packages/core/src/capabilities/CommandClasses.ts#L289-L292
  • Add Indicator CC
  • Remove Configuration CC, this has a dedicated panel already

• We should group the panel by endpoint, maybe with tabs? This does not need to happen if the device only has endpoint 0.

• Maybe we should also add tabs or accordions for the individual CCs, so one doesn't have to scroll too much.

• Not sure if the grouping should go CC -> Endpoint or Endpoint -> CC though.

• CCs without "installer mode" controls should also not be shown I suppose

[AlCalzone]

Tested Multilevel Switch transition, works fine ✅

[AlCalzone]

We may also need a way to display Z-Wave values here that do not translate to an entity. Not sure if this needs a new websocket API or if there is an existing one that can be used.

[MartinHjelmare]

Core PR with invoke_cc_api websocket command merged.