Listing available com ports with Python

Question

I am searching for a simple method to list all available com port on a PC   I have found this method but it is Windows-specific  Listing serial  COM  ports on Windows   I am using Python 3 with pySerial on a Windows 7 PC   I have found in the pySerial API  http   pyserial sourceforge net pyserial api html  a function serial tools list ports comports   that lists com ports  exactly what I want    import serial tools list ports print list serial tools list ports comports       But it seems that it doesn t work  When my USB to COM gateway is connected to the PC  I see the COM5 in the Device Manager   this COM port isn t included in the list returned by list ports comports    Instead I only get COM4 which seems to be connected to a modem  I don t see it in the COM amp LPT section of Device Manager    Do you know why it doesn t work  Have you got another solution which is not system specific

User · Answer

A possible refinement to Thomas s excellent answer is to have Linux and possibly OSX also try to open ports and return only those which could be opened  This is because Linux  at least  lists a boatload of ports as files in  dev  which aren t connected to anything  If you re running in a terminal   dev tty is the terminal in which you re working and opening and closing it can goof up your command line  so the glob is designed to not do that   Code              Windows code unchanged          elif sys platform startswith   linux            temp list   glob glob    dev tty A-Za-z          result          for a port in temp list           try              s   serial Serial a port              s close               result append a port          except serial SerialException              pass      return result   This modification to Thomas s code has been tested on Ubuntu 14 04 only

User · Answer

try this code import serial tools list ports for i in serial tools list ports comports        print i    it returns COM1 - Port de communication  COM1  COM5 - USB-SERIAL CH340  COM5   if you just wont the name of the port for exemple COM1 import serial tools list ports for i in serial tools list ports comports        print str i  split  quot   quot   0    it returns COM1 COM5  as in my case py 3 7 64bits

User · Answer

This is the code I use   Successfully tested on Windows 8 1 x64  Windows 10 x64  Mac OS X 10 9 x   10 10 x   10 11 x and Ubuntu 14 04   14 10   15 04   15 10 with both Python 2 and Python 3   import sys import glob import serial   def serial ports            Lists serial port names           raises EnvironmentError              On unsupported or unknown platforms          returns              A list of the serial ports available on the system             if sys platform startswith  win            ports     COM s     i   1  for i in range 256       elif sys platform startswith  linux   or sys platform startswith  cygwin              this excludes your current terminal   dev tty          ports   glob glob   dev tty A-Za-z         elif sys platform startswith  darwin            ports   glob glob   dev tty         else          raise EnvironmentError  Unsupported platform        result          for port in ports          try              s   serial Serial port              s close               result append port          except  OSError  serial SerialException               pass     return result   if   name         main         print serial ports

User · Answer

Works only on Windows  import winreg import itertools  def serial ports   - gt  list      path    HARDWARE  DEVICEMAP  SERIALCOMM      key   winreg OpenKey winreg HKEY LOCAL MACHINE  path       ports          for i in itertools count            try              ports append winreg EnumValue key  i  1           except EnvironmentError              break      return ports  if   name       quot   main   quot       ports   serial ports

User · Answer

You can use   python -c  import serial tools list ports print serial tools list ports comports     Filter by know port  python -c  import serial tools list ports print  port for port in serial tools list ports comports   if port 2      n a     See more info here  https   pyserial readthedocs org en latest tools html module-serial tools list ports

User · Answer

one line solution with pySerial package   python -m serial tools list ports

User · Answer

Probably late  but might help someone in need  import serial tools list ports   class COMPorts       def   init   self  data  list           self data   data       classmethod     def get com ports cls           data              ports   list serial tools list ports comports             for port  in ports              obj   Object data dict   quot device quot   port  device   quot description quot   port  description split  quot   quot   0  strip                  data append obj           return cls data data        staticmethod     def get description by device device  str           for port  in COMPorts get com ports   data              if port  device    device                  return port  description       staticmethod     def get device by description description  str           for port  in COMPorts get com ports   data              if port  description    description                  return port  device   class Object      def   init   self  data  dict           self data   data         self device   data get  quot device quot           self description   data get  quot description quot     if   name       quot   main   quot       for port in COMPorts get com ports   data          print port device          print port description       print COMPorts get device by description description  quot Arduino Leonardo quot        print COMPorts get description by device device  quot COM3 quot

User · Answer

refinement on moylop260 s answer   import serial tools list ports comlist   serial tools list ports comports   connected      for element in comlist      connected append element device  print  Connected COM ports      str connected     This lists the ports that exist in hardware  including ones that are in use   A whole lot more information exists in the list  per the pyserial tools documentation

User · Answer

Basically mentioned this in pyserial documentation  https   pyserial readthedocs io en latest tools html module-serial tools list ports  import serial tools list ports ports   serial tools list ports comports    for port  desc  hwid in sorted ports           print               format port  desc  hwid     Result     COM1  Communications Port  COM1   ACPI PNP0501 1   COM7  MediaTek USB Port  COM7   USB VID PID 0E8D 0003 SER 6 LOCATION 1-2 1

User · Answer

Several options are available   Call QueryDosDevice with a NULL lpDeviceName to list all DOS devices  Then use CreateFile and GetCommConfig with each device name in turn to figure out whether it s a serial port   Call SetupDiGetClassDevs with a ClassGuid of GUID DEVINTERFACE COMPORT   WMI is also available to C C   programs   There s some conversation on the win32 newsgroup and a CodeProject  er  project

User · Answer

Please  try this code   import serial ports   serial tools list ports comports include links False  for port in ports       print port device    first of all  you need to import package for serial port communication  so   import serial   then you create the list of all the serial ports currently available   ports   serial tools list ports comports include links False    and then  walking along whole list  you can for example print port names   for port in ports       print port device    This is just an example how to get the list of ports and print their names  but there some other options you can do with this data  Just try print different variants after      port

[python] Listing available com ports with Python

Examples related to python

Examples related to pyserial