Skip to content
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

Skoda unsupported connector footnote; note J533 alternative isn't available on all cars #25250

Merged
merged 3 commits into from
Aug 12, 2022

Conversation

belm0
Copy link
Contributor

@belm0 belm0 commented Jul 22, 2022

@incognitojam
Copy link
Contributor

You will need to add the footnote programmatically instead, see here where the others were defined: https://github.com/commaai/openpilot/blob/master/selfdrive/car/volkswagen/values.py#L99

@sshane sshane added docs car vehicle-specific labels Jul 22, 2022
@belm0
Copy link
Contributor Author

belm0 commented Jul 22, 2022

You will need to add the footnote programmatically instead, see here where the others were defined: https://github.com/commaai/openpilot/blob/master/selfdrive/car/volkswagen/values.py#L99

Thank you-- you mean that CARS.md is generated.

By the way, I noticed that multiple footnotes is not rendered correctly (only the first footnote is referenced). E.g.:

VWCarInfo("Volkswagen Passat 2015-22", footnotes=[Footnote.VW_HARNESS, Footnote.PASSAT, Footnote.VW_VARIANT], harness=Harness.j533),

renders as
Screen Shot 2022-07-22 at 10 26 20 PM

CAR.SKODA_KAROQ_MK1: VWCarInfo("Škoda Karoq 2019", footnotes=[Footnote.VW_HARNESS]),
CAR.SKODA_KODIAQ_MK1: VWCarInfo("Škoda Kodiaq 2018-19", footnotes=[Footnote.VW_HARNESS]),
CAR.SKODA_SCALA_MK1: VWCarInfo("Škoda Scala 2020", footnotes=[Footnote.VW_HARNESS]),
CAR.SKODA_SUPERB_MK3: VWCarInfo("Škoda Superb 2015-18", footnotes=[Footnote.VW_HARNESS]),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure if the footnote isn't needed on all SEAT and Audi entries as well. Wait until they are confirmed in the wild?

@belm0
Copy link
Contributor Author

belm0 commented Jul 22, 2022

(At the moment I don't have an openpilot dev environment with proper dependencies to run selfdrive/car/docs.py.)

@belm0
Copy link
Contributor Author

belm0 commented Jul 23, 2022

@sshane thank you for running docs.py, though I think I need to rebase to master first to get the multiple-footnote fix, otherwise this PR would overwrite the generated code

@belm0
Copy link
Contributor Author

belm0 commented Jul 23, 2022

rebased-- this PR will need another run of docs.py before merge

@jyoung8607
Copy link
Collaborator

jyoung8607 commented Jul 23, 2022

Footnote.VW_HARNESS is for MY2021/2022 and beyond vehicles where the required harness changes due to introduction of the MFK 3.0 camera. It's not brand specific. I've been adding the footnote references as MY2022 support comes up. It's Volkswagen-heavy right now because I started a sweep recently (#25123) to extend supported model-years. It's research-intensive and I haven't gotten to the other brands yet.

You're correct to note some vehicles have popped up that don't have the traditional J533 connector anymore. The affected cars appear to be MY2022 and forward MQB-A0 with a new combined BCM/CAN gateway, but that is based on a small sample size. I'm not exactly sure what to say about that in the footnote, and have really been hoping @vanillagorillaa's work on a new MFK 3.0 connector pays off soon.

@belm0
Copy link
Contributor Author

belm0 commented Jul 23, 2022

Footnote.VW_HARNESS is for MY2021/2022 and beyond vehicles where the required harness changes due to introduction of the MFK 3.0 camera. It's not brand specific. I've been adding the footnote references as MY2022 support comes up.

Do you mean this footnote shouldn't be added to all Skoda models?

Since MFK 3.0 is confirmed in one model, it seems highly likely to be adopted by other models. The footnote is and asking users to verify the connector before purchasing a harness. Is there harm in conservatively marking all models of the brand?

@jyoung8607
Copy link
Collaborator

Do you mean this footnote shouldn't be added to all Skoda models?

I mean it should be added as we bring MY2021/2022 onboard, or update the docs with research showing we can. Technically your PR #25271 would have been the time to add it to Karoq, but I didn't want to hold it up for revision given that you had this PR open on similar grounds.

@belm0
Copy link
Contributor Author

belm0 commented Jul 26, 2022

I mean it should be added as we bring MY2021/2022 onboard, or update the docs with research showing we can. Technically your PR #25271 would have been the time to add it to Karoq, but I didn't want to hold it up for revision given that you had this PR open on similar grounds.

@jyoung8607 will you OK this PR if the footnote is limited to Karoq only?

You're correct to note some vehicles have popped up that don't have the traditional J533 connector anymore. The affected cars appear to be MY2022 and forward MQB-A0 with a new combined BCM/CAN gateway, but that is based on a small sample size. I'm not exactly sure what to say about that in the footnote

I'd really like to disclose something in the footnote about the possibility of no J533 (however small). It's not a great user experience to be promised a workaround and find out after purchasing the harness that you don't have the port.

@sshane
Copy link
Contributor

sshane commented Aug 11, 2022

Is this PR ready to merge?

@jyoung8607
Copy link
Collaborator

It's close enough. I wish I had a better definition of which newer cars have combined BCM and CAN gateway hardware (I think it's the MQB-A0 compacts) but this is better than no note at all.

@belm0
Copy link
Contributor Author

belm0 commented Aug 12, 2022

Is this PR ready to merge?

yes, please run docs.py and merge

@sshane sshane merged commit 58fa5ca into commaai:master Aug 12, 2022
@belm0 belm0 deleted the patch-1 branch August 12, 2022 04:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
car vehicle-specific docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants