serial.tools.list_ports_windows Namespace Reference

Data Structures
class	GUID
class	SP_DEVINFO_DATA
class	SP_DEVICE_INTERFACE_DATA

Functions
def	ValidHandle
def	byte_buffer
def	string
def	comports

Variables
int	NULL = 0
	HDEVINFO = ctypes.c_void_p
	PCTSTR = ctypes.c_char_p
	CHAR = ctypes.c_char
tuple	LPDWORD = ctypes.POINTER(DWORD)
	LPBYTE = ctypes.c_void_p
tuple	PHKEY = ctypes.POINTER(HKEY)
	ACCESS_MASK = DWORD
	REGSAM = ACCESS_MASK
tuple	PSP_DEVINFO_DATA = ctypes.POINTER(SP_DEVINFO_DATA)
tuple	PSP_DEVICE_INTERFACE_DATA = ctypes.POINTER(SP_DEVICE_INTERFACE_DATA)
	PSP_DEVICE_INTERFACE_DETAIL_DATA = ctypes.c_void_p
tuple	setupapi = ctypes.windll.LoadLibrary("setupapi")
	SetupDiDestroyDeviceInfoList = setupapi.SetupDiDestroyDeviceInfoList
	SetupDiGetClassDevs = setupapi.SetupDiGetClassDevsA
	SetupDiEnumDeviceInterfaces = setupapi.SetupDiEnumDeviceInterfaces
	SetupDiGetDeviceInterfaceDetail = setupapi.SetupDiGetDeviceInterfaceDetailA
	SetupDiGetDeviceRegistryProperty = setupapi.SetupDiGetDeviceRegistryPropertyA
	SetupDiOpenDevRegKey = setupapi.SetupDiOpenDevRegKey
tuple	advapi32 = ctypes.windll.LoadLibrary("Advapi32")
	RegCloseKey = advapi32.RegCloseKey
	RegQueryValueEx = advapi32.RegQueryValueExA
tuple	GUID_CLASS_COMPORT
int	DIGCF_PRESENT = 2
int	DIGCF_DEVICEINTERFACE = 16
int	INVALID_HANDLE_VALUE = 0
int	ERROR_INSUFFICIENT_BUFFER = 122
int	SPDRP_HARDWAREID = 1
int	SPDRP_FRIENDLYNAME = 12
int	ERROR_NO_MORE_ITEMS = 259
int	DICS_FLAG_GLOBAL = 1
int	DIREG_DEV = 0x00000001
int	KEY_READ = 0x20019
int	REG_SZ = 1
tuple	PortName = serial.to_bytes([80, 111, 114, 116, 78, 97, 109, 101])

Function Documentation

def serial.tools.list_ports_windows.byte_buffer

(

length

)

Get a buffer for a string

Definition at line 35 of file list_ports_windows.py.

def serial.tools.list_ports_windows.comports

(

)

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

Definition at line 141 of file list_ports_windows.py.

def serial.tools.list_ports_windows.string

(

buffer

)

Definition at line 39 of file list_ports_windows.py.

def serial.tools.list_ports_windows.ValidHandle	(		value,
			func,
			arguments
	)

Definition at line 4 of file list_ports_windows.py.

Variable Documentation

serial.tools.list_ports_windows.ACCESS_MASK = DWORD

Definition at line 31 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.advapi32 = ctypes.windll.LoadLibrary("Advapi32")

Definition at line 113 of file list_ports_windows.py.

serial.tools.list_ports_windows.CHAR = ctypes.c_char

Definition at line 25 of file list_ports_windows.py.

int serial.tools.list_ports_windows.DICS_FLAG_GLOBAL = 1

Definition at line 133 of file list_ports_windows.py.

int serial.tools.list_ports_windows.DIGCF_DEVICEINTERFACE = 16

Definition at line 127 of file list_ports_windows.py.

int serial.tools.list_ports_windows.DIGCF_PRESENT = 2

Definition at line 126 of file list_ports_windows.py.

int serial.tools.list_ports_windows.DIREG_DEV = 0x00000001

Definition at line 134 of file list_ports_windows.py.

int serial.tools.list_ports_windows.ERROR_INSUFFICIENT_BUFFER = 122

