add code to list available ports

git-svn-id: http://svn.code.sf.net/p/pyserial/code/trunk/pyserial@397 f19166aa-fa4f-0410-85c2-fa1106f25c8a

2 files changed, 199 insertions, 0 deletions

diff --git a/serial/tools/list_ports_posix.py b/serial/tools/list_ports_posix.py
new file mode 100644
index 0000000..57f31cd
--- /dev/null
+++ b/serial/tools/list_ports_posix.py
@@ -0,0 +1,12 @@
+import glob

+

+def comports():

+    devices = glob.glob('/dev/ttyS*') + glob.glob('/dev/ttyUSB*')

+    return [(d, d, d) for d in devices]

+

+

+if __name__ == '__main__':

+    import serial

+

+    for port, desc, hwid in sorted(comports()):

+        print "%s: %s [%s]" % (port, desc, hwid)

diff --git a/serial/tools/list_ports_windows.py b/serial/tools/list_ports_windows.py
new file mode 100644
index 0000000..60fed5f
--- /dev/null
+++ b/serial/tools/list_ports_windows.py
@@ -0,0 +1,187 @@
+import ctypes

+import re

+

+def ValidHandle(value):

+    if value == 0:

+        raise ctypes.WinError()

+    return value

+

+NULL = 0

+HANDLE = ctypes.c_int

+HDEVINFO = ctypes.c_int

+BOOL = ctypes.c_int

+CHAR = ctypes.c_char

+PCTSTR = ctypes.c_char_p

+HWND = ctypes.c_uint

+DWORD = ctypes.c_ulong

+PDWORD = ctypes.POINTER(DWORD)

+LPDWORD = ctypes.POINTER(DWORD)

+LONG = ctypes.c_long

+ULONG = ctypes.c_ulong

+ULONG_PTR = ctypes.POINTER(ULONG)

+#~ PBYTE = ctypes.c_char_p

+PBYTE = ctypes.c_void_p

+LPBYTE = ctypes.c_void_p

+ACCESS_MASK = DWORD

+REGSAM = ACCESS_MASK

+HKEY = HANDLE

+PHKEY = ctypes.POINTER(HKEY)

+LPCSTR = ctypes.c_char_p

+

+class GUID(ctypes.Structure):

+    _fields_ = [

+        ('Data1', ctypes.c_ulong),

+        ('Data2', ctypes.c_ushort),

+        ('Data3', ctypes.c_ushort),

+        ('Data4', ctypes.c_ubyte*8),

+    ]

+    def __str__(self):

+        return "{%08x-%04x-%04x-%s-%s}" % (

+            self.Data1,

+            self.Data2,

+            self.Data3,

+            ''.join(["%02x" % d for d in self.Data4[:2]]),

+            ''.join(["%02x" % d for d in self.Data4[2:]]),

+        )

+

+class SP_DEVINFO_DATA(ctypes.Structure):

+    _fields_ = [

+        ('cbSize', DWORD),

+        ('ClassGuid', GUID),

+        ('DevInst', DWORD),

+        ('Reserved', ULONG_PTR),

+    ]

+    def __str__(self):

+        return "ClassGuid:%s DevInst:%s" % (self.ClassGuid, self.DevInst)

+PSP_DEVINFO_DATA = ctypes.POINTER(SP_DEVINFO_DATA)

+

+class SP_DEVICE_INTERFACE_DATA(ctypes.Structure):

+    _fields_ = [

+        ('cbSize', DWORD),

+        ('InterfaceClassGuid', GUID),

+        ('Flags', DWORD),

+        ('Reserved', ULONG_PTR),

+    ]

+    def __str__(self):

+        return "InterfaceClassGuid:%s Flags:%s" % (self.InterfaceClassGuid, self.Flags)

+PSP_DEVICE_INTERFACE_DATA = ctypes.POINTER(SP_DEVICE_INTERFACE_DATA)

+

