1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
==============
pySerial API
==============
.. module:: serial
Classes
=======
.. class:: Serial
.. method:: __init__(port=None, baudrate=9600, bytesize=EIGHTBITS, parity=PARITY_NONE, stopbits=STOPBITS_ONE, timeout=None, xonxoff=0, rtscts=0, interCharTimeout=None)
:param port:
Device name or port number number or None.
:param baudrate:
Baud rate such as 9600 or 115200 etc.
:param bytesize:
Number of data bits. Possible values: FIVEBITS, SIXBITS, SEVENBITS, EIGHTBITS
:param parity:
Enable parity checking. Possible values: PARITY_NONE PARITY_EVEN PARITY_ODD PARITY_MARK PARITY_SPACE
:param stopbits:
Number of stop bits. Possible values: STOPBITS_ONE STOPBITS_ONE_POINT_FIVE STOPBITS_TWO
:param timeout:
Set a read timeout value.
:param xonxoff:
Enable software flow control.
:param rtscts:
Enable hardware (RTS/CTS) flow control.
:param interCharTimeout:
Inter-character timeout, None to disable.
The port is immediately opened on object creation, when a ``port`` is
given. It is not opened when port is None.
- Number: number of device, numbering starts at zero.
- Device name: depending on operating system. e.g. ``/dev/ttyUSB0``
on GNU/Linux or ``COM3`` on Windows.
Possible values for the parameter ``timeout``:
- ``timeout = None``: wait forever
- ``timeout = 0``: non-blocking mode (return immediately on read)
- ``timeout = x``: set timeout to x seconds (float allowed)
.. method:: open()
Open port.
.. method:: close()
Close port immediately.
.. method:: setBaudrate(baudrate)
Change baud rate on an open port.
.. method:: inWaiting()
Return the number of chars in the receive buffer.
.. method:: read(size=1)
:param size: Number of bytes to read.
:return: Bytes read from the port.
Read ``size`` bytes from the serial port. If a timeout is set it may
return less characters as requested. With no timeout it will block
until the requested number of bytes is read.
.. method:: write(data)
:param data: Data to send.
Write the string ``data`` to the port.
.. method:: flush():
Flush of file like objects. In this case, wait until all data is
written.
.. method:: flushInput()
Flush input buffer, discarding all it's contents.
.. method:: flushOutput()
Clear output buffer, aborting the current output and
discarding all that is in the buffer.
.. method:: sendBreak(duration=0.25)
:param duration: Time (float) to activate the BREAK condition.
Send break condition. Timed, returns to idle state after given
duration.
.. method:: setBreak(level=True)
:param level: when true activate BREAK condition, else disable.
Set break: Controls TXD. When active, no transmitting is possible.
.. method:: setRTS(level=True)
:param level: Set control line to logic level.
Set RTS line to specified logic level.
.. method:: setDTR(level=True)
:param level: Set control line to logic level.
Set DTR line to specified logic level.
.. method:: getCTS()
:return: Current state (boolean)
Return the state of the CTS line.
.. method:: getDSR()
:return: Current state (boolean)
Return the state of the DSR line.
.. method:: getRI()
:return: Current state (boolean)
Return the state of the RI line.
.. method:: getCD()
:return: Current state (boolean)
Return the state of the CD line
Read-only attributes:
.. attribute:: portstr
Device name. This is always the device name even if the
port was opened by a number. (Read Only).
.. attribute:: BAUDRATES
A list of valid baud rates. The list may be incomplete such that higher
baud rates may be supported by the device and that values in between the
standard baud rates are supported. (Read Only).
.. attribute:: BYTESIZES
A list of valid byte sizes for the device (Read Only).
.. attribute:: PARITIES
A list of valid parities for the device (Read Only).
.. attribute:: STOPBITS
A list of valid stop bit widths for the device (Read Only).
New values can be assigned to the following attributes, the port will be reconfigured, even if it's opened at that time:
.. attribute:: port
Port name/number as set by the user.
.. attribute:: baudrate
Current baud rate setting.
.. attribute:: bytesize
Byte size in bits.
.. attribute:: parity
Parity setting.
.. attribute:: stopbits
Stop bit with.
.. attribute:: timeout
Timeout setting (seconds, float).
.. attribute:: xonxoff
If Xon/Xoff flow control is enabled.
.. attribute:: rtscts
If hardware flow control is enabled.
Platform specific methods.
.. warning:: Programs using the following methods are not portable to other platforms!
.. method:: nonblocking()
:platform: Unix
Configure the device for nonblocking operations. This can be useful if
the port is used with ``select``.
.. method:: fileno()
:platform: Unix
:return: File descriptor.
Return file descriptor number for the port that is opened by this object.
.. method:: setXON(level=True)
:platform: Windows
:param level: Set flow control state.
Set software flow control state.
.. class:: FileLike
An abstract file like class. It is used as base class for :class:`Serial`.
This class implements readline and readlines based on read and
writelines based on write.
This class is used to provide the above functions for to Serial
port objects.
Note that when the serial port was opened with _NO_ timeout that
readline blocks until it sees a newline (or the specified size is
reached) and that readlines would never return and therefore
refuses to work (it raises an exception in this case)!
.. method:: readline(size=None, eol='\n')
:param size: Max number of bytes to read, ``None`` -> no limit.
:param eol: The end of line character.
Read a line which is terminated with end-of-line (eol) character
('\n' by default) or until timeout.
.. method:: readlines(sizehint=None, eol='\n')
:param size: Ignored parameter.
:param eol: The end of line character.
Read a list of lines, until timeout. ``sizehint`` is ignored and only
present for API compatibility with built-in File objects.
.. method:: xreadlines(sizehint=None)
Just calls ``readlines`` - here for compatibility.
.. method:: writelines(sequence)
Write a list of strings to the port.
.. method:: flush()
Flush of file like objects. It's a no-op in this class, may be overridden.
.. method:: read()
Raises NotImplementedError, needs to be overridden by subclass.
.. method:: write(data)
Raises NotImplementedError, needs to be overridden by subclass.
To be able to use the file like object as iterator for e.g.
``for line in Serial(0): ...`` usage:
.. method:: next()
Return the next line by calling :meth:`readline`.
.. method:: __iter__()
Returns self.
.. class:: SerialBase
The following attributes are implemented as properties. They work with open
and closed ports.
.. attribute:: port
Read or write port. When the port is already open, it will be closed
and reopened with the new setting.
.. attribute:: baudrate
Read or write current baud rate setting. It is possible to change this
on an opened port.
.. attribute:: bytesize
Read or write current data byte size setting. It is possible to change
this on an opened port.
.. attribute:: parity
Read or write current parity setting. It is possible to change this on
an opened port.
.. attribute:: stopbits
Read or write current stop bit width setting. It is possible to change
this on an opened port.
.. attribute:: timeout
Read or write current read timeout setting. It is possible to change
this on an opened port.
.. attribute:: writeTimeout
Read or write current write timeout setting. It is possible to change
this on an opened port.
.. attribute:: xonxoff
Read or write current software flow control rate setting. It is
possible to change this on an opened port.
.. attribute:: rtscts
Read or write current hardware flow control setting. It is possible to
change this on an opened port.
.. attribute:: dsrdtr
Read or write current hardware flow control setting. It is possible to
change this on an opened port.
.. attribute:: interCharTimeout
Read or write current inter character timeout setting. It is possible
to change this on an opened port.
The following constants are also provided:
.. attribute:: BAUDRATES
A tuple of standard baud rate values. The actual device may support more
or less...
.. attribute:: BYTESIZES
A tuple of supported byte size values.
.. attribute:: PARITIES
A tuple of supported parity settings.
.. attribute:: STOPBITS
A tuple of supported stop bit settings.
Exceptions
==========
.. exception:: SerialException
Base class for serial port exceptions.
.. exception:: SerialTimeoutException
Exception that is raised on write timeouts.
Constants
=========
Parity
------
.. data:: PARITY_NONE
.. data:: PARITY_EVEN
.. data:: PARITY_ODD
.. data:: PARITY_MARK
.. data:: PARITY_SPACE
Stopbits
--------
.. data:: STOPBITS_ONE
.. data:: STOPBITS_ONE_POINT_FIVE
.. data:: STOPBITS_TWO
Bytesize
--------
.. data:: FIVEBITS
.. data:: SIXBITS
.. data:: SEVENBITS
.. data:: EIGHTBITS
Others
-------
.. data:: XON
.. data:: XOFF
|