adding seeedstudio usb-can-analyzer interface

[es-m-se]

Hi Guys,

I've added an interface for the seeedstudio canbus interface following a blog post:
Posted by Wilfried Voss on September 19, 2018 - copperhilltech.com

I'm not sure if this is something you'd want this in your repo? I thought a pull request was the easiest way to ask. Note it probably still needs a bit of work I'll update it as I go. Please let me know if you're keen.

[codecov]

Codecov Report

Merging #567 into develop will decrease coverage by 0.85%.
The diff coverage is 19.81%.

@@             Coverage Diff             @@
##           develop     #567      +/-   ##
===========================================
- Coverage    63.91%   63.06%   -0.86%     
===========================================
  Files           63       65       +2     
  Lines         5623     5734     +111     
===========================================
+ Hits          3594     3616      +22     
- Misses        2029     2118      +89

[christiansandberg]

Documentation should also be updated. Maybe you can move the notes there instead.

[christiansandberg]

I don't see the format of the sent frame in the notes. It is a little strange that the transmitted frames use timestamps but the received do not.

[es-m-se]

It could take a week or two for me to resolve this.

I suspect you've picked up that I've started from serial_can.py, and that I not got to implementing the required send packet. My current application is only required to read.

[es-m-se]

Maybe not so long:
https://github.com/SeeedDocument/USB-CAN_Analyzer/blob/master/res/USB-CAN%20software%20and%20drive(v7.10)/Document/USB%20(Serial%20port)%20to%20CAN%20protocol%20defines.pdf

[joaofl]

I've been looking forward to this integration. Would also be nice if an example on how to use this specific converter was added to the "examples" folder for getting started easily.

[marcel-kanter]

Can you please clearify the name a bit more to avoid confusion with others?
usb_can_analyzer is a bit generic and there are many things that match that name.
Ixxat has a cananalyzer
vectors canalyzer

something like
seedstudio_usbcan
seedstudio_can

[es-m-se]

How's seeed_can for a name? (3 e's like in www.seeedstudio.io)
I'll work on the doco over the weekend coming.

[marcel-kanter]

That sounds good.
Can you please check if they provide other can interfaces, or is this one the only one?

[christiansandberg]

Or just seeedstudio. Most interfaces here use the manufacturer name since the API is usually the same for all their CAN products and the word CAN is a bit redundant in a CAN library.

[felixdivo]

Can this be merged?

[es-m-se]

working on docs now, I'll update when done, might be tomorrow.

[es-m-se]

debugging something, I'll update again tomorrow.

[es-m-se]

The last commits adds doco but made a few changes as well.

1. I changed the name of the main class from 'CanAnalyzer' to 'SeeedBus', it seemed to fit better with the interface name and align with the other interfaces.
2. the debugging I was doing determined that will it was sometimes working with the CRC library but were configurations when it didn't. I did a bit more digging and found that the CRC is actually very simple, so crccheck package is not needed. I've removed it from the interface and the setup.py file. Note: without this in the setup file it only needs serial, which is identical the existing serial option. I've left them both for now but happy to remove seeedstudio from the setup.py file altogether if preferred.

Apart from that its done.
(Do I need to resolve the conversations above to close out the 'Changes requested'?)

[felixdivo]

(No, that will only make the thread of comments more readable. The review has to be re-requested.)

[felixdivo]

@christiansandberg Do you now approve this PR?

[christiansandberg]

Right, sorry. Looks good!

[felixdivo]

@shedfly The linter (see here for the problems) and formatter (please reformat can/interfaces/seeedstudio/seeedstudio.py for example with this) are not yet happy, but if they are we can immediately merge this. It should be relatively easy to fix this.