search

mvdwetering / yamaha_ynca

Custom integration for Home Assistant to support Yamaha AV receivers with the YNCA protocol (serial and network).
Apache License 2.0
40 stars 4 forks source link

Add TV input #294

Closed joos81 closed 3 months ago

joos81 commented 3 months ago 
New Features
    Added support for the new TVinput option in the audio settings.
Updates
    Updated the Yamaha Ynca configuration to version 7.5, enhancing options for existing users.
    Updated the underlying ynca package to version 5.15.0 for improved stability and performance.
Bug Fixes
    Implemented a migration process to smoothly transition from configuration version 7.4 to 7.5, ensuring compatibility and user preferences are maintained.

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The update primarily revolves around version upgrades and associated transformations for a Yamaha custom component used in Home Assistant. Changes include increasing minor version numbers, adding mappings for new TV inputs, updating configuration migration scripts, and modifying test functions to reflect these updates. The goal is to ensure smooth functionality and seamless migration to the new version while expanding compatibility with additional input devices.

Changes

Files Change Summary
custom_components/yamaha_ynca/config_flow.py, tests/conftest.py Updated MINOR_VERSION from 4 to 5 for YamahaYncaConfigFlow.
custom_components/yamaha_ynca/input_helpers.py Added new mapping for TV input with identifier ["tv"].
custom_components/yamaha_ynca/manifest.json, requirements.txt Updated ynca library version from 5.14.0 to 5.15.0.
custom_components/yamaha_ynca/migrations.py Added migrate_v7_4_to_v7_5 function for upgrading configurations to version 7.5, ensuring compatibility with new TV inputs.
tests/test_migrations.py Added test function for migrating an entry from version 7.4 to 7.5, including updated assertions.
tests/test_options_flow.py Included TV option in audio input sources for options flow tests.

Sequence Diagram(s)

sequenceDiagram
    participant Hass as Home Assistant
    participant Config as YamahaYncaConfigFlow
    participant Migr as Migrations
    participant Tests as Test Suite

    Hass->>Config: Start Config Flow
    Config->>Config: Increment MINOR_VERSION (4 to 5)
    Tests->>Config: Update `create_mock_config_entry`
    Migr->>Migr: Add `migrate_v7_4_to_v7_5` function
    Config->>Hass: Config Flow Complete (v7.5)

    Note over Hass,Config: Adding new TV input
    Config->>Hass: Include TV in available inputs
    Tests->>Hass: Validate TV input in options flow tests

    Hass->>Migr: Call migrate_v7_4_to_v7_5
    Migr->>Hass: Migrate configurations to v7.5
    Tests->>Migr: Test migrations for v7.4 to v7.5

    Hass->>Tests: Execute full test suite
    Tests->>Tests: Validate new TV input and version updates

    Note over Hass,Tests: Update `ynca` library to v5.15.0

Poem

In the world of code, updates flow,
Version numbers rise and grow,
New inputs join the Yamaha dance,
Giving configurations a finer chance.
With tests aligned and changes neat,
We celebrate this coding feat! 🎉

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
mvdwetering commented 3 months ago

Thanks for the addition 👍 Will make a release later today ,