Build Wiki

[N0cynym]

I think documentation and knowledge are the one and only to let this amazing project create a free high level open source software.

Is it possible to create a wiki to bring in our knowledge and the manual how to use this software?

[jglim]

Sounds good, do you have an idea of the content and pages that might be good to include? I drafted this outline, after hearing your opinion and getting a general wiki structure, I will be glad to create the blank wiki pages.

Welcome (Onboarding)

• Setting up CaesarSuite (requirements, cbf files)
• Reminder about copyrighted files, so that no one accidentally takes down the project
• Differences from Vediamo (for seasoned users to understand the limitations of Diogenes e.g. no flashing, HSCAN only)

Common Workflows

• Loading a CBF file, and initiating contact
• ECU preparations (e.g. what sort of issues to preempt)

VC:

• Backup variant strings
• Write new variant strings

Diagnostic Services:

• If the general diagservice has a valid payload (e.g. not blank or 00 00..), they can be executed normally (e.g. FN_Aktivieren)
• Limitations (no embedded scripts)

CFF:

• Export CFF segments
• Splice CFF segments

Memory Editor:

• Read, write memory, adjust parameters

Troubleshooting

• 7F: ECU unlocked?
• Saving traces
• How to ask for help

Technical Notes

• Looking into c32s.dll
• Communications (brief on J2534)
• Protocol support (UDS, KW2C3PE)
• Fingerprinting
• Diogenes behavior for VC (SCN zeroing)
• Preparing a bench setup

[N0cynym]

Yes that's definitely what I'm meaning.

The first page should let us explain CaesarSuite and point on the copyrigths!

The Editor
CaesarSuiteWiki.zip

[jglim]

Got it. I'll try to figure out how to enable the wiki and setup the pages within these few days. Thanks for looking into it and coming up with the nice diagrams

[N0cynym]

You're welcome 😉
I updated this a little bit.

[jglim]

I looked at the tree for a bit, it seems like there is some overlap between User Manual and Guides, so I tried to aggregate them together.

The wiki is now up with significant change to the layout, with notes to refer back to your original diagram (simpler is preferred for now!); hope it looks alright. Your account should have edit capabilities, let me know again if it doesn't work and I will check the repository's settings.

[N0cynym]

Looks like I'm not able to edit.

[jglim]

I changed the settings again, please let me know if it is still broken. Not sure how Github's wiki access control works, so I changed it to be extra permissive for now.

[N0cynym]

Thanks 😄
I will give my best to upload good content as soon as possible.

[N0cynym]

Does someone know how to upload images to wiki?
Is the only way to store them in a private repository or where will/must we store them?

[N0cynym]

This is my latest edit from draw.io
BasicWorkflowCaesarSuiteObd.zip

[jglim]

This issue has been created for anyone to post images inside, and can be used together with the wiki : #23 ; images can be uploaded there, and referenced in the wiki. Hope it makes the process somewhat easier.

Quick note about your J2534 question, the standard is "officially" available from the standards body, SAE, but is behind a paywall. I found these documentation from DrewTech to be a very good alternative.

[N0cynym]

Thank you. KVASER have also a good english description about J2534.
I will search for more and update the wiki as soon as I'm able for.