Neousys WDT_DIO CAN interface pylint fixes

Author: illuusio

can/interfaces/neousys_wdt.py

@@ -1,3 +1,5 @@
+""" Neousys WDT_DIO CAN driver """
+
 #
 # This kind of interface can be found for example on Neousys POC-551VTC
 # One needs to have correct drivers and DLL (Share object for Linux) from Neousys
@@ -8,18 +10,32 @@
 # with Windows but you have to replace with correct named DLL
 #
 
+# pylint: disable=R0903
+# pylint: disable=R0902
+# pylint: disable=C0413
+# pylint: disable=E0202
+# pylint: disable=W0611
+# pylint: disable=R1725
+
 import warnings
-from ctypes import *
 import threading
 import logging
 import platform
 import time
+
+from ctypes import byref, CFUNCTYPE, c_ubyte, c_uint, c_ushort, POINTER, sizeof, Structure
+
+if platform.system() == "Windows":
+    from ctypes import WinDLL
+else:
+    from ctypes import CDLL
 from can import BusABC, Message
 
-logger = logging.getLogger(__name__)
 
+logger = logging.getLogger(__name__)
 
-class WDT_CAN_SETUP(Structure):
+class NeousysWdtCanSetup(Structure):
+    """ C CAN Setup struct """
     _fields_ = [
         ("bitRate", c_uint),
         ("recvConfig", c_uint),
@@ -28,7 +44,8 @@ class WDT_CAN_SETUP(Structure):
     ]
 
 
-class WDT_CAN_MSG(Structure):
+class NeousysWdtCanMsg(Structure):
+    """ C CAN Message struct """
     _fields_ = [
         ("id", c_uint),
         ("flags", c_ushort),
@@ -38,11 +55,13 @@ class WDT_CAN_MSG(Structure):
     ]
 
 
-# valid:2~16, sum of the Synchronization, Propagation, and Phase Buffer 1 segments, measured in time quanta.
+# valid:2~16, sum of the Synchronization, Propagation, and
+#             Phase Buffer 1 segments, measured in time quanta.
 # valid:1~8, the Phase Buffer 2 segment in time quanta.
 # valid:1~4, Resynchronization Jump Width in time quanta
 # valid:1~1023, CAN_CLK divider used to determine time quanta
-class WDT_CAN_BITCLK(Structure):
+class NeousysWdtCanBitClk(Structure):
+    """ C CAN BIT Clock struct """
     _fields_ = [
         ("syncPropPhase1Seg", c_ushort),
         ("phase2Seg", c_ushort),
@@ -51,7 +70,7 @@ class WDT_CAN_BITCLK(Structure):
     ]
 
 
-WDT_CAN_MSG_CALLBACK = CFUNCTYPE(None, POINTER(WDT_CAN_MSG), c_uint)
+WDT_CAN_MSG_CALLBACK = CFUNCTYPE(None, POINTER(NeousysWdtCanMsg), c_uint)
 WDT_CAN_STATUS_CALLBACK = CFUNCTYPE(None, c_uint)
 
 WDT_CAN_MSG_EXTENDED_ID = 0x0004
@@ -90,6 +109,8 @@ class WDT_CAN_BITCLK(Structure):
 
 
 class NeousysWdtBus(BusABC):
