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 alexa remote support #120878

Merged
merged 28 commits into from
Jul 9, 2024

Conversation

CrazyMan2000
Copy link
Contributor

@CrazyMan2000 CrazyMan2000 commented Jun 30, 2024

Proposed change

Added an update for the alexa integration to support the remote domain.
Since the friendly names for the mode controller are one to one the activity names from the remote entity a proper locale must be send with it. To archive this I added the user's alexa configuration to the AlexaCapability class, so the locale from the config can be used.
I added the whole config instead of only the locale because thereby other improvements are possible later, for example setting different names for an activity.

Type of change

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

Additional information

Related to this community thread:
https://community.home-assistant.io/t/alexa-mode-controller-harmony-hub/488905

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

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

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

home-assistant[bot]

This comment was marked as resolved.

@home-assistant
Copy link

Hey there @home-assistant/cloud, @ochlocracy, @jbouwh, mind taking a look at this pull request as it has been labeled with an integration (alexa) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of alexa can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign alexa Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

home-assistant[bot]

This comment was marked as resolved.

Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

I am not sure this PR is in the correct direction.
According to https://developer.amazon.com/en-US/docs/alexa/smarthome/wwa-device-requirements.html, we should implement:

Not the mode controller. At least I would not be the first controller to implement.

@CrazyMan2000
Copy link
Contributor Author

The problem for the input controller is that it only accepts predefined activity names.
That is not needed when using the mode controller because the available modes must not be part of a fixed set of names. This allows the names of the activity to be used with alexa directly.

I think this is actually the same way how the harmony hub handles those alexa requests.

@CrazyMan2000
Copy link
Contributor Author

With commit 86952ad i added a test to check if all the required interfaces for a remote are part of the discovery response.

I think it would make sense to make this a method in test_common.py, but I did not do this because i do not want to blow up the PR any more. Say so if i should do it here directly.

@CrazyMan2000 CrazyMan2000 marked this pull request as ready for review July 7, 2024 14:57
@home-assistant home-assistant bot requested a review from jbouwh July 7, 2024 14:57
Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

Just some minor comments, nice work!

@CrazyMan2000
Copy link
Contributor Author

Just some minor comments, nice work!

Thank you :)

Copy link
Contributor

@jbouwh jbouwh left a comment

Choose a reason for hiding this comment

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

Have some trouble getting a passed CI test, think the failures are not related.

Nice first contribution 🥇

Thanks @CrazyMan2000 👍

@jbouwh jbouwh added the smash Indicator this PR is close to finish for merging or closing label Jul 7, 2024
@CrazyMan2000
Copy link
Contributor Author

Thanks, i had a lot of fun!
And thank you for your help.

Looking forward to my next PR 😄

@jbouwh jbouwh merged commit e44f00c into home-assistant:dev Jul 9, 2024
40 checks passed
@MartinHjelmare
Copy link
Member

Please address the comments in a new PR. Thanks!

@github-actions github-actions bot locked and limited conversation to collaborators Jul 10, 2024
@@ -1200,6 +1205,17 @@ async def async_api_set_mode(
msg = f"Entity '{entity.entity_id}' does not support Mode '{mode}'"
raise AlexaInvalidValueError(msg)

# Remote Activity
if instance == f"{remote.DOMAIN}.{remote.ATTR_ACTIVITY}":
Copy link
Contributor

Choose a reason for hiding this comment

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

Seems we could have used elif here to avoid additional checks like we do for the other cases

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants