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

Invalid or missing params.sound_mode attribute when Sound mode command is assigned to a button and the button is pressed #165

Closed
1 task done
fbutler opened this issue Nov 3, 2023 · 4 comments
Assignees
Labels
bug Something isn't working integration Integration driver related issue

Comments

@fbutler
Copy link

fbutler commented Nov 3, 2023

Is there an existing issue for this?

  • I have searched the existing issues

Description

I mapped the Sound mode command to a "Movie" button in an Activity and assigned a Mode of MOVIE from the drop down list of available Modes. This appears to be correctly saved as the Mode assigned remains associated with the button if I move away from that screen and return to it.

invalid or missing params sound_mode attribute

However when I press the "Movie" button, to which the Sound mode command has been associated, when running that Activity I get the error "Invalid or missing params.sound_mode attribute"

20231103_141315

How to Reproduce

Go to the button mapping screen within an Activity.
Assign the Sound mode command to a button.
Select a Mode from the drop down list of available Modes.
Exit the button mapping dialogue.
Start that Activity using the remote.
Press the button that the Sound mode command is assigned to.
See the error as per the photo above.

Expected behavior

When pressed, the button assigned the Sound mode command should result in the assigned Mode being applied.

In the case of my Denon AVR this should result in a menu of available sound options for the Mode selected being displayed on the TV screen which can be scrolled through by repeatedly clicking the button to which the Sound mode command has been assigned.

I have a Home Assistant script mapped to another button which functions correctly. The script is:

image

System version

1.4.5

What part of the system affected by the problem?

Integration

Additional context

No response

@fbutler fbutler added the bug Something isn't working label Nov 3, 2023
@github-actions github-actions bot added the integration Integration driver related issue label Nov 3, 2023
@zehnm zehnm self-assigned this Nov 14, 2023
@zehnm
Copy link

zehnm commented Nov 14, 2023

Found the issue, fixed in the next release.

  • Home Assistant integration was implemented according to the media-player entity command specification 0.8.0
    • Selecting a sound mode defines a parameter named sound_mode
  • Unfortunately the command metadata for the web-configurator used mode instead of sound_mode.
    • This parameter gets stored in the sequences and UI screen definitions.

I will change the entity command specification to mode and fix the Home Assistant integration. It's the most pragmatic solution, otherwise all activity screens, macro and activity sequences using a sound mode command, would become invalid. Doing a data migration is way more work and riskier...

zehnm added a commit to unfoldedcircle/core-api that referenced this issue Nov 14, 2023
The Core command metadata used `mode` instead of `sound_mode`. To avoid
invalid user configurations and risky data migrations, we change the
specification.

Caused by: unfoldedcircle/feature-and-bug-tracker#165
@fbutler
Copy link
Author

fbutler commented Nov 14, 2023

Thanks

Fergal

zehnm added a commit to unfoldedcircle/integration-home-assistant that referenced this issue Nov 14, 2023
The Core command metadata used `mode` instead of `sound_mode`. To avoid
invalid user configurations and risky data migrations, we changed the
specification.

Relates to: unfoldedcircle/feature-and-bug-tracker#165
zehnm added a commit to unfoldedcircle/integration-denonavr that referenced this issue Nov 14, 2023
The Core command metadata used `mode` instead of `sound_mode`.
To avoid invalid user configurations and risky data migrations,
we changed the specification: unfoldedcircle/core-api#30.

Add parameter checks for setting sound mode, source and volume.

Relates to: unfoldedcircle/feature-and-bug-tracker#165
zehnm added a commit to unfoldedcircle/core-api that referenced this issue Nov 14, 2023
The Core command metadata used `mode` instead of `sound_mode`. To avoid
invalid user configurations and risky data migrations, we change the
specification.

Caused by: unfoldedcircle/feature-and-bug-tracker#165
zehnm added a commit to unfoldedcircle/integration-home-assistant that referenced this issue Nov 14, 2023
)

The Core command metadata used `mode` instead of `sound_mode`. To avoid
invalid user configurations and risky data migrations, we changed the
specification.

Relates to: unfoldedcircle/feature-and-bug-tracker#165
@zehnm
Copy link

zehnm commented Nov 15, 2023

Status: fix is released in the BETA group and available later this week if we don't find any showstopper.

@zehnm
Copy link

zehnm commented Nov 19, 2023

Fixed in the just released v1.4.8 update

@zehnm zehnm closed this as completed Nov 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working integration Integration driver related issue
Projects
Status: Done
Development

No branches or pull requests

2 participants