add canalysstii documentation

Author: Shaoyu

can/interfaces/canalystii.py

@@ -46,6 +46,15 @@ class VCI_CAN_OBJ(Structure):
 
 class CANalystIIBus(BusABC):
     def __init__(self, channel, device=0, baud=10000000, Timing0=0x00, Timing1=0x14, can_filters=None):
+        """
+
+        :param channel: channel number
+        :param device: device number
+        :param baud: baud rate
+        :param Timing0: customize the timing register if baudrate is not specified
+        :param Timing1:
+        :param can_filters: filters for packet
+        """
         super(CANalystIIBus, self).__init__(channel, can_filters)
 
         if isinstance(channel, (list, tuple)):
@@ -58,6 +67,8 @@ def __init__(self, channel, device=0, baud=10000000, Timing0=0x00, Timing1=0x14,
 
         self.device = device
 
+        self.channel_info = "CANalyst-II: device {}, channels {}".format(self.device, self.channels)
+
         if baud == 1000000:
             Timing0, Timing1 = (0x00, 0x14)
         elif baud == 800000:
@@ -149,5 +160,9 @@ def _recv_internal(self, timeout=None):
                 False,
             )
 
+    def flush_tx_buffer(self):
+        for channel in self.channels:
+            CANalystII.VCI_ClearBUffer(VCI_USBCAN2, self.device, channel)
+
     def shutdown(self):
         CANalystII.VCI_CloseDevice(VCI_USBCAN2, self.device)

doc/interfaces.rst

@@ -23,6 +23,7 @@ The available interfaces are:
    interfaces/neovi
    interfaces/vector
    interfaces/virtual
+   interfaces/canalystii
 
 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.

doc/interfaces/canalystii.rst

@@ -0,0 +1,13 @@
+CANalyst-II
+===========
+
+CANalyst-II(+) is a USB to CAN Analyzer. The controlcan library is originally developed by `ZLG ZHIYUAN Electronics`_.
+
+
+Bus
+---
+
+.. autoclass:: can.interfaces.canalystii.CANalystIIBus
+
+
+.. _ZLG ZHIYUAN Electronics: http://www.zlg.com/can/can/product/id/42.html