diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonDeviceInterface.html
--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonDeviceInterface.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonDeviceInterface.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonDeviceInterface</h1>
-
<p>
Module implementing an interface base class to talk to a connected MicroPython device.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonDeviceInterface">MicroPythonDeviceInterface</a></td>
<td>Class implementing an interface to talk to a connected MicroPython device.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MicroPythonDeviceInterface" ID="MicroPythonDeviceInterface"></a>
<h2>MicroPythonDeviceInterface</h2>
-
<p>
Class implementing an interface to talk to a connected MicroPython device.
</p>
+
<h3>Signals</h3>
<dl>
@@ -59,19 +58,18 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>PasteModePrompt</td></tr>
+<tr><td>TracebackMarker</td></tr>
+</table>
-<table>
-<tr><td>PasteModePrompt</td></tr><tr><td>TracebackMarker</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonDeviceInterface.__init__">MicroPythonDeviceInterface</a></td>
<td>Constructor</td>
@@ -109,19 +107,20 @@
<td>Public method to write data to the connected device.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MicroPythonDeviceInterface.__init__" ID="MicroPythonDeviceInterface.__init__"></a>
<h4>MicroPythonDeviceInterface (Constructor)</h4>
<b>MicroPythonDeviceInterface</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -132,10 +131,10 @@
<a NAME="MicroPythonDeviceInterface.connectToDevice" ID="MicroPythonDeviceInterface.connectToDevice"></a>
<h4>MicroPythonDeviceInterface.connectToDevice</h4>
<b>connectToDevice</b>(<i>connection</i>)
-
<p>
Public method to connect to the device.
</p>
+
<dl>
<dt><i>connection</i> (str)</dt>
@@ -166,10 +165,10 @@
<a NAME="MicroPythonDeviceInterface.disconnectFromDevice" ID="MicroPythonDeviceInterface.disconnectFromDevice"></a>
<h4>MicroPythonDeviceInterface.disconnectFromDevice</h4>
<b>disconnectFromDevice</b>(<i></i>)
-
<p>
Public slot to disconnect from the device.
</p>
+
<dl>
<dt>Raises <b>NotImplementedError</b>:</dt>
@@ -181,7 +180,6 @@
<a NAME="MicroPythonDeviceInterface.execute" ID="MicroPythonDeviceInterface.execute"></a>
<h4>MicroPythonDeviceInterface.execute</h4>
<b>execute</b>(<i>commands, *, mode="raw", timeout=0</i>)
-
<p>
Public method to send commands to the connected device and return the
result.
@@ -189,6 +187,7 @@
<p>
If no connection is available, empty results will be returned.
</p>
+
<dl>
<dt><i>commands</i> (str or list of str)</dt>
@@ -233,11 +232,11 @@
<a NAME="MicroPythonDeviceInterface.executeAsync" ID="MicroPythonDeviceInterface.executeAsync"></a>
<h4>MicroPythonDeviceInterface.executeAsync</h4>
<b>executeAsync</b>(<i>commandsList, submitMode</i>)
-
<p>
Public method to execute a series of commands over a period of time
without returning any result (asynchronous execution).
</p>
+
<dl>
<dt><i>commandsList</i> (list of str)</dt>
@@ -265,17 +264,17 @@
<a NAME="MicroPythonDeviceInterface.handlePreferencesChanged" ID="MicroPythonDeviceInterface.handlePreferencesChanged"></a>
<h4>MicroPythonDeviceInterface.handlePreferencesChanged</h4>
<b>handlePreferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle a change of the preferences.
</p>
+
<a NAME="MicroPythonDeviceInterface.isConnected" ID="MicroPythonDeviceInterface.isConnected"></a>
<h4>MicroPythonDeviceInterface.isConnected</h4>
<b>isConnected</b>(<i></i>)
-
<p>
Public method to get the connection status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -299,7 +298,6 @@
<a NAME="MicroPythonDeviceInterface.probeDevice" ID="MicroPythonDeviceInterface.probeDevice"></a>
<h4>MicroPythonDeviceInterface.probeDevice</h4>
<b>probeDevice</b>(<i></i>)
-
<p>
Public method to check the device is responding.
</p>
@@ -307,6 +305,7 @@
If the device has not been flashed with a MicroPython firmware, the
probe will fail.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -330,10 +329,10 @@
<a NAME="MicroPythonDeviceInterface.write" ID="MicroPythonDeviceInterface.write"></a>
<h4>MicroPythonDeviceInterface.write</h4>
<b>write</b>(<i>data</i>)
-
<p>
Public method to write data to the connected device.
</p>
+
<dl>
<dt><i>data</i> (bytes or bytearray)</dt>
@@ -351,4 +350,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
