Skip to content

Add OSD support for Angle of Attack #4339

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

haslinghuis
Copy link
Member

@haslinghuis haslinghuis commented Feb 10, 2025

This pull request introduces a new feature to display the "Angle of Attack" element in the On-Screen Display (OSD). The changes include updates to the localization messages, symbol definitions, and OSD field configurations.

Localization updates:

Symbol definitions:

OSD field configurations:

  • src/js/tabs/osd.js: Added "ANGLE_OF_ATTACK" to the OSD.loadDisplayFields function with relevant properties like text, desc, defaultPosition, draw_order, and preview.
  • src/js/tabs/osd.js: Included F.ANGLE_OF_ATTACK in the OSD.chooseFields function to ensure it is selectable.

Summary by CodeRabbit

  • New Features
    • Added a new "Angle of attack" element to the On Screen Display (OSD) for compatible firmware versions (API 1.47 and above).
    • Updated English language support to include text and description for the new "Angle of attack" OSD element.

@haslinghuis haslinghuis added this to the 11.0 milestone Feb 10, 2025
@haslinghuis haslinghuis self-assigned this Feb 10, 2025
Copy link

netlify bot commented Feb 10, 2025

Deploy Preview for origin-betaflight-app ready!

Name Link
🔨 Latest commit 74e8ae8
🔍 Latest deploy log https://app.netlify.com/sites/origin-betaflight-app/deploys/67ce0be5449a24000840ddb3
😎 Deploy Preview https://deploy-preview-4339.dev.app.betaflight.com
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@demvlad
Copy link
Contributor

demvlad commented Feb 11, 2025

This is great!
I've just thought about delete (//comment) my osd blink mode code to go it in separate PRs.
I've not seen osd indication during last test my PR, due of some mistake probably. Will test with this PR together next time.

Copy link

sonarqubecloud bot commented Mar 9, 2025

Copy link

coderabbitai bot commented Apr 30, 2025

Walkthrough

The changes introduce a new "Angle of attack" element to the On Screen Display (OSD) system. This includes adding English localization strings for the new element and its description, defining a new symbol constant for "Angle of attack," and updating the display fields to include this element for firmware versions 1.47 and above. The new display field is fully integrated with properties for name, text, description, position, draw order, and preview formatting.

Changes

File(s) Change Summary
locales/en/messages.json Added two new localization entries: "osdTextElementAngleOfAttack" and "osdDescElementAngleOfAttack".
src/js/tabs/osd.js Added ANGLE_OF_ATTACK symbol constant, defined new display field for "Angle of attack", and updated field selection logic for firmware API 1.47+.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OSD_Module
    participant Firmware

    User->>OSD_Module: Load OSD configuration
    OSD_Module->>Firmware: Query firmware API version
    Firmware-->>OSD_Module: Return API version (>= 1.47)
    OSD_Module->>OSD_Module: Add ANGLE_OF_ATTACK to display fields
    OSD_Module->>User: Render OSD with Angle of attack element
Loading

Poem

In the fields where numbers stack,
A new angle joins the pack!
"Angle of attack" now takes its place,
With symbols, text, and a previewed face.
OSD grows, the screens delight—
More data for every flight!
🐰✨

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

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

🧹 Nitpick comments (1)
locales/en/messages.json (1)

5756-5763: Good addition of localization strings for the new 'Angle of attack' OSD element.

The new localization strings for the 'Angle of attack' OSD element are properly formatted and follow the established pattern for OSD elements in this file.

Consider enhancing the description for the Angle of Attack element to provide users with more context about what this element displays and why it might be useful. Most other OSD element descriptions in this file offer more detailed explanations. For example:

  "osdDescElementAngleOfAttack": {
-     "message": "Angle of attack",
+     "message": "Displays the aircraft's angle of attack - the angle between the aircraft's reference line and the oncoming airflow. Useful for monitoring flight efficiency and avoiding stall conditions.",
      "description": "Description of the angle of attack element of the OSD"
  },
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f5e3b6 and 405a210.

📒 Files selected for processing (2)
  • locales/en/messages.json (1 hunks)
  • src/js/tabs/osd.js (3 hunks)
🔇 Additional comments (3)
src/js/tabs/osd.js (3)

87-87: Symbol addition looks good

Adding a new symbol constant for Angle of Attack with a unique hex value follows the established pattern for OSD symbols.


1582-1590: Correctly implemented new OSD display field

The new Angle of Attack display field follows the appropriate structure with all required properties. The preview pattern using ${FONT.symbol(SYM.ANGLE_OF_ATTACK)}-00.0 aligns with how other angle measurements like pitch and roll are formatted.


2037-2037: Proper field registration for appropriate firmware version

Correctly adding the Angle of Attack field to the display fields array for firmware version 1.47 and above ensures backward compatibility.

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

Successfully merging this pull request may close these issues.

2 participants