From ccdafe22ec795997484d2ccfaa7e3a5b60a5b80d Mon Sep 17 00:00:00 2001 From: cliechti Date: Fri, 5 Aug 2011 03:55:12 +0000 Subject: - add serial.tools.list_ports, implement platform detection code and a main routine - add code from 2912349 (scan for mac) git-svn-id: http://svn.code.sf.net/p/pyserial/code/trunk/pyserial@408 f19166aa-fa4f-0410-85c2-fa1106f25c8a --- documentation/shortintro.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'documentation') diff --git a/documentation/shortintro.rst b/documentation/shortintro.rst index 01d9943..b9a8a8c 100644 --- a/documentation/shortintro.rst +++ b/documentation/shortintro.rst @@ -79,3 +79,26 @@ mode, it is advised to use io.TextIOWrapper_:: .. _io.TextIOWrapper: http://docs.python.org/library/io.html#io.TextIOWrapper + + +Testing ports +============= +Listing ports +------------- +``python -m serial.tools.list_ports`` will print a list of available ports. It +is also possible to add a regexp as first argument and the list will only +include entries that matched. + +.. note:: + + The enumeration may not work on all operating systems. It may be + incomplete, list unavailable ports or may lack detailed descriptions of the + ports. + +.. versionadded: 2.6 + +Accessing ports +--------------- +pySerial includes a small terminal console based terminal program called +:ref:`miniterm`. It ca be started with ``python -m serial.tools.miniterm `` +(use option ``-h`` to get a listing of all options). -- cgit v1.2.1