--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonSerialDeviceInterface.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonSerialDeviceInterface.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,55 +7,52 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonSerialDeviceInterface</h1>
-
<p>
Module implementing an interface to talk to a connected MicroPython device via
a serial link.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonSerialDeviceInterface">MicroPythonSerialDeviceInterface</a></td>
<td>Class implementing an interface to talk to a connected MicroPython device via a serial link.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MicroPythonSerialDeviceInterface" ID="MicroPythonSerialDeviceInterface"></a>
<h2>MicroPythonSerialDeviceInterface</h2>
-
<p>
Class implementing an interface to talk to a connected MicroPython device via
a serial link.
</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="#MicroPythonSerialDeviceInterface.__init__">MicroPythonSerialDeviceInterface</a></td>
<td>Constructor</td>
@@ -129,19 +126,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="MicroPythonSerialDeviceInterface.__init__" ID="MicroPythonSerialDeviceInterface.__init__"></a>
<h4>MicroPythonSerialDeviceInterface (Constructor)</h4>
<b>MicroPythonSerialDeviceInterface</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -152,11 +150,11 @@
<a NAME="MicroPythonSerialDeviceInterface.__executeAsyncPaste" ID="MicroPythonSerialDeviceInterface.__executeAsyncPaste"></a>
<h4>MicroPythonSerialDeviceInterface.__executeAsyncPaste</h4>
<b>__executeAsyncPaste</b>(<i>commandsList</i>)
-
<p>
Private 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>
@@ -167,11 +165,11 @@
<a NAME="MicroPythonSerialDeviceInterface.__executeAsyncRaw" ID="MicroPythonSerialDeviceInterface.__executeAsyncRaw"></a>
<h4>MicroPythonSerialDeviceInterface.__executeAsyncRaw</h4>
<b>__executeAsyncRaw</b>(<i>commandsList</i>)
-
<p>
Private 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 bytes)</dt>
@@ -182,7 +180,6 @@
<a NAME="MicroPythonSerialDeviceInterface.__execute_paste" ID="MicroPythonSerialDeviceInterface.__execute_paste"></a>
<h4>MicroPythonSerialDeviceInterface.__execute_paste</h4>
<b>__execute_paste</b>(<i>commands, timeout=0</i>)
-
<p>
Private method to send commands to the connected device using 'paste' mode
and return the result.
@@ -190,6 +187,7 @@
<p>
If no serial connection is available, empty results will be returned.
</p>
+
<dl>
<dt><i>commands</i> (str or list of str)</dt>
@@ -217,7 +215,6 @@
<a NAME="MicroPythonSerialDeviceInterface.__execute_raw" ID="MicroPythonSerialDeviceInterface.__execute_raw"></a>
<h4>MicroPythonSerialDeviceInterface.__execute_raw</h4>
<b>__execute_raw</b>(<i>commands, timeout=0</i>)
-
<p>
Private method to send commands to the connected device using 'raw REPL' mode
and return the result.
@@ -225,6 +222,7 @@
<p>
If no serial connection is available, empty results will be returned.
</p>
+
<dl>
<dt><i>commands</i> (str or list of str)</dt>
@@ -252,20 +250,20 @@
<a NAME="MicroPythonSerialDeviceInterface.__pasteOff" ID="MicroPythonSerialDeviceInterface.__pasteOff"></a>
<h4>MicroPythonSerialDeviceInterface.__pasteOff</h4>
<b>__pasteOff</b>(<i></i>)
-
<p>
Private method to switch 'paste' mode off.
</p>
+
<a NAME="MicroPythonSerialDeviceInterface.__pasteOn" ID="MicroPythonSerialDeviceInterface.__pasteOn"></a>
<h4>MicroPythonSerialDeviceInterface.__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>
@@ -281,20 +279,20 @@
<a NAME="MicroPythonSerialDeviceInterface.__rawOff" ID="MicroPythonSerialDeviceInterface.__rawOff"></a>
<h4>MicroPythonSerialDeviceInterface.__rawOff</h4>
<b>__rawOff</b>(<i></i>)
-
<p>
Private method to switch 'raw' mode off.
</p>
+
<a NAME="MicroPythonSerialDeviceInterface.__rawOn" ID="MicroPythonSerialDeviceInterface.__rawOn"></a>
<h4>MicroPythonSerialDeviceInterface.__rawOn</h4>
<b>__rawOn</b>(<i></i>)
-
<p>
Private method to switch the connected device to 'raw' mode.
</p>
<p>
Note: switching to raw mode is done with synchronous writes.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -310,18 +308,18 @@
<a NAME="MicroPythonSerialDeviceInterface.__readSerial" ID="MicroPythonSerialDeviceInterface.__readSerial"></a>
<h4>MicroPythonSerialDeviceInterface.__readSerial</h4>
<b>__readSerial</b>(<i></i>)
-
<p>
Private slot to read all available serial data and emit it with the
"dataReceived" signal for further processing.
</p>
+
<a NAME="MicroPythonSerialDeviceInterface.connectToDevice" ID="MicroPythonSerialDeviceInterface.connectToDevice"></a>
<h4>MicroPythonSerialDeviceInterface.connectToDevice</h4>
<b>connectToDevice</b>(<i>connection</i>)
-
<p>
Public method to connect to the device.
</p>
+
<dl>
<dt><i>connection</i> (str)</dt>
@@ -344,14 +342,13 @@
<a NAME="MicroPythonSerialDeviceInterface.disconnectFromDevice" ID="MicroPythonSerialDeviceInterface.disconnectFromDevice"></a>
<h4>MicroPythonSerialDeviceInterface.disconnectFromDevice</h4>
<b>disconnectFromDevice</b>(<i></i>)
-
<p>
Public slot to disconnect from the device.
</p>
+
<a NAME="MicroPythonSerialDeviceInterface.execute" ID="MicroPythonSerialDeviceInterface.execute"></a>
<h4>MicroPythonSerialDeviceInterface.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.
@@ -359,6 +356,7 @@
<p>
If no serial connection is available, empty results will be returned.
</p>
+
<dl>
<dt><i>commands</i> (str or list of str)</dt>
@@ -398,11 +396,11 @@
<a NAME="MicroPythonSerialDeviceInterface.executeAsync" ID="MicroPythonSerialDeviceInterface.executeAsync"></a>
<h4>MicroPythonSerialDeviceInterface.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>
@@ -424,17 +422,17 @@
<a NAME="MicroPythonSerialDeviceInterface.handlePreferencesChanged" ID="MicroPythonSerialDeviceInterface.handlePreferencesChanged"></a>
<h4>MicroPythonSerialDeviceInterface.handlePreferencesChanged</h4>
<b>handlePreferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle a change of the preferences.
</p>
+
<a NAME="MicroPythonSerialDeviceInterface.isConnected" ID="MicroPythonSerialDeviceInterface.isConnected"></a>
<h4>MicroPythonSerialDeviceInterface.isConnected</h4>
<b>isConnected</b>(<i></i>)
-
<p>
Public method to get the connection status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -450,7 +448,6 @@
<a NAME="MicroPythonSerialDeviceInterface.probeDevice" ID="MicroPythonSerialDeviceInterface.probeDevice"></a>
<h4>MicroPythonSerialDeviceInterface.probeDevice</h4>
<b>probeDevice</b>(<i></i>)
-
<p>
Public method to check the device is responding.
</p>
@@ -458,6 +455,7 @@
If the device has not been flashed with a MicroPython firmware, the
probe will fail.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -473,10 +471,10 @@
<a NAME="MicroPythonSerialDeviceInterface.write" ID="MicroPythonSerialDeviceInterface.write"></a>
<h4>MicroPythonSerialDeviceInterface.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>
@@ -486,4 +484,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
