summaryrefslogtreecommitdiff
path: root/documentation/examples.rst
diff options
context:
space:
mode:
authorcliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a>2009-07-22 01:06:29 +0000
committercliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a>2009-07-22 01:06:29 +0000
commit6d1e9d18533cc3f71ce7d6fce21adb2342d68f7a (patch)
treefb472b727e86ac3b18b3c94b119f4830f2614bc3 /documentation/examples.rst
parent6ffdb8fcfdb025a0998ed9325b75f00f5992e8c6 (diff)
downloadpyserial-git-6d1e9d18533cc3f71ce7d6fce21adb2342d68f7a.tar.gz
add description of new example
Diffstat (limited to 'documentation/examples.rst')
-rw-r--r--documentation/examples.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/documentation/examples.rst b/documentation/examples.rst
index 33450ea..7b8b826 100644
--- a/documentation/examples.rst
+++ b/documentation/examples.rst
@@ -195,11 +195,19 @@ Finding serial ports
scan.py_
A simple loop that probes serial ports by number.
+scanlinux.py_
+ A Linux only version looking at the entries in ``/dev``. It works best with
+ on systems with devfs or udev that only create those entries that represent
+ devices. On older installations a lot of pre-created device files are found
+ and an additional open check should be added to ensure that the device is
+ real.
+
scanwin32.py_
A Windows only version that returns a list of serial ports with information
from the registry.
.. _scan.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/scan.py
+.. _scanlinux.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/scanlinux.py
.. _scanwin32.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/scanwin32.py