Tell mobile app to scan for Improv devices when 'Add Integration' tap

[bgoncal]

Breaking change

Proposed change

Add event to call the mobile app and ask to start scanning for Improv BLE devices.

ref: home-assistant/iOS#2855

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 action based on configuration state that triggers "improv/scan" messages.
  • Added support for detecting if setup improv is possible with the new canSetupImprov indicator.

[coderabbitai]

Walkthrough

Walkthrough

The changes introduce a new interface EMOutgoingMessageImprovScan and update the ExternalConfig interface to include a canSetupImprov boolean field. They also modify the HaConfigIntegrationsDashboard class to send a "improv/scan" message conditionally based on the canSetupImprov configuration. This enhances functionality by allowing the application to trigger specific actions based on the external configuration state.

Changes

File Path	Change Summary
src/external_app/external_messaging.ts	Added EMOutgoingMessageImprovScan interface, updated EMOutgoingMessageWithoutAnswer type, and ExternalConfig with canSetupImprov.
src/panels/config/integrations/ha-config-integrations-dashboard.ts	Added a conditional check to trigger a "improv/scan" message based on canSetupImprov property.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HaConfigIntegrationsDashboard
    participant ExternalApp

    User->>HaConfigIntegrationsDashboard: Access Integration Dashboard
    HaConfigIntegrationsDashboard->>ExternalApp: Check canSetupImprov
    alt canSetupImprov is true
        HaConfigIntegrationsDashboard->>ExternalApp: fireMessage(type: "improv/scan")
    end

Loading

---

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>.
  • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[bramkragten]

Should we do this when you click add integration, or when the integration page is loaded? We scan for USB devices for example when the page is opened.

https://github.com/home-assistant/frontend/blob/dev/src/panels/config/integrations/ha-config-integrations-dashboard.ts#L238

[bgoncal]

Should we do this when you click add integration, or when the integration page is loaded? We scan for USB devices for example when the page is opened.

https://github.com/home-assistant/frontend/blob/dev/src/panels/config/integrations/ha-config-integrations-dashboard.ts#L238

My idea was to trigger it as soon as the user taps "add integration" so it knows it is in a "Add device context" and then the mobile app can ask for Bluetooth usage permission etc.
What do you think?

[bramkragten]

Since it is discovered I would expect as a user not to have to press on the add device button for it to show up.

The permission is just a one time thing right?

[bgoncal]

Since it is discovered I would expect as a user not to have to press on the add device button for it to show up.

The permission is just a one time thing right?

Indeed but on top of that I wanted to avoid unecessary usage of Bluetooth, devices & integrations is a page where (at least myself) go through it many times. But we can experiment having it on page load too.

[bramkragten]

I can't judge how expensive the scanning is, so I leave that judgement to you, could be a good reason not to do it on page load indeed.

[bgoncal]

I can't judge how expensive the scanning is, so I leave that judgement to you, could be a good reason not to do it on page load indeed.

Sounds good, I'll merge it like this for now until I evaluate the impact and then update it if makes sense