blob: 47f869a8328942249ef112c4ee29cf7e8ea52243 [file] [log] [blame]
cliechti89b4af12002-02-12 23:24:41 +00001#!/usr/bin/env python
cliechti58b481c2009-02-16 20:42:32 +00002#
Chris Liechti3e02f702015-12-16 23:06:04 +01003# backend for serial IO for POSIX compatible systems, like Linux, OSX
cliechti89b4af12002-02-12 23:24:41 +00004#
Chris Liechti3e02f702015-12-16 23:06:04 +01005# This file is part of pySerial. https://github.com/pyserial/pyserial
Chris Liechtie13d0f62016-04-25 23:30:44 +02006# (C) 2001-2016 Chris Liechti <cliechti@gmx.net>
Chris Liechtifbdd8a02015-08-09 02:37:45 +02007#
8# SPDX-License-Identifier: BSD-3-Clause
cliechti89b4af12002-02-12 23:24:41 +00009#
cliechtic54b2c82008-06-21 01:59:08 +000010# parts based on code from Grant B. Edwards <grante@visi.com>:
cliechti89b4af12002-02-12 23:24:41 +000011# ftp://ftp.visi.com/users/grante/python/PosixSerial.py
cliechti53c9fd42009-07-23 23:51:51 +000012#
cliechti89b4af12002-02-12 23:24:41 +000013# references: http://www.easysw.com/~mike/serial/serial.html
14
Chris Liechtie13d0f62016-04-25 23:30:44 +020015# Collection of port names (was previously used by number_to_device which was
16# removed.
17# - Linux /dev/ttyS%d (confirmed)
18# - cygwin/win32 /dev/com%d (confirmed)
19# - openbsd (OpenBSD) /dev/cua%02d
20# - bsd*, freebsd* /dev/cuad%d
21# - darwin (OS X) /dev/cuad%d
22# - netbsd /dev/dty%02d (NetBSD 1.6 testing by Erk)
23# - irix (IRIX) /dev/ttyf%d (partially tested) names depending on flow control
24# - hp (HP-UX) /dev/tty%dp0 (not tested)
25# - sunos (Solaris/SunOS) /dev/tty%c (letters, 'a'..'z') (confirmed)
26# - aix (AIX) /dev/tty%d
27
28
Chris Liechti9eaa40c2016-02-12 23:32:59 +010029# pylint: disable=abstract-method
Chris Liechti33f0ec52015-08-06 16:37:21 +020030import errno
31import fcntl
Chris Liechti33f0ec52015-08-06 16:37:21 +020032import os
33import select
34import struct
35import sys
36import termios
37import time
Chris Liechti033f17c2015-08-30 21:28:04 +020038
39import serial
40from serial.serialutil import SerialBase, SerialException, to_bytes, portNotOpenError, writeTimeoutError
cliechti89b4af12002-02-12 23:24:41 +000041
cliechti89b4af12002-02-12 23:24:41 +000042
Chris Liechtid6847af2015-08-06 17:54:30 +020043class PlatformSpecificBase(object):
44 BAUDRATE_CONSTANTS = {}
cliechti89b4af12002-02-12 23:24:41 +000045
Chris Liechtid6847af2015-08-06 17:54:30 +020046 def _set_special_baudrate(self, baudrate):
47 raise NotImplementedError('non-standard baudrates are not supported on this platform')
48
49 def _set_rs485_mode(self, rs485_settings):
50 raise NotImplementedError('RS485 not supported on this platform')
51
52# try to detect the OS so that a device can be selected...
53# this code block should supply a device() and set_special_baudrate() function
54# for the platform
55plat = sys.platform.lower()
56
Chris Liechtiba45c522016-02-06 23:53:23 +010057if plat[:5] == 'linux': # Linux (confirmed) # noqa
Chris Liechtid6847af2015-08-06 17:54:30 +020058 import array
59
60 # baudrate ioctls
61 TCGETS2 = 0x802C542A
62 TCSETS2 = 0x402C542B
63 BOTHER = 0o010000
64
65 # RS485 ioctls
66 TIOCGRS485 = 0x542E
67 TIOCSRS485 = 0x542F
Chris Liechti033f17c2015-08-30 21:28:04 +020068 SER_RS485_ENABLED = 0b00000001
69 SER_RS485_RTS_ON_SEND = 0b00000010
Chris Liechtid6847af2015-08-06 17:54:30 +020070 SER_RS485_RTS_AFTER_SEND = 0b00000100
Chris Liechti033f17c2015-08-30 21:28:04 +020071 SER_RS485_RX_DURING_TX = 0b00010000
Chris Liechtid6847af2015-08-06 17:54:30 +020072
73 class PlatformSpecific(PlatformSpecificBase):
74 BAUDRATE_CONSTANTS = {
75 0: 0o000000, # hang up
76 50: 0o000001,
77 75: 0o000002,
78 110: 0o000003,
79 134: 0o000004,
80 150: 0o000005,
81 200: 0o000006,
82 300: 0o000007,
83 600: 0o000010,
84 1200: 0o000011,
85 1800: 0o000012,
86 2400: 0o000013,
87 4800: 0o000014,
88 9600: 0o000015,
89 19200: 0o000016,
90 38400: 0o000017,
91 57600: 0o010001,
92 115200: 0o010002,
93 230400: 0o010003,
94 460800: 0o010004,
95 500000: 0o010005,
96 576000: 0o010006,
97 921600: 0o010007,
98 1000000: 0o010010,
99 1152000: 0o010011,
100 1500000: 0o010012,
101 2000000: 0o010013,
102 2500000: 0o010014,
103 3000000: 0o010015,
104 3500000: 0o010016,
105 4000000: 0o010017
106 }
107
Chris Liechtid6847af2015-08-06 17:54:30 +0200108 def _set_special_baudrate(self, baudrate):
109 # right size is 44 on x86_64, allow for some growth
110 buf = array.array('i', [0] * 64)
111 try:
112 # get serial_struct
113 fcntl.ioctl(self.fd, TCGETS2, buf)
114 # set custom speed
115 buf[2] &= ~termios.CBAUD
116 buf[2] |= BOTHER
117 buf[9] = buf[10] = baudrate
118
119 # set serial_struct
Chris Liechti033f17c2015-08-30 21:28:04 +0200120 fcntl.ioctl(self.fd, TCSETS2, buf)
Chris Liechtid6847af2015-08-06 17:54:30 +0200121 except IOError as e:
Chris Liechti984c5c52016-02-15 23:48:45 +0100122 raise ValueError('Failed to set custom baud rate ({}): {}'.format(baudrate, e))
Chris Liechtid6847af2015-08-06 17:54:30 +0200123
124 def _set_rs485_mode(self, rs485_settings):
Chris Liechti033f17c2015-08-30 21:28:04 +0200125 buf = array.array('i', [0] * 8) # flags, delaytx, delayrx, padding
Chris Liechtid6847af2015-08-06 17:54:30 +0200126 try:
127 fcntl.ioctl(self.fd, TIOCGRS485, buf)
Chris Liechti7a554462016-03-24 21:17:22 +0100128 buf[0] |= SER_RS485_ENABLED
Chris Liechtid6847af2015-08-06 17:54:30 +0200129 if rs485_settings is not None:
130 if rs485_settings.loopback:
131 buf[0] |= SER_RS485_RX_DURING_TX
132 else:
133 buf[0] &= ~SER_RS485_RX_DURING_TX
134 if rs485_settings.rts_level_for_tx:
135 buf[0] |= SER_RS485_RTS_ON_SEND
136 else:
137 buf[0] &= ~SER_RS485_RTS_ON_SEND
138 if rs485_settings.rts_level_for_rx:
139 buf[0] |= SER_RS485_RTS_AFTER_SEND
140 else:
141 buf[0] &= ~SER_RS485_RTS_AFTER_SEND
Chris Liechti01df8892016-03-17 23:01:42 +0100142 buf[1] = int(rs485_settings.delay_before_tx * 1000)
143 buf[2] = int(rs485_settings.delay_before_rx * 1000)
Chris Liechtid6847af2015-08-06 17:54:30 +0200144 else:
145 buf[0] = 0 # clear SER_RS485_ENABLED
Chris Liechti033f17c2015-08-30 21:28:04 +0200146 fcntl.ioctl(self.fd, TIOCSRS485, buf)
Chris Liechtid6847af2015-08-06 17:54:30 +0200147 except IOError as e:
Chris Liechti984c5c52016-02-15 23:48:45 +0100148 raise ValueError('Failed to set RS485 mode: {}'.format(e))
Chris Liechtid6847af2015-08-06 17:54:30 +0200149
150
151elif plat == 'cygwin': # cygwin/win32 (confirmed)
152
153 class PlatformSpecific(PlatformSpecificBase):
154 BAUDRATE_CONSTANTS = {
155 128000: 0x01003,
156 256000: 0x01005,
157 500000: 0x01007,
158 576000: 0x01008,
159 921600: 0x01009,
160 1000000: 0x0100a,
161 1152000: 0x0100b,
162 1500000: 0x0100c,
163 2000000: 0x0100d,
164 2500000: 0x0100e,
165 3000000: 0x0100f
166 }
167
Chris Liechtid6847af2015-08-06 17:54:30 +0200168
169elif plat[:6] == 'darwin': # OS X
170 import array
Chris Liechti033f17c2015-08-30 21:28:04 +0200171 IOSSIOSPEED = 0x80045402 # _IOW('T', 2, speed_t)
Chris Liechtid6847af2015-08-06 17:54:30 +0200172
173 class PlatformSpecific(PlatformSpecificBase):
Chris Liechtid6847af2015-08-06 17:54:30 +0200174 osx_version = os.uname()[2].split('.')
175 # Tiger or above can support arbitrary serial speeds
176 if int(osx_version[0]) >= 8:
177 def _set_special_baudrate(self, baudrate):
178 # use IOKit-specific call to set up high speeds
179 buf = array.array('i', [baudrate])
180 fcntl.ioctl(self.fd, IOSSIOSPEED, buf, 1)
181
Chris Liechtid6847af2015-08-06 17:54:30 +0200182else:
183 class PlatformSpecific(PlatformSpecificBase):
184 pass
cliechti89b4af12002-02-12 23:24:41 +0000185
cliechti89b4af12002-02-12 23:24:41 +0000186
cliechti58b481c2009-02-16 20:42:32 +0000187# load some constants for later use.
Chris Liechti11465c82015-08-04 15:55:22 +0200188# try to use values from termios, use defaults from linux otherwise
Chris Liechti033f17c2015-08-30 21:28:04 +0200189TIOCMGET = getattr(termios, 'TIOCMGET', 0x5415)
190TIOCMBIS = getattr(termios, 'TIOCMBIS', 0x5416)
191TIOCMBIC = getattr(termios, 'TIOCMBIC', 0x5417)
192TIOCMSET = getattr(termios, 'TIOCMSET', 0x5418)
cliechti89b4af12002-02-12 23:24:41 +0000193
Chris Liechti033f17c2015-08-30 21:28:04 +0200194# TIOCM_LE = getattr(termios, 'TIOCM_LE', 0x001)
Chris Liechtid6847af2015-08-06 17:54:30 +0200195TIOCM_DTR = getattr(termios, 'TIOCM_DTR', 0x002)
196TIOCM_RTS = getattr(termios, 'TIOCM_RTS', 0x004)
Chris Liechti033f17c2015-08-30 21:28:04 +0200197# TIOCM_ST = getattr(termios, 'TIOCM_ST', 0x008)
198# TIOCM_SR = getattr(termios, 'TIOCM_SR', 0x010)
cliechti89b4af12002-02-12 23:24:41 +0000199
Chris Liechtid6847af2015-08-06 17:54:30 +0200200TIOCM_CTS = getattr(termios, 'TIOCM_CTS', 0x020)
201TIOCM_CAR = getattr(termios, 'TIOCM_CAR', 0x040)
202TIOCM_RNG = getattr(termios, 'TIOCM_RNG', 0x080)
203TIOCM_DSR = getattr(termios, 'TIOCM_DSR', 0x100)
Chris Liechti033f17c2015-08-30 21:28:04 +0200204TIOCM_CD = getattr(termios, 'TIOCM_CD', TIOCM_CAR)
205TIOCM_RI = getattr(termios, 'TIOCM_RI', TIOCM_RNG)
206# TIOCM_OUT1 = getattr(termios, 'TIOCM_OUT1', 0x2000)
207# TIOCM_OUT2 = getattr(termios, 'TIOCM_OUT2', 0x4000)
Chris Liechti11465c82015-08-04 15:55:22 +0200208if hasattr(termios, 'TIOCINQ'):
209 TIOCINQ = termios.TIOCINQ
cliechti28b8fd02011-12-28 21:39:42 +0000210else:
Chris Liechtid6847af2015-08-06 17:54:30 +0200211 TIOCINQ = getattr(termios, 'FIONREAD', 0x541B)
Chris Liechti033f17c2015-08-30 21:28:04 +0200212TIOCOUTQ = getattr(termios, 'TIOCOUTQ', 0x5411)
cliechti89b4af12002-02-12 23:24:41 +0000213
214TIOCM_zero_str = struct.pack('I', 0)
215TIOCM_RTS_str = struct.pack('I', TIOCM_RTS)
216TIOCM_DTR_str = struct.pack('I', TIOCM_DTR)
217
Chris Liechti033f17c2015-08-30 21:28:04 +0200218TIOCSBRK = getattr(termios, 'TIOCSBRK', 0x5427)
219TIOCCBRK = getattr(termios, 'TIOCCBRK', 0x5428)
cliechti997b63c2008-06-21 00:09:31 +0000220
Chris Liechti033f17c2015-08-30 21:28:04 +0200221CMSPAR = 0o10000000000 # Use "stick" (mark/space) parity
cliechtiaec27ab2014-07-31 22:21:24 +0000222
cliechti89b4af12002-02-12 23:24:41 +0000223
Chris Liechtief6b7b42015-08-06 22:19:26 +0200224class Serial(SerialBase, PlatformSpecific):
cliechti7d448562014-08-03 21:57:45 +0000225 """\
Chris Liechti033f17c2015-08-30 21:28:04 +0200226 Serial port class POSIX implementation. Serial port configuration is
cliechtid6bf52c2003-10-01 02:28:12 +0000227 done with termios and fcntl. Runs on Linux and many other Un*x like
cliechtif0a81d42014-08-04 14:03:53 +0000228 systems.
229 """
cliechtid6bf52c2003-10-01 02:28:12 +0000230
231 def open(self):
cliechti7d448562014-08-03 21:57:45 +0000232 """\
233 Open port with current settings. This may throw a SerialException
234 if the port cannot be opened."""
cliechtid6bf52c2003-10-01 02:28:12 +0000235 if self._port is None:
236 raise SerialException("Port must be configured before it can be used.")
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200237 if self.is_open:
cliechti02ef43a2011-03-24 23:33:12 +0000238 raise SerialException("Port is already open.")
239 self.fd = None
cliechti58b481c2009-02-16 20:42:32 +0000240 # open
cliechti4616bf12002-04-08 23:13:14 +0000241 try:
Chris Liechti033f17c2015-08-30 21:28:04 +0200242 self.fd = os.open(self.portstr, os.O_RDWR | os.O_NOCTTY | os.O_NONBLOCK)
Chris Liechti68340d72015-08-03 14:15:48 +0200243 except OSError as msg:
cliechti4616bf12002-04-08 23:13:14 +0000244 self.fd = None
Chris Liechti984c5c52016-02-15 23:48:45 +0100245 raise SerialException(msg.errno, "could not open port {}: {}".format(self._port, msg))
Chris Liechti11465c82015-08-04 15:55:22 +0200246 #~ fcntl.fcntl(self.fd, fcntl.F_SETFL, 0) # set blocking
cliechti58b481c2009-02-16 20:42:32 +0000247
cliechtib2f5fc82006-10-20 00:09:07 +0000248 try:
Chris Liechti94284702015-11-15 01:21:48 +0100249 self._reconfigure_port(force_update=True)
cliechtib2f5fc82006-10-20 00:09:07 +0000250 except:
cliechti2750b832009-07-28 00:13:52 +0000251 try:
252 os.close(self.fd)
253 except:
254 # ignore any exception when closing the port
255 # also to keep original exception that happened when setting up
256 pass
cliechtib2f5fc82006-10-20 00:09:07 +0000257 self.fd = None
cliechtif0a4f0f2009-07-21 21:12:37 +0000258 raise
cliechtib2f5fc82006-10-20 00:09:07 +0000259 else:
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200260 self.is_open = True
Chris Liechtif2fdeb92016-05-07 23:57:50 +0200261 try:
262 if not self._dsrdtr:
263 self._update_dtr_state()
264 if not self._rtscts:
265 self._update_rts_state()
266 except IOError as e:
267 if e.errno == 22: # ignore Invalid argument
268 pass
269 else:
270 raise
Chris Liechtief1fe252015-08-27 23:25:21 +0200271 self.reset_input_buffer()
Chris Liechti42ab2b42016-05-15 23:35:05 +0200272 self.pipe_abort_read_r, self.pipe_abort_read_w = os.pipe()
cliechti58b481c2009-02-16 20:42:32 +0000273
Chris Liechti94284702015-11-15 01:21:48 +0100274 def _reconfigure_port(self, force_update=False):
cliechtib2f5fc82006-10-20 00:09:07 +0000275 """Set communication parameters on opened port."""
cliechtic6178262004-03-22 22:04:52 +0000276 if self.fd is None:
cliechtia9a093e2010-01-02 03:05:08 +0000277 raise SerialException("Can only operate on a valid file descriptor")
cliechtie8c45422008-06-20 23:23:14 +0000278 custom_baud = None
cliechti58b481c2009-02-16 20:42:32 +0000279
cliechti2750b832009-07-28 00:13:52 +0000280 vmin = vtime = 0 # timeout is done via select
Chris Liechti518b0d32015-08-30 02:20:39 +0200281 if self._inter_byte_timeout is not None:
cliechti679bfa62008-06-20 23:58:15 +0000282 vmin = 1
Chris Liechti518b0d32015-08-30 02:20:39 +0200283 vtime = int(self._inter_byte_timeout * 10)
cliechti6ce7ab12002-11-07 02:15:00 +0000284 try:
cliechti4d0af5e2011-08-05 02:18:16 +0000285 orig_attr = termios.tcgetattr(self.fd)
286 iflag, oflag, cflag, lflag, ispeed, ospeed, cc = orig_attr
Chris Liechti68340d72015-08-03 14:15:48 +0200287 except termios.error as msg: # if a port is nonexistent but has a /dev file, it'll fail here
Chris Liechti984c5c52016-02-15 23:48:45 +0100288 raise SerialException("Could not configure port: {}".format(msg))
cliechti58b481c2009-02-16 20:42:32 +0000289 # set up raw mode / no echo / binary
Chris Liechti033f17c2015-08-30 21:28:04 +0200290 cflag |= (termios.CLOCAL | termios.CREAD)
291 lflag &= ~(termios.ICANON | termios.ECHO | termios.ECHOE |
292 termios.ECHOK | termios.ECHONL |
293 termios.ISIG | termios.IEXTEN) # |termios.ECHOPRT
294 for flag in ('ECHOCTL', 'ECHOKE'): # netbsd workaround for Erk
Chris Liechti11465c82015-08-04 15:55:22 +0200295 if hasattr(termios, flag):
296 lflag &= ~getattr(termios, flag)
cliechti58b481c2009-02-16 20:42:32 +0000297
Chris Liechti033f17c2015-08-30 21:28:04 +0200298 oflag &= ~(termios.OPOST | termios.ONLCR | termios.OCRNL)
299 iflag &= ~(termios.INLCR | termios.IGNCR | termios.ICRNL | termios.IGNBRK)
Chris Liechti11465c82015-08-04 15:55:22 +0200300 if hasattr(termios, 'IUCLC'):
301 iflag &= ~termios.IUCLC
302 if hasattr(termios, 'PARMRK'):
303 iflag &= ~termios.PARMRK
cliechti58b481c2009-02-16 20:42:32 +0000304
cliechtif0a4f0f2009-07-21 21:12:37 +0000305 # setup baud rate
cliechti89b4af12002-02-12 23:24:41 +0000306 try:
Chris Liechti984c5c52016-02-15 23:48:45 +0100307 ispeed = ospeed = getattr(termios, 'B{}'.format(self._baudrate))
cliechti895e8302004-04-20 02:40:28 +0000308 except AttributeError:
cliechtif1559d02007-11-08 23:43:58 +0000309 try:
Chris Liechtid6847af2015-08-06 17:54:30 +0200310 ispeed = ospeed = self.BAUDRATE_CONSTANTS[self._baudrate]
cliechtif1559d02007-11-08 23:43:58 +0000311 except KeyError:
cliechtie8c45422008-06-20 23:23:14 +0000312 #~ raise ValueError('Invalid baud rate: %r' % self._baudrate)
cliechtif0a4f0f2009-07-21 21:12:37 +0000313 # may need custom baud rate, it isn't in our list.
Chris Liechti11465c82015-08-04 15:55:22 +0200314 ispeed = ospeed = getattr(termios, 'B38400')
cliechtif0a4f0f2009-07-21 21:12:37 +0000315 try:
Chris Liechti033f17c2015-08-30 21:28:04 +0200316 custom_baud = int(self._baudrate) # store for later
cliechtif0a4f0f2009-07-21 21:12:37 +0000317 except ValueError:
Chris Liechti984c5c52016-02-15 23:48:45 +0100318 raise ValueError('Invalid baud rate: {!r}'.format(self._baudrate))
cliechtif0a4f0f2009-07-21 21:12:37 +0000319 else:
320 if custom_baud < 0:
Chris Liechti984c5c52016-02-15 23:48:45 +0100321 raise ValueError('Invalid baud rate: {!r}'.format(self._baudrate))
cliechti58b481c2009-02-16 20:42:32 +0000322
323 # setup char len
Chris Liechti11465c82015-08-04 15:55:22 +0200324 cflag &= ~termios.CSIZE
cliechtid6bf52c2003-10-01 02:28:12 +0000325 if self._bytesize == 8:
Chris Liechti11465c82015-08-04 15:55:22 +0200326 cflag |= termios.CS8
cliechtid6bf52c2003-10-01 02:28:12 +0000327 elif self._bytesize == 7:
Chris Liechti11465c82015-08-04 15:55:22 +0200328 cflag |= termios.CS7
cliechtid6bf52c2003-10-01 02:28:12 +0000329 elif self._bytesize == 6:
Chris Liechti11465c82015-08-04 15:55:22 +0200330 cflag |= termios.CS6
cliechtid6bf52c2003-10-01 02:28:12 +0000331 elif self._bytesize == 5:
Chris Liechti11465c82015-08-04 15:55:22 +0200332 cflag |= termios.CS5
cliechti89b4af12002-02-12 23:24:41 +0000333 else:
Chris Liechti984c5c52016-02-15 23:48:45 +0100334 raise ValueError('Invalid char len: {!r}'.format(self._bytesize))
cliechtif0a81d42014-08-04 14:03:53 +0000335 # setup stop bits
Chris Liechti033f17c2015-08-30 21:28:04 +0200336 if self._stopbits == serial.STOPBITS_ONE:
Chris Liechti11465c82015-08-04 15:55:22 +0200337 cflag &= ~(termios.CSTOPB)
Chris Liechti033f17c2015-08-30 21:28:04 +0200338 elif self._stopbits == serial.STOPBITS_ONE_POINT_FIVE:
339 cflag |= (termios.CSTOPB) # XXX same as TWO.. there is no POSIX support for 1.5
340 elif self._stopbits == serial.STOPBITS_TWO:
341 cflag |= (termios.CSTOPB)
cliechti89b4af12002-02-12 23:24:41 +0000342 else:
Chris Liechti984c5c52016-02-15 23:48:45 +0100343 raise ValueError('Invalid stop bit specification: {!r}'.format(self._stopbits))
cliechti58b481c2009-02-16 20:42:32 +0000344 # setup parity
Chris Liechti033f17c2015-08-30 21:28:04 +0200345 iflag &= ~(termios.INPCK | termios.ISTRIP)
346 if self._parity == serial.PARITY_NONE:
347 cflag &= ~(termios.PARENB | termios.PARODD)
348 elif self._parity == serial.PARITY_EVEN:
Chris Liechti11465c82015-08-04 15:55:22 +0200349 cflag &= ~(termios.PARODD)
Chris Liechti033f17c2015-08-30 21:28:04 +0200350 cflag |= (termios.PARENB)
351 elif self._parity == serial.PARITY_ODD:
352 cflag |= (termios.PARENB | termios.PARODD)
353 elif self._parity == serial.PARITY_MARK and plat[:5] == 'linux':
354 cflag |= (termios.PARENB | CMSPAR | termios.PARODD)
355 elif self._parity == serial.PARITY_SPACE and plat[:5] == 'linux':
356 cflag |= (termios.PARENB | CMSPAR)
Chris Liechti11465c82015-08-04 15:55:22 +0200357 cflag &= ~(termios.PARODD)
cliechti89b4af12002-02-12 23:24:41 +0000358 else:
Chris Liechti984c5c52016-02-15 23:48:45 +0100359 raise ValueError('Invalid parity: {!r}'.format(self._parity))
cliechti58b481c2009-02-16 20:42:32 +0000360 # setup flow control
361 # xonxoff
Chris Liechti11465c82015-08-04 15:55:22 +0200362 if hasattr(termios, 'IXANY'):
cliechtid6bf52c2003-10-01 02:28:12 +0000363 if self._xonxoff:
Chris Liechti033f17c2015-08-30 21:28:04 +0200364 iflag |= (termios.IXON | termios.IXOFF) # |termios.IXANY)
cliechti89b4af12002-02-12 23:24:41 +0000365 else:
Chris Liechti033f17c2015-08-30 21:28:04 +0200366 iflag &= ~(termios.IXON | termios.IXOFF | termios.IXANY)
cliechti89b4af12002-02-12 23:24:41 +0000367 else:
cliechtid6bf52c2003-10-01 02:28:12 +0000368 if self._xonxoff:
Chris Liechti033f17c2015-08-30 21:28:04 +0200369 iflag |= (termios.IXON | termios.IXOFF)
cliechti89b4af12002-02-12 23:24:41 +0000370 else:
Chris Liechti033f17c2015-08-30 21:28:04 +0200371 iflag &= ~(termios.IXON | termios.IXOFF)
cliechti58b481c2009-02-16 20:42:32 +0000372 # rtscts
Chris Liechti11465c82015-08-04 15:55:22 +0200373 if hasattr(termios, 'CRTSCTS'):
cliechtid6bf52c2003-10-01 02:28:12 +0000374 if self._rtscts:
Chris Liechti033f17c2015-08-30 21:28:04 +0200375 cflag |= (termios.CRTSCTS)
cliechti89b4af12002-02-12 23:24:41 +0000376 else:
Chris Liechti11465c82015-08-04 15:55:22 +0200377 cflag &= ~(termios.CRTSCTS)
378 elif hasattr(termios, 'CNEW_RTSCTS'): # try it with alternate constant name
cliechtid6bf52c2003-10-01 02:28:12 +0000379 if self._rtscts:
Chris Liechti033f17c2015-08-30 21:28:04 +0200380 cflag |= (termios.CNEW_RTSCTS)
cliechtid4743692002-04-08 22:39:53 +0000381 else:
Chris Liechti11465c82015-08-04 15:55:22 +0200382 cflag &= ~(termios.CNEW_RTSCTS)
cliechti2750b832009-07-28 00:13:52 +0000383 # XXX should there be a warning if setting up rtscts (and xonxoff etc) fails??
cliechti58b481c2009-02-16 20:42:32 +0000384
385 # buffer
cliechtif0a81d42014-08-04 14:03:53 +0000386 # vmin "minimal number of characters to be read. 0 for non blocking"
cliechtid6bf52c2003-10-01 02:28:12 +0000387 if vmin < 0 or vmin > 255:
Chris Liechti984c5c52016-02-15 23:48:45 +0100388 raise ValueError('Invalid vmin: {!r}'.format(vmin))
Chris Liechti11465c82015-08-04 15:55:22 +0200389 cc[termios.VMIN] = vmin
cliechti58b481c2009-02-16 20:42:32 +0000390 # vtime
cliechtid6bf52c2003-10-01 02:28:12 +0000391 if vtime < 0 or vtime > 255:
Chris Liechti984c5c52016-02-15 23:48:45 +0100392 raise ValueError('Invalid vtime: {!r}'.format(vtime))
Chris Liechti11465c82015-08-04 15:55:22 +0200393 cc[termios.VTIME] = vtime
cliechti58b481c2009-02-16 20:42:32 +0000394 # activate settings
Chris Liechti94284702015-11-15 01:21:48 +0100395 if force_update or [iflag, oflag, cflag, lflag, ispeed, ospeed, cc] != orig_attr:
Chris Liechti033f17c2015-08-30 21:28:04 +0200396 termios.tcsetattr(
Chris Liechti9eaa40c2016-02-12 23:32:59 +0100397 self.fd,
398 termios.TCSANOW,
399 [iflag, oflag, cflag, lflag, ispeed, ospeed, cc])
cliechti58b481c2009-02-16 20:42:32 +0000400
cliechtie8c45422008-06-20 23:23:14 +0000401 # apply custom baud rate, if any
402 if custom_baud is not None:
Chris Liechtid6847af2015-08-06 17:54:30 +0200403 self._set_special_baudrate(custom_baud)
404
405 if self._rs485_mode is not None:
406 self._set_rs485_mode(self._rs485_mode)
cliechti89b4af12002-02-12 23:24:41 +0000407
408 def close(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000409 """Close port"""
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200410 if self.is_open:
cliechtic6178262004-03-22 22:04:52 +0000411 if self.fd is not None:
cliechtid6bf52c2003-10-01 02:28:12 +0000412 os.close(self.fd)
413 self.fd = None
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200414 self.is_open = False
cliechtid6bf52c2003-10-01 02:28:12 +0000415
416 # - - - - - - - - - - - - - - - - - - - - - - - -
cliechti95c62212002-03-04 22:17:53 +0000417
Chris Liechtief1fe252015-08-27 23:25:21 +0200418 @property
419 def in_waiting(self):
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200420 """Return the number of bytes currently in the input buffer."""
Chris Liechti11465c82015-08-04 15:55:22 +0200421 #~ s = fcntl.ioctl(self.fd, termios.FIONREAD, TIOCM_zero_str)
cliechtif5831e02002-12-05 23:15:27 +0000422 s = fcntl.ioctl(self.fd, TIOCINQ, TIOCM_zero_str)
Chris Liechti033f17c2015-08-30 21:28:04 +0200423 return struct.unpack('I', s)[0]
cliechti89b4af12002-02-12 23:24:41 +0000424
cliechtia9a093e2010-01-02 03:05:08 +0000425 # select based implementation, proved to work on many systems
426 def read(self, size=1):
cliechti7d448562014-08-03 21:57:45 +0000427 """\
428 Read size bytes from the serial port. If a timeout is set it may
429 return less characters as requested. With no timeout it will block
430 until the requested number of bytes is read.
431 """
Chris Liechti033f17c2015-08-30 21:28:04 +0200432 if not self.is_open:
433 raise portNotOpenError
cliechtia9a093e2010-01-02 03:05:08 +0000434 read = bytearray()
Cristiano De Altic30622f2015-12-12 11:00:01 +0100435 timeout = self._timeout
cliechtia9a093e2010-01-02 03:05:08 +0000436 while len(read) < size:
cliechti8d744de2013-10-11 14:31:13 +0000437 try:
Cristiano De Altic30622f2015-12-12 11:00:01 +0100438 start_time = time.time()
Chris Liechti42ab2b42016-05-15 23:35:05 +0200439 ready, _, _ = select.select([self.fd, self.pipe_abort_read_r], [], [], timeout)
440 if self.pipe_abort_read_r in ready:
441 os.read(self.pipe_abort_read_r, 1)
442 break
cliechti8d744de2013-10-11 14:31:13 +0000443 # If select was used with a timeout, and the timeout occurs, it
444 # returns with empty lists -> thus abort read operation.
Chris Liechti033f17c2015-08-30 21:28:04 +0200445 # For timeout == 0 (non-blocking operation) also abort when
446 # there is nothing to read.
cliechti8d744de2013-10-11 14:31:13 +0000447 if not ready:
448 break # timeout
Chris Liechti033f17c2015-08-30 21:28:04 +0200449 buf = os.read(self.fd, size - len(read))
cliechti8d744de2013-10-11 14:31:13 +0000450 # read should always return some data as select reported it was
451 # ready to read when we get to this point.
452 if not buf:
453 # Disconnected devices, at least on Linux, show the
454 # behavior that they are always ready to read immediately
455 # but reading returns nothing.
Chris Liechti92df95a2016-02-09 23:30:37 +0100456 raise SerialException(
457 'device reports readiness to read but returned no data '
458 '(device disconnected or multiple access on port?)')
cliechti8d744de2013-10-11 14:31:13 +0000459 read.extend(buf)
Cristiano De Altic30622f2015-12-12 11:00:01 +0100460 if timeout is not None:
461 timeout -= time.time() - start_time
462 if timeout <= 0:
463 break
Chris Liechti68340d72015-08-03 14:15:48 +0200464 except OSError as e:
Chris Liechti033f17c2015-08-30 21:28:04 +0200465 # this is for Python 3.x where select.error is a subclass of
466 # OSError ignore EAGAIN errors. all other errors are shown
cliechtic7cd7212014-08-03 21:34:38 +0000467 if e.errno != errno.EAGAIN:
Chris Liechti984c5c52016-02-15 23:48:45 +0100468 raise SerialException('read failed: {}'.format(e))
Chris Liechti68340d72015-08-03 14:15:48 +0200469 except select.error as e:
cliechtic7cd7212014-08-03 21:34:38 +0000470 # this is for Python 2.x
cliechti8d744de2013-10-11 14:31:13 +0000471 # ignore EAGAIN errors. all other errors are shown
472 # see also http://www.python.org/dev/peps/pep-3151/#select
473 if e[0] != errno.EAGAIN:
Chris Liechti984c5c52016-02-15 23:48:45 +0100474 raise SerialException('read failed: {}'.format(e))
cliechtia9a093e2010-01-02 03:05:08 +0000475 return bytes(read)
cliechti89b4af12002-02-12 23:24:41 +0000476
Chris Liechti42ab2b42016-05-15 23:35:05 +0200477 def cancel_read(self):
478 os.write(self.pipe_abort_read_w, b"x")
479
cliechti4a567a02009-07-27 22:09:31 +0000480 def write(self, data):
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200481 """Output the given byte string over the serial port."""
Chris Liechti033f17c2015-08-30 21:28:04 +0200482 if not self.is_open:
483 raise portNotOpenError
cliechti38077122013-10-16 02:57:27 +0000484 d = to_bytes(data)
485 tx_len = len(d)
Robert Smallshire325a7382016-03-25 21:18:38 +0100486 timeout = self._write_timeout
487 if timeout and timeout > 0: # Avoid comparing None with zero
488 timeout += time.time()
cliechti9f7c2352013-10-11 01:13:46 +0000489 while tx_len > 0:
cliechti5d4d0bd2004-11-13 03:27:39 +0000490 try:
cliechti5d4d0bd2004-11-13 03:27:39 +0000491 n = os.write(self.fd, d)
Robert Smallshire325a7382016-03-25 21:18:38 +0100492 if timeout == 0:
493 # Zero timeout indicates non-blocking - simply return the
494 # number of bytes of data actually written
495 return n
496 elif timeout and timeout > 0: # Avoid comparing None with zero
cliechti3cf46d62009-08-07 00:19:57 +0000497 # when timeout is set, use select to wait for being ready
498 # with the time left as timeout
499 timeleft = timeout - time.time()
500 if timeleft < 0:
501 raise writeTimeoutError
502 _, ready, _ = select.select([], [self.fd], [], timeleft)
cliechti5d4d0bd2004-11-13 03:27:39 +0000503 if not ready:
504 raise writeTimeoutError
cliechti88c62442013-10-12 04:03:16 +0000505 else:
Robert Smallshire325a7382016-03-25 21:18:38 +0100506 assert timeout is None
cliechti88c62442013-10-12 04:03:16 +0000507 # wait for write operation
508 _, ready, _ = select.select([], [self.fd], [], None)
509 if not ready:
510 raise SerialException('write failed (select)')
cliechti5d4d0bd2004-11-13 03:27:39 +0000511 d = d[n:]
cliechti9f7c2352013-10-11 01:13:46 +0000512 tx_len -= n
Chris Liechti675f7e12015-08-03 15:48:41 +0200513 except SerialException:
514 raise
Chris Liechti68340d72015-08-03 14:15:48 +0200515 except OSError as v:
cliechti5d4d0bd2004-11-13 03:27:39 +0000516 if v.errno != errno.EAGAIN:
Chris Liechti984c5c52016-02-15 23:48:45 +0100517 raise SerialException('write failed: {}'.format(v))
Chris Liechtic6362db2015-12-13 23:44:35 +0100518 # still calculate and check timeout
519 if timeout and timeout - time.time() < 0:
520 raise writeTimeoutError
cliechtif81362e2009-07-25 03:44:33 +0000521 return len(data)
cliechtid6bf52c2003-10-01 02:28:12 +0000522
cliechtia30a8a02003-10-05 12:28:13 +0000523 def flush(self):
cliechti7d448562014-08-03 21:57:45 +0000524 """\
525 Flush of file like objects. In this case, wait until all data
526 is written.
527 """
Chris Liechti033f17c2015-08-30 21:28:04 +0200528 if not self.is_open:
529 raise portNotOpenError
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200530 termios.tcdrain(self.fd)
cliechtia30a8a02003-10-05 12:28:13 +0000531
Chris Liechtief1fe252015-08-27 23:25:21 +0200532 def reset_input_buffer(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000533 """Clear input buffer, discarding all that is in the buffer."""
Chris Liechti033f17c2015-08-30 21:28:04 +0200534 if not self.is_open:
535 raise portNotOpenError
Chris Liechti11465c82015-08-04 15:55:22 +0200536 termios.tcflush(self.fd, termios.TCIFLUSH)
cliechti89b4af12002-02-12 23:24:41 +0000537
Chris Liechtief1fe252015-08-27 23:25:21 +0200538 def reset_output_buffer(self):
cliechti7d448562014-08-03 21:57:45 +0000539 """\
540 Clear output buffer, aborting the current output and discarding all
541 that is in the buffer.
542 """
Chris Liechti033f17c2015-08-30 21:28:04 +0200543 if not self.is_open:
544 raise portNotOpenError
Chris Liechti11465c82015-08-04 15:55:22 +0200545 termios.tcflush(self.fd, termios.TCOFLUSH)
cliechti89b4af12002-02-12 23:24:41 +0000546
Chris Liechtief1fe252015-08-27 23:25:21 +0200547 def send_break(self, duration=0.25):
cliechti7d448562014-08-03 21:57:45 +0000548 """\
549 Send break condition. Timed, returns to idle state after given
550 duration.
551 """
Chris Liechti033f17c2015-08-30 21:28:04 +0200552 if not self.is_open:
553 raise portNotOpenError
554 termios.tcsendbreak(self.fd, int(duration / 0.25))
cliechti89b4af12002-02-12 23:24:41 +0000555
Chris Liechtief1fe252015-08-27 23:25:21 +0200556 def _update_break_state(self):
cliechti7d448562014-08-03 21:57:45 +0000557 """\
558 Set break: Controls TXD. When active, no transmitting is possible.
559 """
Chris Liechtief1fe252015-08-27 23:25:21 +0200560 if self._break_state:
cliechti997b63c2008-06-21 00:09:31 +0000561 fcntl.ioctl(self.fd, TIOCSBRK)
562 else:
563 fcntl.ioctl(self.fd, TIOCCBRK)
564
Chris Liechtief1fe252015-08-27 23:25:21 +0200565 def _update_rts_state(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000566 """Set terminal status line: Request To Send"""
Chris Liechtif7534c82016-05-07 23:35:54 +0200567 if self._rts_state:
568 fcntl.ioctl(self.fd, TIOCMBIS, TIOCM_RTS_str)
569 else:
570 fcntl.ioctl(self.fd, TIOCMBIC, TIOCM_RTS_str)
cliechtid6bf52c2003-10-01 02:28:12 +0000571
Chris Liechtief1fe252015-08-27 23:25:21 +0200572 def _update_dtr_state(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000573 """Set terminal status line: Data Terminal Ready"""
Chris Liechtif7534c82016-05-07 23:35:54 +0200574 if self._dtr_state:
575 fcntl.ioctl(self.fd, TIOCMBIS, TIOCM_DTR_str)
576 else:
577 fcntl.ioctl(self.fd, TIOCMBIC, TIOCM_DTR_str)
cliechtid6bf52c2003-10-01 02:28:12 +0000578
Chris Liechtief1fe252015-08-27 23:25:21 +0200579 @property
580 def cts(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000581 """Read terminal status line: Clear To Send"""
Chris Liechti033f17c2015-08-30 21:28:04 +0200582 if not self.is_open:
583 raise portNotOpenError
cliechtid6bf52c2003-10-01 02:28:12 +0000584 s = fcntl.ioctl(self.fd, TIOCMGET, TIOCM_zero_str)
Chris Liechti033f17c2015-08-30 21:28:04 +0200585 return struct.unpack('I', s)[0] & TIOCM_CTS != 0
cliechtid6bf52c2003-10-01 02:28:12 +0000586
Chris Liechtief1fe252015-08-27 23:25:21 +0200587 @property
588 def dsr(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000589 """Read terminal status line: Data Set Ready"""
Chris Liechti033f17c2015-08-30 21:28:04 +0200590 if not self.is_open:
591 raise portNotOpenError
cliechtid6bf52c2003-10-01 02:28:12 +0000592 s = fcntl.ioctl(self.fd, TIOCMGET, TIOCM_zero_str)
Chris Liechti033f17c2015-08-30 21:28:04 +0200593 return struct.unpack('I', s)[0] & TIOCM_DSR != 0
cliechtid6bf52c2003-10-01 02:28:12 +0000594
Chris Liechtief1fe252015-08-27 23:25:21 +0200595 @property
596 def ri(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000597 """Read terminal status line: Ring Indicator"""
Chris Liechti033f17c2015-08-30 21:28:04 +0200598 if not self.is_open:
599 raise portNotOpenError
cliechti89b4af12002-02-12 23:24:41 +0000600 s = fcntl.ioctl(self.fd, TIOCMGET, TIOCM_zero_str)
Chris Liechti033f17c2015-08-30 21:28:04 +0200601 return struct.unpack('I', s)[0] & TIOCM_RI != 0
cliechti89b4af12002-02-12 23:24:41 +0000602
Chris Liechtief1fe252015-08-27 23:25:21 +0200603 @property
604 def cd(self):
cliechtid6bf52c2003-10-01 02:28:12 +0000605 """Read terminal status line: Carrier Detect"""
Chris Liechti033f17c2015-08-30 21:28:04 +0200606 if not self.is_open:
607 raise portNotOpenError
cliechti89b4af12002-02-12 23:24:41 +0000608 s = fcntl.ioctl(self.fd, TIOCMGET, TIOCM_zero_str)
Chris Liechti033f17c2015-08-30 21:28:04 +0200609 return struct.unpack('I', s)[0] & TIOCM_CD != 0
cliechti89b4af12002-02-12 23:24:41 +0000610
cliechtia30a8a02003-10-05 12:28:13 +0000611 # - - platform specific - - - -
612
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200613 @property
614 def out_waiting(self):
615 """Return the number of bytes currently in the output buffer."""
Chris Liechti11465c82015-08-04 15:55:22 +0200616 #~ s = fcntl.ioctl(self.fd, termios.FIONREAD, TIOCM_zero_str)
cliechti28b8fd02011-12-28 21:39:42 +0000617 s = fcntl.ioctl(self.fd, TIOCOUTQ, TIOCM_zero_str)
Chris Liechti033f17c2015-08-30 21:28:04 +0200618 return struct.unpack('I', s)[0]
cliechti28b8fd02011-12-28 21:39:42 +0000619
cliechtia30a8a02003-10-05 12:28:13 +0000620 def nonblocking(self):
621 """internal - not portable!"""
Chris Liechti033f17c2015-08-30 21:28:04 +0200622 if not self.is_open:
623 raise portNotOpenError
Chris Liechti11465c82015-08-04 15:55:22 +0200624 fcntl.fcntl(self.fd, fcntl.F_SETFL, os.O_NONBLOCK)
cliechtia30a8a02003-10-05 12:28:13 +0000625
cliechti8753bbc2005-01-15 20:32:51 +0000626 def fileno(self):
cliechti2f0f8a32011-12-28 22:10:00 +0000627 """\
628 For easier use of the serial port instance with select.
629 WARNING: this function is not portable to different platforms!
630 """
Chris Liechti033f17c2015-08-30 21:28:04 +0200631 if not self.is_open:
632 raise portNotOpenError
cliechti8753bbc2005-01-15 20:32:51 +0000633 return self.fd
cliechti89b4af12002-02-12 23:24:41 +0000634
Chris Liechti518b0d32015-08-30 02:20:39 +0200635 def set_input_flow_control(self, enable=True):
cliechti2f0f8a32011-12-28 22:10:00 +0000636 """\
637 Manually control flow - when software flow control is enabled.
Chris Liechti3ad62fb2015-08-29 21:53:32 +0200638 This will send XON (true) or XOFF (false) to the other device.
cliechti2f0f8a32011-12-28 22:10:00 +0000639 WARNING: this function is not portable to different platforms!
640 """
Chris Liechti033f17c2015-08-30 21:28:04 +0200641 if not self.is_open:
642 raise portNotOpenError
cliechti4a601342011-12-29 02:22:17 +0000643 if enable:
Chris Liechti11465c82015-08-04 15:55:22 +0200644 termios.tcflow(self.fd, termios.TCION)
cliechti57e48a62009-08-03 22:29:58 +0000645 else:
Chris Liechti11465c82015-08-04 15:55:22 +0200646 termios.tcflow(self.fd, termios.TCIOFF)
cliechti57e48a62009-08-03 22:29:58 +0000647
Chris Liechti518b0d32015-08-30 02:20:39 +0200648 def set_output_flow_control(self, enable=True):
cliechti2f0f8a32011-12-28 22:10:00 +0000649 """\
650 Manually control flow of outgoing data - when hardware or software flow
651 control is enabled.
652 WARNING: this function is not portable to different platforms!
653 """
Chris Liechti033f17c2015-08-30 21:28:04 +0200654 if not self.is_open:
655 raise portNotOpenError
cliechti2f0f8a32011-12-28 22:10:00 +0000656 if enable:
Chris Liechti11465c82015-08-04 15:55:22 +0200657 termios.tcflow(self.fd, termios.TCOON)
cliechti2f0f8a32011-12-28 22:10:00 +0000658 else:
Chris Liechti11465c82015-08-04 15:55:22 +0200659 termios.tcflow(self.fd, termios.TCOOFF)
cliechti2f0f8a32011-12-28 22:10:00 +0000660
cliechtif81362e2009-07-25 03:44:33 +0000661
cliechtia9a093e2010-01-02 03:05:08 +0000662class PosixPollSerial(Serial):
cliechti7d448562014-08-03 21:57:45 +0000663 """\
cliechtif0a81d42014-08-04 14:03:53 +0000664 Poll based read implementation. Not all systems support poll properly.
665 However this one has better handling of errors, such as a device
cliechti7d448562014-08-03 21:57:45 +0000666 disconnecting while it's in use (e.g. USB-serial unplugged).
667 """
cliechtia9a093e2010-01-02 03:05:08 +0000668
669 def read(self, size=1):
cliechti7d448562014-08-03 21:57:45 +0000670 """\
671 Read size bytes from the serial port. If a timeout is set it may
672 return less characters as requested. With no timeout it will block
673 until the requested number of bytes is read.
674 """
Chris Liechtiacac2362016-03-29 22:37:48 +0200675 if not self.is_open:
Chris Liechti033f17c2015-08-30 21:28:04 +0200676 raise portNotOpenError
cliechtia9a093e2010-01-02 03:05:08 +0000677 read = bytearray()
678 poll = select.poll()
Chris Liechti033f17c2015-08-30 21:28:04 +0200679 poll.register(self.fd, select.POLLIN | select.POLLERR | select.POLLHUP | select.POLLNVAL)
cliechtia9a093e2010-01-02 03:05:08 +0000680 if size > 0:
681 while len(read) < size:
682 # print "\tread(): size",size, "have", len(read) #debug
683 # wait until device becomes ready to read (or something fails)
Chris Liechti033f17c2015-08-30 21:28:04 +0200684 for fd, event in poll.poll(self._timeout * 1000):
685 if event & (select.POLLERR | select.POLLHUP | select.POLLNVAL):
cliechtia9a093e2010-01-02 03:05:08 +0000686 raise SerialException('device reports error (poll)')
687 # we don't care if it is select.POLLIN or timeout, that's
688 # handled below
689 buf = os.read(self.fd, size - len(read))
690 read.extend(buf)
Chris Liechti518b0d32015-08-30 02:20:39 +0200691 if ((self._timeout is not None and self._timeout >= 0) or
Chris Liechti033f17c2015-08-30 21:28:04 +0200692 (self._inter_byte_timeout is not None and self._inter_byte_timeout > 0)) and not buf:
cliechtia9a093e2010-01-02 03:05:08 +0000693 break # early abort on timeout
694 return bytes(read)
695
cliechtif81362e2009-07-25 03:44:33 +0000696
Chris Liechti4cf54702015-10-18 00:21:56 +0200697class VTIMESerial(Serial):
698 """\
699 Implement timeout using vtime of tty device instead of using select.
700 This means that no inter character timeout can be specified and that
701 the error handling is degraded.
702
703 Overall timeout is disabled when inter-character timeout is used.
704 """
705
Chris Liechti94284702015-11-15 01:21:48 +0100706 def _reconfigure_port(self, force_update=True):
Chris Liechti4cf54702015-10-18 00:21:56 +0200707 """Set communication parameters on opened port."""
708 super(VTIMESerial, self)._reconfigure_port()
Chris Liechtid6bcaaf2016-02-01 22:55:26 +0100709 fcntl.fcntl(self.fd, fcntl.F_SETFL, 0) # clear O_NONBLOCK
Chris Liechti4cf54702015-10-18 00:21:56 +0200710
711 if self._inter_byte_timeout is not None:
712 vmin = 1
713 vtime = int(self._inter_byte_timeout * 10)
714 else:
715 vmin = 0
716 vtime = int(self._timeout * 10)
717 try:
718 orig_attr = termios.tcgetattr(self.fd)
719 iflag, oflag, cflag, lflag, ispeed, ospeed, cc = orig_attr
720 except termios.error as msg: # if a port is nonexistent but has a /dev file, it'll fail here
Chris Liechti984c5c52016-02-15 23:48:45 +0100721 raise serial.SerialException("Could not configure port: {}".format(msg))
Chris Liechti4cf54702015-10-18 00:21:56 +0200722
723 if vtime < 0 or vtime > 255:
Chris Liechti984c5c52016-02-15 23:48:45 +0100724 raise ValueError('Invalid vtime: {!r}'.format(vtime))
Chris Liechti4cf54702015-10-18 00:21:56 +0200725 cc[termios.VTIME] = vtime
726 cc[termios.VMIN] = vmin
727
728 termios.tcsetattr(
729 self.fd,
730 termios.TCSANOW,
731 [iflag, oflag, cflag, lflag, ispeed, ospeed, cc])
732
Chris Liechti4cf54702015-10-18 00:21:56 +0200733 def read(self, size=1):
734 """\
735 Read size bytes from the serial port. If a timeout is set it may
736 return less characters as requested. With no timeout it will block
737 until the requested number of bytes is read.
738 """
739 if not self.is_open:
740 raise portNotOpenError
741 read = bytearray()
742 while len(read) < size:
743 buf = os.read(self.fd, size - len(read))
744 if not buf:
745 break
746 read.extend(buf)
747 return bytes(read)