summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorRob Gaddi <rgaddi@highlandtechnology.com>2017-02-24 11:39:46 -0800
committerRob Gaddi <rgaddi@highlandtechnology.com>2017-02-24 11:39:46 -0800
commit636cc64cc949076fe9051cc4b971384006eafee2 (patch)
tree51b5fa53b3a92ef6d8f6a851c29f0cb3b7ab1e23 /documentation
parentffb44d6d7394e2b73bfb1bb91dd69c377c0f8aa0 (diff)
downloadpyserial-git-636cc64cc949076fe9051cc4b971384006eafee2.tar.gz
Added exclusive locking for POSIX serial ports.
Diffstat (limited to 'documentation')
-rw-r--r--documentation/pyserial_api.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/documentation/pyserial_api.rst b/documentation/pyserial_api.rst
index cec0078..b41dd0d 100644
--- a/documentation/pyserial_api.rst
+++ b/documentation/pyserial_api.rst
@@ -12,7 +12,7 @@ Native ports
.. class:: Serial
- .. method:: __init__(port=None, baudrate=9600, bytesize=EIGHTBITS, parity=PARITY_NONE, stopbits=STOPBITS_ONE, timeout=None, xonxoff=False, rtscts=False, write_timeout=None, dsrdtr=False, inter_byte_timeout=None)
+ .. method:: __init__(port=None, baudrate=9600, bytesize=EIGHTBITS, parity=PARITY_NONE, stopbits=STOPBITS_ONE, timeout=None, xonxoff=False, rtscts=False, write_timeout=None, dsrdtr=False, inter_byte_timeout=None, exclusive=None)
:param port:
Device name or :const:`None`.
@@ -52,6 +52,9 @@ Native ports
:param float inter_byte_timeout:
Inter-character timeout, :const:`None` to disable (default).
+
+ :param bool exclusive:
+ Set exclusive access mode (POSIX only).
:exception ValueError:
Will be raised when parameter are out of range, e.g. baud rate, data bits.