[Help/Suggestion] Documentation help

[mjm918]

First of all, thank you for this awesome library. You did a great job. However, I think your documentation needs to be elaborated. The documentation you provided is very basic. I would like to know more about livedata, livedata update duration,DTC, clearing fault codes and other usages. An example project or an elaborated documentation will be appreciated. Thank you @MacFJA

[MacFJA]

Thanks for testing my library!

You right, my documentation is very minimal 😕
I will try to write a real documentation (not just a README) that explain a bit more how to use the library and what are the capabilities it offer.

---

I can also try to write an example that will cover some case.

What come to my mind right now is:
A simple GUI application that can display basic data (Speed, Engine RPM, Engine Coolant Temperature) and the list of DTCs (with the ability to clear them).
(The only difficulty is how the connect to an OBD without making the whole example too complex)

[mjm918]

@MacFJA thank you for your fast response. I'm trying to write an android app using your library to connect OBD device. I can share the android app on github.
I have just created the project here but nothing is done yet. I will start working on it from today:
CarOBD
You can contribute here if you are interested. At the end, i will give credit to your lib ;)

[MacFJA]

@mjm918 I just push a new branch (https://github.com/MacFJA/OBD2/tree/gui-sample-issue-1) with an example.
Is it useful?

I'm myself writing an application (for a RaspberryPI) which use this library (that why I wrote the library in the first place).
I'm far for finish, but I can publish some part of it (for example the part that wrap the library into a more easy to use service)

[mjm918]

@MacFJA that would be great. Appreciated :)

[MacFJA]

@mjm918 I add a new repository with the service: https://github.com/MacFJA/OBD2Service

I also push a branch with documentation on it: https://github.com/MacFJA/OBD2/blob/documentation-issue-1/docs/README.md

[mjm918]

@MacFJA Thank you for you cooperation. I really appreciate it : )