Update PCAN basic Python file to February 7, 2020

altendky · altendky · commit d17939b2a537 · 2020-10-30T15:24:11.000-04:00
diff --git a/can/interfaces/pcan/basic.py b/can/interfaces/pcan/basic.py
@@ -2,11 +2,11 @@
 PCAN-Basic API
 
 Author: Keneth Wagner
-Last change: 13.11.2017 Wagner
+Last change: 02.07.2020 Wagner
 
 Language: Python 2.7, 3.5
 
-Copyright (C) 1999-2017 PEAK-System Technik GmbH, Darmstadt, Germany
+Copyright (C) 1999-2020  PEAK-System Technik GmbH, Darmstadt, Germany
 http://www.peak-system.com
 """
 
@@ -157,6 +157,9 @@
 PCAN_ERROR_ILLPARAMVAL = TPCANStatus(0x08000)  # Invalid parameter value
 PCAN_ERROR_UNKNOWN = TPCANStatus(0x10000)  # Unknown error
 PCAN_ERROR_ILLDATA = TPCANStatus(0x20000)  # Invalid data, function, or action
+PCAN_ERROR_ILLMODE = TPCANStatus(
+    0x80000
+)  # Driver object state is wrong for the attempted operation
 PCAN_ERROR_CAUTION = TPCANStatus(
     0x2000000
 )  # An operation was successfully carried out, however, irregularities were registered
@@ -183,7 +186,7 @@
 PCAN_LAN = TPCANDevice(0x08)  # PCAN Gateway devices
 
 # PCAN parameters
-PCAN_DEVICE_NUMBER = TPCANParameter(0x01)  # PCAN-USB device number parameter
+PCAN_DEVICE_ID = TPCANParameter(0x01)  # PCAN-USB device identifier parameter
 PCAN_5VOLTS_POWER = TPCANParameter(0x02)  # PCAN-PC Card 5-Volt power parameter
 PCAN_RECEIVE_EVENT = TPCANParameter(0x03)  # PCAN receive event handler parameter
 PCAN_MESSAGE_FILTER = TPCANParameter(0x04)  # PCAN message filter parameter
@@ -263,6 +266,18 @@
 )  # Value assigned to a 32 digital I/O pins of a PCAN-USB Chip - Multiple digital I/O pins to 1 = High
 PCAN_IO_DIGITAL_CLEAR = TPCANParameter(0x27)  # Clear multiple digital I/O pins to 0
 PCAN_IO_ANALOG_VALUE = TPCANParameter(0x28)  # Get value of a single analog input pin
+PCAN_FIRMWARE_VERSION = TPCANParameter(
+    0x29
+)  # Get the version of the firmware used by the device associated with a PCAN-Channel
+PCAN_ATTACHED_CHANNELS_COUNT = TPCANParameter(
+    0x2A
+)  # Get the amount of PCAN channels attached to a system
+PCAN_ATTACHED_CHANNELS = TPCANParameter(
+    0x2B
+)  # Get information about PCAN channels attached to a system
+
+# DEPRECATED parameters
+PCAN_DEVICE_NUMBER = PCAN_DEVICE_ID  # DEPRECATED. Use PCAN_DEVICE_ID instead
 
 # PCAN parameter values
 PCAN_PARAMETER_OFF = int(0x00)  # The PCAN parameter is not set (inactive)
@@ -324,6 +339,14 @@
 SERVICE_STATUS_STOPPED = int(0x01)  # The service is not running
 SERVICE_STATUS_RUNNING = int(0x04)  # The service is running
 
+# Other constants
+MAX_LENGTH_HARDWARE_NAME = int(
+    33
+)  # Maximum length of the name of a device: 32 characters + terminator
+MAX_LENGTH_VERSION_STRING = int(
+    18
+)  # Maximum length of a version string: 17 characters + terminator
+
 # PCAN message types
 PCAN_MESSAGE_STANDARD = TPCANMessageType(
     0x00
@@ -524,6 +547,22 @@ class TPCANMsgFDMac(Structure):
     ]  # Data of the message (DATA[0]..DATA[63])
 
 
+class TPCANChannelInformation(Structure):
+    """
+    Describes an available PCAN channel
+    """
+
+    _fields_ = [
+        ("channel_handle", TPCANHandle),  # PCAN channel handle
+        ("device_type", TPCANDevice),  # Kind of PCAN device
+        ("controller_number", c_ubyte),  # CAN-Controller number
+        ("device_features", c_uint),  # Device capabilities flag (see FEATURE_*)
+        ("device_name", c_char * MAX_LENGTH_HARDWARE_NAME),  # Device name
+        ("device_id", c_uint),  # Device number
+        ("channel_condition", c_uint),
+    ]  # Availability status of a PCAN-Channel
+
+
 # ///////////////////////////////////////////////////////////
 # PCAN-Basic API function declarations
 # ///////////////////////////////////////////////////////////
@@ -834,15 +873,24 @@ def GetValue(self, Channel, Parameter):
                 PCAN_TRACE_LOCATION,
                 PCAN_BITRATE_INFO_FD,
                 PCAN_IP_ADDRESS,
+                PCAN_FIRMWARE_VERSION,
             ):
                 mybuffer = create_string_buffer(256)
+            elif Parameter == PCAN_ATTACHED_CHANNELS:
+                res = self.GetValue(Channel, PCAN_ATTACHED_CHANNELS_COUNT)
+                if TPCANStatus(res[0]) != PCAN_ERROR_OK:
+                    return (TPCANStatus(res[0]),)
+                mybuffer = (TPCANChannelInformation * res[1])()
             else:
                 mybuffer = c_int(0)
 
             res = self.__m_dllBasic.CAN_GetValue(
                 Channel, Parameter, byref(mybuffer), sizeof(mybuffer)
             )
-            return TPCANStatus(res), mybuffer.value
+            if Parameter == PCAN_ATTACHED_CHANNELS:
+                return TPCANStatus(res), mybuffer
+            else:
+                return TPCANStatus(res), mybuffer.value
         except:
             logger.error("Exception on PCANBasic.GetValue")
             raise
