Skip to content

Conversation

@builderjer
Copy link
Member

@builderjer builderjer commented Jun 15, 2025

Updates script to use either the version of current kernel, or the default branch for the respeaker drivers

Summary by CodeRabbit

  • New Features

    • Added automatic installation of respeaker drivers during setup, dynamically selecting the driver version based on the system's kernel version.
  • Bug Fixes

    • Enhanced installation feedback with clear success or failure messages for respeaker drivers.

@coderabbitai
Copy link

coderabbitai bot commented Jun 15, 2025

Walkthrough

The updates modify the respeaker driver installation process in the build script by invoking a dedicated setup script, which now dynamically selects the appropriate driver version based on the running kernel. Commented-out update commands are cleaned up, and the setup script adds logic to report installation success or failure.

Changes

File(s) Change Summary
build_raspOVOS.sh Removes commented update commands; adds active call to setup_respeaker.sh for driver installation.
scripts/setup_respeaker.sh Dynamically selects seeed-voicecard driver version based on kernel minor version; adds install success/failure messages.

Poem

In the warren, drivers hop and play,
Now respeaker finds its kernel way.
No more hardcoded, versions chase—
Dynamic scripts now set the pace!
With every build, a bunny cheers,
For smarter scripts and bug-free ears.
🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between edc528f and 827eaf7.

📒 Files selected for processing (1)
  • scripts/setup_respeaker.sh (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • scripts/setup_respeaker.sh
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 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.

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: 2

🧹 Nitpick comments (1)
scripts/setup_respeaker.sh (1)

21-26: Quote variables and explicitly fallback to default branch
Unquoted $checkout_version can break on unusual tag names. Also, while failing a checkout leaves you on the original branch, it’s clearer to explicitly git checkout the default (e.g., main or master) to avoid a detached HEAD state.

Example:

- if git checkout $checkout_version; then
+ if git checkout --quiet "$checkout_version"; then
    echo "using version $checkout_version of respeaker drivers"
  else
    echo "Could not checkout version $checkout_version"
+   git checkout main   # or `master`, whichever is the default
    echo "Falling back to default branch"
  fi
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db1f3ac and edc528f.

📒 Files selected for processing (2)
  • build_raspOVOS.sh (1 hunks)
  • scripts/setup_respeaker.sh (3 hunks)
🧰 Additional context used
🪛 Shellcheck (0.10.0)
scripts/setup_respeaker.sh

[error] 67-67: Couldn't parse this test expression. Fix to allow more checks.

(SC1073)


[error] 67-67: Expected comparison operator (don't wrap commands in []/[[]]). Fix any mentioned problems and try again.

(SC1072)

🔇 Additional comments (1)
build_raspOVOS.sh (1)

146-148: Properly invoke the ReSpeaker setup script
The addition of the echo and bash setup_respeaker.sh commands correctly integrates driver installation into the build workflow, leveraging set -e to abort on failure.

Comment on lines +17 to +19
kernel=$(uname -r)
k_ver=$(echo $kernel | cut -d '.' -f2)
checkout_version="v6.$k_ver"
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve kernel version extraction logic
Current code only captures the minor version and hardcodes major as “6”, which will break on non-6.x kernels and may mis-handle tags. Also, variable expansions should be quoted to prevent word-splitting.

Proposed diff:

- kernel=$(uname -r)
- k_ver=$(echo $kernel | cut -d '.' -f2)
- checkout_version="v6.$k_ver"
+ # Extract major and minor from the raw kernel version (ignore suffix)
+ kernel_base=$(uname -r | cut -d '-' -f1)
+ major=$(echo "$kernel_base" | cut -d '.' -f1)
+ minor=$(echo "$kernel_base" | cut -d '.' -f2)
+ checkout_version="v${major}.${minor}"

This makes the tag dynamic and robust across kernel series.

🤖 Prompt for AI Agents
In scripts/setup_respeaker.sh around lines 17 to 19, the kernel version
extraction hardcodes the major version as "6" and only extracts the minor
version, which breaks compatibility with other kernel series. Update the code to
dynamically extract both the major and minor kernel version parts from the uname
output, and quote all variable expansions to prevent word splitting. Construct
the checkout_version variable using these extracted parts to make the tag
dynamic and robust across different kernel versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants