src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDialogs.EspFirmwareSelectionDialog.html

branch
eric7
changeset 9756
9854647c8c5c
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDialogs.EspFirmwareSelectionDialog.html	Mon Feb 13 17:49:52 2023 +0100
@@ -0,0 +1,180 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.MicroPython.Devices.EspDialogs.EspFirmwareSelectionDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.MicroPython.Devices.EspDialogs.EspFirmwareSelectionDialog</h1>
+
+<p>
+Module implementing a dialog to select the ESP chip type and the firmware to
+be flashed.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#EspFirmwareSelectionDialog">EspFirmwareSelectionDialog</a></td>
+<td>Class implementing a dialog to select the ESP chip type and the firmware to be flashed.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="EspFirmwareSelectionDialog" ID="EspFirmwareSelectionDialog"></a>
+<h2>EspFirmwareSelectionDialog</h2>
+
+<p>
+    Class implementing a dialog to select the ESP chip type and the firmware to
+    be flashed.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_EspFirmwareSelectionDialog
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>Chips</td></tr><tr><td>FlashAddresses</td></tr><tr><td>FlashModes</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#EspFirmwareSelectionDialog.__init__">EspFirmwareSelectionDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#EspFirmwareSelectionDialog.__updateOkButton">__updateOkButton</a></td>
+<td>Private method to update the state of the OK button.</td>
+</tr>
+<tr>
+<td><a href="#EspFirmwareSelectionDialog.getData">getData</a></td>
+<td>Public method to get the entered data.</td>
+</tr>
+<tr>
+<td><a href="#EspFirmwareSelectionDialog.on_addressEdit_textChanged">on_addressEdit_textChanged</a></td>
+<td>Private slot handling a change of the address.</td>
+</tr>
+<tr>
+<td><a href="#EspFirmwareSelectionDialog.on_espComboBox_currentTextChanged">on_espComboBox_currentTextChanged</a></td>
+<td>Private slot to handle the selection of a chip type.</td>
+</tr>
+<tr>
+<td><a href="#EspFirmwareSelectionDialog.on_firmwarePicker_textChanged">on_firmwarePicker_textChanged</a></td>
+<td>Private slot handling a change of the firmware path.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="EspFirmwareSelectionDialog.__init__" ID="EspFirmwareSelectionDialog.__init__"></a>
+<h4>EspFirmwareSelectionDialog (Constructor)</h4>
+<b>EspFirmwareSelectionDialog</b>(<i>addon=False, parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>addon</i> (bool)</dt>
+<dd>
+flag indicating an addon firmware
+</dd>
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<a NAME="EspFirmwareSelectionDialog.__updateOkButton" ID="EspFirmwareSelectionDialog.__updateOkButton"></a>
+<h4>EspFirmwareSelectionDialog.__updateOkButton</h4>
+<b>__updateOkButton</b>(<i></i>)
+
+<p>
+        Private method to update the state of the OK button.
+</p>
+<a NAME="EspFirmwareSelectionDialog.getData" ID="EspFirmwareSelectionDialog.getData"></a>
+<h4>EspFirmwareSelectionDialog.getData</h4>
+<b>getData</b>(<i></i>)
+
+<p>
+        Public method to get the entered data.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the selected chip type, the path of the
+            firmware file, the baud rate, the flash mode and the flash
+            address
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str, str, str, str)
+</dd>
+</dl>
+<a NAME="EspFirmwareSelectionDialog.on_addressEdit_textChanged" ID="EspFirmwareSelectionDialog.on_addressEdit_textChanged"></a>
+<h4>EspFirmwareSelectionDialog.on_addressEdit_textChanged</h4>
+<b>on_addressEdit_textChanged</b>(<i>address</i>)
+
+<p>
+        Private slot handling a change of the address.
+</p>
+<dl>
+
+<dt><i>address</i> (str)</dt>
+<dd>
+entered address
+</dd>
+</dl>
+<a NAME="EspFirmwareSelectionDialog.on_espComboBox_currentTextChanged" ID="EspFirmwareSelectionDialog.on_espComboBox_currentTextChanged"></a>
+<h4>EspFirmwareSelectionDialog.on_espComboBox_currentTextChanged</h4>
+<b>on_espComboBox_currentTextChanged</b>(<i>chip</i>)
+
+<p>
+        Private slot to handle the selection of a chip type.
+</p>
+<dl>
+
+<dt><i>chip</i> (str)</dt>
+<dd>
+selected chip type
+</dd>
+</dl>
+<a NAME="EspFirmwareSelectionDialog.on_firmwarePicker_textChanged" ID="EspFirmwareSelectionDialog.on_firmwarePicker_textChanged"></a>
+<h4>EspFirmwareSelectionDialog.on_firmwarePicker_textChanged</h4>
+<b>on_firmwarePicker_textChanged</b>(<i>firmware</i>)
+
+<p>
+        Private slot handling a change of the firmware path.
+</p>
+<dl>
+
+<dt><i>firmware</i> (str)</dt>
+<dd>
+path to the firmware
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial