summaryrefslogtreecommitdiff
path: root/serial/tools/list_ports.py
blob: c652fef304d1d8b2a7bd1b98cc0f1b9689e8266c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#!/usr/bin/env python

# portable serial port access with python
# this is a wrapper module for different platform implementations of the
# port enumeration feature
#
# (C) 2011 Chris Liechti <cliechti@gmx.net>
# this is distributed under a free software license, see license.txt

"""\
This module will provide a function called comports that returns an
iterable (generator or list) that will enumerate available com ports. Note that
on some systems non-existent ports may be listed.

Additionally a grep function is supplied that can be used to search for ports
based on their descriptions or hardware ID.
"""

import sys, os, re

# chose an implementation, depending on os
#~ if sys.platform == 'cli':
#~ else:
import os
# chose an implementation, depending on os
if os.name == 'nt': #sys.platform == 'win32':
    from serial.tools.list_ports_windows import *
elif os.name == 'posix':
    from serial.tools.list_ports_posix import *
#~ elif os.name == 'java':
else:
    raise ImportError("Sorry: no implementation for your platform ('%s') available" % (os.name,))


def grep(regexp):
    """\
    Search for ports using a regular expression. Port name, description and
    hardware ID are searched. The function returns an iterable that returns the
    same tuples as comport() would do.
    """
    for port, desc, hwid in comports():
        if re.search(regexp, port, re.I) or re.search(regexp, desc) or re.search(regexp, hwid):
            yield port, desc, hwid

# test
if __name__ == '__main__':
    hits = 0
    if len(sys.argv) > 1:
        print "Filtered list with regexp: %r" % (sys.argv[1],)
        for port, desc, hwid in sorted(grep(sys.argv[1])):
            print "%-20s: %s [%s]" % (port, desc, hwid)
            hits += 1
    else:
        for port, desc, hwid in sorted(comports()):
            print "%-20s: %s [%s]" % (port, desc, hwid)
            hits += 1
    if hits:
        print "%d ports found" % (hits,)
    else:
        print "no ports found"