+PSP_DEVICE_INTERFACE_DETAIL_DATA = ctypes.c_void_p

+

+setupapi = ctypes.windll.LoadLibrary("setupapi")

+SetupDiDestroyDeviceInfoList = setupapi.SetupDiDestroyDeviceInfoList

+SetupDiDestroyDeviceInfoList.argtypes = [HDEVINFO]

+SetupDiDestroyDeviceInfoList.restype = BOOL

+

+SetupDiGetClassDevs = setupapi.SetupDiGetClassDevsA

+SetupDiGetClassDevs.argtypes = [ctypes.POINTER(GUID), PCTSTR, HWND, DWORD]

+SetupDiGetClassDevs.restype = ValidHandle #HDEVINFO

+

+SetupDiEnumDeviceInterfaces = setupapi.SetupDiEnumDeviceInterfaces

+SetupDiEnumDeviceInterfaces.argtypes = [HDEVINFO, PSP_DEVINFO_DATA, ctypes.POINTER(GUID), DWORD, PSP_DEVICE_INTERFACE_DATA]

+SetupDiEnumDeviceInterfaces.restype = BOOL

+

+SetupDiGetDeviceInterfaceDetail = setupapi.SetupDiGetDeviceInterfaceDetailA

+SetupDiGetDeviceInterfaceDetail.argtypes = [HDEVINFO, PSP_DEVICE_INTERFACE_DATA, PSP_DEVICE_INTERFACE_DETAIL_DATA, DWORD, PDWORD, PSP_DEVINFO_DATA]

+SetupDiGetDeviceInterfaceDetail.restype = BOOL

+

+SetupDiGetDeviceRegistryProperty = setupapi.SetupDiGetDeviceRegistryPropertyA

+SetupDiGetDeviceRegistryProperty.argtypes = [HDEVINFO, PSP_DEVINFO_DATA, DWORD, PDWORD, PBYTE, DWORD, PDWORD]

+SetupDiGetDeviceRegistryProperty.restype = BOOL

+

+SetupDiOpenDevRegKey = setupapi.SetupDiOpenDevRegKey

+SetupDiOpenDevRegKey.argtypes = [HDEVINFO, PSP_DEVINFO_DATA, DWORD, DWORD, DWORD, REGSAM]

+SetupDiOpenDevRegKey.restype = HKEY

+

+advapi32 = ctypes.windll.LoadLibrary("Advapi32")

+RegCloseKey = advapi32.RegCloseKey

+RegCloseKey.argtypes = [HKEY]

+RegCloseKey.restype = LONG

+

+RegQueryValueEx = advapi32.RegQueryValueExA

+RegQueryValueEx.argtypes = [HKEY, LPCSTR, LPDWORD, LPDWORD, LPBYTE, LPDWORD]

+RegQueryValueEx.restype = LONG

+

+

+GUID_CLASS_COMPORT = GUID(0x86e0d1e0L, 0x8089, 0x11d0,

+    (ctypes.c_ubyte*8)(0x9c, 0xe4, 0x08, 0x00, 0x3e, 0x30, 0x1f, 0x73))

+

+DIGCF_PRESENT = 2

+DIGCF_DEVICEINTERFACE = 16

+INVALID_HANDLE_VALUE = 0

+ERROR_INSUFFICIENT_BUFFER = 122

+SPDRP_HARDWAREID = 1

+SPDRP_FRIENDLYNAME = 12

+ERROR_NO_MORE_ITEMS = 259

+DICS_FLAG_GLOBAL = 1

+DIREG_DEV = 0x00000001

+KEY_READ = 0x20019

+REG_SZ = 1

+

+def comports():

+    """This generator scans the device registry for com ports and yields port, desc, hwid"""

+    g_hdi = SetupDiGetClassDevs(ctypes.byref(GUID_CLASS_COMPORT), None, NULL, DIGCF_PRESENT|DIGCF_DEVICEINTERFACE);

