Skip to content

The gs_usb interface support #905

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.

Sign up for GitHub

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

Merged
merged 16 commits into from
Nov 16, 2020
Merged

The gs_usb interface support #905

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
c31b5ba
Add gs_usb support
jxltom Sep 12, 2020
6972ab8
Enable gs_usb in interface list
jxltom Sep 12, 2020
ab9d4a3
Add install requires for gs_usb interface
jxltom Sep 12, 2020
9f7b60a
Add documentation for gs_usb interface
jxltom Sep 12, 2020
470c50e
Reformat code by black
jxltom Sep 12, 2020
80f8a9f
Remove additional comment since float is actually accepted as timeout
jxltom Oct 22, 2020
c4ccdd0
Pass can message fields as named arguments
jxltom Oct 22, 2020
74e3272
Update docs for complete setup for a first time user
jxltom Oct 22, 2020
ad49fca
Update can/interfaces/gs_usb.py
jxltom Oct 22, 2020
52b53b2
Catch usb error and re-raise as CanError
jxltom Oct 22, 2020
5565e2b
Add logging for future use
jxltom Oct 22, 2020
e90535a
Update docs for expected behavior for send method
jxltom Oct 22, 2020
676dd7c
Add supplementary info on gs_usb
jxltom Oct 22, 2020
ec5740a
Reformat code by black
jxltom Oct 22, 2020
751dfa4
Fix bug where msg is referenced befor assignment
jxltom Oct 22, 2020
17f05d7
Merge branch 'develop' into feature/gs-usb-support
hardbyte Nov 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add supplementary info on gs_usb
  • Loading branch information
@jxltom
jxltom committed Oct 22, 2020
commit 676dd7c9613a7272d1d138c3791bc2f5933a5ac6
20 changes: 17 additions & 3 deletions doc/interfaces/gs_usb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _gs_usb:

CAN driver based on WCID for Geschwister Schneider USB/CAN devices and bytewerk.org candleLight USB CAN interfaces
CAN driver for Geschwister Schneider USB/CAN devices and bytewerk.org candleLight USB CAN interfaces
==================================================================================================================

Windows/Linux/Mac CAN driver based on WCID for Geschwister Schneider USB/CAN devices and candleLight USB CAN interfaces.
Windows/Linux/Mac CAN driver based on usbfs or WinUSB WCID for Geschwister Schneider USB/CAN devices and candleLight USB CAN interfaces.

Install: ``pip install "python-can[gs_usb]"``

Expand All @@ -29,7 +29,21 @@ Supported platform

Windows, Linux and Mac.

Note: Since ``pyusb`` is used, ``libusb-win32`` usb driver is required to be installed in Windows
Note: Since ``pyusb`` with ```libusb0``` as backend is used, ``libusb-win32`` usb driver is required to be installed in Windows.


Supplementary Info on ``gs_usb``
-----------------------------------

The firmware implementation for Geschwister Schneider USB/CAN devices and candleLight USB CAN can be found in `candle-usb/candleLight_fw <https://github.com/candle-usb/candleLight_fw>`_.
The Linux kernel driver can be found in `linux/drivers/net/can/usb/gs_usb.c <https://github.com/torvalds/linux/blob/master/drivers/net/can/usb/gs_usb.c>`_.

The ``gs_usb`` interface in ``PythonCan`` relys on upstream ``gs_usb`` package, which can be found in `https://pypi.org/project/gs-usb/ <https://pypi.org/project/gs-usb/>`_ or `https://github.com/jxltom/gs_usb <https://github.com/jxltom/gs_usb>`_.
The ``gs_usb`` package is using ``pyusb`` as backend, which brings better crossplatform compatibility.

Note: The bitrate ``10K``, ``20K``, ``50K``, ``83.333K``, ``100K``, ``125K``, ``250K``, ``500K``, ``800K`` and ``1M`` are supported in this interface, as implemented in the upstream ``gs_usb`` package's ``set_bitrate`` method.

Note: Message filtering is not supported in Geschwister Schneider USB/CAN devices and bytewerk.org candleLight USB CAN interfaces.

Bus
---
Expand Down