Skip to content

Allwinner: Replace bc with awk for floating-point comparison in temperature check #8205

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

Merged
merged 1 commit into from
May 27, 2025

Conversation

igorpecovnik
Copy link
Member

@igorpecovnik igorpecovnik commented May 18, 2025

Description

This pull request removes the dependency on bc for floating-point comparisons in the temperature checking logic. The updated implementation uses awk, which is more portable and avoids spawning an extra process for bc.

Closing #8143

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

@igorpecovnik igorpecovnik requested a review from a team as a code owner May 18, 2025 15:51
Copy link
Contributor

coderabbitai bot commented May 18, 2025

Walkthrough

The pull request updates the internal logic of the getboardtemp function in the Armbian Allwinner battery script. The changes replace the use of grep and bc for numeric validation and range checking of the raw temperature input with a Bash regex match and awk for comparison. The method for converting the raw temperature from millidegrees to degrees Celsius is also adjusted to properly quote the input variable. No changes are made to function signatures or exported entities; all modifications are internal to the function.

Suggested labels

ready to merge

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch nobc
  • Post Copyable Unit Tests in Comment

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 generate unit tests to generate unit tests for 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.

@github-actions github-actions bot added 05 Milestone: Second quarter release size/small PR with less then 50 lines Needs review Seeking for review BSP Board Support Packages labels May 18, 2025
@coderabbitai coderabbitai bot added the Ready to merge Reviewed, tested and ready for merge label May 18, 2025
Copy link
Contributor

@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

🧹 Nitpick comments (1)
packages/bsp/common/usr/lib/armbian/armbian-allwinner-battery (1)

18-18: Proper variable quoting improvement

Adding double quotes around ${raw_temp} in the here-string prevents potential word splitting issues if the temperature value contains spaces or special characters.

For consistency, similar unquoted variables appear in lines 67 and 73 in the ambienttemp function:

-amb_temp=$(awk '{printf("%d",$1/1000)}' <<<${raw_temp})
+amb_temp=$(awk '{printf("%d",$1/1000)}' <<<"${raw_temp}")
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d0f708d and ecafb5e.

📒 Files selected for processing (1)
  • packages/bsp/common/usr/lib/armbian/armbian-allwinner-battery (1 hunks)
🔇 Additional comments (2)
packages/bsp/common/usr/lib/armbian/armbian-allwinner-battery (2)

14-14: Good replacement of bc with shell regex + awk

The change effectively replaces the bc utility with a combination of Bash regex and awk for floating-point validation and comparison. This approach improves efficiency by:

  1. Using native Bash regex to validate numeric format
  2. Using awk for the comparison operation in a single process

14-19: Verify the numeric validation logic

The validation logic has been changed from using grep to a Bash regex. The new pattern ^[1-9][0-9]*\.?[0-9]*$ only matches positive numbers starting with 1-9, which excludes zero and negative temperatures.

Confirm that negative temperatures or zero are not valid readings for this board. If they are valid, consider modifying the regex pattern to ^-?[0-9]+\.?[0-9]*$ to include negative values and zero.

@igorpecovnik igorpecovnik merged commit 0cfdb8c into main May 27, 2025
1 check passed
@igorpecovnik igorpecovnik deleted the nobc branch May 27, 2025 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
05 Milestone: Second quarter release BSP Board Support Packages Needs review Seeking for review Ready to merge Reviewed, tested and ready for merge size/small PR with less then 50 lines
Development

Successfully merging this pull request may close these issues.

1 participant