Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html	Fri Mar 21 18:12:17 2025 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html	Sun Mar 23 14:55:14 2025 +0100
@@ -96,6 +96,10 @@
 <td>Private slot to show the firmware version of the connected device and the available firmware version.</td>
 </tr>
 <tr>
+<td><a href="#MicrobitDevice._boardInformationCommands">_boardInformationCommands</a></td>
+<td>Protected method defining the list of commands to be execute on the board for determining information about the board.</td>
+</tr>
+<tr>
 <td><a href="#MicrobitDevice._getSetTimeCode">_getSetTimeCode</a></td>
 <td>Protected method to get the device code to set the time.</td>
 </tr>
@@ -144,6 +148,10 @@
 <td>Public method to get some information data of the connected board.</td>
 </tr>
 <tr>
+<td><a href="#MicrobitDevice.getData">getData</a></td>
+<td>Public method to read data from the connected device.</td>
+</tr>
+<tr>
 <td><a href="#MicrobitDevice.getDeviceScan">getDeviceScan</a></td>
 <td>Public method to perform a Bluetooth device scan.</td>
 </tr>
@@ -168,6 +176,10 @@
 <td>Public method to check, if the device supports time commands.</td>
 </tr>
 <tr>
+<td><a href="#MicrobitDevice.isMicrobit">isMicrobit</a></td>
+<td>Public method to check, if the device is a BBC micro:bit or Calliope mini.</td>
+</tr>
+<tr>
 <td><a href="#MicrobitDevice.lls">lls</a></td>
 <td>Public method to get a long directory listing of the connected device including meta data.</td>
 </tr>
@@ -176,10 +188,18 @@
 <td>Public method to get a directory listing of the connected device.</td>
 </tr>
 <tr>
+<td><a href="#MicrobitDevice.putData">putData</a></td>
+<td>Public method to write the given data to the connected device.</td>
+</tr>
+<tr>
 <td><a href="#MicrobitDevice.pwd">pwd</a></td>
 <td>Public method to get the current directory of the connected device.</td>
 </tr>
 <tr>
+<td><a href="#MicrobitDevice.rm">rm</a></td>
+<td>Public method to remove a file from the connected device.</td>
+</tr>
+<tr>
 <td><a href="#MicrobitDevice.runScript">runScript</a></td>
 <td>Public method to run the given Python script.</td>
 </tr>
@@ -345,6 +365,26 @@
         available firmware version.
 </p>
 
+<a NAME="MicrobitDevice._boardInformationCommands" ID="MicrobitDevice._boardInformationCommands"></a>
+<h4>MicrobitDevice._boardInformationCommands</h4>
+<b>_boardInformationCommands</b>(<i></i>)
+<p>
+        Protected method defining the list of commands to be execute on the board
+        for determining information about the board.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+list of command strings to be executed
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
 <a NAME="MicrobitDevice._getSetTimeCode" ID="MicrobitDevice._getSetTimeCode"></a>
 <h4>MicrobitDevice._getSetTimeCode</h4>
 <b>_getSetTimeCode</b>(<i></i>)
@@ -599,6 +639,32 @@
 dict
 </dd>
 </dl>
+<a NAME="MicrobitDevice.getData" ID="MicrobitDevice.getData"></a>
+<h4>MicrobitDevice.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>
 <a NAME="MicrobitDevice.getDeviceScan" ID="MicrobitDevice.getDeviceScan"></a>
 <h4>MicrobitDevice.getDeviceScan</h4>
 <b>getDeviceScan</b>(<i>timeout=10</i>)
@@ -733,6 +799,25 @@
 bool
 </dd>
 </dl>
+<a NAME="MicrobitDevice.isMicrobit" ID="MicrobitDevice.isMicrobit"></a>
+<h4>MicrobitDevice.isMicrobit</h4>
+<b>isMicrobit</b>(<i></i>)
+<p>
+        Public method to check, if the device is a BBC micro:bit or Calliope mini.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a micro:bit device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="MicrobitDevice.lls" ID="MicrobitDevice.lls"></a>
 <h4>MicrobitDevice.lls</h4>
 <b>lls</b>(<i>dirname="", fullstat=False, showHidden=False</i>)
@@ -811,6 +896,36 @@
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="MicrobitDevice.putData" ID="MicrobitDevice.putData"></a>
+<h4>MicrobitDevice.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>
 <a NAME="MicrobitDevice.pwd" ID="MicrobitDevice.pwd"></a>
 <h4>MicrobitDevice.pwd</h4>
 <b>pwd</b>(<i></i>)
@@ -830,6 +945,20 @@
 str
 </dd>
 </dl>
+<a NAME="MicrobitDevice.rm" ID="MicrobitDevice.rm"></a>
+<h4>MicrobitDevice.rm</h4>
+<b>rm</b>(<i>filename</i>)
+<p>
+        Public method to remove a file from the connected device.
+</p>
+
+<dl>
+
+<dt><i>filename</i> (str)</dt>
+<dd>
+name of the file to be removed
+</dd>
+</dl>
 <a NAME="MicrobitDevice.runScript" ID="MicrobitDevice.runScript"></a>
 <h4>MicrobitDevice.runScript</h4>
 <b>runScript</b>(<i>script</i>)