diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplDeviceInterface.html
--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplDeviceInterface.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplDeviceInterface.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,55 +7,52 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonWebreplDeviceInterface</h1>
-
<p>
Module implementing an interface to talk to a connected MicroPython device via
a webrepl connection.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonWebreplDeviceInterface">MicroPythonWebreplDeviceInterface</a></td>
<td>Class implementing an interface to talk to a connected MicroPython device via a webrepl connection.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MicroPythonWebreplDeviceInterface" ID="MicroPythonWebreplDeviceInterface"></a>
<h2>MicroPythonWebreplDeviceInterface</h2>
-
<p>
Class implementing an interface to talk to a connected MicroPython device via
a webrepl connection.
</p>
+
<h3>Derived from</h3>
MicroPythonDeviceInterface
<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="#MicroPythonWebreplDeviceInterface.__init__">MicroPythonWebreplDeviceInterface</a></td>
<td>Constructor</td>
@@ -109,19 +106,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="MicroPythonWebreplDeviceInterface.__init__" ID="MicroPythonWebreplDeviceInterface.__init__"></a>
<h4>MicroPythonWebreplDeviceInterface (Constructor)</h4>
<b>MicroPythonWebreplDeviceInterface</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -132,20 +130,20 @@
<a NAME="MicroPythonWebreplDeviceInterface.__pasteOff" ID="MicroPythonWebreplDeviceInterface.__pasteOff"></a>
<h4>MicroPythonWebreplDeviceInterface.__pasteOff</h4>
<b>__pasteOff</b>(<i></i>)
-
<p>
Private method to switch 'paste' mode off.
</p>
+
<a NAME="MicroPythonWebreplDeviceInterface.__pasteOn" ID="MicroPythonWebreplDeviceInterface.__pasteOn"></a>
<h4>MicroPythonWebreplDeviceInterface.__pasteOn</h4>
<b>__pasteOn</b>(<i></i>)
-
<p>
Private method to switch the connected device to 'paste' mode.
</p>
<p>
Note: switching to paste mode is done with synchronous writes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -161,25 +159,25 @@
<a NAME="MicroPythonWebreplDeviceInterface.__readAll" ID="MicroPythonWebreplDeviceInterface.__readAll"></a>
<h4>MicroPythonWebreplDeviceInterface.__readAll</h4>
<b>__readAll</b>(<i></i>)
-
<p>
Private method to read all data and emit it for further processing.
</p>
+
<a NAME="MicroPythonWebreplDeviceInterface.__readSocket" ID="MicroPythonWebreplDeviceInterface.__readSocket"></a>
<h4>MicroPythonWebreplDeviceInterface.__readSocket</h4>
<b>__readSocket</b>(<i></i>)
-
<p>
Private slot to read all available data and emit it with the
"dataReceived" signal for further processing.
</p>
+
<a NAME="MicroPythonWebreplDeviceInterface.connectToDevice" ID="MicroPythonWebreplDeviceInterface.connectToDevice"></a>
<h4>MicroPythonWebreplDeviceInterface.connectToDevice</h4>
<b>connectToDevice</b>(<i>connection</i>)
-
<p>
Public method to connect to the device.
</p>
+
<dl>
<dt><i>connection</i> (str)</dt>
@@ -203,18 +201,18 @@
<a NAME="MicroPythonWebreplDeviceInterface.disconnectFromDevice" ID="MicroPythonWebreplDeviceInterface.disconnectFromDevice"></a>
<h4>MicroPythonWebreplDeviceInterface.disconnectFromDevice</h4>
<b>disconnectFromDevice</b>(<i></i>)
-
<p>
Public slot to disconnect from the device.
</p>
+
<a NAME="MicroPythonWebreplDeviceInterface.execute" ID="MicroPythonWebreplDeviceInterface.execute"></a>
<h4>MicroPythonWebreplDeviceInterface.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.
</p>
+
<dl>
<dt><i>commands</i> (str or list of str)</dt>
@@ -247,11 +245,11 @@
<a NAME="MicroPythonWebreplDeviceInterface.executeAsync" ID="MicroPythonWebreplDeviceInterface.executeAsync"></a>
<h4>MicroPythonWebreplDeviceInterface.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>
@@ -266,17 +264,17 @@
<a NAME="MicroPythonWebreplDeviceInterface.handlePreferencesChanged" ID="MicroPythonWebreplDeviceInterface.handlePreferencesChanged"></a>
<h4>MicroPythonWebreplDeviceInterface.handlePreferencesChanged</h4>
<b>handlePreferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle a change of the preferences.
</p>
+
<a NAME="MicroPythonWebreplDeviceInterface.isConnected" ID="MicroPythonWebreplDeviceInterface.isConnected"></a>
<h4>MicroPythonWebreplDeviceInterface.isConnected</h4>
<b>isConnected</b>(<i></i>)
-
<p>
Public method to get the connection status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -292,7 +290,6 @@
<a NAME="MicroPythonWebreplDeviceInterface.probeDevice" ID="MicroPythonWebreplDeviceInterface.probeDevice"></a>
<h4>MicroPythonWebreplDeviceInterface.probeDevice</h4>
<b>probeDevice</b>(<i></i>)
-
<p>
Public method to check the device is responding.
</p>
@@ -300,6 +297,7 @@
If the device has not been flashed with a MicroPython firmware, the
probe will fail.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -315,10 +313,10 @@
<a NAME="MicroPythonWebreplDeviceInterface.write" ID="MicroPythonWebreplDeviceInterface.write"></a>
<h4>MicroPythonWebreplDeviceInterface.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>
@@ -328,4 +326,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
