8000 "docs: update 'Turn the Speed Blue' tutorial with new UI path and fu… by WilliamBonilla62 · Pull Request #35016 · commaai/openpilot · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

"docs: update 'Turn the Speed Blue' tutorial with new UI path and fu… #35016

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 2 commits into from
Apr 28, 2025

Conversation

WilliamBonilla62
Copy link
Contributor

Purpose

Update the "Turn the Speed Blue" tutorial in the OpenPilot docs to reflect recent code changes in the UI system. The original guide pointed to selfdrive/ui/paint.cc, which is now outdated.

This change updates:

  • The path to the speed rendering logic, now located in selfdrive/ui/qt/onroad/hud.cc
  • The function to edit (HudRenderer::drawText)
  • The specific color update line to make the speed text appear blue
  • Instructions to recompile with scons after changes

Changes Made

In docs/TUTORIAL.md (or the file where the tutorial is located):

  • Updated step 3 to point to hud.cc
  • Explained the new drawText() function and how to modify the QColor(...) line
  • Provided a visual explanation of the color change from white to light blue (#8080FF)

Justification

  • Ensures new contributors can follow the tutorial without confusion
  • Prevents wasted time searching for legacy code in paint.cc
  • Keeps documentation aligned with current OpenPilot UI architecture

Verification

  • Verified that the drawText() function in hud.cc is the correct place to update the speed color
  • Rebuilt OpenPilot with scons and confirmed that speed text displays in light blue during tools/replay/replay --demo

Screenshot from 2025-04-12 09-48-35

Copy link
Contributor
@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thanks for contributing to openpilot! In order for us to review your PR as quickly as possible, check the following:

  • Convert your PR to a draft unless it's ready to review
  • Read the contributing docs
  • Before marking as "ready for review", ensure:
    • the goal is clearly stated in the description
    • all the tests are passing
    • the change is something we merge
    • include a route or your device' dongle ID if relevant

## 5. Push your fork to GitHub

Click fork on GitHub. Then, push with:
Click **"Fork"** on the [OpenPilot GitHub repo](https://github.com/commaai/openpilot). Then push with:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Click **"Fork"** on the [OpenPilot GitHub repo](https://github.com/commaai/openpilot). Then push with:
Click **"Fork"** on the [openpilot GitHub repo](https://github.com/commaai/openpilot). Then push with:

We always use lower case for openpilot

Uninstall openpilot from your device through the settings. Then, enter the URL for your very own installer:
## 6. Run your fork on your comma device

Uninstall OpenPilot through the settings on your device.
Copy link
Contributor
@maxime-desroches maxime-desroches Apr 18, 2025

Choose a reason for hiding this comment

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

Again lower case


## 7. Admire your work IRL 🚗💨

You’ve now successfully modified OpenPilot’s UI and deployed it to your own car!
Copy link
Contributor
@maxime-desroches maxime-desroches Apr 18, 2025

Choose a reason for hiding this comment

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

Again lower case

@WilliamBonilla62
Copy link
Contributor Author
WilliamBonilla62 commented Apr 18, 2025

@maxime-desroches I corrected the openpilot mention to all lowercase.

The pr is ready to merge.

Merci pour la review !

Copy link
Contributor

This PR has had no activity for 9 days. It will be automatically closed in 2 days if there is no activity.

@github-actions github-actions bot added the stale label Apr 28, 2025
@maxime-desroches maxime-desroches merged commit c4acae6 into commaai:master Apr 28, 2025
16 checks passed
@maxime-desroches
Copy link
Contributor

Pas de trouble


## 4. Rebuild the UI

After making changes, rebuild Openpilot so your new UI is compiled:
Copy link
Contributor

Choose a reason for hiding this comment

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

openpilot is always lowercase

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

Successfully merging this pull request may close these issues.

3 participants
0