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.

Sign up for GitHub

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

Jump to bottom

Add librespot_options option #262

Closed
wants to merge 1 commit into from
Closed

Add librespot_options option #262

wants to merge 1 commit into from

Conversation

DarkMatterMatt
Copy link

@DarkMatterMatt DarkMatterMatt commented Apr 6, 2024 •
edited by coderabbitai bot
Loading

This PR adds support for adding arbitrary additional librespot options. It's completely opt-in and does not change any existing behaviour

Some users may wish to change librespot settings, and many won't have the time to fluff around cloning repos and adding options to suit their use case. This is a minimal effort way to enable advanced users to use any option in while using the addon.

See the librespot documentation for more information about other options

To test this option:

  1. Enable debug logging; we'll check that the settings are being correctly set by reading the logs
  2. Change the value in the config, e.g. --volume-ctrl fixed --normalisation-pregain -9
  3. Save changes & restart the addon
  4. View the logs, see sample output below
Sample output 
[2024-04-06T12:31:32Z INFO  librespot] librespot 0.4.2 UNKNOWN (Built on 2024-04-01, Build ID: YwHEteUz, Profile: release)
[2024-04-06T12:31:32Z TRACE librespot] Command line argument(s):
[2024-04-06T12:31:32Z TRACE librespot] 		bitrate "320"
[2024-04-06T12:31:32Z TRACE librespot] 		name "Home Assistant"
[2024-04-06T12:31:32Z TRACE librespot] 		disable-audio-cache
[2024-04-06T12:31:32Z TRACE librespot] 		verbose
[2024-04-06T12:31:32Z TRACE librespot] 		volume-ctrl "fixed"
[2024-04-06T12:31:32Z TRACE librespot] 		normalisation-pregain "-9"
[2024-04-06T12:31:32Z DEBUG librespot_discovery::server] Zeroconf server listening on 0.0.0.0:43321

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration option, librespot_options, allowing users to specify additional parameters for the Librespot service in HomeAssistant.
    • Updated documentation to include details about the librespot_options for better user awareness and guidance.

  • Enhancements

    • Improved flexibility in the Spotify daemon’s startup configuration by allowing more customizable command-line options.

  • Translations

    • Added new entries in the translation files to inform users about the librespot_options feature.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 7, 2024

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

@github-actions github-actions bot added the stale There has not been activity on this issue or PR for quite some time. label May 7, 2024
@DarkMatterMatt
Copy link
Author

.

@github-actions github-actions bot removed the stale There has not been activity on this issue or PR for quite some time. label May 8, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 7, 2024

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

@github-actions github-actions bot added the stale There has not been activity on this issue or PR for quite some time. label Jun 7, 2024
@DarkMatterMatt
Copy link
Author

.

@github-actions github-actions bot removed the stale There has not been activity on this issue or PR for quite some time. label Jun 11, 2024
@github-actions GitHub Actions
Copy link

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

@github-actions github-actions bot added the stale There has not been activity on this issue or PR for quite some time. label Jul 12, 2024
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 12, 2024 •
edited
Loading

Walkthrough

The recent updates introduce a new configuration option, librespot_options, across several components of the HomeAssistant Spotify Connect integration. This feature enhances user control by allowing additional parameters for the librespot library, thereby improving customization and functionality. The changes span documentation, configuration files, script enhancements, and translations, all aimed at providing a richer user experience and better integration with Spotify services.

Changes

Files Change Summary
spotify/DOCS.md, spotify/config.yaml Added librespot_options: a new configuration option for specifying additional librespot parameters.
spotify/rootfs/etc/services.d/spotifyd/run Introduced librespot_options variable for command-line options, enhancing daemon configurability.
spotify/translations/en.yaml Added new entry for librespot_options with name and description for better user guidance.

Poem

🐰 In the garden of code, with hops and leaps,
New options bloom where the Spotify peeps.
A sprinkle of librespot, a dash of delight,
Now HomeAssistant sings through the night!
With every new config, our joy's on display,
Hopping high with tunes, let's dance and play! 🎶

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

@github-actions github-actions bot removed the stale There has not been activity on this issue or PR for quite some time. label Jul 13, 2024
@github-actions GitHub Actions
Copy link

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

@github-actions github-actions bot added the stale There has not been activity on this issue or PR for quite some time. label Aug 12, 2024
coderabbitai[bot]
coderabbitai bot reviewed Aug 12, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a1f0d43 and 4270cb8.

Files selected for processing (4)
  • spotify/DOCS.md (3 hunks)
  • spotify/config.yaml (1 hunks)
  • spotify/rootfs/etc/services.d/spotifyd/run (2 hunks)
  • spotify/translations/en.yaml (1 hunks)
Additional comments not posted (5)
spotify/config.yaml (1)

24-24: Addition of librespot_options is appropriate.

The inclusion of librespot_options as an optional string enhances configurability without affecting existing functionality.

spotify/translations/en.yaml (1)

26-30: New translation entry for librespot_options is well-structured.

The entry provides a clear name and description, enhancing user understanding and providing a helpful link to external documentation.

spotify/rootfs/etc/services.d/spotifyd/run (1)

Line range hint 11-48:
Inclusion of librespot_options in the script is well-implemented.

The script correctly checks for and applies additional command-line options, enhancing flexibility without altering existing behavior.

spotify/DOCS.md (2)

40-40: Ensure clarity in example configuration.

The example configuration line for librespot_options is clear and provides a practical example. Ensure that users understand that this is an optional field and can be customized as needed.

92-94: Clarify the librespot_options description.

The description of the librespot_options is concise and directs users to the external documentation. Ensure that the link to the librespot documentation is correct and accessible.

@github-actions github-actions bot removed the stale There has not been activity on this issue or PR for quite some time. label Aug 13, 2024
@github-actions GitHub Actions
Copy link

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

@github-actions github-actions bot added the stale There has not been activity on this issue or PR for quite some time. label Sep 12, 2024
@github-actions github-actions bot closed this Sep 19, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Sep 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

Assignees
No one assigned
Labels
stale There has not been activity on this issue or PR for quite some time.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@DarkMatterMatt