--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.PyBoardDevices.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.PyBoardDevices.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,57 +7,54 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.Devices.PyBoardDevices</h1>
-
<p>
Module implementing the device interface class for PyBoard boards.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PyBoardDevice">PyBoardDevice</a></td>
<td>Class implementing the device for PyBoard 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="PyBoardDevice" ID="PyBoardDevice"></a>
<h2>PyBoardDevice</h2>
-
<p>
Class implementing the device for PyBoard boards.
</p>
+
<h3>Derived from</h3>
BaseDevice
<h3>Class Attributes</h3>
+<table>
+<tr><td>DeviceVolumeName</td></tr>
+<tr><td>FlashInstructionsURL</td></tr>
+</table>
-<table>
-<tr><td>DeviceVolumeName</td></tr><tr><td>FlashInstructionsURL</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PyBoardDevice.__init__">PyBoardDevice</a></td>
<td>Constructor</td>
@@ -175,19 +172,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="PyBoardDevice.__init__" ID="PyBoardDevice.__init__"></a>
<h4>PyBoardDevice (Constructor)</h4>
<b>PyBoardDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -206,24 +204,24 @@
<a NAME="PyBoardDevice.__activateBootloader" ID="PyBoardDevice.__activateBootloader"></a>
<h4>PyBoardDevice.__activateBootloader</h4>
<b>__activateBootloader</b>(<i></i>)
-
<p>
Private slot to activate the bootloader and disconnect.
</p>
+
<a NAME="PyBoardDevice.__createPyboardMenu" ID="PyBoardDevice.__createPyboardMenu"></a>
<h4>PyBoardDevice.__createPyboardMenu</h4>
<b>__createPyboardMenu</b>(<i></i>)
-
<p>
Private method to create the pyboard submenu.
</p>
+
<a NAME="PyBoardDevice.__deviceVolumeMounted" ID="PyBoardDevice.__deviceVolumeMounted"></a>
<h4>PyBoardDevice.__deviceVolumeMounted</h4>
<b>__deviceVolumeMounted</b>(<i></i>)
-
<p>
Private method to check, if the device volume is mounted.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -239,10 +237,10 @@
<a NAME="PyBoardDevice.__dfuUtilAvailable" ID="PyBoardDevice.__dfuUtilAvailable"></a>
<h4>PyBoardDevice.__dfuUtilAvailable</h4>
<b>__dfuUtilAvailable</b>(<i></i>)
-
<p>
Private method to check the availability of dfu-util.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -258,10 +256,10 @@
<a NAME="PyBoardDevice.__findWorkspace" ID="PyBoardDevice.__findWorkspace"></a>
<h4>PyBoardDevice.__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>
@@ -284,10 +282,10 @@
<a NAME="PyBoardDevice.__firmwareVersionResponse" ID="PyBoardDevice.__firmwareVersionResponse"></a>
<h4>PyBoardDevice.__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>
@@ -298,38 +296,38 @@
<a NAME="PyBoardDevice.__flashMicroPython" ID="PyBoardDevice.__flashMicroPython"></a>
<h4>PyBoardDevice.__flashMicroPython</h4>
<b>__flashMicroPython</b>(<i></i>)
-
<p>
Private slot to flash a MicroPython firmware.
</p>
+
<a NAME="PyBoardDevice.__listDfuCapableDevices" ID="PyBoardDevice.__listDfuCapableDevices"></a>
<h4>PyBoardDevice.__listDfuCapableDevices</h4>
<b>__listDfuCapableDevices</b>(<i></i>)
-
<p>
Private slot to list all DFU-capable devices.
</p>
+
<a NAME="PyBoardDevice.__resetDevice" ID="PyBoardDevice.__resetDevice"></a>
<h4>PyBoardDevice.__resetDevice</h4>
<b>__resetDevice</b>(<i></i>)
-
<p>
Private slot to reset the connected device.
</p>
+
<a NAME="PyBoardDevice.__showDfuDisableInstructions" ID="PyBoardDevice.__showDfuDisableInstructions"></a>
<h4>PyBoardDevice.__showDfuDisableInstructions</h4>
<b>__showDfuDisableInstructions</b>(<i></i>)
-
<p>
Private method to show some instructions to disable the DFU mode.
</p>
+
<a NAME="PyBoardDevice.__showDfuEnableInstructions" ID="PyBoardDevice.__showDfuEnableInstructions"></a>
<h4>PyBoardDevice.__showDfuEnableInstructions</h4>
<b>__showDfuEnableInstructions</b>(<i>flash=True</i>)
-
<p>
Private method to show some instructions to enable the DFU mode.
</p>
+
<dl>
<dt><i>flash</i> (bool)</dt>
@@ -352,23 +350,22 @@
<a NAME="PyBoardDevice.__showFirmwareVersions" ID="PyBoardDevice.__showFirmwareVersions"></a>
<h4>PyBoardDevice.__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="PyBoardDevice.__showFlashInstructions" ID="PyBoardDevice.__showFlashInstructions"></a>
<h4>PyBoardDevice.__showFlashInstructions</h4>
<b>__showFlashInstructions</b>(<i></i>)
-
<p>
Private slot to open the URL containing instructions for installing
MicroPython on the pyboard.
</p>
+
<a NAME="PyBoardDevice._getSetTimeCode" ID="PyBoardDevice._getSetTimeCode"></a>
<h4>PyBoardDevice._getSetTimeCode</h4>
<b>_getSetTimeCode</b>(<i></i>)
-
<p>
Protected method to get the device code to set the time.
</p>
@@ -376,6 +373,7 @@
Note: This method must be implemented in the various device specific
subclasses.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -391,10 +389,10 @@
<a NAME="PyBoardDevice.addDeviceMenuEntries" ID="PyBoardDevice.addDeviceMenuEntries"></a>
<h4>PyBoardDevice.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>
@@ -405,10 +403,10 @@
<a NAME="PyBoardDevice.canRunScript" ID="PyBoardDevice.canRunScript"></a>
<h4>PyBoardDevice.canRunScript</h4>
<b>canRunScript</b>(<i></i>)
-
<p>
Public method to determine, if a script can be executed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -425,10 +423,10 @@
<a NAME="PyBoardDevice.canStartFileManager" ID="PyBoardDevice.canStartFileManager"></a>
<h4>PyBoardDevice.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>
@@ -445,10 +443,10 @@
<a NAME="PyBoardDevice.canStartPlotter" ID="PyBoardDevice.canStartPlotter"></a>
<h4>PyBoardDevice.canStartPlotter</h4>
<b>canStartPlotter</b>(<i></i>)
-
<p>
Public method to determine, if a Plotter can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -465,10 +463,10 @@
<a NAME="PyBoardDevice.canStartRepl" ID="PyBoardDevice.canStartRepl"></a>
<h4>PyBoardDevice.canStartRepl</h4>
<b>canStartRepl</b>(<i></i>)
-
<p>
Public method to determine, if a REPL can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -485,10 +483,10 @@
<a NAME="PyBoardDevice.deviceName" ID="PyBoardDevice.deviceName"></a>
<h4>PyBoardDevice.deviceName</h4>
<b>deviceName</b>(<i></i>)
-
<p>
Public method to get the name of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -504,11 +502,11 @@
<a NAME="PyBoardDevice.forceInterrupt" ID="PyBoardDevice.forceInterrupt"></a>
<h4>PyBoardDevice.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>
@@ -524,10 +522,10 @@
<a NAME="PyBoardDevice.getDocumentationUrl" ID="PyBoardDevice.getDocumentationUrl"></a>
<h4>PyBoardDevice.getDocumentationUrl</h4>
<b>getDocumentationUrl</b>(<i></i>)
-
<p>
Public method to get the device documentation URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -543,10 +541,10 @@
<a NAME="PyBoardDevice.getFirmwareUrl" ID="PyBoardDevice.getFirmwareUrl"></a>
<h4>PyBoardDevice.getFirmwareUrl</h4>
<b>getFirmwareUrl</b>(<i></i>)
-
<p>
Public method to get the device firmware download URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -562,10 +560,10 @@
<a NAME="PyBoardDevice.getWorkspace" ID="PyBoardDevice.getWorkspace"></a>
<h4>PyBoardDevice.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>
@@ -588,10 +586,10 @@
<a NAME="PyBoardDevice.hasFlashMenuEntry" ID="PyBoardDevice.hasFlashMenuEntry"></a>
<h4>PyBoardDevice.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>
@@ -607,10 +605,10 @@
<a NAME="PyBoardDevice.runScript" ID="PyBoardDevice.runScript"></a>
<h4>PyBoardDevice.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>
@@ -621,17 +619,17 @@
<a NAME="PyBoardDevice.setButtons" ID="PyBoardDevice.setButtons"></a>
<h4>PyBoardDevice.setButtons</h4>
<b>setButtons</b>(<i></i>)
-
<p>
Public method to enable the supported action buttons.
</p>
+
<a NAME="PyBoardDevice.supportsLocalFileAccess" ID="PyBoardDevice.supportsLocalFileAccess"></a>
<h4>PyBoardDevice.supportsLocalFileAccess</h4>
<b>supportsLocalFileAccess</b>(<i></i>)
-
<p>
Public method to indicate file access via a local directory.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -650,10 +648,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>
@@ -695,4 +693,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