+    """ Neousys WDT_DIO Canbus Class"""
+
     def __init__(self, channel, device=0, bitrate=500000, **kwargs):
         """
         :param channel: channel number
@@ -120,21 +141,22 @@ def __init__(self, channel, device=0, bitrate=500000, **kwargs):
             self.recv_msg_array = []
 
             # Init with accept all and wanted bitrate
-            self.init_config = WDT_CAN_SETUP(bitrate, WDT_CAN_MSG_USE_ID_FILTER, 0, 0)
+            self.init_config = NeousysWdtCanSetup(bitrate, WDT_CAN_MSG_USE_ID_FILTER, 0, 0)
 
             # These can be needed in some old 2.x consepts not needed in 3.6 though
             # self.canlib.CAN_RegisterReceived.argtypes = [c_uint, WDT_CAN_MSG_CALLBACK]
             # self.canlib.CAN_RegisterReceived.restype = c_int
             # self.canlib.CAN_RegisterStatus.argtypes = [c_uint, WDT_CAN_STATUS_CALLBACK]
             # self.canlib.CAN_RegisterStatus.restype = c_int
 
-            self._WDTCAN_Received = WDT_CAN_MSG_CALLBACK(self._WDTCAN_Received)
-            self._WDTCAN_Status = WDT_CAN_STATUS_CALLBACK(self._WDTCAN_Status)
 
-            if self.canlib.CAN_RegisterReceived(0, self._WDTCAN_Received) == 0:
+            self._neousys_wdt_recv_cb = WDT_CAN_MSG_CALLBACK(self._neousys_wdt_recv_cb)
+            self._neousys_wdt_status_cb = WDT_CAN_STATUS_CALLBACK(self._neousys_wdt_status_cb)
+
+            if self.canlib.CAN_RegisterReceived(0, self._neousys_wdt_recv_cb) == 0:
                 logger.error("Neousys WDT_DIO CANBus Setup receive callback")
 
-            if self.canlib.CAN_RegisterStatus(0, self._WDTCAN_Status) == 0:
+            if self.canlib.CAN_RegisterStatus(0, self._neousys_wdt_status_cb) == 0:
                 logger.error("Neousys WDT_DIO CANBus Setup status callback")
 
             if (
@@ -148,8 +170,8 @@ def __init__(self, channel, device=0, bitrate=500000, **kwargs):
             if self.canlib.CAN_Start(channel) == 0:
                 logger.error("Neousys WDT_DIO CANBus Start Error")
 
-        except OSError as e:
-            logger.info("Cannot Neousys WDT_DIO CANBus dll or share object")
+        except OSError as error:
+            logger.info("Cannot Neousys WDT_DIO CANBus dll or share object: %d", format(error))
 
     def send(self, msg, timeout=None):
         """
@@ -161,7 +183,7 @@ def send(self, msg, timeout=None):
         if self.canlib is None:
             logger.error("Can't send msg as Neousys WDT_DIO DLL/SO is not loaded")
         else:
-            tx_msg = WDT_CAN_MSG(
+            tx_msg = NeousysWdtCanMsg(
                 msg.arbitration_id, 0, 0, msg.dlc, (c_ubyte * 8)(*msg.data)
             )
 
@@ -180,34 +202,34 @@ def _recv_internal(self, timeout):
 
         return msg, False
 
-    def _WDTCAN_Received(self, lpMsg, cbMsg):
+    def _neousys_wdt_recv_cb(self, msg, sizeof_msg):
         """
-        :param lpMsg struct CAN_MSG
-        :param cbMsg message number
+        :param msg struct CAN_MSG
+        :param sizeof_msg message number
         :return:
         """
         remote_frame = False
         extended_frame = False
 
-        msg_bytes = bytearray(lpMsg.contents.data)
+        msg_bytes = bytearray(msg.contents.data)
 
-        if lpMsg.contents.flags & WDT_CAN_MSG_REMOTE_FRAME:
+        if msg.contents.flags & WDT_CAN_MSG_REMOTE_FRAME:
             remote_frame = True
 
-        if lpMsg.contents.flags & WDT_CAN_MSG_EXTENDED_ID:
+        if msg.contents.flags & WDT_CAN_MSG_EXTENDED_ID:
             extended_frame = True
 
-        if lpMsg.contents.flags & WDT_CAN_MSG_DATA_LOST:
-            logger.error("_WDTCAN_Received flag CAN_MSG_DATA_LOST")
+        if msg.contents.flags & WDT_CAN_MSG_DATA_LOST:
+            logger.error("_neousys_wdt_recv_cb flag CAN_MSG_DATA_LOST")
 
         msg = Message(
             timestamp=time.time(),
-            arbitration_id=lpMsg.contents.id,
+            arbitration_id=msg.contents.id,
             is_remote_frame=remote_frame,
             is_extended_id=extended_frame,
             channel=self.channel,
-            dlc=lpMsg.contents.len,
-            data=msg_bytes[: lpMsg.contents.len],
+            dlc=msg.contents.len,
+            data=msg_bytes[: msg.contents.len],
         )
 
         # Reading happens in Callback function and
@@ -217,18 +239,13 @@ def _WDTCAN_Received(self, lpMsg, cbMsg):
         self.recv_msg_array.append(msg)
         self.lock.release()
 
-    def _WDTCAN_Status(status):
+    def _neousys_wdt_status_cb(self, status):
         """
         :param status BUS Status
         :return:
         """
-
-        logger.info("_WDTCAN_Status" + str(status))
+        logger.info("%s _neousys_wdt_status_cb: %d", self.init_config, status)
 
     def shutdown(self):
         if self.canlib is not None:
-            logger.error(
-                "No need Can't send msg as Neousys WDT_DIO DLL/SO is not loaded"
-            )
-        else:
             self.canlib.CAN_Stop(self.channel)