--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonSerialPort.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonSerialPort.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,55 +7,52 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonSerialPort</h1>
-
<p>
Module implementing a QSerialPort with additional functionality for
MicroPython devices.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonSerialPort">MicroPythonSerialPort</a></td>
<td>Class implementing a QSerialPort with additional functionality for MicroPython devices.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MicroPythonSerialPort" ID="MicroPythonSerialPort"></a>
<h2>MicroPythonSerialPort</h2>
-
<p>
Class implementing a QSerialPort with additional functionality for
MicroPython devices.
</p>
+
<h3>Derived from</h3>
QSerialPort
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonSerialPort.__init__">MicroPythonSerialPort</a></td>
<td>Constructor</td>
@@ -85,19 +82,20 @@
<td>Public method to set the timeout for device operations.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MicroPythonSerialPort.__init__" ID="MicroPythonSerialPort.__init__"></a>
<h4>MicroPythonSerialPort (Constructor)</h4>
<b>MicroPythonSerialPort</b>(<i>timeout=10000, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>timeout</i> (int)</dt>
@@ -112,17 +110,17 @@
<a NAME="MicroPythonSerialPort.closeSerialLink" ID="MicroPythonSerialPort.closeSerialLink"></a>
<h4>MicroPythonSerialPort.closeSerialLink</h4>
<b>closeSerialLink</b>(<i></i>)
-
<p>
Public method to close the open serial connection.
</p>
+
<a NAME="MicroPythonSerialPort.hasTimedOut" ID="MicroPythonSerialPort.hasTimedOut"></a>
<h4>MicroPythonSerialPort.hasTimedOut</h4>
<b>hasTimedOut</b>(<i></i>)
-
<p>
Public method to check, if the last 'readUntil' has timed out.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -138,10 +136,10 @@
<a NAME="MicroPythonSerialPort.isConnected" ID="MicroPythonSerialPort.isConnected"></a>
<h4>MicroPythonSerialPort.isConnected</h4>
<b>isConnected</b>(<i></i>)
-
<p>
Public method to get the connection state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -157,10 +155,10 @@
<a NAME="MicroPythonSerialPort.openSerialLink" ID="MicroPythonSerialPort.openSerialLink"></a>
<h4>MicroPythonSerialPort.openSerialLink</h4>
<b>openSerialLink</b>(<i>port</i>)
-
<p>
Public method to open a serial link to a given serial port.
</p>
+
<dl>
<dt><i>port</i> (str)</dt>
@@ -183,11 +181,11 @@
<a NAME="MicroPythonSerialPort.readUntil" ID="MicroPythonSerialPort.readUntil"></a>
<h4>MicroPythonSerialPort.readUntil</h4>
<b>readUntil</b>(<i>expected=b"\n", size=None, timeout=0</i>)
-
<p>
Public method to read data until an expected sequence is found
(default: \n) or a specific size is exceeded.
</p>
+
<dl>
<dt><i>expected</i> (bytes)</dt>
@@ -219,10 +217,10 @@
<a NAME="MicroPythonSerialPort.setTimeout" ID="MicroPythonSerialPort.setTimeout"></a>
<h4>MicroPythonSerialPort.setTimeout</h4>
<b>setTimeout</b>(<i>timeout</i>)
-
<p>
Public method to set the timeout for device operations.
</p>
+
<dl>
<dt><i>timeout</i> (int)</dt>
@@ -232,4 +230,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