+    #~ for i in range(256):

+    for dwIndex in range(256):

+        did = SP_DEVICE_INTERFACE_DATA()

+        did.cbSize = ctypes.sizeof(did)

+

+        if not SetupDiEnumDeviceInterfaces(g_hdi, None, ctypes.byref(GUID_CLASS_COMPORT), dwIndex, ctypes.byref(did)):

+            if ctypes.GetLastError() != ERROR_NO_MORE_ITEMS:

+                raise ctypes.WinError()

+            break

+

+        dwNeeded = DWORD()

+        # get the size

+        if not SetupDiGetDeviceInterfaceDetail(g_hdi, ctypes.byref(did), None, 0, ctypes.byref(dwNeeded), None):

+            # Ignore ERROR_INSUFFICIENT_BUFFER

+            if ctypes.GetLastError() != ERROR_INSUFFICIENT_BUFFER:

+                raise ctypes.WinError()

+        # allocate buffer

+        class SP_DEVICE_INTERFACE_DETAIL_DATA_A(ctypes.Structure):

+            _fields_ = [

+                ('cbSize', DWORD),

+                ('DevicePath', CHAR*(dwNeeded.value - ctypes.sizeof(DWORD))),

+            ]

+            def __str__(self):

+                return "DevicePath:%s" % (self.DevicePath,)

+        idd = SP_DEVICE_INTERFACE_DETAIL_DATA_A()

+        idd.cbSize = 5

+        devinfo = SP_DEVINFO_DATA()

+        devinfo.cbSize = ctypes.sizeof(devinfo)

+        if not SetupDiGetDeviceInterfaceDetail(g_hdi, ctypes.byref(did), ctypes.byref(idd), dwNeeded, None, ctypes.byref(devinfo)):

+            raise ctypes.WinError()

+

+        # hardware ID

+        szHardwareID = ctypes.create_string_buffer('\0' * 250)

+        if not SetupDiGetDeviceRegistryProperty(g_hdi, ctypes.byref(devinfo), SPDRP_HARDWAREID, None, ctypes.byref(szHardwareID), ctypes.sizeof(szHardwareID) - 1, None):

+            # Ignore ERROR_INSUFFICIENT_BUFFER

+            if GetLastError() != ERROR_INSUFFICIENT_BUFFER:

+                raise ctypes.WinError()

+

+        # friendly name

+        szFriendlyName = ctypes.create_string_buffer('\0' * 250)

+        if not SetupDiGetDeviceRegistryProperty(g_hdi, ctypes.byref(devinfo), SPDRP_FRIENDLYNAME, None, ctypes.byref(szFriendlyName), ctypes.sizeof(szFriendlyName) - 1, None):

+            # Ignore ERROR_INSUFFICIENT_BUFFER

+            if ctypes.GetLastError() != ERROR_INSUFFICIENT_BUFFER:

+                #~ raise IOError("failed to get details for %s (%s)" % (devinfo, szHardwareID.value))

+                port_name = None

+        else:

+            # the real com port name has to read differently...

+            hkey = SetupDiOpenDevRegKey(g_hdi, ctypes.byref(devinfo), DICS_FLAG_GLOBAL, 0, DIREG_DEV, KEY_READ)

+            port_name_buffer = ctypes.create_string_buffer('\0' * 250)

+            port_name_length = ULONG(ctypes.sizeof(port_name_buffer))

+            RegQueryValueEx(hkey, "PortName", None, None, ctypes.byref(port_name_buffer), ctypes.byref(port_name_length))

+            RegCloseKey(hkey)

+            port_name = str(port_name_buffer.value)

+            yield port_name, szFriendlyName.value, szHardwareID.value

+

+    SetupDiDestroyDeviceInfoList(g_hdi)

+

+

+

+if __name__ == '__main__':

+    import serial

+

+    for port, desc, hwid in sorted(comports()):

+        print "%s: %s [%s]" % (port, desc, hwid)