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

branch
eric7
changeset 9760
11245ac9c258
parent 9753
a774e75a45ca
--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonCommandsInterface.html	Mon Feb 13 17:53:27 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonCommandsInterface.html	Mon Feb 13 17:55:13 2023 +0100
@@ -146,6 +146,10 @@
 <td>Public method to get some information data of the connected board.</td>
 </tr>
 <tr>
+<td><a href="#MicroPythonCommandsInterface.getData">getData</a></td>
+<td>Public method to read data from the connected device.</td>
+</tr>
+<tr>
 <td><a href="#MicroPythonCommandsInterface.getDeviceData">getDeviceData</a></td>
 <td>Public method to get some essential data for the connected board.</td>
 </tr>
@@ -186,6 +190,10 @@
 <td>Public method to copy a local file to the connected device.</td>
 </tr>
 <tr>
+<td><a href="#MicroPythonCommandsInterface.putData">putData</a></td>
+<td>Public method to write the given data to the connected device.</td>
+</tr>
+<tr>
 <td><a href="#MicroPythonCommandsInterface.pwd">pwd</a></td>
 <td>Public method to get the current directory of the connected device.</td>
 </tr>
@@ -482,6 +490,39 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="MicroPythonCommandsInterface.getData" ID="MicroPythonCommandsInterface.getData"></a>
+<h4>MicroPythonCommandsInterface.getData</h4>
+<b>getData</b>(<i>deviceFileName</i>)
+
+<p>
+        Public method to read data from the connected device.
+</p>
+<dl>
+
+<dt><i>deviceFileName</i> (str)</dt>
+<dd>
+name of the file to read from
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+data read from the device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>OSError</b>:</dt>
+<dd>
+raised to indicate an issue with the device
+</dd>
+</dl>
 <a NAME="MicroPythonCommandsInterface.getDeviceData" ID="MicroPythonCommandsInterface.getDeviceData"></a>
 <h4>MicroPythonCommandsInterface.getDeviceData</h4>
 <b>getDeviceData</b>(<i></i>)
@@ -745,6 +786,43 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="MicroPythonCommandsInterface.putData" ID="MicroPythonCommandsInterface.putData"></a>
+<h4>MicroPythonCommandsInterface.putData</h4>
+<b>putData</b>(<i>deviceFileName, content</i>)
+
+<p>
+        Public method to write the given data to the connected device.
+</p>
+<dl>
+
+<dt><i>deviceFileName</i> (str)</dt>
+<dd>
+name of the file to write to
+</dd>
+<dt><i>content</i> (bytes)</dt>
+<dd>
+data to write
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>OSError</b>:</dt>
+<dd>
+raised to indicate an issue with the device
+</dd>
+</dl>
 <a NAME="MicroPythonCommandsInterface.pwd" ID="MicroPythonCommandsInterface.pwd"></a>
 <h4>MicroPythonCommandsInterface.pwd</h4>
 <b>pwd</b>(<i></i>)

eric ide

mercurial