Finding a specific serial COM port in pySerial (Windows)

Question

I have a script built (Windows 7, Python 2.7) to list the serial ports but I'm looking for a device with a specific name. My script:

import serial.tools.list_ports
ports = list(serial.tools.list_ports.comports())
for p in ports:
    print(p)

This returns:

COM3 - Intel(R) Active Management Technology - SOL (COM3)
COM6 - MyCDCDevice (COM6)
COM1 - Communications Port (COM1)
>>>

Great! However, I want this script to automatically pick out MyCDCDevice from the bunch and connect to it. I tried:

import serial.tools.list_ports

ports = list(serial.tools.list_ports.comports())
for p in ports:
    if 'MyCDCDevice' in p:
        print(p)
        // do connection stuff to COM6

But that doesn't work. I suspect because p isn't exactly a string, but an object of some sort?

Anyways, what's the correct way to go about this?

Thanks!!

add else: print "NOT:",repr(p) where you have your comment (which is not a python comment...but i suspect you knew that) — Joran Beasley
– Joran Beasley, Commented Jan 20, 2016 at 1:20
I figured it would be just that simple! Thanks guys, YOU ROCK! str(p) did the trick. — coolestDisplayName
– coolestDisplayName, Commented Jan 20, 2016 at 8:38
In windows am facing problem even with import after installing pyserial, any idea on how to solve this. Error is: "ImportError: No module named tools.list_ports" — Ds Arjun
– Ds Arjun, Commented May 7, 2018 at 11:46

jzamora · Accepted Answer · 2018-05-11 22:47:55Z

6

I know this post is very old, but I thought I would post my findings since there was no 'accepted' answer (better late than never).

This documentation helped with determining members of the object, and I eventually came to this solution.

import serial.tools.list_ports

ports = list(serial.tools.list_ports.comports())
for p in ports:
    if 'MyCDCDevice' in p.description:
        print(p)
        # Connection to port
        s = serial.Serial(p.device)

edited May 11, 2018 at 22:47

answered May 11, 2018 at 21:05

jzamora

611 silver badge4 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Stephen Rauch · Accepted Answer · 2018-04-17 01:34:58Z

5

To further extend on this, I've found it safer to make use of the PID and VID of the device in question.

import serial.tools.list_ports

# FTDI FT232 device (http://www.linux-usb.org/usb.ids)
pid="0403"
hid="6001"
my_comm_port = None

ports = list(serial.tools.list_ports.comports())

for p in ports:
    if pid and hid in p.hwid:
       my_comm_port = p.device

Better still, you can use the serial number of the device for the lookup, just in case you have 2 of the same device plugged in.

(Source)

edited Apr 17, 2018 at 1:34

Stephen Rauch♦

50.1k32 gold badges118 silver badges143 bronze badges

answered Apr 17, 2018 at 1:13

user2473494

711 silver badge3 bronze badges

Comments

krs013 · Accepted Answer · 2016-10-20 23:00:22Z

0

You can use serial.tools.list_ports.grep, which searches all of the description fields for you. For example:

from serial.tools import list_ports

try:
    cdc = next(list_ports.grep("MyCDCDevice"))
    # Do connection stuff on cdc
except StopIteration:
    print "No device found"

If that doesn't work, you may try adding a * to the end of the string you pass to grep in case there are extra characters in the descriptor.

answered Oct 20, 2016 at 23:00

krs013

2,9491 gold badge19 silver badges17 bronze badges

Collectives™ on Stack Overflow

Finding a specific serial COM port in pySerial (Windows)

3 Answers 3

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related