diff -r 57496966803c -r 6378da868bb0 src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html --- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html Tue Feb 14 11:09:49 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html Tue Feb 14 18:10:30 2023 +0100 @@ -104,6 +104,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._getSetTimeCode">_getSetTimeCode</a></td> +<td>Protected method to get the device code to set the time.</td> +</tr> +<tr> <td><a href="#MicrobitDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> <td>Public method to add device specific entries to the given menu.</td> </tr> @@ -148,6 +152,18 @@ <td>Public method to check, if the device supports time commands.</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> +<tr> +<td><a href="#MicrobitDevice.ls">ls</a></td> +<td>Public method to get a directory listing of 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.runScript">runScript</a></td> <td>Public method to run the given Python script.</td> </tr> @@ -319,6 +335,29 @@ Private slot to show the firmware version of the connected device and the available firmware version. </p> +<a NAME="MicrobitDevice._getSetTimeCode" ID="MicrobitDevice._getSetTimeCode"></a> +<h4>MicrobitDevice._getSetTimeCode</h4> +<b>_getSetTimeCode</b>(<i></i>) + +<p> + Protected method to get the device code to set the time. +</p> +<p> + Note: This method must be implemented in the various device specific + subclasses. +</p> +<dl> +<dt>Return:</dt> +<dd> +code to be executed on the connected device to set the time +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="MicrobitDevice.addDeviceMenuEntries" ID="MicrobitDevice.addDeviceMenuEntries"></a> <h4>MicrobitDevice.addDeviceMenuEntries</h4> <b>addDeviceMenuEntries</b>(<i>menu</i>) @@ -532,6 +571,103 @@ 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>) + +<p> + Public method to get a long directory listing of the connected device + including meta data. +</p> +<dl> + +<dt><i>dirname</i> (str)</dt> +<dd> +name of the directory to be listed +</dd> +<dt><i>fullstat</i> (bool)</dt> +<dd> +flag indicating to return the full stat() tuple +</dd> +<dt><i>showHidden</i> (bool)</dt> +<dd> +flag indicating to show hidden files as well +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list containing the directory listing with tuple entries of + the name and and a tuple of mode, size and time (if fullstat is + false) or the complete stat() tuple. 'None' is returned in case the + directory doesn't exist. +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, tuple) +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +raised to indicate an issue with the device +</dd> +</dl> +<a NAME="MicrobitDevice.ls" ID="MicrobitDevice.ls"></a> +<h4>MicrobitDevice.ls</h4> +<b>ls</b>(<i>dirname=""</i>) + +<p> + Public method to get a directory listing of the connected device. +</p> +<dl> + +<dt><i>dirname</i> (str)</dt> +<dd> +name of the directory to be listed +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containg the directory listing +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of str +</dd> +</dl> +<dl> + +<dt>Raises <b>OSError</b>:</dt> +<dd> +raised to indicate an issue with the device +</dd> +</dl> +<a NAME="MicrobitDevice.pwd" ID="MicrobitDevice.pwd"></a> +<h4>MicrobitDevice.pwd</h4> +<b>pwd</b>(<i></i>) + +<p> + Public method to get the current directory of the connected device. +</p> +<dl> +<dt>Return:</dt> +<dd> +current directory +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="MicrobitDevice.runScript" ID="MicrobitDevice.runScript"></a> <h4>MicrobitDevice.runScript</h4> <b>runScript</b>(<i>script</i>)