summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Liechti <cliechti@gmx.net>2016-09-28 18:18:25 +0200
committerChris Liechti <cliechti@gmx.net>2016-09-28 18:18:25 +0200
commit5e953c32f3d4458492b5f0b69e998b89b59e9afb (patch)
tree2049b1a7271f87c481a286c5e57326a72db2fb5b
parent961234d714b29032aca01ae03408e69a45a92863 (diff)
downloadpyserial-git-5e953c32f3d4458492b5f0b69e998b89b59e9afb.tar.gz
docs: mention RTS/DTR update on open, not all platforms supporting it
-rw-r--r--documentation/pyserial_api.rst18
1 files changed, 13 insertions, 5 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst
index 357852e..92b42e5 100644
--- a/documentation/pyserial_api.rst
+++ b/documentation/pyserial_api.rst
@@ -111,7 +111,14 @@ Native ports
.. method:: open()
- Open port.
+ Open port. The state of :attr:`rts`` and :attr:`dtr` is applied.
+
+ .. note::
+
+ Some OS and/or drivers may activate RTS and or DTR automatically,
+ as soon as the port is opened. There may be a glitch on RTS/DTR
+ when :attr:`rts`` or :attr:`dtr` are set differently from their
+ default value (``True`` / active).
.. method:: close()
@@ -226,7 +233,7 @@ Native ports
Set RTS line to specified logic level. It is possible to assign this
value before opening the serial port, then the value is applied uppon
- :meth:`open`.
+ :meth:`open` (with restrictions, see :meth:`open`).
.. attribute:: dtr
@@ -236,7 +243,7 @@ Native ports
Set DTR line to specified logic level. It is possible to assign this
value before opening the serial port, then the value is applied uppon
- :meth:`open`.
+ :meth:`open` (with restrictions, see :meth:`open`).
Read-only attributes:
@@ -276,8 +283,9 @@ Native ports
Return the state of the CD line
.. attribute:: is_open
- :getter: Get the state of the serial port, whether it's open.
- :type: bool
+
+ :getter: Get the state of the serial port, whether it's open.
+ :type: bool
New values can be assigned to the following attributes (properties), the
port will be reconfigured, even if it's opened at that time: