--- a/src/eric7/Documentation/Source/eric7.MicroPython.EspDevices.html Sun Feb 12 18:11:20 2023 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,556 +0,0 @@
-<!DOCTYPE html>
-<html><head>
-<title>eric7.MicroPython.EspDevices</title>
-<meta charset="UTF-8">
-<link rel="stylesheet" href="styles.css">
-</head>
-<body>
-<a NAME="top" ID="top"></a>
-<h1>eric7.MicroPython.EspDevices</h1>
-
-<p>
-Module implementing the device interface class for ESP32 and ESP8266 based
-boards.
-</p>
-<h3>Global Attributes</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Classes</h3>
-
-<table>
-
-<tr>
-<td><a href="#EspDevice">EspDevice</a></td>
-<td>Class implementing the device for ESP32 and ESP8266 based 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="EspDevice" ID="EspDevice"></a>
-<h2>EspDevice</h2>
-
-<p>
- Class implementing the device for ESP32 and ESP8266 based boards.
-</p>
-<h3>Derived from</h3>
-MicroPythonDevice
-<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="#EspDevice.__init__">EspDevice</a></td>
-<td>Constructor</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__backupFlash">__backupFlash</a></td>
-<td>Private slot to backup the currently flashed firmware.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__createEsp32Submenu">__createEsp32Submenu</a></td>
-<td>Private method to create the ESP32 submenu.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__eraseFlash">__eraseFlash</a></td>
-<td>Private slot to erase the device flash memory.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__firmwareVersionResponse">__firmwareVersionResponse</a></td>
-<td>Private method handling the response of the latest version request.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__flashAddons">__flashAddons</a></td>
-<td>Private slot to flash some additional firmware images.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__flashMicroPython">__flashMicroPython</a></td>
-<td>Private slot to flash a MicroPython firmware to the device.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__installEspTool">__installEspTool</a></td>
-<td>Private slot to install the esptool package via pip.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__resetDevice">__resetDevice</a></td>
-<td>Private slot to reset the connected device.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__restoreFlash">__restoreFlash</a></td>
-<td>Private slot to restore a previously saved firmware.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__showChipID">__showChipID</a></td>
-<td>Private slot to show the ID of the ESP chip.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__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="#EspDevice.__showFlashID">__showFlashID</a></td>
-<td>Private slot to show the ID of the ESP flash chip.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.__showMACAddress">__showMACAddress</a></td>
-<td>Private slot to show the MAC address of the ESP chip.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
-<td>Public method to add device specific entries to the given menu.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.canRunScript">canRunScript</a></td>
-<td>Public method to determine, if a script can be executed.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.canStartFileManager">canStartFileManager</a></td>
-<td>Public method to determine, if a File Manager can be started.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.canStartPlotter">canStartPlotter</a></td>
-<td>Public method to determine, if a Plotter can be started.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.canStartRepl">canStartRepl</a></td>
-<td>Public method to determine, if a REPL can be started.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.deviceName">deviceName</a></td>
-<td>Public method to get the name of the device.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.forceInterrupt">forceInterrupt</a></td>
-<td>Public method to determine the need for an interrupt when opening the serial connection.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.getDocumentationUrl">getDocumentationUrl</a></td>
-<td>Public method to get the device documentation URL.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.getFirmwareUrl">getFirmwareUrl</a></td>
-<td>Public method to get the device firmware download URL.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td>
-<td>Public method to check, if the device has its own flash menu entry.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.runScript">runScript</a></td>
-<td>Public method to run the given Python script.</td>
-</tr>
-<tr>
-<td><a href="#EspDevice.setButtons">setButtons</a></td>
-<td>Public method to enable the supported action buttons.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-
-<a NAME="EspDevice.__init__" ID="EspDevice.__init__"></a>
-<h4>EspDevice (Constructor)</h4>
-<b>EspDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>)
-
-<p>
- Constructor
-</p>
-<dl>
-
-<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
-<dd>
-reference to the main MicroPython widget
-</dd>
-<dt><i>deviceType</i> (str)</dt>
-<dd>
-device type assigned to this device interface
-</dd>
-<dt><i>parent</i> (QObject)</dt>
-<dd>
-reference to the parent object
-</dd>
-</dl>
-<a NAME="EspDevice.__backupFlash" ID="EspDevice.__backupFlash"></a>
-<h4>EspDevice.__backupFlash</h4>
-<b>__backupFlash</b>(<i></i>)
-
-<p>
- Private slot to backup the currently flashed firmware.
-</p>
-<a NAME="EspDevice.__createEsp32Submenu" ID="EspDevice.__createEsp32Submenu"></a>
-<h4>EspDevice.__createEsp32Submenu</h4>
-<b>__createEsp32Submenu</b>(<i></i>)
-
-<p>
- Private method to create the ESP32 submenu.
-</p>
-<a NAME="EspDevice.__eraseFlash" ID="EspDevice.__eraseFlash"></a>
-<h4>EspDevice.__eraseFlash</h4>
-<b>__eraseFlash</b>(<i></i>)
-
-<p>
- Private slot to erase the device flash memory.
-</p>
-<a NAME="EspDevice.__firmwareVersionResponse" ID="EspDevice.__firmwareVersionResponse"></a>
-<h4>EspDevice.__firmwareVersionResponse</h4>
-<b>__firmwareVersionResponse</b>(<i>reply</i>)
-
-<p>
- Private method 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="EspDevice.__flashAddons" ID="EspDevice.__flashAddons"></a>
-<h4>EspDevice.__flashAddons</h4>
-<b>__flashAddons</b>(<i></i>)
-
-<p>
- Private slot to flash some additional firmware images.
-</p>
-<a NAME="EspDevice.__flashMicroPython" ID="EspDevice.__flashMicroPython"></a>
-<h4>EspDevice.__flashMicroPython</h4>
-<b>__flashMicroPython</b>(<i></i>)
-
-<p>
- Private slot to flash a MicroPython firmware to the device.
-</p>
-<a NAME="EspDevice.__installEspTool" ID="EspDevice.__installEspTool"></a>
-<h4>EspDevice.__installEspTool</h4>
-<b>__installEspTool</b>(<i></i>)
-
-<p>
- Private slot to install the esptool package via pip.
-</p>
-<a NAME="EspDevice.__resetDevice" ID="EspDevice.__resetDevice"></a>
-<h4>EspDevice.__resetDevice</h4>
-<b>__resetDevice</b>(<i></i>)
-
-<p>
- Private slot to reset the connected device.
-</p>
-<a NAME="EspDevice.__restoreFlash" ID="EspDevice.__restoreFlash"></a>
-<h4>EspDevice.__restoreFlash</h4>
-<b>__restoreFlash</b>(<i></i>)
-
-<p>
- Private slot to restore a previously saved firmware.
-</p>
-<a NAME="EspDevice.__showChipID" ID="EspDevice.__showChipID"></a>
-<h4>EspDevice.__showChipID</h4>
-<b>__showChipID</b>(<i></i>)
-
-<p>
- Private slot to show the ID of the ESP chip.
-</p>
-<a NAME="EspDevice.__showFirmwareVersions" ID="EspDevice.__showFirmwareVersions"></a>
-<h4>EspDevice.__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="EspDevice.__showFlashID" ID="EspDevice.__showFlashID"></a>
-<h4>EspDevice.__showFlashID</h4>
-<b>__showFlashID</b>(<i></i>)
-
-<p>
- Private slot to show the ID of the ESP flash chip.
-</p>
-<a NAME="EspDevice.__showMACAddress" ID="EspDevice.__showMACAddress"></a>
-<h4>EspDevice.__showMACAddress</h4>
-<b>__showMACAddress</b>(<i></i>)
-
-<p>
- Private slot to show the MAC address of the ESP chip.
-</p>
-<a NAME="EspDevice.addDeviceMenuEntries" ID="EspDevice.addDeviceMenuEntries"></a>
-<h4>EspDevice.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="EspDevice.canRunScript" ID="EspDevice.canRunScript"></a>
-<h4>EspDevice.canRunScript</h4>
-<b>canRunScript</b>(<i></i>)
-
-<p>
- Public method to determine, if a script can be executed.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-tuple containing a flag indicating it is safe to start a
- Plotter and a reason why it cannot.
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-tuple of (bool, str)
-</dd>
-</dl>
-<a NAME="EspDevice.canStartFileManager" ID="EspDevice.canStartFileManager"></a>
-<h4>EspDevice.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>
-tuple containing a flag indicating it is safe to start a
- File Manager and a reason why it cannot.
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-tuple of (bool, str)
-</dd>
-</dl>
-<a NAME="EspDevice.canStartPlotter" ID="EspDevice.canStartPlotter"></a>
-<h4>EspDevice.canStartPlotter</h4>
-<b>canStartPlotter</b>(<i></i>)
-
-<p>
- Public method to determine, if a Plotter can be started.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-tuple containing a flag indicating it is safe to start a
- Plotter and a reason why it cannot.
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-tuple of (bool, str)
-</dd>
-</dl>
-<a NAME="EspDevice.canStartRepl" ID="EspDevice.canStartRepl"></a>
-<h4>EspDevice.canStartRepl</h4>
-<b>canStartRepl</b>(<i></i>)
-
-<p>
- Public method to determine, if a REPL can be started.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-tuple containing a flag indicating it is safe to start a REPL
- and a reason why it cannot.
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-tuple of (bool, str)
-</dd>
-</dl>
-<a NAME="EspDevice.deviceName" ID="EspDevice.deviceName"></a>
-<h4>EspDevice.deviceName</h4>
-<b>deviceName</b>(<i></i>)
-
-<p>
- Public method to get the name of the device.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-name of the device
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-str
-</dd>
-</dl>
-<a NAME="EspDevice.forceInterrupt" ID="EspDevice.forceInterrupt"></a>
-<h4>EspDevice.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>
-flag indicating an interrupt is needed
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
-<a NAME="EspDevice.getDocumentationUrl" ID="EspDevice.getDocumentationUrl"></a>
-<h4>EspDevice.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="EspDevice.getFirmwareUrl" ID="EspDevice.getFirmwareUrl"></a>
-<h4>EspDevice.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="EspDevice.hasFlashMenuEntry" ID="EspDevice.hasFlashMenuEntry"></a>
-<h4>EspDevice.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>
-flag indicating a specific flash menu entry
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
-<a NAME="EspDevice.runScript" ID="EspDevice.runScript"></a>
-<h4>EspDevice.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>
-<dd>
-script to be executed
-</dd>
-</dl>
-<a NAME="EspDevice.setButtons" ID="EspDevice.setButtons"></a>
-<h4>EspDevice.setButtons</h4>
-<b>setButtons</b>(<i></i>)
-
-<p>
- Public method to enable the supported action buttons.
-</p>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-<hr />
-<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>
-<dd>
-reference to the main MicroPython widget
-</dd>
-<dt><i>deviceType</i> (str)</dt>
-<dd>
-device type assigned to this device interface
-</dd>
-<dt><i>vid</i> (int)</dt>
-<dd>
-vendor ID
-</dd>
-<dt><i>pid</i> (int)</dt>
-<dd>
-product ID
-</dd>
-<dt><i>boardName</i> (str)</dt>
-<dd>
-name of the board
-</dd>
-<dt><i>serialNumber</i> (str)</dt>
-<dd>
-serial number of the board
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-reference to the instantiated device object
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-EspDevice
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
-</body></html>
\ No newline at end of file