Definition at line 129 of file list_ports_windows.py.

int serial.tools.list_ports_windows.ERROR_NO_MORE_ITEMS = 259

Definition at line 132 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.GUID_CLASS_COMPORT

Initial value:

= GUID(0x86e0d1e0L, 0x8089, 0x11d0,
    (BYTE*8)(0x9c, 0xe4, 0x08, 0x00, 0x3e, 0x30, 0x1f, 0x73))

Definition at line 123 of file list_ports_windows.py.

serial.tools.list_ports_windows.HDEVINFO = ctypes.c_void_p

Definition at line 23 of file list_ports_windows.py.

int serial.tools.list_ports_windows.INVALID_HANDLE_VALUE = 0

Definition at line 128 of file list_ports_windows.py.

int serial.tools.list_ports_windows.KEY_READ = 0x20019

Definition at line 135 of file list_ports_windows.py.

serial.tools.list_ports_windows.LPBYTE = ctypes.c_void_p

Definition at line 28 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.LPDWORD = ctypes.POINTER(DWORD)

Definition at line 26 of file list_ports_windows.py.

int serial.tools.list_ports_windows.NULL = 0

Definition at line 22 of file list_ports_windows.py.

serial.tools.list_ports_windows.PCTSTR = ctypes.c_char_p

Definition at line 24 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.PHKEY = ctypes.POINTER(HKEY)

Definition at line 29 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.PortName = serial.to_bytes([80, 111, 114, 116, 78, 97, 109, 101])

Definition at line 139 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.PSP_DEVICE_INTERFACE_DATA = ctypes.POINTER(SP_DEVICE_INTERFACE_DATA)

Definition at line 83 of file list_ports_windows.py.

serial.tools.list_ports_windows.PSP_DEVICE_INTERFACE_DETAIL_DATA = ctypes.c_void_p

Definition at line 85 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.PSP_DEVINFO_DATA = ctypes.POINTER(SP_DEVINFO_DATA)

Definition at line 72 of file list_ports_windows.py.

int serial.tools.list_ports_windows.REG_SZ = 1

Definition at line 136 of file list_ports_windows.py.

serial.tools.list_ports_windows.RegCloseKey = advapi32.RegCloseKey

Definition at line 114 of file list_ports_windows.py.

serial.tools.list_ports_windows.RegQueryValueEx = advapi32.RegQueryValueExA

Definition at line 118 of file list_ports_windows.py.

serial.tools.list_ports_windows.REGSAM = ACCESS_MASK

Definition at line 32 of file list_ports_windows.py.

tuple serial.tools.list_ports_windows.setupapi = ctypes.windll.LoadLibrary("setupapi")

Definition at line 87 of file list_ports_windows.py.

serial.tools.list_ports_windows.SetupDiDestroyDeviceInfoList = setupapi.SetupDiDestroyDeviceInfoList

Definition at line 88 of file list_ports_windows.py.

serial.tools.list_ports_windows.SetupDiEnumDeviceInterfaces = setupapi.SetupDiEnumDeviceInterfaces

Definition at line 97 of file list_ports_windows.py.

serial.tools.list_ports_windows.SetupDiGetClassDevs = setupapi.SetupDiGetClassDevsA

Definition at line 92 of file list_ports_windows.py.

serial.tools.list_ports_windows.SetupDiGetDeviceInterfaceDetail = setupapi.SetupDiGetDeviceInterfaceDetailA

Definition at line 101 of file list_ports_windows.py.

serial.tools.list_ports_windows.SetupDiGetDeviceRegistryProperty = setupapi.SetupDiGetDeviceRegistryPropertyA

Definition at line 105 of file list_ports_windows.py.

serial.tools.list_ports_windows.SetupDiOpenDevRegKey = setupapi.SetupDiOpenDevRegKey

Definition at line 109 of file list_ports_windows.py.

int serial.tools.list_ports_windows.SPDRP_FRIENDLYNAME = 12

Definition at line 131 of file list_ports_windows.py.

int serial.tools.list_ports_windows.SPDRP_HARDWAREID = 1

Definition at line 130 of file list_ports_windows.py.