Regenerated source documentation. eric7

Thu, 16 Mar 2023 12:10:12 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 16 Mar 2023 12:10:12 +0100
branch
eric7
changeset 9912
c731e9bdd105
parent 9911
5f84aa2564f8
child 9913
702ad0ef6b3f

Regenerated source documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.GenericMicroPythonDevices.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MicroPython.UF2FlashDialog.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Thu Mar 16 12:09:10 2023 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Thu Mar 16 12:10:12 2023 +0100
@@ -2798,11 +2798,15 @@
 eric7.MicroPython.Devices.EspDialogs.EspFirmwareSelectionDialog.EspFirmwareSelectionDialog.on_firmwarePicker_textChanged?4(firmware)
 eric7.MicroPython.Devices.EspDialogs.EspFirmwareSelectionDialog.EspFirmwareSelectionDialog?1(addon=False, parent=None)
 eric7.MicroPython.Devices.FirmwareGithubUrls?7
+eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice._getSetTimeCode?5()
+eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.addDeviceMenuEntries?4(menu)
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.canRunScript?4()
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.canStartFileManager?4()
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.canStartPlotter?4()
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.canStartRepl?4()
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.deviceName?4()
+eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.getDocumentationUrl?4()
+eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.getFirmwareUrl?4()
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.getWorkspace?4(silent=False)
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.runScript?4(script)
 eric7.MicroPython.Devices.GenericMicroPythonDevices.GenericMicroPythonDevice.setButtons?4()
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Thu Mar 16 12:09:10 2023 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Thu Mar 16 12:10:12 2023 +0100
@@ -2844,6 +2844,7 @@
       <keyword name="CircuitPythonDevice (Constructor)" id="CircuitPythonDevice (Constructor)" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.__init__" />
       <keyword name="CircuitPythonDevice.__aboutToShowLibraryMenu" id="CircuitPythonDevice.__aboutToShowLibraryMenu" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.__aboutToShowLibraryMenu" />
       <keyword name="CircuitPythonDevice.__activateBootloader" id="CircuitPythonDevice.__activateBootloader" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.__activateBootloader" />
+      <keyword name="CircuitPythonDevice.__activateUF2Boot" id="CircuitPythonDevice.__activateUF2Boot" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.__activateUF2Boot" />
       <keyword name="CircuitPythonDevice.__cpyVersionResponse" id="CircuitPythonDevice.__cpyVersionResponse" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.__cpyVersionResponse" />
       <keyword name="CircuitPythonDevice.__createCPyMenu" id="CircuitPythonDevice.__createCPyMenu" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.__createCPyMenu" />
       <keyword name="CircuitPythonDevice.__createFlashMenus" id="CircuitPythonDevice.__createFlashMenus" ref="eric7.MicroPython.Devices.CircuitPythonDevices.html#CircuitPythonDevice.__createFlashMenus" />
@@ -6670,13 +6671,22 @@
       <keyword name="FunctionVisitor.switchContext" id="FunctionVisitor.switchContext" ref="eric7.Plugins.CheckerPlugins.CodeStyleChecker.Annotations.AnnotationsFunctionVisitor.html#FunctionVisitor.switchContext" />
       <keyword name="GenericMicroPythonDevice" id="GenericMicroPythonDevice" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice" />
       <keyword name="GenericMicroPythonDevice (Constructor)" id="GenericMicroPythonDevice (Constructor)" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__init__" />
+      <keyword name="GenericMicroPythonDevice.__activateBootloader" id="GenericMicroPythonDevice.__activateBootloader" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__activateBootloader" />
+      <keyword name="GenericMicroPythonDevice.__createGenericMenu" id="GenericMicroPythonDevice.__createGenericMenu" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__createGenericMenu" />
       <keyword name="GenericMicroPythonDevice.__deviceVolumeMounted" id="GenericMicroPythonDevice.__deviceVolumeMounted" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__deviceVolumeMounted" />
       <keyword name="GenericMicroPythonDevice.__findWorkspace" id="GenericMicroPythonDevice.__findWorkspace" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__findWorkspace" />
+      <keyword name="GenericMicroPythonDevice.__firmwareVersionResponse" id="GenericMicroPythonDevice.__firmwareVersionResponse" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__firmwareVersionResponse" />
+      <keyword name="GenericMicroPythonDevice.__resetDevice" id="GenericMicroPythonDevice.__resetDevice" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__resetDevice" />
+      <keyword name="GenericMicroPythonDevice.__showFirmwareVersions" id="GenericMicroPythonDevice.__showFirmwareVersions" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.__showFirmwareVersions" />
+      <keyword name="GenericMicroPythonDevice._getSetTimeCode" id="GenericMicroPythonDevice._getSetTimeCode" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice._getSetTimeCode" />
+      <keyword name="GenericMicroPythonDevice.addDeviceMenuEntries" id="GenericMicroPythonDevice.addDeviceMenuEntries" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.addDeviceMenuEntries" />
       <keyword name="GenericMicroPythonDevice.canRunScript" id="GenericMicroPythonDevice.canRunScript" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.canRunScript" />
       <keyword name="GenericMicroPythonDevice.canStartFileManager" id="GenericMicroPythonDevice.canStartFileManager" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.canStartFileManager" />
       <keyword name="GenericMicroPythonDevice.canStartPlotter" id="GenericMicroPythonDevice.canStartPlotter" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.canStartPlotter" />
       <keyword name="GenericMicroPythonDevice.canStartRepl" id="GenericMicroPythonDevice.canStartRepl" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.canStartRepl" />
       <keyword name="GenericMicroPythonDevice.deviceName" id="GenericMicroPythonDevice.deviceName" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.deviceName" />
+      <keyword name="GenericMicroPythonDevice.getDocumentationUrl" id="GenericMicroPythonDevice.getDocumentationUrl" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.getDocumentationUrl" />
+      <keyword name="GenericMicroPythonDevice.getFirmwareUrl" id="GenericMicroPythonDevice.getFirmwareUrl" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.getFirmwareUrl" />
       <keyword name="GenericMicroPythonDevice.getWorkspace" id="GenericMicroPythonDevice.getWorkspace" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.getWorkspace" />
       <keyword name="GenericMicroPythonDevice.runScript" id="GenericMicroPythonDevice.runScript" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.runScript" />
       <keyword name="GenericMicroPythonDevice.setButtons" id="GenericMicroPythonDevice.setButtons" ref="eric7.MicroPython.Devices.GenericMicroPythonDevices.html#GenericMicroPythonDevice.setButtons" />
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Thu Mar 16 12:09:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Thu Mar 16 12:10:12 2023 +0100
@@ -71,6 +71,10 @@
 <td>Private slot to switch the board into 'bootloader' mode.</td>
 </tr>
 <tr>
+<td><a href="#CircuitPythonDevice.__activateUF2Boot">__activateUF2Boot</a></td>
+<td>Private slot to switch the board into 'UF2 Boot' mode.</td>
+</tr>
+<tr>
 <td><a href="#CircuitPythonDevice.__cpyVersionResponse">__cpyVersionResponse</a></td>
 <td>Private slot handling the response of the latest version request.</td>
 </tr>
@@ -362,6 +366,13 @@
 <p>
         Private slot to switch the board into 'bootloader' mode.
 </p>
+<a NAME="CircuitPythonDevice.__activateUF2Boot" ID="CircuitPythonDevice.__activateUF2Boot"></a>
+<h4>CircuitPythonDevice.__activateUF2Boot</h4>
+<b>__activateUF2Boot</b>(<i></i>)
+
+<p>
+        Private slot to switch the board into 'UF2 Boot' mode.
+</p>
 <a NAME="CircuitPythonDevice.__cpyVersionResponse" ID="CircuitPythonDevice.__cpyVersionResponse"></a>
 <h4>CircuitPythonDevice.__cpyVersionResponse</h4>
 <b>__cpyVersionResponse</b>(<i>reply</i>)
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Thu Mar 16 12:09:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Thu Mar 16 12:10:12 2023 +0100
@@ -44,8 +44,10 @@
     If a board needs special treatment, the command should be overwritten
     in the board specific subclass. Commands are provided to perform operations
     on the file system of a connected MicroPython device, for getting and setting
-    the time on the board and getting board related data. Supported file system
-    commands are:
+    the time on the board and getting board related data.
+</p>
+<p>
+    Supported file system commands are:
     <ul>
     <li>cd: change directory</li>
     <li>exists: test the existence of a file or directory on the device</li>
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.GenericMicroPythonDevices.html	Thu Mar 16 12:09:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.GenericMicroPythonDevices.html	Thu Mar 16 12:10:12 2023 +0100
@@ -64,6 +64,14 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#GenericMicroPythonDevice.__activateBootloader">__activateBootloader</a></td>
+<td>Private slot to switch the board into 'bootloader' mode.</td>
+</tr>
+<tr>
+<td><a href="#GenericMicroPythonDevice.__createGenericMenu">__createGenericMenu</a></td>
+<td>Private method to create the Generic submenu.</td>
+</tr>
+<tr>
 <td><a href="#GenericMicroPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td>
 <td>Private method to check, if the device volume is mounted.</td>
 </tr>
