diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,58 +7,54 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.Devices.MicrobitDevices</h1>
-
<p>
Module implementing the device interface class for BBC micro:bit and
Calliope mini boards.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicrobitDevice">MicrobitDevice</a></td>
<td>Class implementing the device for BBC micro:bit and Calliope mini boards.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#createDevice">createDevice</a></td>
<td>Function to instantiate a MicroPython device object.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="MicrobitDevice" ID="MicrobitDevice"></a>
<h2>MicrobitDevice</h2>
-
<p>
Class implementing the device for BBC micro:bit and Calliope mini boards.
</p>
+
<h3>Derived from</h3>
BaseDevice
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#MicrobitDevice.__init__">MicrobitDevice</a></td>
<td>Constructor</td>
@@ -192,19 +188,20 @@
<td>Public method to set the connection state.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MicrobitDevice.__init__" ID="MicrobitDevice.__init__"></a>
<h4>MicrobitDevice (Constructor)</h4>
<b>MicrobitDevice</b>(<i>microPythonWidget, deviceType, serialNumber, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -227,17 +224,17 @@
<a NAME="MicrobitDevice.__createMicrobitMenu" ID="MicrobitDevice.__createMicrobitMenu"></a>
<h4>MicrobitDevice.__createMicrobitMenu</h4>
<b>__createMicrobitMenu</b>(<i></i>)
-
<p>
Private method to create the microbit submenu.
</p>
+
<a NAME="MicrobitDevice.__firmwareVersionResponse" ID="MicrobitDevice.__firmwareVersionResponse"></a>
<h4>MicrobitDevice.__firmwareVersionResponse</h4>
<b>__firmwareVersionResponse</b>(<i>reply</i>)
-
<p>
Private slot handling the response of the latest version request.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -248,11 +245,11 @@
<a NAME="MicrobitDevice.__flashMicroPython" ID="MicrobitDevice.__flashMicroPython"></a>
<h4>MicrobitDevice.__flashMicroPython</h4>
<b>__flashMicroPython</b>(<i>firmware=False</i>)
-
<p>
Private slot to flash MicroPython or the DAPLink firmware to the
device.
</p>
+
<dl>
<dt><i>firmware</i> (bool)</dt>
@@ -263,10 +260,10 @@
<a NAME="MicrobitDevice.__isCalliope" ID="MicrobitDevice.__isCalliope"></a>
<h4>MicrobitDevice.__isCalliope</h4>
<b>__isCalliope</b>(<i></i>)
-
<p>
Private method to check, if the device is a Calliope mini.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -282,10 +279,10 @@
<a NAME="MicrobitDevice.__isMicroBitV1" ID="MicrobitDevice.__isMicroBitV1"></a>
<h4>MicrobitDevice.__isMicroBitV1</h4>
<b>__isMicroBitV1</b>(<i></i>)
-
<p>
Private method to check, if the device is a BBC micro:bit v1.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -301,10 +298,10 @@
<a NAME="MicrobitDevice.__isMicroBitV2" ID="MicrobitDevice.__isMicroBitV2"></a>
<h4>MicrobitDevice.__isMicroBitV2</h4>
<b>__isMicroBitV2</b>(<i></i>)
-
<p>
Private method to check, if the device is a BBC micro:bit v2.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -320,30 +317,29 @@
<a NAME="MicrobitDevice.__resetDevice" ID="MicrobitDevice.__resetDevice"></a>
<h4>MicrobitDevice.__resetDevice</h4>
<b>__resetDevice</b>(<i></i>)
-
<p>
Private slot to reset the connected device.
</p>
+
<a NAME="MicrobitDevice.__saveMain" ID="MicrobitDevice.__saveMain"></a>
<h4>MicrobitDevice.__saveMain</h4>
<b>__saveMain</b>(<i></i>)
-
<p>
Private slot to copy the current script as 'main.py' onto the
connected device.
</p>
+
<a NAME="MicrobitDevice.__showFirmwareVersions" ID="MicrobitDevice.__showFirmwareVersions"></a>
<h4>MicrobitDevice.__showFirmwareVersions</h4>
<b>__showFirmwareVersions</b>(<i></i>)
-
<p>
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>
@@ -351,6 +347,7 @@
Note: This method must be implemented in the various device specific
subclasses.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -366,10 +363,10 @@
<a NAME="MicrobitDevice.activateBluetoothInterface" ID="MicrobitDevice.activateBluetoothInterface"></a>
<h4>MicrobitDevice.activateBluetoothInterface</h4>
<b>activateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to activate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -392,10 +389,10 @@
<a NAME="MicrobitDevice.addDeviceMenuEntries" ID="MicrobitDevice.addDeviceMenuEntries"></a>
<h4>MicrobitDevice.addDeviceMenuEntries</h4>
<b>addDeviceMenuEntries</b>(<i>menu</i>)
-
<p>
Public method to add device specific entries to the given menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -406,10 +403,10 @@
<a NAME="MicrobitDevice.canRunScript" ID="MicrobitDevice.canRunScript"></a>
<h4>MicrobitDevice.canRunScript</h4>
<b>canRunScript</b>(<i></i>)
-
<p>
Public method to determine, if a script can be executed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -426,10 +423,10 @@
<a NAME="MicrobitDevice.canStartFileManager" ID="MicrobitDevice.canStartFileManager"></a>
<h4>MicrobitDevice.canStartFileManager</h4>
<b>canStartFileManager</b>(<i></i>)
-
<p>
Public method to determine, if a File Manager can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -446,10 +443,10 @@
<a NAME="MicrobitDevice.canStartPlotter" ID="MicrobitDevice.canStartPlotter"></a>
<h4>MicrobitDevice.canStartPlotter</h4>
<b>canStartPlotter</b>(<i></i>)
-
<p>
Public method to determine, if a Plotter can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -466,10 +463,10 @@
<a NAME="MicrobitDevice.canStartRepl" ID="MicrobitDevice.canStartRepl"></a>
<h4>MicrobitDevice.canStartRepl</h4>
<b>canStartRepl</b>(<i></i>)
-
<p>
Public method to determine, if a REPL can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -486,10 +483,10 @@
<a NAME="MicrobitDevice.deactivateBluetoothInterface" ID="MicrobitDevice.deactivateBluetoothInterface"></a>
<h4>MicrobitDevice.deactivateBluetoothInterface</h4>
<b>deactivateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to deactivate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -512,10 +509,10 @@
<a NAME="MicrobitDevice.deviceName" ID="MicrobitDevice.deviceName"></a>
<h4>MicrobitDevice.deviceName</h4>
<b>deviceName</b>(<i></i>)
-
<p>
Public method to get the name of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -531,11 +528,11 @@
<a NAME="MicrobitDevice.forceInterrupt" ID="MicrobitDevice.forceInterrupt"></a>
<h4>MicrobitDevice.forceInterrupt</h4>
<b>forceInterrupt</b>(<i></i>)
-
<p>
Public method to determine the need for an interrupt when opening the
serial connection.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -551,10 +548,10 @@
<a NAME="MicrobitDevice.getBluetoothStatus" ID="MicrobitDevice.getBluetoothStatus"></a>
<h4>MicrobitDevice.getBluetoothStatus</h4>
<b>getBluetoothStatus</b>(<i></i>)
-
<p>
Public method to get Bluetooth status data of the connected board.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -578,10 +575,10 @@
<a NAME="MicrobitDevice.getDeviceScan" ID="MicrobitDevice.getDeviceScan"></a>
<h4>MicrobitDevice.getDeviceScan</h4>
<b>getDeviceScan</b>(<i>timeout=10</i>)
-
<p>
Public method to perform a Bluetooth device scan.
</p>
+
<dl>
<dt><i>timeout</i> (int (optional))</dt>
@@ -606,10 +603,10 @@
<a NAME="MicrobitDevice.getDocumentationUrl" ID="MicrobitDevice.getDocumentationUrl"></a>
<h4>MicrobitDevice.getDocumentationUrl</h4>
<b>getDocumentationUrl</b>(<i></i>)
-
<p>
Public method to get the device documentation URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -625,10 +622,10 @@
<a NAME="MicrobitDevice.getDownloadMenuEntries" ID="MicrobitDevice.getDownloadMenuEntries"></a>
<h4>MicrobitDevice.getDownloadMenuEntries</h4>
<b>getDownloadMenuEntries</b>(<i></i>)
-
<p>
Public method to retrieve the entries for the downloads menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -645,10 +642,10 @@
<a NAME="MicrobitDevice.hasBluetooth" ID="MicrobitDevice.hasBluetooth"></a>
<h4>MicrobitDevice.hasBluetooth</h4>
<b>hasBluetooth</b>(<i></i>)
-
<p>
Public method to check the availability of Bluetooth.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -671,10 +668,10 @@
<a NAME="MicrobitDevice.hasFlashMenuEntry" ID="MicrobitDevice.hasFlashMenuEntry"></a>
<h4>MicrobitDevice.hasFlashMenuEntry</h4>
<b>hasFlashMenuEntry</b>(<i></i>)
-
<p>
Public method to check, if the device has its own flash menu entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -690,13 +687,13 @@
<a NAME="MicrobitDevice.hasTimeCommands" ID="MicrobitDevice.hasTimeCommands"></a>
<h4>MicrobitDevice.hasTimeCommands</h4>
<b>hasTimeCommands</b>(<i></i>)
-
<p>
Public method to check, if the device supports time commands.
</p>
<p>
The default returns True.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -712,11 +709,11 @@
<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>
@@ -757,10 +754,10 @@
<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>
@@ -790,10 +787,10 @@
<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>
@@ -809,10 +806,10 @@
<a NAME="MicrobitDevice.runScript" ID="MicrobitDevice.runScript"></a>
<h4>MicrobitDevice.runScript</h4>
<b>runScript</b>(<i>script</i>)
-
<p>
Public method to run the given Python script.
</p>
+
<dl>
<dt><i>script</i> (str)</dt>
@@ -823,14 +820,13 @@
<a NAME="MicrobitDevice.setButtons" ID="MicrobitDevice.setButtons"></a>
<h4>MicrobitDevice.setButtons</h4>
<b>setButtons</b>(<i></i>)
-
<p>
Public method to enable the supported action buttons.
</p>
+
<a NAME="MicrobitDevice.setConnected" ID="MicrobitDevice.setConnected"></a>
<h4>MicrobitDevice.setConnected</h4>
<b>setConnected</b>(<i>connected</i>)
-
<p>
Public method to set the connection state.
</p>
@@ -838,6 +834,7 @@
Note: This method can be overwritten to perform actions upon connect
or disconnect of the device.
</p>
+
<dl>
<dt><i>connected</i> (bool)</dt>
@@ -851,10 +848,10 @@
<a NAME="createDevice" ID="createDevice"></a>
<h2>createDevice</h2>
<b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName, serialNumber</i>)
-
<p>
Function to instantiate a MicroPython device object.
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -896,4 +893,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
