Skip to content

Commit 676dd7c

Browse files
committed
Add supplementary info on gs_usb
1 parent e90535a commit 676dd7c

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

doc/interfaces/gs_usb.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. _gs_usb:
22

3-
CAN driver based on WCID for Geschwister Schneider USB/CAN devices and bytewerk.org candleLight USB CAN interfaces
3+
CAN driver for Geschwister Schneider USB/CAN devices and bytewerk.org candleLight USB CAN interfaces
44
==================================================================================================================
55

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

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

@@ -29,7 +29,21 @@ Supported platform
2929

3030
Windows, Linux and Mac.
3131

32-
Note: Since ``pyusb`` is used, ``libusb-win32`` usb driver is required to be installed in Windows
32+
Note: Since ``pyusb`` with ```libusb0``` as backend is used, ``libusb-win32`` usb driver is required to be installed in Windows.
33+
34+
35+
Supplementary Info on ``gs_usb``
36+
-----------------------------------
37+
38+
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>`_.
39+
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>`_.
40+
41+
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>`_.
42+
The ``gs_usb`` package is using ``pyusb`` as backend, which brings better crossplatform compatibility.
43+
44+
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.
45+
46+
Note: Message filtering is not supported in Geschwister Schneider USB/CAN devices and bytewerk.org candleLight USB CAN interfaces.
3347

3448
Bus
3549
---

0 commit comments

Comments
 (0)