Thu, 04 Jan 2024 18:02:25 +0100
Fine tuned the source code documentation template and regenerated the source code documentation.
<!DOCTYPE html> <html><head> <title>eric7.MicroPython.Devices.EspDialogs.EspBackupRestoreFirmwareDialog</title> <meta charset="UTF-8"> <link rel="stylesheet" href="styles.css"> </head> <body> <a NAME="top" ID="top"></a> <h1>eric7.MicroPython.Devices.EspDialogs.EspBackupRestoreFirmwareDialog</h1> <p> Module implementing a dialog to select the ESP chip type and the backup and restore parameters. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#EspBackupRestoreFirmwareDialog">EspBackupRestoreFirmwareDialog</a></td> <td>Class implementing a dialog to select the ESP chip type and the backup and restore parameters.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /> <hr /> <a NAME="EspBackupRestoreFirmwareDialog" ID="EspBackupRestoreFirmwareDialog"></a> <h2>EspBackupRestoreFirmwareDialog</h2> <p> Class implementing a dialog to select the ESP chip type and the backup and restore parameters. </p> <h3>Derived from</h3> QDialog, Ui_EspBackupRestoreFirmwareDialog <h3>Class Attributes</h3> <table> <tr><td>Chips</td></tr> <tr><td>FlashModes</td></tr> <tr><td>FlashSizes</td></tr> </table> <h3>Class Methods</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#EspBackupRestoreFirmwareDialog.__init__">EspBackupRestoreFirmwareDialog</a></td> <td>Constructor</td> </tr> <tr> <td><a href="#EspBackupRestoreFirmwareDialog.__updateOkButton">__updateOkButton</a></td> <td>Private method to update the state of the OK button.</td> </tr> <tr> <td><a href="#EspBackupRestoreFirmwareDialog.getData">getData</a></td> <td>Public method to get the entered data.</td> </tr> <tr> <td><a href="#EspBackupRestoreFirmwareDialog.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="#EspBackupRestoreFirmwareDialog.on_firmwarePicker_textChanged">on_firmwarePicker_textChanged</a></td> <td>Private slot handling a change of the firmware path.</td> </tr> <tr> <td><a href="#EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged">on_sizeComboBox_currentTextChanged</a></td> <td>Private slot handling a change of the selected firmware size.</td> </tr> </table> <h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> <a NAME="EspBackupRestoreFirmwareDialog.__init__" ID="EspBackupRestoreFirmwareDialog.__init__"></a> <h4>EspBackupRestoreFirmwareDialog (Constructor)</h4> <b>EspBackupRestoreFirmwareDialog</b>(<i>backupMode=True, parent=None</i>) <p> Constructor </p> <dl> <dt><i>backupMode</i> (bool)</dt> <dd> flag indicating parameters for a firmware backup are requested </dd> <dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> </dl> <a NAME="EspBackupRestoreFirmwareDialog.__updateOkButton" ID="EspBackupRestoreFirmwareDialog.__updateOkButton"></a> <h4>EspBackupRestoreFirmwareDialog.__updateOkButton</h4> <b>__updateOkButton</b>(<i></i>) <p> Private method to update the state of the OK button. </p> <a NAME="EspBackupRestoreFirmwareDialog.getData" ID="EspBackupRestoreFirmwareDialog.getData"></a> <h4>EspBackupRestoreFirmwareDialog.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 firmware size, the baud rate or flashing, the flash mode and the path of the firmware file </dd> </dl> <dl> <dt>Return Type:</dt> <dd> tuple of (str, str, str, str, str) </dd> </dl> <a NAME="EspBackupRestoreFirmwareDialog.on_espComboBox_currentTextChanged" ID="EspBackupRestoreFirmwareDialog.on_espComboBox_currentTextChanged"></a> <h4>EspBackupRestoreFirmwareDialog.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="EspBackupRestoreFirmwareDialog.on_firmwarePicker_textChanged" ID="EspBackupRestoreFirmwareDialog.on_firmwarePicker_textChanged"></a> <h4>EspBackupRestoreFirmwareDialog.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> <a NAME="EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged" ID="EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged"></a> <h4>EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged</h4> <b>on_sizeComboBox_currentTextChanged</b>(<i>size</i>) <p> Private slot handling a change of the selected firmware size. </p> <dl> <dt><i>size</i> (str)</dt> <dd> selected size text </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>