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

branch
eric7
changeset 9756
9854647c8c5c
child 10479
856476537696
equal deleted inserted replaced
9755:1a09700229e7 9756:9854647c8c5c
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.MicroPython.Devices.EspDialogs.EspBackupRestoreFirmwareDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.Devices.EspDialogs.EspBackupRestoreFirmwareDialog</h1>
10
11 <p>
12 Module implementing a dialog to select the ESP chip type and the backup and
13 restore parameters.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#EspBackupRestoreFirmwareDialog">EspBackupRestoreFirmwareDialog</a></td>
26 <td>Class implementing a dialog to select the ESP chip type and the backup and restore parameters.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="EspBackupRestoreFirmwareDialog" ID="EspBackupRestoreFirmwareDialog"></a>
37 <h2>EspBackupRestoreFirmwareDialog</h2>
38
39 <p>
40 Class implementing a dialog to select the ESP chip type and the backup and
41 restore parameters.
42 </p>
43 <h3>Derived from</h3>
44 QDialog, Ui_EspBackupRestoreFirmwareDialog
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>Chips</td></tr><tr><td>FlashModes</td></tr><tr><td>FlashSizes</td></tr>
49 </table>
50 <h3>Class Methods</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Methods</h3>
56
57 <table>
58
59 <tr>
60 <td><a href="#EspBackupRestoreFirmwareDialog.__init__">EspBackupRestoreFirmwareDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#EspBackupRestoreFirmwareDialog.__updateOkButton">__updateOkButton</a></td>
65 <td>Private method to update the state of the OK button.</td>
66 </tr>
67 <tr>
68 <td><a href="#EspBackupRestoreFirmwareDialog.getData">getData</a></td>
69 <td>Public method to get the entered data.</td>
70 </tr>
71 <tr>
72 <td><a href="#EspBackupRestoreFirmwareDialog.on_espComboBox_currentTextChanged">on_espComboBox_currentTextChanged</a></td>
73 <td>Private slot to handle the selection of a chip type.</td>
74 </tr>
75 <tr>
76 <td><a href="#EspBackupRestoreFirmwareDialog.on_firmwarePicker_textChanged">on_firmwarePicker_textChanged</a></td>
77 <td>Private slot handling a change of the firmware path.</td>
78 </tr>
79 <tr>
80 <td><a href="#EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged">on_sizeComboBox_currentTextChanged</a></td>
81 <td>Private slot handling a change of the selected firmware size.</td>
82 </tr>
83 </table>
84 <h3>Static Methods</h3>
85
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89
90 <a NAME="EspBackupRestoreFirmwareDialog.__init__" ID="EspBackupRestoreFirmwareDialog.__init__"></a>
91 <h4>EspBackupRestoreFirmwareDialog (Constructor)</h4>
92 <b>EspBackupRestoreFirmwareDialog</b>(<i>backupMode=True, parent=None</i>)
93
94 <p>
95 Constructor
96 </p>
97 <dl>
98
99 <dt><i>backupMode</i> (bool)</dt>
100 <dd>
101 flag indicating parameters for a firmware backup are
102 requested
103 </dd>
104 <dt><i>parent</i> (QWidget)</dt>
105 <dd>
106 reference to the parent widget
107 </dd>
108 </dl>
109 <a NAME="EspBackupRestoreFirmwareDialog.__updateOkButton" ID="EspBackupRestoreFirmwareDialog.__updateOkButton"></a>
110 <h4>EspBackupRestoreFirmwareDialog.__updateOkButton</h4>
111 <b>__updateOkButton</b>(<i></i>)
112
113 <p>
114 Private method to update the state of the OK button.
115 </p>
116 <a NAME="EspBackupRestoreFirmwareDialog.getData" ID="EspBackupRestoreFirmwareDialog.getData"></a>
117 <h4>EspBackupRestoreFirmwareDialog.getData</h4>
118 <b>getData</b>(<i></i>)
119
120 <p>
121 Public method to get the entered data.
122 </p>
123 <dl>
124 <dt>Return:</dt>
125 <dd>
126 tuple containing the selected chip type, the firmware size,
127 the baud rate or flashing, the flash mode and the path of the
128 firmware file
129 </dd>
130 </dl>
131 <dl>
132 <dt>Return Type:</dt>
133 <dd>
134 tuple of (str, str, str, str, str)
135 </dd>
136 </dl>
137 <a NAME="EspBackupRestoreFirmwareDialog.on_espComboBox_currentTextChanged" ID="EspBackupRestoreFirmwareDialog.on_espComboBox_currentTextChanged"></a>
138 <h4>EspBackupRestoreFirmwareDialog.on_espComboBox_currentTextChanged</h4>
139 <b>on_espComboBox_currentTextChanged</b>(<i>chip</i>)
140
141 <p>
142 Private slot to handle the selection of a chip type.
143 </p>
144 <dl>
145
146 <dt><i>chip</i> (str)</dt>
147 <dd>
148 selected chip type
149 </dd>
150 </dl>
151 <a NAME="EspBackupRestoreFirmwareDialog.on_firmwarePicker_textChanged" ID="EspBackupRestoreFirmwareDialog.on_firmwarePicker_textChanged"></a>
152 <h4>EspBackupRestoreFirmwareDialog.on_firmwarePicker_textChanged</h4>
153 <b>on_firmwarePicker_textChanged</b>(<i>firmware</i>)
154
155 <p>
156 Private slot handling a change of the firmware path.
157 </p>
158 <dl>
159
160 <dt><i>firmware</i> (str)</dt>
161 <dd>
162 path to the firmware
163 </dd>
164 </dl>
165 <a NAME="EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged" ID="EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged"></a>
166 <h4>EspBackupRestoreFirmwareDialog.on_sizeComboBox_currentTextChanged</h4>
167 <b>on_sizeComboBox_currentTextChanged</b>(<i>size</i>)
168
169 <p>
170 Private slot handling a change of the selected firmware size.
171 </p>
172 <dl>
173
174 <dt><i>size</i> (str)</dt>
175 <dd>
176 selected size text
177 </dd>
178 </dl>
179 <div align="right"><a href="#top">Up</a></div>
180 <hr />
181 </body></html>

eric ide

mercurial