From 7821d0f7c8e862eb8999bb3fc299ca21ad59850d Mon Sep 17 00:00:00 2001 From: Yann Sionneau Date: Tue, 23 Jun 2015 17:05:46 +0200 Subject: [PATCH] manual: explain how to list attached serial devices on windows/linux --- doc/manual/faq.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/manual/faq.rst b/doc/manual/faq.rst index de9e59006..b98c3f2c1 100644 --- a/doc/manual/faq.rst +++ b/doc/manual/faq.rst @@ -74,3 +74,19 @@ sub-experiments difficult and fragile. You can however always use the scheduler API to achieve the same (``scheduler.yield(duration=0)``) or wrap your own generators/coroutines/tasks in regular functions that you then expose as part of the API. + +list the serial devices attached to my Linux/Windows system? +------------------------------------------------------------ + +You can do it by running:: + + $ python3 -m serial.tools.list_ports -v + +It will give you the ``/dev/ttyUSBxx`` (or the ``COMxx`` for Windows) device +names. +The ``hwid:`` field gives you the string you can pass via the ``hwgrep://`` +feature of pyserial +`serial_for_url() `_ +in order to open a serial device. + +See the :ref:`TDC001 documentation ` for an example of ``hwgrep://`` usage. \ No newline at end of file