src/eric7/Documentation/Source/eric7.MicroPython.ConvertToUF2Dialog.html

branch
eric7
changeset 10479
856476537696
parent 9915
fd5ff16632cb
child 10690
fab36645aa7d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.ConvertToUF2Dialog</h1> 9 <h1>eric7.MicroPython.ConvertToUF2Dialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to convert a .hex or .bin firmware file to .uf2. 11 Module implementing a dialog to convert a .hex or .bin firmware file to .uf2.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ConvertToUF2Dialog">ConvertToUF2Dialog</a></td> 22 <td><a href="#ConvertToUF2Dialog">ConvertToUF2Dialog</a></td>
25 <td>Class implementing a dialog to convert a .hex or .bin firmware file to .uf2.</td> 23 <td>Class implementing a dialog to convert a .hex or .bin firmware file to .uf2.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="ConvertToUF2Dialog" ID="ConvertToUF2Dialog"></a> 34 <a NAME="ConvertToUF2Dialog" ID="ConvertToUF2Dialog"></a>
36 <h2>ConvertToUF2Dialog</h2> 35 <h2>ConvertToUF2Dialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog to convert a .hex or .bin firmware file to .uf2. 37 Class implementing a dialog to convert a .hex or .bin firmware file to .uf2.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QDialog, Ui_ConvertToUF2Dialog 41 QDialog, Ui_ConvertToUF2Dialog
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
43 <table>
44 <tr><td>ConvertScript</td></tr>
45 <tr><td>FamiliesFile</td></tr>
46 </table>
44 47
45 <table>
46 <tr><td>ConvertScript</td></tr><tr><td>FamiliesFile</td></tr>
47 </table>
48 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
49
50 <table> 49 <table>
51 <tr><td>None</td></tr> 50 <tr><td>None</td></tr>
52 </table> 51 </table>
52
53 <h3>Methods</h3> 53 <h3>Methods</h3>
54
55 <table> 54 <table>
56
57 <tr> 55 <tr>
58 <td><a href="#ConvertToUF2Dialog.__init__">ConvertToUF2Dialog</a></td> 56 <td><a href="#ConvertToUF2Dialog.__init__">ConvertToUF2Dialog</a></td>
59 <td>Constructor</td> 57 <td>Constructor</td>
60 </tr> 58 </tr>
61 <tr> 59 <tr>
89 <tr> 87 <tr>
90 <td><a href="#ConvertToUF2Dialog.on_firmwarePicker_textChanged">on_firmwarePicker_textChanged</a></td> 88 <td><a href="#ConvertToUF2Dialog.on_firmwarePicker_textChanged">on_firmwarePicker_textChanged</a></td>
91 <td>Private slot handling a change of the firmware file name.</td> 89 <td>Private slot handling a change of the firmware file name.</td>
92 </tr> 90 </tr>
93 </table> 91 </table>
92
94 <h3>Static Methods</h3> 93 <h3>Static Methods</h3>
95
96 <table> 94 <table>
97 <tr><td>None</td></tr> 95 <tr><td>None</td></tr>
98 </table> 96 </table>
99 97
98
100 <a NAME="ConvertToUF2Dialog.__init__" ID="ConvertToUF2Dialog.__init__"></a> 99 <a NAME="ConvertToUF2Dialog.__init__" ID="ConvertToUF2Dialog.__init__"></a>
101 <h4>ConvertToUF2Dialog (Constructor)</h4> 100 <h4>ConvertToUF2Dialog (Constructor)</h4>
102 <b>ConvertToUF2Dialog</b>(<i>parent=None</i>) 101 <b>ConvertToUF2Dialog</b>(<i>parent=None</i>)
103
104 <p> 102 <p>
105 Constructor 103 Constructor
106 </p> 104 </p>
105
107 <dl> 106 <dl>
108 107
109 <dt><i>parent</i> (QWidget (optional))</dt> 108 <dt><i>parent</i> (QWidget (optional))</dt>
110 <dd> 109 <dd>
111 reference to the parent widget (defaults to None) 110 reference to the parent widget (defaults to None)
112 </dd> 111 </dd>
113 </dl> 112 </dl>
114 <a NAME="ConvertToUF2Dialog.__conversionFinished" ID="ConvertToUF2Dialog.__conversionFinished"></a> 113 <a NAME="ConvertToUF2Dialog.__conversionFinished" ID="ConvertToUF2Dialog.__conversionFinished"></a>
115 <h4>ConvertToUF2Dialog.__conversionFinished</h4> 114 <h4>ConvertToUF2Dialog.__conversionFinished</h4>
116 <b>__conversionFinished</b>(<i>exitCode, exitStatus</i>) 115 <b>__conversionFinished</b>(<i>exitCode, exitStatus</i>)
117
118 <p> 116 <p>
119 Private slot handling the end of the conversion process. 117 Private slot handling the end of the conversion process.
120 </p> 118 </p>
119
121 <dl> 120 <dl>
122 121
123 <dt><i>exitCode</i> (int)</dt> 122 <dt><i>exitCode</i> (int)</dt>
124 <dd> 123 <dd>
125 exit code of the process 124 exit code of the process
130 </dd> 129 </dd>
131 </dl> 130 </dl>
132 <a NAME="ConvertToUF2Dialog.__populateFamilyComboBox" ID="ConvertToUF2Dialog.__populateFamilyComboBox"></a> 131 <a NAME="ConvertToUF2Dialog.__populateFamilyComboBox" ID="ConvertToUF2Dialog.__populateFamilyComboBox"></a>
133 <h4>ConvertToUF2Dialog.__populateFamilyComboBox</h4> 132 <h4>ConvertToUF2Dialog.__populateFamilyComboBox</h4>
134 <b>__populateFamilyComboBox</b>(<i></i>) 133 <b>__populateFamilyComboBox</b>(<i></i>)
135
136 <p> 134 <p>
137 Private method to populate the chip family combo box with values read from 135 Private method to populate the chip family combo box with values read from
138 'uf2families.json' file. 136 'uf2families.json' file.
139 </p> 137 </p>
138
140 <a NAME="ConvertToUF2Dialog.__readError" ID="ConvertToUF2Dialog.__readError"></a> 139 <a NAME="ConvertToUF2Dialog.__readError" ID="ConvertToUF2Dialog.__readError"></a>
141 <h4>ConvertToUF2Dialog.__readError</h4> 140 <h4>ConvertToUF2Dialog.__readError</h4>
142 <b>__readError</b>(<i></i>) 141 <b>__readError</b>(<i></i>)
143
144 <p> 142 <p>
145 Private slot to read the standard error channel of the conversion process. 143 Private slot to read the standard error channel of the conversion process.
146 </p> 144 </p>
145
147 <a NAME="ConvertToUF2Dialog.__readOutput" ID="ConvertToUF2Dialog.__readOutput"></a> 146 <a NAME="ConvertToUF2Dialog.__readOutput" ID="ConvertToUF2Dialog.__readOutput"></a>
148 <h4>ConvertToUF2Dialog.__readOutput</h4> 147 <h4>ConvertToUF2Dialog.__readOutput</h4>
149 <b>__readOutput</b>(<i></i>) 148 <b>__readOutput</b>(<i></i>)
150
151 <p> 149 <p>
152 Private slot to read the standard output channel of the conversion process. 150 Private slot to read the standard output channel of the conversion process.
153 </p> 151 </p>
152
154 <a NAME="ConvertToUF2Dialog.__updateConvertButton" ID="ConvertToUF2Dialog.__updateConvertButton"></a> 153 <a NAME="ConvertToUF2Dialog.__updateConvertButton" ID="ConvertToUF2Dialog.__updateConvertButton"></a>
155 <h4>ConvertToUF2Dialog.__updateConvertButton</h4> 154 <h4>ConvertToUF2Dialog.__updateConvertButton</h4>
156 <b>__updateConvertButton</b>(<i></i>) 155 <b>__updateConvertButton</b>(<i></i>)
157
158 <p> 156 <p>
159 Private method to set the enabled status of the 'Convert' button. 157 Private method to set the enabled status of the 'Convert' button.
160 </p> 158 </p>
159
161 <a NAME="ConvertToUF2Dialog.on_convertButton_clicked" ID="ConvertToUF2Dialog.on_convertButton_clicked"></a> 160 <a NAME="ConvertToUF2Dialog.on_convertButton_clicked" ID="ConvertToUF2Dialog.on_convertButton_clicked"></a>
162 <h4>ConvertToUF2Dialog.on_convertButton_clicked</h4> 161 <h4>ConvertToUF2Dialog.on_convertButton_clicked</h4>
163 <b>on_convertButton_clicked</b>(<i></i>) 162 <b>on_convertButton_clicked</b>(<i></i>)
164
165 <p> 163 <p>
166 Private slot activating the conversion process. 164 Private slot activating the conversion process.
167 </p> 165 </p>
166
168 <a NAME="ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged" ID="ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged"></a> 167 <a NAME="ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged" ID="ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged"></a>
169 <h4>ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged</h4> 168 <h4>ConvertToUF2Dialog.on_familiesComboBox_currentTextChanged</h4>
170 <b>on_familiesComboBox_currentTextChanged</b>(<i>family</i>) 169 <b>on_familiesComboBox_currentTextChanged</b>(<i>family</i>)
171
172 <p> 170 <p>
173 Private slot handling the selection of a chip family. 171 Private slot handling the selection of a chip family.
174 </p> 172 </p>
173
175 <dl> 174 <dl>
176 175
177 <dt><i>family</i> (str)</dt> 176 <dt><i>family</i> (str)</dt>
178 <dd> 177 <dd>
179 name of the selected chip family 178 name of the selected chip family
180 </dd> 179 </dd>
181 </dl> 180 </dl>
182 <a NAME="ConvertToUF2Dialog.on_firmwarePicker_textChanged" ID="ConvertToUF2Dialog.on_firmwarePicker_textChanged"></a> 181 <a NAME="ConvertToUF2Dialog.on_firmwarePicker_textChanged" ID="ConvertToUF2Dialog.on_firmwarePicker_textChanged"></a>
183 <h4>ConvertToUF2Dialog.on_firmwarePicker_textChanged</h4> 182 <h4>ConvertToUF2Dialog.on_firmwarePicker_textChanged</h4>
184 <b>on_firmwarePicker_textChanged</b>(<i>firmware</i>) 183 <b>on_firmwarePicker_textChanged</b>(<i>firmware</i>)
185
186 <p> 184 <p>
187 Private slot handling a change of the firmware file name. 185 Private slot handling a change of the firmware file name.
188 </p> 186 </p>
187
189 <dl> 188 <dl>
190 189
191 <dt><i>firmware</i> (str)</dt> 190 <dt><i>firmware</i> (str)</dt>
192 <dd> 191 <dd>
193 name of the firmware file 192 name of the firmware file

eric ide

mercurial