Documentation

[collin80]

Documentation should be added to the project. Currently there are a few pages but they aren't linked to the program yet. Fill out more documentation and also link to it from the relevant areas in the program itself.

[collin80]

Like lots of open source programs, the documentation here is sorely lacking. What exists is hopelessly outdated. What kind of dummy didn't document this program as they were writing... it.... oh.... yeah....

[macropin]

Definitely needs some docs. As an outsider trying to get started I'm scratching my head. This project looks awesome but I cannot figure out which devices are supported. So far looks like I need to spend USD$149 on EVTV CAN KIT... are elm327/LAWICEL (or similar) not supported?

[collin80]

The original adapter was the EVTV CAN Kit. You can also use the Macchina M2. They both present themselves the same way to SavvyCAN if you use the GVRET firmware on the EVTV kit or the M2RET firmware on the M2. This actually allows a whole range of Arduino Due boards with CAN shields to work. But, you can also use any socketcan compatible device so lawicel works too but only on linux with the slcand daemon. I suppose that supporting lawicel directly on the other operating systems wouldn't be out of the question but such support currently doesn't exist.

[prensel]

What is the format or extension of the log files to import ?? Furthermore the install is a very difficult process and doesnt work as presented. I did manage to get it working / compiling on Debian 9 with Qt 5.9.2.

[collin80]

In the examples folder (here on GITHub in the repo) you'll find several example log files that you can copy the format of.

Your best bet is here: https://github.com/collin80/SavvyCAN/blob/master/examples/GVRET_Log.csv

Sorry it wasn't an easy compile for you. I routinely compile it on Linux Mint 18.2 and I've never thought it was too especially tough to do. It used to require an external library that you had to compile yourself and that was a challenge. These days it ought to compile with just QT 5.9.2 and your system GCC version. But, QT does require openGL so perhaps there were a couple of kinks in getting that all set up. The good news is that once you get it setup once it ought to keep working like that from then on.

[prensel]

I have just added an installer document for Debian 9 in the wiki part The default extension for importing PeakCAN viewer files is .trc. So when saving a trace from PCanView be sure to add the .trc to the file name.

[prensel]

Can you add the DBC examples you have in your Youtube demonstration ? I'm interested in the Think City DBC

[collin80]

Ok, I just added the Think City DBC file. The company went bankrupt years ago. I think they probably won't sue me over releasing the file. ;)

[prensel]

Great, is there a DBC for Leaf as well ?

[collin80]

A slave driver, I tell ya! ;) Well, I had the start of a DBC file for the Leaf. I suppose it's better than nothing but I didn't get very far. I put it into the examples folder. Some day I'll try to transfer more information into that file.

[andre-hartmann]

@prensel: Thanks for the Wiki instructions.

I have one more comment on the Linux part: It is not necessary to install the Qt sources (in the Qt Online Installer) to build programs. This is only needed if you want to compile and/or modify Qt itself.

[collin80]

Pretty much complete documentation was added about a month ago but I forgot to close this issue. The WIP branch has documentation in the docs folder and the version of code found there also brings up the relevant help document if you press F1 while a given screen has focus. I'll try to keep it up-to-date.