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

Automate documentation / Supported vehicles list #239

Merged
merged 9 commits into from
Oct 21, 2024

Conversation

camueller
Copy link
Contributor

@camueller camueller commented Oct 19, 2024

I added documentation for the Automate feature. It includes generation of a list of supported vehicles. It will always be generated when vehicle_ profiles.json is built. Therefore it is always up-to-date.

Copy link
Collaborator

@jay-oswald jay-oswald left a comment

Choose a reason for hiding this comment

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

Great idea, love it.

Just a few small things

.vehicle_profiles/package.json Outdated Show resolved Hide resolved
.vehicle_profiles/buildSupportedVehiclesList.js Outdated Show resolved Hide resolved
docs/content/0.Config/5.Automate/2.Supported_Vehicles.md Outdated Show resolved Hide resolved
@camueller
Copy link
Contributor Author

Please also review documentation content. I decscribed my understanding of the feature but I might have missed something.

@meatpiHQ
Copy link
Owner

@camueller Good stuff! There's couple of changes in the automate documentation. I'll add some notes later.


## Vehicle Profiles
The "Automate" feature automatically downloads **vehicle profiles** from GitHub containing some popular PIDs (e.g. SoC, SoH). These vehicle profiles are car vendor and/or model specific. There is a growing [list of supported vehicles](2.Supported_Vehicles.md).
Copy link
Owner

Choose a reason for hiding this comment

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

you have to press the sync button next to the vehicle model drop down list to fetch the vehicle profiles

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You mean I have to press the sync button initially to get the list? I cannot remember, that I did it ...

Copy link
Owner

Choose a reason for hiding this comment

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

Yes that's right, it's probably because you had the whole file stored in the device. Once you click the sync you fetch the latest from GitHub

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed

@meatpiHQ meatpiHQ merged commit b81bb75 into meatpiHQ:main Oct 21, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants