Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplDeviceInterface.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplDeviceInterface.html	Fri Oct 27 14:09:40 2023 +0200
@@ -86,11 +86,11 @@
 </tr>
 <tr>
 <td><a href="#MicroPythonWebreplDeviceInterface.execute">execute</a></td>
-<td></td>
+<td>Public method to send commands to the connected device and return the result.</td>
 </tr>
 <tr>
 <td><a href="#MicroPythonWebreplDeviceInterface.executeAsync">executeAsync</a></td>
-<td></td>
+<td>Public method to execute a series of commands over a period of time without returning any result (asynchronous execution).</td>
 </tr>
 <tr>
 <td><a href="#MicroPythonWebreplDeviceInterface.handlePreferencesChanged">handlePreferencesChanged</a></td>
@@ -211,10 +211,58 @@
 <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>
+<dd>
+list of commands to be executed
+</dd>
+<dt><i>mode=</i> (str)</dt>
+<dd>
+submit mode to be used (one of 'raw' or 'paste') (defaults to
+            'raw'). This is ignored because webrepl always uses 'paste' mode.
+</dd>
+<dt><i>timeout=</i> (int (optional))</dt>
+<dd>
+per command timeout in milliseconds (0 for configured default)
+            (defaults to 0)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing stdout and stderr output of the device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bytes, bytes)
+</dd>
+</dl>
 <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>
+<dd>
+list of commands to be execute on the device
+</dd>
+<dt><i>submitMode</i> (str (one of 'raw' or 'paste'))</dt>
+<dd>
+mode to be used to submit the commands
+</dd>
+</dl>
 <a NAME="MicroPythonWebreplDeviceInterface.handlePreferencesChanged" ID="MicroPythonWebreplDeviceInterface.handlePreferencesChanged"></a>
 <h4>MicroPythonWebreplDeviceInterface.handlePreferencesChanged</h4>
 <b>handlePreferencesChanged</b>(<i></i>)