Skip to content

Fix GNSS status icon when fix is attained without sat info #4461

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 5, 2025

Conversation

haslinghuis
Copy link
Member

@haslinghuis haslinghuis commented May 3, 2025

Some GNSS modules won't send sat info, but could attain a fix.

This pull request refactors the sensor_status function in src/js/sensor_helpers.js to improve readability and reduce redundant code. The most important change consolidates the logic for toggling GPS icon classes based on sensor detection and GPS fix state.

Code refactoring for readability and maintainability:

  • Introduced gnssSensorDetected and hasGnssFix constants to clarify the conditions for GPS sensor detection and fix state.
  • Simplified the logic for toggling GPS icon classes (active and active_fix) by using the toggleClass method, reducing redundancy in class manipulation.
  • Streamlined the removal of multiple classes (active and active_fix) into a single removeClass call for better readability.

Summary by CodeRabbit

  • Refactor
    • Streamlined and consolidated the logic controlling GPS sensor status indicators in the user interface for improved maintainability. No changes to visible behavior.

Copy link

coderabbitai bot commented May 3, 2025

Walkthrough

The code responsible for updating the GPS sensor status in the UI was refactored. The new implementation introduces boolean variables to represent GPS sensor detection and GPS fix presence, and uses these to streamline the logic for toggling CSS classes on the GPS icon. The condition for displaying the "on" state of the GPS icon was updated to activate if either the sensor is detected or a GPS fix is present. The process for removing CSS classes when GPS is not detected or no fix is present was also consolidated. No changes were made to exported or public entity declarations.

Changes

File(s) Change Summary
src/js/sensor_helpers.js Refactored GPS sensor status UI logic: introduced boolean flags, consolidated class toggling, updated conditions for displaying GPS icon "on" state, and simplified class removal.

Sequence Diagram(s)

sequenceDiagram
    participant SensorData
    participant SensorHelpers
    participant GPSIconUI

    SensorData->>SensorHelpers: Update GPS sensor status (detected, fix)
    SensorHelpers->>GPSIconUI: Toggle "active", "active_fix", "on" classes based on detection/fix booleans
Loading

Assessment against linked issues

Objective Addressed Explanation
Ensure GPS icon is displayed when GPS fix is present, even if sensor is not listed (#13919)

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27791d9 and c8a5d8f.

📒 Files selected for processing (1)
  • src/js/sensor_helpers.js (1 hunks)
🔇 Additional comments (4)
src/js/sensor_helpers.js (4)

79-81: Great improvement in code readability!

Using descriptive constants gnssSensorDetected and hasGnssFix makes the code more self-documenting and easier to understand.


82-82: Good fix addressing the GNSS module issue.

The condition gnssSensorDetected || hasGnssFix properly handles the case where some GNSS modules achieve a fix without sending satellite information (issue #4462).


84-86: Clean refactoring using toggleClass.

Using jQuery's toggleClass with boolean conditions is more concise and maintainable than separate addClass/removeClass calls. The conditions clearly express when each class should be applied.


89-89: Good consolidation of class removal.

Removing both classes in a single removeClass call is more efficient than separate calls.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

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.

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

sonarqubecloud bot commented May 3, 2025

Copy link
Contributor

github-actions bot commented May 3, 2025

Preview URL: https://1e4b8c44.betaflight-configurator.pages.dev

@haslinghuis haslinghuis changed the title Fix GNSS status when fix is attained without sat info Fix GNSS status icon when fix is attained without sat info May 3, 2025
@haslinghuis haslinghuis merged commit 1a3a949 into betaflight:master May 5, 2025
6 checks passed
@haslinghuis haslinghuis deleted the gnss-status-sat-fix branch May 5, 2025 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

Yellow GPS icon is not displayed despite GPS fix
2 participants