mvdwetering / huesyncbox

Custom integration for Home Assistant to control the Philips Hue Play HDMI Sync Box 4K or 8K
Apache License 2.0
113 stars 8 forks source link

Use icons translations #127

Closed piitaya closed 1 month ago

piitaya commented 2 months ago

Use icon translations introduced few months ago (https://developers.home-assistant.io/blog/2024/01/19/icon-translations/)

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The pull request introduces significant structural changes to the icons.json file in the custom_components/huesyncbox, transitioning from a flat icon mapping to a hierarchical categorization by entity types. This includes detailed attributes for number, select, sensor, and switch categories. Additionally, icon attributes have been removed from various entity descriptions in the number.py, select.py, sensor.py, and switch.py files, indicating a shift in icon management and representation.

Changes

File Change Summary
custom_components/huesyncbox/icons.json Expanded structure to categorize icons by entity types (number, select, sensor, switch) with default and state-specific icons; modified services section.
custom_components/huesyncbox/number.py Removed icon attribute from HueSyncBoxNumberEntityDescription for "brightness."
custom_components/huesyncbox/select.py Removed icon attributes from HueSyncBoxSelectEntityDescription for "hdmi_input," "entertainment_area," "intensity," and "led_indicator_mode."
custom_components/huesyncbox/sensor.py Removed icons attribute, WIFI_STRENGTH_ICONS dictionary, and icon property method from HueSyncBoxSensorEntityDescription.
custom_components/huesyncbox/switch.py Removed icon attributes from HueSyncBoxSwitchEntityDescription for "power," "light_sync," and "dolby_vision_compatibility."

Possibly related PRs

Poem

🐰 In the land of hues and sync,
Icons dance and blink,
From flat to grand they rise,
A structured feast for eyes!
With every switch and sensor bright,
A joyful hop, a new delight! 🌈


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 , 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](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 1 month ago

Thanks for the contribution.

There is a test failing that was checking the Wifi strength icons. The line with the check on the icon can be removed since icons are now handled by the translation system (I think)

I would prefer to keep the icon for Syncmode since the movie/music/game ones differ too much and while it does represent the current Syncmode it does not represent Syncmode itself (for which I could not find an icon yet, so that is why it is still default Select entity).

I think the entity icon should primarily represent the entity and should only use enhanced versions of the base icon for state specific versions so it stays clear what entity it represents.

E.g. the Wifi icon is always a Wifi icon, just more or less bars. Similar for the LED icons, it is always an LED, but off/dimmed/on

piitaya commented 1 month ago

Thank you for the review. I adjusted the code according to your feedback 🙂

What do you think about this icon for the sync mode? CleanShot 2024-09-20 at 21 23 03@2x

I also found these ones.

CleanShot 2024-09-20 at 21 22 24@2xCleanShot 2024-09-20 at 21 23 17@2x

If none is good for you, we can keep the default one for now 🙂

mvdwetering commented 1 month ago

I like the multimedia one. Lets go with that.