api change: provide control lines as properties, rename flush* and other functions
- flushInput() -> reset_input_buffer()
- flushOuput() -> reset_output_buffer()
- inWaiting -> in_waiting
- getCD()/getRI()/getDSR() -> cd/ri/dsr
- setRTS()/setDTR() -> rts/dtr
- sendBreak() -> send_break()
- setBreak() -> break_condition
rts and dtr can now be read back and can be set before opening the port
(and some platforms are able to apply the contol without a glitch on open)
the old functions are still available and going to be deprecated.
diff --git a/serial/urlhandler/protocol_loop.py b/serial/urlhandler/protocol_loop.py
index 10dedeb..a3bfbc9 100644
--- a/serial/urlhandler/protocol_loop.py
+++ b/serial/urlhandler/protocol_loop.py
@@ -58,8 +58,6 @@
raise SerialException("Port is already open.")
self.logger = None
self.queue = queue.Queue(self.buffer_size)
- self.cts = False
- self.dsr = False
if self._port is None:
raise SerialException("Port must be configured before it can be used.")
@@ -71,11 +69,12 @@
self._reconfigurePort()
# all things set up get, now a clean start
self._isOpen = True
+ if not self.dsrdtr:
+ self._update_dtr_state()
if not self._rtscts:
- self.setRTS(True)
- self.setDTR(True)
- self.flushInput()
- self.flushOutput()
+ self._update_rts_state()
+ self.reset_input_buffer()
+ self.reset_output_buffer()
def close(self):
self.queue.put(None)
@@ -119,7 +118,8 @@
# - - - - - - - - - - - - - - - - - - - - - - - -
- def inWaiting(self):
+ @property
+ def in_waiting(self):
"""Return the number of characters currently in the input buffer."""
if not self._isOpen: raise portNotOpenError
if self.logger:
@@ -172,7 +172,7 @@
self.queue.put(byte, timeout=self._writeTimeout)
return len(data)
- def flushInput(self):
+ def reset_input_buffer(self):
"""Clear input buffer, discarding all that is in the buffer."""
if not self._isOpen: raise portNotOpenError
if self.logger:
@@ -183,7 +183,7 @@
except queue.Empty:
pass
- def flushOutput(self):
+ def reset_output_buffer(self):
"""\
Clear output buffer, aborting the current output and
discarding all that is in the buffer.
@@ -197,59 +197,49 @@
except queue.Empty:
pass
- def sendBreak(self, duration=0.25):
- """\
- Send break condition. Timed, returns to idle state after given
- duration.
- """
- if not self._isOpen: raise portNotOpenError
- time.sleep(duration)
-
- def setBreak(self, level=True):
+ def _update_break_state(self):
"""\
Set break: Controls TXD. When active, to transmitting is
possible.
"""
- if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('setBreak(%r)' % (level,))
+ self.logger.info('setBreak(%r)' % (self._break_state,))
- def setRTS(self, level=True):
+ def _update_rts_state(self):
"""Set terminal status line: Request To Send"""
- if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('setRTS(%r) -> state of CTS' % (level,))
- self.cts = level
+ self.logger.info('setRTS(%r) -> state of CTS' % (self._rts_state,))
- def setDTR(self, level=True):
+ def _update_dtr_state(self):
"""Set terminal status line: Data Terminal Ready"""
- if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('setDTR(%r) -> state of DSR' % (level,))
- self.dsr = level
+ self.logger.info('setDTR(%r) -> state of DSR' % (self._dtr_state,))
- def getCTS(self):
+ @property
+ def cts(self):
"""Read terminal status line: Clear To Send"""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('getCTS() -> state of RTS (%r)' % (self.cts,))
- return self.cts
+ self.logger.info('getCTS() -> state of RTS (%r)' % (self._rts_state,))
+ return self._rts_state
- def getDSR(self):
+ @property
+ def dsr(self):
"""Read terminal status line: Data Set Ready"""
- if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('getDSR() -> state of DTR (%r)' % (self.dsr,))
- return self.dsr
+ self.logger.info('getDSR() -> state of DTR (%r)' % (self._dtr_state,))
+ return self._dtr_state
- def getRI(self):
+ @property
+ def ri(self):
"""Read terminal status line: Ring Indicator"""
if not self._isOpen: raise portNotOpenError
if self.logger:
self.logger.info('returning dummy for getRI()')
return False
- def getCD(self):
+ @property
+ def cd(self):
"""Read terminal status line: Carrier Detect"""
if not self._isOpen: raise portNotOpenError
if self.logger:
diff --git a/serial/urlhandler/protocol_socket.py b/serial/urlhandler/protocol_socket.py
index 3dedb48..c0e3dfb 100644
--- a/serial/urlhandler/protocol_socket.py
+++ b/serial/urlhandler/protocol_socket.py
@@ -67,11 +67,12 @@
self._reconfigurePort()
# all things set up get, now a clean start
self._isOpen = True
+ if not self.dsrdtr:
+ self._update_dtr_state()
if not self._rtscts:
- self.setRTS(True)
- self.setDTR(True)
- self.flushInput()
- self.flushOutput()
+ self._update_rts_state()
+ self.reset_input_buffer()
+ self.reset_output_buffer()
def _reconfigurePort(self):
"""\
@@ -125,7 +126,8 @@
# - - - - - - - - - - - - - - - - - - - - - - - -
- def inWaiting(self):
+ @property
+ def in_waiting(self):
"""Return the number of characters currently in the input buffer."""
if not self._isOpen: raise portNotOpenError
# Poll the socket to see if it is ready for reading.
@@ -180,75 +182,76 @@
raise SerialException("socket connection failed: %s" % e)
return len(data)
- def flushInput(self):
+ def reset_input_buffer(self):
"""Clear input buffer, discarding all that is in the buffer."""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('ignored flushInput')
+ self.logger.info('ignored reset_input_buffer')
- def flushOutput(self):
+ def reset_output_buffer(self):
"""\
Clear output buffer, aborting the current output and
discarding all that is in the buffer.
"""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('ignored flushOutput')
+ self.logger.info('ignored reset_output_buffer')
- def sendBreak(self, duration=0.25):
+ def send_break(self, duration=0.25):
"""\
Send break condition. Timed, returns to idle state after given
duration.
"""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('ignored sendBreak(%r)' % (duration,))
+ self.logger.info('ignored send_break(%r)' % (duration,))
- def setBreak(self, level=True):
+ def _update_break_state(self):
"""Set break: Controls TXD. When active, to transmitting is
possible."""
- if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('ignored setBreak(%r)' % (level,))
+ self.logger.info('ignored _update_break_state(%r)' % (self._break_state,))
- def setRTS(self, level=True):
+ def _update_rts_state(self):
"""Set terminal status line: Request To Send"""
- if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('ignored setRTS(%r)' % (level,))
+ self.logger.info('ignored _update_rts_state(%r)' % (self._rts_state,))
- def setDTR(self, level=True):
+ def _update_dtr_state(self):
"""Set terminal status line: Data Terminal Ready"""
- if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('ignored setDTR(%r)' % (level,))
+ self.logger.info('ignored _update_dtr_state(%r)' % (self._dtr_state,))
- def getCTS(self):
+ @property
+ def cts(self):
"""Read terminal status line: Clear To Send"""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('returning dummy for getCTS()')
+ self.logger.info('returning dummy for cts')
return True
- def getDSR(self):
+ @property
+ def dsr(self):
"""Read terminal status line: Data Set Ready"""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('returning dummy for getDSR()')
+ self.logger.info('returning dummy for dsr')
return True
- def getRI(self):
+ @property
+ def ri(self):
"""Read terminal status line: Ring Indicator"""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('returning dummy for getRI()')
+ self.logger.info('returning dummy for ri')
return False
- def getCD(self):
+ @property
+ def cd(self):
"""Read terminal status line: Carrier Detect"""
if not self._isOpen: raise portNotOpenError
if self.logger:
- self.logger.info('returning dummy for getCD()')
+ self.logger.info('returning dummy for cd)')
return True
# - - - platform specific - - -
diff --git a/serial/urlhandler/protocol_spy.py b/serial/urlhandler/protocol_spy.py
index a1993e7..f52b7fe 100644
--- a/serial/urlhandler/protocol_spy.py
+++ b/serial/urlhandler/protocol_spy.py
@@ -196,58 +196,65 @@
self.formatter.rx(rx)
return rx
-
- def inWaiting(self):
- n = super(Serial, self).inWaiting()
+ @property
+ def in_waiting(self):
+ n = super(Serial, self).in_waiting
if self.show_all:
- self.formatter.control('Q-RX', 'inWaiting -> {}'.format(n))
+ self.formatter.control('Q-RX', 'in_waiting -> {}'.format(n))
return n
def flush(self):
self.formatter.control('Q-TX', 'flush')
super(Serial, self).flush()
- def flushInput(self):
- self.formatter.control('Q-RX', 'flushInput')
- super(Serial, self).flushInput()
+ def reset_input_buffer(self):
+ self.formatter.control('Q-RX', 'reset_input_buffer')
+ super(Serial, self).reset_input_buffer()
- def flushOutput(self):
- self.formatter.control('Q-TX', 'flushOutput')
- super(Serial, self).flushOutput()
+ def reset_output_buffer(self):
+ self.formatter.control('Q-TX', 'reset_output_buffer')
+ super(Serial, self).reset_output_buffer()
- def sendBreak(self, duration=0.25):
- self.formatter.control('BRK', 'sendBreak {}s'.format(duration))
- super(Serial, self).sendBreak(duration)
+ def send_break(self, duration=0.25):
+ self.formatter.control('BRK', 'send_break {}s'.format(duration))
+ super(Serial, self).send_break(duration)
- def setBreak(self, level=1):
+ @serial.Serial.break_condition.setter
+ def break_condition(self, level):
self.formatter.control('BRK', 'active' if level else 'inactive')
- super(Serial, self).setBreak(level)
+ serial.Serial.break_condition.__set__(self, level)
- def setRTS(self, level=1):
+ @serial.Serial.rts.setter
+ def rts(self, level):
self.formatter.control('RTS', 'active' if level else 'inactive')
- super(Serial, self).setRTS(level)
+ serial.Serial.rts.__set__(self, level)
- def setDTR(self, level=1):
+ @serial.Serial.dtr.setter
+ def dtr(self, level):
self.formatter.control('DTR', 'active' if level else 'inactive')
- super(Serial, self).setDTR(level)
+ serial.Serial.dtr.__set__(self, level)
- def getCTS(self):
- level = super(Serial, self).getCTS()
+ @serial.Serial.cts.getter
+ def cts(self):
+ level = super(Serial, self).cts
self.formatter.control('CTS', 'active' if level else 'inactive')
return level
- def getDSR(self):
- level = super(Serial, self).getDSR()
+ @serial.Serial.dsr.getter
+ def dsr(self):
+ level = super(Serial, self).dsr
self.formatter.control('DSR', 'active' if level else 'inactive')
return level
- def getRI(self):
- level = super(Serial, self).getRI()
+ @serial.Serial.ri.getter
+ def ri(self):
+ level = super(Serial, self).ri
self.formatter.control('RI', 'active' if level else 'inactive')
return level
- def getCD(self):
- level = super(Serial, self).getCD()
+ @serial.Serial.cd.getter
+ def cd(self):
+ level = super(Serial, self).cd
self.formatter.control('CD', 'active' if level else 'inactive')
return level