@@ -72,6 +80,26 @@
 <td>Private method to find the workspace directory.</td>
 </tr>
 <tr>
+<td><a href="#GenericMicroPythonDevice.__firmwareVersionResponse">__firmwareVersionResponse</a></td>
+<td>Private slot handling the response of the latest version request.</td>
+</tr>
+<tr>
+<td><a href="#GenericMicroPythonDevice.__resetDevice">__resetDevice</a></td>
+<td>Private slot to reset the connected device.</td>
+</tr>
+<tr>
+<td><a href="#GenericMicroPythonDevice.__showFirmwareVersions">__showFirmwareVersions</a></td>
+<td>Private slot to show the firmware version of the connected device and the available firmware version.</td>
+</tr>
+<tr>
+<td><a href="#GenericMicroPythonDevice._getSetTimeCode">_getSetTimeCode</a></td>
+<td>Protected method to get the device code to set the time.</td>
+</tr>
+<tr>
+<td><a href="#GenericMicroPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
+<td>Public method to add device specific entries to the given menu.</td>
+</tr>
+<tr>
 <td><a href="#GenericMicroPythonDevice.canRunScript">canRunScript</a></td>
 <td>Public method to determine, if a script can be executed.</td>
 </tr>
@@ -92,6 +120,14 @@
 <td>Public method to get the name of the device.</td>
 </tr>
 <tr>
+<td><a href="#GenericMicroPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td>
+<td>Public method to get the device documentation URL.</td>
+</tr>
+<tr>
+<td><a href="#GenericMicroPythonDevice.getFirmwareUrl">getFirmwareUrl</a></td>
+<td>Public method to get the device firmware download URL.</td>
+</tr>
+<tr>
 <td><a href="#GenericMicroPythonDevice.getWorkspace">getWorkspace</a></td>
 <td>Public method to get the workspace directory.</td>
 </tr>
@@ -144,6 +180,20 @@
 reference to the parent object
 </dd>
 </dl>
+<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>)
@@ -189,6 +239,72 @@
 str
 </dd>
 </dl>
+<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>
+<dd>
+reference to the reply object
+</dd>
+</dl>
+<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>
+<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="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>
+<dd>
+reference to the context menu
+</dd>
+</dl>
 <a NAME="GenericMicroPythonDevice.canRunScript" ID="GenericMicroPythonDevice.canRunScript"></a>
 <h4>GenericMicroPythonDevice.canRunScript</h4>
 <b>canRunScript</b>(<i></i>)
@@ -288,6 +404,44 @@
 str
 </dd>
 </dl>
+<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>
+documentation URL of the device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<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>
+firmware download URL of the device
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="GenericMicroPythonDevice.getWorkspace" ID="GenericMicroPythonDevice.getWorkspace"></a>
 <h4>GenericMicroPythonDevice.getWorkspace</h4>
 <b>getWorkspace</b>(<i>silent=False</i>)
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html	Thu Mar 16 12:09:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html	Thu Mar 16 12:10:12 2023 +0100
@@ -69,7 +69,7 @@
 </tr>
 <tr>
 <td><a href="#RP2040Device.__createRP2040Menu">__createRP2040Menu</a></td>
-<td>Private method to create the RO2040 submenu.</td>
+<td>Private method to create the RP2040 submenu.</td>
 </tr>
 <tr>
 <td><a href="#RP2040Device.__firmwareVersionResponse">__firmwareVersionResponse</a></td>
@@ -276,7 +276,7 @@
 <b>__createRP2040Menu</b>(<i></i>)
 
 <p>
-        Private method to create the RO2040 submenu.
+        Private method to create the RP2040 submenu.
 </p>
 <a NAME="RP2040Device.__firmwareVersionResponse" ID="RP2040Device.__firmwareVersionResponse"></a>
 <h4>RP2040Device.__firmwareVersionResponse</h4>
--- a/src/eric7/Documentation/Source/eric7.MicroPython.UF2FlashDialog.html	Thu Mar 16 12:09:10 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.UF2FlashDialog.html	Thu Mar 16 12:10:12 2023 +0100
@@ -330,7 +330,7 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-list of tuple of (str, str, int, int)
+list of tuple of (str, str, (int, int))
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial