--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.GenericMicroPythonDevices.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.GenericMicroPythonDevices.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,58 +7,54 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.Devices.GenericMicroPythonDevices</h1>
-
<p>
Module implementing the device interface class for generic MicroPython devices
(i.e. those devices not specifically supported yet).
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#GenericMicroPythonDevice">GenericMicroPythonDevice</a></td>
<td>Class implementing the device interface for generic MicroPython 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="GenericMicroPythonDevice" ID="GenericMicroPythonDevice"></a>
<h2>GenericMicroPythonDevice</h2>
-
<p>
Class implementing the device interface for generic MicroPython 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="#GenericMicroPythonDevice.__init__">GenericMicroPythonDevice</a></td>
<td>Constructor</td>
@@ -144,19 +140,20 @@
<td>Public method to indicate file access via a local directory.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="GenericMicroPythonDevice.__init__" ID="GenericMicroPythonDevice.__init__"></a>
<h4>GenericMicroPythonDevice (Constructor)</h4>
<b>GenericMicroPythonDevice</b>(<i>microPythonWidget, deviceType, vid, pid, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -183,24 +180,24 @@
<a NAME="GenericMicroPythonDevice.__activateBootloader" ID="GenericMicroPythonDevice.__activateBootloader"></a>
<h4>GenericMicroPythonDevice.__activateBootloader</h4>
<b>__activateBootloader</b>(<i></i>)
-
<p>
Private slot to switch the board into 'bootloader' mode.
</p>
+
<a NAME="GenericMicroPythonDevice.__createGenericMenu" ID="GenericMicroPythonDevice.__createGenericMenu"></a>
<h4>GenericMicroPythonDevice.__createGenericMenu</h4>
<b>__createGenericMenu</b>(<i></i>)
-
<p>
Private method to create the Generic submenu.
</p>
+
<a NAME="GenericMicroPythonDevice.__deviceVolumeMounted" ID="GenericMicroPythonDevice.__deviceVolumeMounted"></a>
<h4>GenericMicroPythonDevice.__deviceVolumeMounted</h4>
<b>__deviceVolumeMounted</b>(<i></i>)
-
<p>
Private method to check, if the device volume is mounted.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -216,10 +213,10 @@
<a NAME="GenericMicroPythonDevice.__findWorkspace" ID="GenericMicroPythonDevice.__findWorkspace"></a>
<h4>GenericMicroPythonDevice.__findWorkspace</h4>
<b>__findWorkspace</b>(<i>silent=False</i>)
-
<p>
Private method to find the workspace directory.
</p>
+
<dl>
<dt><i>silent</i> (bool)</dt>
@@ -242,10 +239,10 @@
<a NAME="GenericMicroPythonDevice.__firmwareVersionResponse" ID="GenericMicroPythonDevice.__firmwareVersionResponse"></a>
<h4>GenericMicroPythonDevice.__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>
@@ -256,22 +253,21 @@
<a NAME="GenericMicroPythonDevice.__resetDevice" ID="GenericMicroPythonDevice.__resetDevice"></a>
<h4>GenericMicroPythonDevice.__resetDevice</h4>
<b>__resetDevice</b>(<i></i>)
-
<p>
Private slot to reset the connected device.
</p>
+
<a NAME="GenericMicroPythonDevice.__showFirmwareVersions" ID="GenericMicroPythonDevice.__showFirmwareVersions"></a>
<h4>GenericMicroPythonDevice.__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="GenericMicroPythonDevice._getSetTimeCode" ID="GenericMicroPythonDevice._getSetTimeCode"></a>
<h4>GenericMicroPythonDevice._getSetTimeCode</h4>
<b>_getSetTimeCode</b>(<i></i>)
-
<p>
Protected method to get the device code to set the time.
</p>
@@ -279,6 +275,7 @@
Note: This method must be implemented in the various device specific
subclasses.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -294,10 +291,10 @@
<a NAME="GenericMicroPythonDevice.addDeviceMenuEntries" ID="GenericMicroPythonDevice.addDeviceMenuEntries"></a>
<h4>GenericMicroPythonDevice.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>
@@ -308,10 +305,10 @@
<a NAME="GenericMicroPythonDevice.canRunScript" ID="GenericMicroPythonDevice.canRunScript"></a>
<h4>GenericMicroPythonDevice.canRunScript</h4>
<b>canRunScript</b>(<i></i>)
-
<p>
Public method to determine, if a script can be executed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -328,10 +325,10 @@
<a NAME="GenericMicroPythonDevice.canStartFileManager" ID="GenericMicroPythonDevice.canStartFileManager"></a>
<h4>GenericMicroPythonDevice.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>
@@ -348,10 +345,10 @@
<a NAME="GenericMicroPythonDevice.canStartPlotter" ID="GenericMicroPythonDevice.canStartPlotter"></a>
<h4>GenericMicroPythonDevice.canStartPlotter</h4>
<b>canStartPlotter</b>(<i></i>)
-
<p>
Public method to determine, if a Plotter can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -368,10 +365,10 @@
<a NAME="GenericMicroPythonDevice.canStartRepl" ID="GenericMicroPythonDevice.canStartRepl"></a>
<h4>GenericMicroPythonDevice.canStartRepl</h4>
<b>canStartRepl</b>(<i></i>)
-
<p>
Public method to determine, if a REPL can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -388,10 +385,10 @@
<a NAME="GenericMicroPythonDevice.deviceName" ID="GenericMicroPythonDevice.deviceName"></a>
<h4>GenericMicroPythonDevice.deviceName</h4>
<b>deviceName</b>(<i></i>)
-
<p>
Public method to get the name of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -407,10 +404,10 @@
<a NAME="GenericMicroPythonDevice.getDocumentationUrl" ID="GenericMicroPythonDevice.getDocumentationUrl"></a>
<h4>GenericMicroPythonDevice.getDocumentationUrl</h4>
<b>getDocumentationUrl</b>(<i></i>)
-
<p>
Public method to get the device documentation URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -426,10 +423,10 @@
<a NAME="GenericMicroPythonDevice.getFirmwareUrl" ID="GenericMicroPythonDevice.getFirmwareUrl"></a>
<h4>GenericMicroPythonDevice.getFirmwareUrl</h4>
<b>getFirmwareUrl</b>(<i></i>)
-
<p>
Public method to get the device firmware download URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -445,10 +442,10 @@
<a NAME="GenericMicroPythonDevice.getWorkspace" ID="GenericMicroPythonDevice.getWorkspace"></a>
<h4>GenericMicroPythonDevice.getWorkspace</h4>
<b>getWorkspace</b>(<i>silent=False</i>)
-
<p>
Public method to get the workspace directory.
</p>
+
<dl>
<dt><i>silent</i> (bool)</dt>
@@ -471,10 +468,10 @@
<a NAME="GenericMicroPythonDevice.runScript" ID="GenericMicroPythonDevice.runScript"></a>
<h4>GenericMicroPythonDevice.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>
@@ -485,17 +482,17 @@
<a NAME="GenericMicroPythonDevice.setButtons" ID="GenericMicroPythonDevice.setButtons"></a>
<h4>GenericMicroPythonDevice.setButtons</h4>
<b>setButtons</b>(<i></i>)
-
<p>
Public method to enable the supported action buttons.
</p>
+
<a NAME="GenericMicroPythonDevice.supportsLocalFileAccess" ID="GenericMicroPythonDevice.supportsLocalFileAccess"></a>
<h4>GenericMicroPythonDevice.supportsLocalFileAccess</h4>
<b>supportsLocalFileAccess</b>(<i></i>)
-
<p>
Public method to indicate file access via a local directory.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -514,10 +511,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>
@@ -559,4 +556,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
