src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonCommandsInterface.html

branch
eric7
changeset 9749
5d409223cf3f
parent 9748
df9520c864f2
child 9753
a774e75a45ca
--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonCommandsInterface.html	Wed Feb 08 11:54:36 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonCommandsInterface.html	Wed Feb 08 18:09:19 2023 +0100
@@ -178,6 +178,10 @@
 <td>Public method to create a new directory.</td>
 </tr>
 <tr>
+<td><a href="#MicroPythonCommandsInterface.probeDevice">probeDevice</a></td>
+<td>Public method to check the device is responding.</td>
+</tr>
+<tr>
 <td><a href="#MicroPythonCommandsInterface.put">put</a></td>
 <td>Public method to copy a local file to the connected device.</td>
 </tr>
@@ -686,6 +690,29 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="MicroPythonCommandsInterface.probeDevice" ID="MicroPythonCommandsInterface.probeDevice"></a>
+<h4>MicroPythonCommandsInterface.probeDevice</h4>
+<b>probeDevice</b>(<i></i>)
+
+<p>
+        Public method to check the device is responding.
+</p>
+<p>
+        If the device has not been flashed with a MicroPython formware, the
+        probe will fail.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a communicating MicroPython device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="MicroPythonCommandsInterface.put" ID="MicroPythonCommandsInterface.put"></a>
 <h4>MicroPythonCommandsInterface.put</h4>
 <b>put</b>(<i>hostFileName, deviceFileName=None</i>)

eric ide

mercurial