Add documentation for gs_usb interface

jxltom · jxltom · commit 9f7b60a72fb8 · 2020-10-22T14:34:20.000+08:00
diff --git a/doc/interfaces.rst b/doc/interfaces.rst
@@ -27,6 +27,7 @@ The available interfaces are:
    interfaces/canalystii
    interfaces/systec
    interfaces/seeedstudio
+   interfaces/gs_usb
 
 Additional interfaces can be added via a plugin interface. An external package
 can register a new interface by using the ``can.interface`` entry point in its setup.py.
diff --git a/doc/interfaces/gs_usb.rst b/doc/interfaces/gs_usb.rst
@@ -0,0 +1,29 @@
+.. _gs_usb:
+
+CAN driver based on WCID 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.
+
+Install: ``pip install "python-can[gs_usb]"``
+Usage: pass ``bus`` and ``address`` to open the device. The parameters can be got by ``pyusb``
+
+
+Supported devices
+-----------------
+
+Geschwister Schneider USB/CAN devices and bytewerk.org candleLight USB CAN interfaces such as candleLight, canable, cantact, etc.
+
+
+Supported platform
+------------------
+
+Windows, Linux and Mac.
+
+Note: Since ``pyusb``` is used, ``libusb-win32`` usb driver is required to install in Windows
+
+Bus
+---
+
+.. autoclass:: can.interfaces.gs_usb.GsUsbBus
+    :members:
