Skip to content

Commit 1016a41

Browse files
committed
take out example; there's a time and place for everything
1 parent 95b3792 commit 1016a41

File tree

1 file changed

+3
-21
lines changed

1 file changed

+3
-21
lines changed

README.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
## How and Why to Use
88

9-
openpilot queries the firmware of your vehicle upon start and configures itself to your vehicle accordingly with a list of pre-existing firmwares in the codebase. This process is called [Fingerprinting](https://github.com/commaai/openpilot/wiki/Fingerprinting). If you currently see an error of `Car Unrecognized: Dashcam Mode`, you should try to go through the [fingerprinting guide](https://github.com/commaai/openpilot/wiki/Fingerprinting). *Please make sure to follow the suggestion in the guide to try the `master-ci` branch first.*
9+
openpilot queries the firmware of your vehicle upon start and configures itself to your vehicle accordingly with a list of pre-existing firmwares in the codebase. This process is called [Fingerprinting](https://github.com/commaai/openpilot/wiki/Fingerprinting). If you currently see an error of `Car Unrecognized: Dashcam Mode`, you should try to go through the [fingerprinting guide](https://github.com/commaai/openpilot/wiki/Fingerprinting). *Please make sure to follow the suggestion in the guide to try the `master-ci` branch first and reaching out to the vehicle brand's Discord channel if you have issues.*
1010

11-
If you are having trouble going through the fingerprinting guide, you could use this repository to install a version of openpilot on your vehicle with a hardcoded fingerprint so you can get things working ASAP. This method does not require knowledge of SSH, editing code, or modifying system files.
11+
If you are having trouble going through the fingerprinting guide and after consulting the vehicle brand's Discord channel, you may agree to use this repository to install a version of openpilot on your vehicle with a hardcoded fingerprint so you can get things working ASAP. This method does not require knowledge of SSH, editing code, or modifying system files.
1212

13-
_Be aware that choosing and setting an erronous fingerprint can and usually will cause your vehicle and openpilot to behave unexpectedly_. **Consult your vehicle brand's Discord channel for guidance first.**
13+
_Be aware that choosing and setting an erronous fingerprint can and usually will cause your vehicle and openpilot to behave unexpectedly_. **To repeat, consult your vehicle brand's Discord channel for guidance first.**
1414

1515
This repository is not to be considered a replacement for proper fingerprinting and should be used as an emergency, last, and temporary resort. As such, it does not apply cosmetic changes to the UI to disable warning messages such as "untested branch" as that is a genuine warning. Users and resident vehicle brand experts prescribing this should campaign and create an [pull request for the proper upstreaming of their fingerprints to the official openpilot repository](https://github.com/commaai/openpilot/pulls). The commits of this repository are direct child commits of the official commits.
1616

@@ -24,24 +24,6 @@ You can see a list of fingerprint models, their corresponding installer URLs for
2424

2525
https://hardcoded-fp.github.io/openpilot/
2626

27-
## Example
28-
29-
So you got yourself a Hyundai Santa Fe Hybrid 2022 and you install the comma device. [It says it was supported on comma.ai's vehicles listing page](https://comma.ai/vehicles).
30-
31-
Once you do, you get `Car Unrecognized: Dashcam Mode` when you install `https://openpilot.comma.ai` on your comma device. That installer installed the "stable" `release3` branch of openpilot.
32-
33-
The next step is to [go through the fingerprinting guide and try the `master-ci` branch first as mentioned in the guide.](https://github.com/commaai/openpilot/wiki/Fingerprinting). If it works, you're done. If you want to get off the "unstable" `master-ci`, you may switch back to the "stable" `release3` branch when its new version is released by installing "Custom Software" `https://openpilot.comma.ai` again.
34-
35-
The fingerprint guide may be a bit daunting, so this repository is here as a last resort if you can't get through it.
36-
37-
If "unstable" `master-ci` doesn't work, stop here and consult the [comma.ai Discord](https://discord.comma.ai) channel for your car brand. In this case, the #hyundai-kia-genesis channel may recommend you force fingerprinting your vehicle as "HYUNDAI SANTA FE HYBRID 2022".
38-
39-
With this repository's [generated documentation](https://hardcoded-fp.github.io/openpilot/), you can find the corresponding installer/branch with that hardcoded fingerprint. In this case, the corresponding Custom Software installer URL is:
40-
41-
https://installer.comma.ai/hardcoded-fp/master-ci-hyundai-santa-fe-hybrid-2022
42-
43-
If all goes well, you'll run through the installation process and have "unstable" `master-ci` openpilot installed on your vehicle with a hardcoded fingerprint. When `master-ci` gets updated with the fingerprint for your vehicle, uninstall and switch back to the official `master-ci` branch. Please consult your brand's Discord channel for how to push your fingerprint upstream to the official openpilot repository and information on when it will be merged in.
44-
4527
## "Stable" `release3` Option
4628

4729
This GitHub repository also periodically continuously generates openpilot branches off of openpilot's "deployment"-style "stable" `release3` branches with a hardcoded fingerprint identification of the vehicle for the purpose of installing the respective "stable" `release3` flavors of openpilot on un-fingerprinted vehicles where there is currently a massive lag in the freshness of fingerprints in the "stable" `release3` compared to the "unstable" `master-ci` that has more current fingerprints but they want the possible increased "stable" `release3`'s stability.

0 commit comments

Comments
 (0)