Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.UF2FlashDialog.html
src/eric7/Documentation/Source/eric7.MicroPython.UF2FlashDialog.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 9912
- c731e9bdd105
- child 11178
- 52699bca6df9
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.UF2FlashDialog</h1> | 9 <h1>eric7.MicroPython.UF2FlashDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a dialog to flash any UF2 capable device. | 11 Module implementing a dialog to flash any UF2 capable device. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>SupportedUF2Boards</td></tr> | 16 <tr><td>SupportedUF2Boards</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#UF2FlashDialog">UF2FlashDialog</a></td> | 22 <td><a href="#UF2FlashDialog">UF2FlashDialog</a></td> |
| 25 <td>Class implementing a dialog to flash any UF2 capable device.</td> | 23 <td>Class implementing a dialog to flash any UF2 capable device.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | |
| 31 | |
| 32 <tr> | 29 <tr> |
| 33 <td><a href="#getFoundDevices">getFoundDevices</a></td> | 30 <td><a href="#getFoundDevices">getFoundDevices</a></td> |
| 34 <td>Function to get the list of known serial devices supporting UF2.</td> | 31 <td>Function to get the list of known serial devices supporting UF2.</td> |
| 35 </tr> | 32 </tr> |
| 36 </table> | 33 </table> |
| 34 | |
| 37 <hr /> | 35 <hr /> |
| 38 <hr /> | 36 <hr /> |
| 39 <a NAME="UF2FlashDialog" ID="UF2FlashDialog"></a> | 37 <a NAME="UF2FlashDialog" ID="UF2FlashDialog"></a> |
| 40 <h2>UF2FlashDialog</h2> | 38 <h2>UF2FlashDialog</h2> |
| 41 | |
| 42 <p> | 39 <p> |
| 43 Class implementing a dialog to flash any UF2 capable device. | 40 Class implementing a dialog to flash any UF2 capable device. |
| 44 </p> | 41 </p> |
| 42 | |
| 45 <h3>Derived from</h3> | 43 <h3>Derived from</h3> |
| 46 QDialog, Ui_UF2FlashDialog | 44 QDialog, Ui_UF2FlashDialog |
| 47 <h3>Class Attributes</h3> | 45 <h3>Class Attributes</h3> |
| 48 | 46 <table> |
| 49 <table> | 47 <tr><td>DeviceTypeRole</td></tr> |
| 50 <tr><td>DeviceTypeRole</td></tr><tr><td>DeviceVidPidRole</td></tr> | 48 <tr><td>DeviceVidPidRole</td></tr> |
| 51 </table> | 49 </table> |
| 50 | |
| 52 <h3>Class Methods</h3> | 51 <h3>Class Methods</h3> |
| 53 | |
| 54 <table> | 52 <table> |
| 55 <tr><td>None</td></tr> | 53 <tr><td>None</td></tr> |
| 56 </table> | 54 </table> |
| 55 | |
| 57 <h3>Methods</h3> | 56 <h3>Methods</h3> |
| 58 | 57 <table> |
| 59 <table> | |
| 60 | |
| 61 <tr> | 58 <tr> |
| 62 <td><a href="#UF2FlashDialog.__init__">UF2FlashDialog</a></td> | 59 <td><a href="#UF2FlashDialog.__init__">UF2FlashDialog</a></td> |
| 63 <td>Constructor</td> | 60 <td>Constructor</td> |
| 64 </tr> | 61 </tr> |
| 65 <tr> | 62 <tr> |
| 117 <tr> | 114 <tr> |
| 118 <td><a href="#UF2FlashDialog.on_searchBootButton_clicked">on_searchBootButton_clicked</a></td> | 115 <td><a href="#UF2FlashDialog.on_searchBootButton_clicked">on_searchBootButton_clicked</a></td> |
| 119 <td>Private slot to look for all known boot paths and present a list to select from.</td> | 116 <td>Private slot to look for all known boot paths and present a list to select from.</td> |
| 120 </tr> | 117 </tr> |
| 121 </table> | 118 </table> |
| 119 | |
| 122 <h3>Static Methods</h3> | 120 <h3>Static Methods</h3> |
| 123 | |
| 124 <table> | 121 <table> |
| 125 <tr><td>None</td></tr> | 122 <tr><td>None</td></tr> |
| 126 </table> | 123 </table> |
| 124 | |
| 127 | 125 |
| 128 <a NAME="UF2FlashDialog.__init__" ID="UF2FlashDialog.__init__"></a> | 126 <a NAME="UF2FlashDialog.__init__" ID="UF2FlashDialog.__init__"></a> |
| 129 <h4>UF2FlashDialog (Constructor)</h4> | 127 <h4>UF2FlashDialog (Constructor)</h4> |
| 130 <b>UF2FlashDialog</b>(<i>boardType="", parent=None</i>) | 128 <b>UF2FlashDialog</b>(<i>boardType="", parent=None</i>) |
| 131 | |
| 132 <p> | 129 <p> |
| 133 Constructor | 130 Constructor |
| 134 </p> | 131 </p> |
| 132 | |
| 135 <dl> | 133 <dl> |
| 136 | 134 |
| 137 <dt><i>boardType</i> (str)</dt> | 135 <dt><i>boardType</i> (str)</dt> |
| 138 <dd> | 136 <dd> |
| 139 specific board type to show the dialog for | 137 specific board type to show the dialog for |
| 144 </dd> | 142 </dd> |
| 145 </dl> | 143 </dl> |
| 146 <a NAME="UF2FlashDialog.__populate" ID="UF2FlashDialog.__populate"></a> | 144 <a NAME="UF2FlashDialog.__populate" ID="UF2FlashDialog.__populate"></a> |
| 147 <h4>UF2FlashDialog.__populate</h4> | 145 <h4>UF2FlashDialog.__populate</h4> |
| 148 <b>__populate</b>(<i></i>) | 146 <b>__populate</b>(<i></i>) |
| 149 | |
| 150 <p> | 147 <p> |
| 151 Private method to (re-)populate the dialog. | 148 Private method to (re-)populate the dialog. |
| 152 </p> | 149 </p> |
| 150 | |
| 153 <a NAME="UF2FlashDialog.__showAllInstructions" ID="UF2FlashDialog.__showAllInstructions"></a> | 151 <a NAME="UF2FlashDialog.__showAllInstructions" ID="UF2FlashDialog.__showAllInstructions"></a> |
| 154 <h4>UF2FlashDialog.__showAllInstructions</h4> | 152 <h4>UF2FlashDialog.__showAllInstructions</h4> |
| 155 <b>__showAllInstructions</b>(<i></i>) | 153 <b>__showAllInstructions</b>(<i></i>) |
| 156 | |
| 157 <p> | 154 <p> |
| 158 Private method to show instructions for resetting devices to bootloader | 155 Private method to show instructions for resetting devices to bootloader |
| 159 mode. | 156 mode. |
| 160 </p> | 157 </p> |
| 158 | |
| 161 <a NAME="UF2FlashDialog.__showManualInstructions" ID="UF2FlashDialog.__showManualInstructions"></a> | 159 <a NAME="UF2FlashDialog.__showManualInstructions" ID="UF2FlashDialog.__showManualInstructions"></a> |
| 162 <h4>UF2FlashDialog.__showManualInstructions</h4> | 160 <h4>UF2FlashDialog.__showManualInstructions</h4> |
| 163 <b>__showManualInstructions</b>(<i></i>) | 161 <b>__showManualInstructions</b>(<i></i>) |
| 164 | |
| 165 <p> | 162 <p> |
| 166 Private method to show instructions for flashing devices manually. | 163 Private method to show instructions for flashing devices manually. |
| 167 </p> | 164 </p> |
| 165 | |
| 168 <a NAME="UF2FlashDialog.__showMultipleVolumesInformation" ID="UF2FlashDialog.__showMultipleVolumesInformation"></a> | 166 <a NAME="UF2FlashDialog.__showMultipleVolumesInformation" ID="UF2FlashDialog.__showMultipleVolumesInformation"></a> |
| 169 <h4>UF2FlashDialog.__showMultipleVolumesInformation</h4> | 167 <h4>UF2FlashDialog.__showMultipleVolumesInformation</h4> |
| 170 <b>__showMultipleVolumesInformation</b>(<i>volumePaths</i>) | 168 <b>__showMultipleVolumesInformation</b>(<i>volumePaths</i>) |
| 171 | |
| 172 <p> | 169 <p> |
| 173 Private method to show information because multiple devices of the | 170 Private method to show information because multiple devices of the |
| 174 same type are ready for flashing. | 171 same type are ready for flashing. |
| 175 </p> | 172 </p> |
| 176 <p> | 173 <p> |
| 177 Note: This is a dangerous situation! | 174 Note: This is a dangerous situation! |
| 178 </p> | 175 </p> |
| 176 | |
| 179 <dl> | 177 <dl> |
| 180 | 178 |
| 181 <dt><i>volumePaths</i> (list of str)</dt> | 179 <dt><i>volumePaths</i> (list of str)</dt> |
| 182 <dd> | 180 <dd> |
| 183 list of volume paths | 181 list of volume paths |
| 184 </dd> | 182 </dd> |
| 185 </dl> | 183 </dl> |
| 186 <a NAME="UF2FlashDialog.__showNoVolumeInformation" ID="UF2FlashDialog.__showNoVolumeInformation"></a> | 184 <a NAME="UF2FlashDialog.__showNoVolumeInformation" ID="UF2FlashDialog.__showNoVolumeInformation"></a> |
| 187 <h4>UF2FlashDialog.__showNoVolumeInformation</h4> | 185 <h4>UF2FlashDialog.__showNoVolumeInformation</h4> |
| 188 <b>__showNoVolumeInformation</b>(<i>volumes, boardType</i>) | 186 <b>__showNoVolumeInformation</b>(<i>volumes, boardType</i>) |
| 189 | |
| 190 <p> | 187 <p> |
| 191 Private method to show information about the expected boot volume(s). | 188 Private method to show information about the expected boot volume(s). |
| 192 </p> | 189 </p> |
| 190 | |
| 193 <dl> | 191 <dl> |
| 194 | 192 |
| 195 <dt><i>volumes</i> (list of str)</dt> | 193 <dt><i>volumes</i> (list of str)</dt> |
| 196 <dd> | 194 <dd> |
| 197 list of expected volume names | 195 list of expected volume names |
| 202 </dd> | 200 </dd> |
| 203 </dl> | 201 </dl> |
| 204 <a NAME="UF2FlashDialog.__showSpecificInstructions" ID="UF2FlashDialog.__showSpecificInstructions"></a> | 202 <a NAME="UF2FlashDialog.__showSpecificInstructions" ID="UF2FlashDialog.__showSpecificInstructions"></a> |
| 205 <h4>UF2FlashDialog.__showSpecificInstructions</h4> | 203 <h4>UF2FlashDialog.__showSpecificInstructions</h4> |
| 206 <b>__showSpecificInstructions</b>(<i>devices</i>) | 204 <b>__showSpecificInstructions</b>(<i>devices</i>) |
| 207 | |
| 208 <p> | 205 <p> |
| 209 Private method to show instructions for resetting devices to bootloader | 206 Private method to show instructions for resetting devices to bootloader |
| 210 mode for a list of detected devices. | 207 mode for a list of detected devices. |
| 211 </p> | 208 </p> |
| 209 | |
| 212 <dl> | 210 <dl> |
| 213 | 211 |
| 214 <dt><i>devices</i> (list of str)</dt> | 212 <dt><i>devices</i> (list of str)</dt> |
| 215 <dd> | 213 <dd> |
| 216 list of detected devices | 214 list of detected devices |
| 217 </dd> | 215 </dd> |
| 218 </dl> | 216 </dl> |
| 219 <a NAME="UF2FlashDialog.__showTypedInstructions" ID="UF2FlashDialog.__showTypedInstructions"></a> | 217 <a NAME="UF2FlashDialog.__showTypedInstructions" ID="UF2FlashDialog.__showTypedInstructions"></a> |
| 220 <h4>UF2FlashDialog.__showTypedInstructions</h4> | 218 <h4>UF2FlashDialog.__showTypedInstructions</h4> |
| 221 <b>__showTypedInstructions</b>(<i>boardType</i>) | 219 <b>__showTypedInstructions</b>(<i>boardType</i>) |
| 222 | |
| 223 <p> | 220 <p> |
| 224 Private method to show instructions for resetting devices to bootloader | 221 Private method to show instructions for resetting devices to bootloader |
| 225 mode for a specific board type. | 222 mode for a specific board type. |
| 226 </p> | 223 </p> |
| 224 | |
| 227 <dl> | 225 <dl> |
| 228 | 226 |
| 229 <dt><i>boardType</i> (str)</dt> | 227 <dt><i>boardType</i> (str)</dt> |
| 230 <dd> | 228 <dd> |
| 231 type of the board to show instructions for | 229 type of the board to show instructions for |
| 232 </dd> | 230 </dd> |
| 233 </dl> | 231 </dl> |
| 234 <a NAME="UF2FlashDialog.__updateFlashButton" ID="UF2FlashDialog.__updateFlashButton"></a> | 232 <a NAME="UF2FlashDialog.__updateFlashButton" ID="UF2FlashDialog.__updateFlashButton"></a> |
| 235 <h4>UF2FlashDialog.__updateFlashButton</h4> | 233 <h4>UF2FlashDialog.__updateFlashButton</h4> |
| 236 <b>__updateFlashButton</b>(<i></i>) | 234 <b>__updateFlashButton</b>(<i></i>) |
| 237 | |
| 238 <p> | 235 <p> |
| 239 Private method to update the state of the Flash button and the retest | 236 Private method to update the state of the Flash button and the retest |
| 240 button. | 237 button. |
| 241 </p> | 238 </p> |
| 239 | |
| 242 <a NAME="UF2FlashDialog.on_bootPicker_textChanged" ID="UF2FlashDialog.on_bootPicker_textChanged"></a> | 240 <a NAME="UF2FlashDialog.on_bootPicker_textChanged" ID="UF2FlashDialog.on_bootPicker_textChanged"></a> |
| 243 <h4>UF2FlashDialog.on_bootPicker_textChanged</h4> | 241 <h4>UF2FlashDialog.on_bootPicker_textChanged</h4> |
| 244 <b>on_bootPicker_textChanged</b>(<i>text</i>) | 242 <b>on_bootPicker_textChanged</b>(<i>text</i>) |
| 245 | |
| 246 <p> | 243 <p> |
| 247 Private slot handling a change of the boot volume. | 244 Private slot handling a change of the boot volume. |
| 248 </p> | 245 </p> |
| 246 | |
| 249 <dl> | 247 <dl> |
| 250 | 248 |
| 251 <dt><i>text</i> (str)</dt> | 249 <dt><i>text</i> (str)</dt> |
| 252 <dd> | 250 <dd> |
| 253 current text of the boot volume edit | 251 current text of the boot volume edit |
| 254 </dd> | 252 </dd> |
| 255 </dl> | 253 </dl> |
| 256 <a NAME="UF2FlashDialog.on_devicesComboBox_currentIndexChanged" ID="UF2FlashDialog.on_devicesComboBox_currentIndexChanged"></a> | 254 <a NAME="UF2FlashDialog.on_devicesComboBox_currentIndexChanged" ID="UF2FlashDialog.on_devicesComboBox_currentIndexChanged"></a> |
| 257 <h4>UF2FlashDialog.on_devicesComboBox_currentIndexChanged</h4> | 255 <h4>UF2FlashDialog.on_devicesComboBox_currentIndexChanged</h4> |
| 258 <b>on_devicesComboBox_currentIndexChanged</b>(<i>index</i>) | 256 <b>on_devicesComboBox_currentIndexChanged</b>(<i>index</i>) |
| 259 | |
| 260 <p> | 257 <p> |
| 261 Private slot to handle the selection of a board. | 258 Private slot to handle the selection of a board. |
| 262 </p> | 259 </p> |
| 260 | |
| 263 <dl> | 261 <dl> |
| 264 | 262 |
| 265 <dt><i>index</i> (int)</dt> | 263 <dt><i>index</i> (int)</dt> |
| 266 <dd> | 264 <dd> |
| 267 selected index | 265 selected index |
| 268 </dd> | 266 </dd> |
| 269 </dl> | 267 </dl> |
| 270 <a NAME="UF2FlashDialog.on_firmwarePicker_textChanged" ID="UF2FlashDialog.on_firmwarePicker_textChanged"></a> | 268 <a NAME="UF2FlashDialog.on_firmwarePicker_textChanged" ID="UF2FlashDialog.on_firmwarePicker_textChanged"></a> |
| 271 <h4>UF2FlashDialog.on_firmwarePicker_textChanged</h4> | 269 <h4>UF2FlashDialog.on_firmwarePicker_textChanged</h4> |
| 272 <b>on_firmwarePicker_textChanged</b>(<i>text</i>) | 270 <b>on_firmwarePicker_textChanged</b>(<i>text</i>) |
| 273 | |
| 274 <p> | 271 <p> |
| 275 Private slot handling a change of the firmware file. | 272 Private slot handling a change of the firmware file. |
| 276 </p> | 273 </p> |
| 274 | |
| 277 <dl> | 275 <dl> |
| 278 | 276 |
| 279 <dt><i>text</i> (str)</dt> | 277 <dt><i>text</i> (str)</dt> |
| 280 <dd> | 278 <dd> |
| 281 current text of the firmware edit | 279 current text of the firmware edit |
| 282 </dd> | 280 </dd> |
| 283 </dl> | 281 </dl> |
| 284 <a NAME="UF2FlashDialog.on_flashButton_clicked" ID="UF2FlashDialog.on_flashButton_clicked"></a> | 282 <a NAME="UF2FlashDialog.on_flashButton_clicked" ID="UF2FlashDialog.on_flashButton_clicked"></a> |
| 285 <h4>UF2FlashDialog.on_flashButton_clicked</h4> | 283 <h4>UF2FlashDialog.on_flashButton_clicked</h4> |
| 286 <b>on_flashButton_clicked</b>(<i></i>) | 284 <b>on_flashButton_clicked</b>(<i></i>) |
| 287 | |
| 288 <p> | 285 <p> |
| 289 Private slot to flash the selected MicroPython or CircuitPython | 286 Private slot to flash the selected MicroPython or CircuitPython |
| 290 firmware onto the device. | 287 firmware onto the device. |
| 291 </p> | 288 </p> |
| 289 | |
| 292 <a NAME="UF2FlashDialog.on_refreshButton_clicked" ID="UF2FlashDialog.on_refreshButton_clicked"></a> | 290 <a NAME="UF2FlashDialog.on_refreshButton_clicked" ID="UF2FlashDialog.on_refreshButton_clicked"></a> |
| 293 <h4>UF2FlashDialog.on_refreshButton_clicked</h4> | 291 <h4>UF2FlashDialog.on_refreshButton_clicked</h4> |
| 294 <b>on_refreshButton_clicked</b>(<i></i>) | 292 <b>on_refreshButton_clicked</b>(<i></i>) |
| 295 | |
| 296 <p> | 293 <p> |
| 297 Private slot to refresh the dialog. | 294 Private slot to refresh the dialog. |
| 298 </p> | 295 </p> |
| 296 | |
| 299 <a NAME="UF2FlashDialog.on_searchBootButton_clicked" ID="UF2FlashDialog.on_searchBootButton_clicked"></a> | 297 <a NAME="UF2FlashDialog.on_searchBootButton_clicked" ID="UF2FlashDialog.on_searchBootButton_clicked"></a> |
| 300 <h4>UF2FlashDialog.on_searchBootButton_clicked</h4> | 298 <h4>UF2FlashDialog.on_searchBootButton_clicked</h4> |
| 301 <b>on_searchBootButton_clicked</b>(<i></i>) | 299 <b>on_searchBootButton_clicked</b>(<i></i>) |
| 302 | |
| 303 <p> | 300 <p> |
| 304 Private slot to look for all known boot paths and present a list to select from. | 301 Private slot to look for all known boot paths and present a list to select from. |
| 305 </p> | 302 </p> |
| 303 | |
| 306 <div align="right"><a href="#top">Up</a></div> | 304 <div align="right"><a href="#top">Up</a></div> |
| 307 <hr /> | 305 <hr /> |
| 308 <hr /> | 306 <hr /> |
| 309 <a NAME="getFoundDevices" ID="getFoundDevices"></a> | 307 <a NAME="getFoundDevices" ID="getFoundDevices"></a> |
| 310 <h2>getFoundDevices</h2> | 308 <h2>getFoundDevices</h2> |
| 311 <b>getFoundDevices</b>(<i>boardType=""</i>) | 309 <b>getFoundDevices</b>(<i>boardType=""</i>) |
| 312 | |
| 313 <p> | 310 <p> |
| 314 Function to get the list of known serial devices supporting UF2. | 311 Function to get the list of known serial devices supporting UF2. |
| 315 </p> | 312 </p> |
| 313 | |
| 316 <dl> | 314 <dl> |
| 317 | 315 |
| 318 <dt><i>boardType</i> (str)</dt> | 316 <dt><i>boardType</i> (str)</dt> |
| 319 <dd> | 317 <dd> |
| 320 specific board type to search for | 318 specific board type to search for |
