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

branch
eric7
changeset 10479
856476537696
parent 10478
de9106c55c3d
child 10518
1682f3203ae5
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.MicroPythonWidget</h1> 9 <h1>eric7.MicroPython.MicroPythonWidget</h1>
10
11 <p> 10 <p>
12 Module implementing the MicroPython REPL widget. 11 Module implementing the MicroPython REPL widget.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>HAS_QTCHART</td></tr><tr><td>HAS_QTSERIALPORT</td></tr> 16 <tr><td>HAS_QTCHART</td></tr>
17 <tr><td>HAS_QTSERIALPORT</td></tr>
18 </table> 18 </table>
19
19 <h3>Classes</h3> 20 <h3>Classes</h3>
20
21 <table> 21 <table>
22
23 <tr> 22 <tr>
24 <td><a href="#MicroPythonWidget">MicroPythonWidget</a></td> 23 <td><a href="#MicroPythonWidget">MicroPythonWidget</a></td>
25 <td>Class implementing the MicroPython REPL widget.</td> 24 <td>Class implementing the MicroPython REPL widget.</td>
26 </tr> 25 </tr>
27 </table> 26 </table>
27
28 <h3>Functions</h3> 28 <h3>Functions</h3>
29
30 <table> 29 <table>
31 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
32 </table> 31 </table>
32
33 <hr /> 33 <hr />
34 <hr /> 34 <hr />
35 <a NAME="MicroPythonWidget" ID="MicroPythonWidget"></a> 35 <a NAME="MicroPythonWidget" ID="MicroPythonWidget"></a>
36 <h2>MicroPythonWidget</h2> 36 <h2>MicroPythonWidget</h2>
37
38 <p> 37 <p>
39 Class implementing the MicroPython REPL widget. 38 Class implementing the MicroPython REPL widget.
40 </p> 39 </p>
40
41 <h3>Signals</h3> 41 <h3>Signals</h3>
42 <dl> 42 <dl>
43 43
44 <dt>dataReceived(data)</dt> 44 <dt>dataReceived(data)</dt>
45 <dd> 45 <dd>
48 </dd> 48 </dd>
49 </dl> 49 </dl>
50 <h3>Derived from</h3> 50 <h3>Derived from</h3>
51 QWidget, Ui_MicroPythonWidget 51 QWidget, Ui_MicroPythonWidget
52 <h3>Class Attributes</h3> 52 <h3>Class Attributes</h3>
53
54 <table> 53 <table>
55 <tr><td>DeviceBoardRole</td></tr><tr><td>DeviceInterfaceTypeRole</td></tr><tr><td>DevicePidRole</td></tr><tr><td>DevicePortRole</td></tr><tr><td>DeviceSerNoRole</td></tr><tr><td>DeviceTypeRole</td></tr><tr><td>DeviceVidRole</td></tr><tr><td>DeviceWebreplUrlRole</td></tr><tr><td>ManualMarker</td></tr> 54 <tr><td>DeviceBoardRole</td></tr>
55 <tr><td>DeviceInterfaceTypeRole</td></tr>
56 <tr><td>DevicePidRole</td></tr>
57 <tr><td>DevicePortRole</td></tr>
58 <tr><td>DeviceSerNoRole</td></tr>
59 <tr><td>DeviceTypeRole</td></tr>
60 <tr><td>DeviceVidRole</td></tr>
61 <tr><td>DeviceWebreplUrlRole</td></tr>
62 <tr><td>ManualMarker</td></tr>
56 </table> 63 </table>
64
57 <h3>Class Methods</h3> 65 <h3>Class Methods</h3>
58
59 <table> 66 <table>
60 <tr><td>None</td></tr> 67 <tr><td>None</td></tr>
61 </table> 68 </table>
69
62 <h3>Methods</h3> 70 <h3>Methods</h3>
63
64 <table> 71 <table>
65
66 <tr> 72 <tr>
67 <td><a href="#MicroPythonWidget.__init__">MicroPythonWidget</a></td> 73 <td><a href="#MicroPythonWidget.__init__">MicroPythonWidget</a></td>
68 <td>Constructor</td> 74 <td>Constructor</td>
69 </tr> 75 </tr>
70 <tr> 76 <tr>
266 <tr> 272 <tr>
267 <td><a href="#MicroPythonWidget.shutdown">shutdown</a></td> 273 <td><a href="#MicroPythonWidget.shutdown">shutdown</a></td>
268 <td>Public method to perform some shutdown actions.</td> 274 <td>Public method to perform some shutdown actions.</td>
269 </tr> 275 </tr>
270 </table> 276 </table>
277
271 <h3>Static Methods</h3> 278 <h3>Static Methods</h3>
272
273 <table> 279 <table>
274 <tr><td>None</td></tr> 280 <tr><td>None</td></tr>
275 </table> 281 </table>
276 282
283
277 <a NAME="MicroPythonWidget.__init__" ID="MicroPythonWidget.__init__"></a> 284 <a NAME="MicroPythonWidget.__init__" ID="MicroPythonWidget.__init__"></a>
278 <h4>MicroPythonWidget (Constructor)</h4> 285 <h4>MicroPythonWidget (Constructor)</h4>
279 <b>MicroPythonWidget</b>(<i>parent=None</i>) 286 <b>MicroPythonWidget</b>(<i>parent=None</i>)
280
281 <p> 287 <p>
282 Constructor 288 Constructor
283 </p> 289 </p>
290
284 <dl> 291 <dl>
285 292
286 <dt><i>parent</i> (QWidget)</dt> 293 <dt><i>parent</i> (QWidget)</dt>
287 <dd> 294 <dd>
288 reference to the parent widget 295 reference to the parent widget
289 </dd> 296 </dd>
290 </dl> 297 </dl>
291 <a NAME="MicroPythonWidget.__aboutToShowSuperMenu" ID="MicroPythonWidget.__aboutToShowSuperMenu"></a> 298 <a NAME="MicroPythonWidget.__aboutToShowSuperMenu" ID="MicroPythonWidget.__aboutToShowSuperMenu"></a>
292 <h4>MicroPythonWidget.__aboutToShowSuperMenu</h4> 299 <h4>MicroPythonWidget.__aboutToShowSuperMenu</h4>
293 <b>__aboutToShowSuperMenu</b>(<i></i>) 300 <b>__aboutToShowSuperMenu</b>(<i></i>)
294
295 <p> 301 <p>
296 Private slot to populate the Super Menu before showing it. 302 Private slot to populate the Super Menu before showing it.
297 </p> 303 </p>
304
298 <a NAME="MicroPythonWidget.__addUnknownDevices" ID="MicroPythonWidget.__addUnknownDevices"></a> 305 <a NAME="MicroPythonWidget.__addUnknownDevices" ID="MicroPythonWidget.__addUnknownDevices"></a>
299 <h4>MicroPythonWidget.__addUnknownDevices</h4> 306 <h4>MicroPythonWidget.__addUnknownDevices</h4>
300 <b>__addUnknownDevices</b>(<i>devices</i>) 307 <b>__addUnknownDevices</b>(<i>devices</i>)
301
302 <p> 308 <p>
303 Private method to add devices to the list of manually added boards. 309 Private method to add devices to the list of manually added boards.
304 </p> 310 </p>
311
305 <dl> 312 <dl>
306 313
307 <dt><i>devices</i> (list of tuple of (int, int, str))</dt> 314 <dt><i>devices</i> (list of tuple of (int, int, str))</dt>
308 <dd> 315 <dd>
309 list of not ignored but unknown devices 316 list of not ignored but unknown devices
310 </dd> 317 </dd>
311 </dl> 318 </dl>
312 <a NAME="MicroPythonWidget.__compileEditor2Mpy" ID="MicroPythonWidget.__compileEditor2Mpy"></a> 319 <a NAME="MicroPythonWidget.__compileEditor2Mpy" ID="MicroPythonWidget.__compileEditor2Mpy"></a>
313 <h4>MicroPythonWidget.__compileEditor2Mpy</h4> 320 <h4>MicroPythonWidget.__compileEditor2Mpy</h4>
314 <b>__compileEditor2Mpy</b>(<i></i>) 321 <b>__compileEditor2Mpy</b>(<i></i>)
315
316 <p> 322 <p>
317 Private slot to cross compile the current editor to a .mpy file. 323 Private slot to cross compile the current editor to a .mpy file.
318 </p> 324 </p>
325
319 <a NAME="MicroPythonWidget.__compileFile2Mpy" ID="MicroPythonWidget.__compileFile2Mpy"></a> 326 <a NAME="MicroPythonWidget.__compileFile2Mpy" ID="MicroPythonWidget.__compileFile2Mpy"></a>
320 <h4>MicroPythonWidget.__compileFile2Mpy</h4> 327 <h4>MicroPythonWidget.__compileFile2Mpy</h4>
321 <b>__compileFile2Mpy</b>(<i></i>) 328 <b>__compileFile2Mpy</b>(<i></i>)
322
323 <p> 329 <p>
324 Private slot to cross compile a Python file (*.py) to a .mpy file. 330 Private slot to cross compile a Python file (*.py) to a .mpy file.
325 </p> 331 </p>
332
326 <a NAME="MicroPythonWidget.__configure" ID="MicroPythonWidget.__configure"></a> 333 <a NAME="MicroPythonWidget.__configure" ID="MicroPythonWidget.__configure"></a>
327 <h4>MicroPythonWidget.__configure</h4> 334 <h4>MicroPythonWidget.__configure</h4>
328 <b>__configure</b>(<i></i>) 335 <b>__configure</b>(<i></i>)
329
330 <p> 336 <p>
331 Private slot to open the MicroPython configuration page. 337 Private slot to open the MicroPython configuration page.
332 </p> 338 </p>
339
333 <a NAME="MicroPythonWidget.__configureWebreplUrls" ID="MicroPythonWidget.__configureWebreplUrls"></a> 340 <a NAME="MicroPythonWidget.__configureWebreplUrls" ID="MicroPythonWidget.__configureWebreplUrls"></a>
334 <h4>MicroPythonWidget.__configureWebreplUrls</h4> 341 <h4>MicroPythonWidget.__configureWebreplUrls</h4>
335 <b>__configureWebreplUrls</b>(<i></i>) 342 <b>__configureWebreplUrls</b>(<i></i>)
336
337 <p> 343 <p>
338 Private slot to configure the list of selectable WebREPL URLs. 344 Private slot to configure the list of selectable WebREPL URLs.
339 </p> 345 </p>
346
340 <a NAME="MicroPythonWidget.__connectToDevice" ID="MicroPythonWidget.__connectToDevice"></a> 347 <a NAME="MicroPythonWidget.__connectToDevice" ID="MicroPythonWidget.__connectToDevice"></a>
341 <h4>MicroPythonWidget.__connectToDevice</h4> 348 <h4>MicroPythonWidget.__connectToDevice</h4>
342 <b>__connectToDevice</b>(<i>withAutostart=False</i>) 349 <b>__connectToDevice</b>(<i>withAutostart=False</i>)
343
344 <p> 350 <p>
345 Private method to connect to the selected device. 351 Private method to connect to the selected device.
346 </p> 352 </p>
353
347 <dl> 354 <dl>
348 355
349 <dt><i>withAutostart</i> (bool)</dt> 356 <dt><i>withAutostart</i> (bool)</dt>
350 <dd> 357 <dd>
351 flag indicating to start the repl and file manager 358 flag indicating to start the repl and file manager
360 </dd> 367 </dd>
361 </dl> 368 </dl>
362 <a NAME="MicroPythonWidget.__convertToUF2" ID="MicroPythonWidget.__convertToUF2"></a> 369 <a NAME="MicroPythonWidget.__convertToUF2" ID="MicroPythonWidget.__convertToUF2"></a>
363 <h4>MicroPythonWidget.__convertToUF2</h4> 370 <h4>MicroPythonWidget.__convertToUF2</h4>
364 <b>__convertToUF2</b>(<i></i>) 371 <b>__convertToUF2</b>(<i></i>)
365
366 <p> 372 <p>
367 Private slot to convert a non-UF2 MicroPython firmware file to UF2. 373 Private slot to convert a non-UF2 MicroPython firmware file to UF2.
368 </p> 374 </p>
375
369 <a NAME="MicroPythonWidget.__crossCompile" ID="MicroPythonWidget.__crossCompile"></a> 376 <a NAME="MicroPythonWidget.__crossCompile" ID="MicroPythonWidget.__crossCompile"></a>
370 <h4>MicroPythonWidget.__crossCompile</h4> 377 <h4>MicroPythonWidget.__crossCompile</h4>
371 <b>__crossCompile</b>(<i>pythonFile="", title=""</i>) 378 <b>__crossCompile</b>(<i>pythonFile="", title=""</i>)
372
373 <p> 379 <p>
374 Private method to cross compile a Python file to a .mpy file. 380 Private method to cross compile a Python file to a .mpy file.
375 </p> 381 </p>
382
376 <dl> 383 <dl>
377 384
378 <dt><i>pythonFile</i> (str)</dt> 385 <dt><i>pythonFile</i> (str)</dt>
379 <dd> 386 <dd>
380 name of the Python file to be compiled 387 name of the Python file to be compiled
385 </dd> 392 </dd>
386 </dl> 393 </dl>
387 <a NAME="MicroPythonWidget.__disconnectFromDevice" ID="MicroPythonWidget.__disconnectFromDevice"></a> 394 <a NAME="MicroPythonWidget.__disconnectFromDevice" ID="MicroPythonWidget.__disconnectFromDevice"></a>
388 <h4>MicroPythonWidget.__disconnectFromDevice</h4> 395 <h4>MicroPythonWidget.__disconnectFromDevice</h4>
389 <b>__disconnectFromDevice</b>(<i></i>) 396 <b>__disconnectFromDevice</b>(<i></i>)
390
391 <p> 397 <p>
392 Private method to disconnect from the device. 398 Private method to disconnect from the device.
393 </p> 399 </p>
400
394 <a NAME="MicroPythonWidget.__downloadFirmware" ID="MicroPythonWidget.__downloadFirmware"></a> 401 <a NAME="MicroPythonWidget.__downloadFirmware" ID="MicroPythonWidget.__downloadFirmware"></a>
395 <h4>MicroPythonWidget.__downloadFirmware</h4> 402 <h4>MicroPythonWidget.__downloadFirmware</h4>
396 <b>__downloadFirmware</b>(<i></i>) 403 <b>__downloadFirmware</b>(<i></i>)
397
398 <p> 404 <p>
399 Private slot to open the firmware download page. 405 Private slot to open the firmware download page.
400 </p> 406 </p>
407
401 <a NAME="MicroPythonWidget.__downloadFromUrl" ID="MicroPythonWidget.__downloadFromUrl"></a> 408 <a NAME="MicroPythonWidget.__downloadFromUrl" ID="MicroPythonWidget.__downloadFromUrl"></a>
402 <h4>MicroPythonWidget.__downloadFromUrl</h4> 409 <h4>MicroPythonWidget.__downloadFromUrl</h4>
403 <b>__downloadFromUrl</b>(<i>url</i>) 410 <b>__downloadFromUrl</b>(<i>url</i>)
404
405 <p> 411 <p>
406 Private method to open a web browser for the given URL. 412 Private method to open a web browser for the given URL.
407 </p> 413 </p>
414
408 <dl> 415 <dl>
409 416
410 <dt><i>url</i> (str)</dt> 417 <dt><i>url</i> (str)</dt>
411 <dd> 418 <dd>
412 URL to be opened 419 URL to be opened
413 </dd> 420 </dd>
414 </dl> 421 </dl>
415 <a NAME="MicroPythonWidget.__flashUF2" ID="MicroPythonWidget.__flashUF2"></a> 422 <a NAME="MicroPythonWidget.__flashUF2" ID="MicroPythonWidget.__flashUF2"></a>
416 <h4>MicroPythonWidget.__flashUF2</h4> 423 <h4>MicroPythonWidget.__flashUF2</h4>
417 <b>__flashUF2</b>(<i></i>) 424 <b>__flashUF2</b>(<i></i>)
418
419 <p> 425 <p>
420 Private slot to flash MicroPython/CircuitPython to a device 426 Private slot to flash MicroPython/CircuitPython to a device
421 support the UF2 bootloader. 427 support the UF2 bootloader.
422 </p> 428 </p>
429
423 <a NAME="MicroPythonWidget.__getDeviceTime" ID="MicroPythonWidget.__getDeviceTime"></a> 430 <a NAME="MicroPythonWidget.__getDeviceTime" ID="MicroPythonWidget.__getDeviceTime"></a>
424 <h4>MicroPythonWidget.__getDeviceTime</h4> 431 <h4>MicroPythonWidget.__getDeviceTime</h4>
425 <b>__getDeviceTime</b>(<i></i>) 432 <b>__getDeviceTime</b>(<i></i>)
426
427 <p> 433 <p>
428 Private method to get a string containing the date and time of the 434 Private method to get a string containing the date and time of the
429 connected device. 435 connected device.
430 </p> 436 </p>
437
431 <dl> 438 <dl>
432 <dt>Return:</dt> 439 <dt>Return:</dt>
433 <dd> 440 <dd>
434 date and time of the connected device 441 date and time of the connected device
435 </dd> 442 </dd>
441 </dd> 448 </dd>
442 </dl> 449 </dl>
443 <a NAME="MicroPythonWidget.__handlePreferencesChanged" ID="MicroPythonWidget.__handlePreferencesChanged"></a> 450 <a NAME="MicroPythonWidget.__handlePreferencesChanged" ID="MicroPythonWidget.__handlePreferencesChanged"></a>
444 <h4>MicroPythonWidget.__handlePreferencesChanged</h4> 451 <h4>MicroPythonWidget.__handlePreferencesChanged</h4>
445 <b>__handlePreferencesChanged</b>(<i></i>) 452 <b>__handlePreferencesChanged</b>(<i></i>)
446
447 <p> 453 <p>
448 Private slot to handle a change in preferences. 454 Private slot to handle a change in preferences.
449 </p> 455 </p>
456
450 <a NAME="MicroPythonWidget.__installPackage" ID="MicroPythonWidget.__installPackage"></a> 457 <a NAME="MicroPythonWidget.__installPackage" ID="MicroPythonWidget.__installPackage"></a>
451 <h4>MicroPythonWidget.__installPackage</h4> 458 <h4>MicroPythonWidget.__installPackage</h4>
452 <b>__installPackage</b>(<i>method</i>) 459 <b>__installPackage</b>(<i>method</i>)
453
454 <p> 460 <p>
455 Private slot to install packages using the given method. 461 Private slot to install packages using the given method.
456 </p> 462 </p>
463
457 <dl> 464 <dl>
458 465
459 <dt><i>method</i> (str)</dt> 466 <dt><i>method</i> (str)</dt>
460 <dd> 467 <dd>
461 package management method to be used (one of 'upip' or 'mip') 468 package management method to be used (one of 'upip' or 'mip')
470 </dd> 477 </dd>
471 </dl> 478 </dl>
472 <a NAME="MicroPythonWidget.__manageIgnored" ID="MicroPythonWidget.__manageIgnored"></a> 479 <a NAME="MicroPythonWidget.__manageIgnored" ID="MicroPythonWidget.__manageIgnored"></a>
473 <h4>MicroPythonWidget.__manageIgnored</h4> 480 <h4>MicroPythonWidget.__manageIgnored</h4>
474 <b>__manageIgnored</b>(<i></i>) 481 <b>__manageIgnored</b>(<i></i>)
475
476 <p> 482 <p>
477 Private slot to manage the list of ignored serial devices. 483 Private slot to manage the list of ignored serial devices.
478 </p> 484 </p>
485
479 <a NAME="MicroPythonWidget.__manageUnknownDevices" ID="MicroPythonWidget.__manageUnknownDevices"></a> 486 <a NAME="MicroPythonWidget.__manageUnknownDevices" ID="MicroPythonWidget.__manageUnknownDevices"></a>
480 <h4>MicroPythonWidget.__manageUnknownDevices</h4> 487 <h4>MicroPythonWidget.__manageUnknownDevices</h4>
481 <b>__manageUnknownDevices</b>(<i></i>) 488 <b>__manageUnknownDevices</b>(<i></i>)
482
483 <p> 489 <p>
484 Private slot to manage manually added boards (i.e. those not in the 490 Private slot to manage manually added boards (i.e. those not in the
485 list of supported boards). 491 list of supported boards).
486 </p> 492 </p>
493
487 <a NAME="MicroPythonWidget.__mpyCrossAvailable" ID="MicroPythonWidget.__mpyCrossAvailable"></a> 494 <a NAME="MicroPythonWidget.__mpyCrossAvailable" ID="MicroPythonWidget.__mpyCrossAvailable"></a>
488 <h4>MicroPythonWidget.__mpyCrossAvailable</h4> 495 <h4>MicroPythonWidget.__mpyCrossAvailable</h4>
489 <b>__mpyCrossAvailable</b>(<i></i>) 496 <b>__mpyCrossAvailable</b>(<i></i>)
490
491 <p> 497 <p>
492 Private method to check the availability of mpy-cross. 498 Private method to check the availability of mpy-cross.
493 </p> 499 </p>
500
494 <dl> 501 <dl>
495 <dt>Return:</dt> 502 <dt>Return:</dt>
496 <dd> 503 <dd>
497 flag indicating the availability of mpy-cross 504 flag indicating the availability of mpy-cross
498 </dd> 505 </dd>
504 </dd> 511 </dd>
505 </dl> 512 </dl>
506 <a NAME="MicroPythonWidget.__populateDeviceTypeComboBox" ID="MicroPythonWidget.__populateDeviceTypeComboBox"></a> 513 <a NAME="MicroPythonWidget.__populateDeviceTypeComboBox" ID="MicroPythonWidget.__populateDeviceTypeComboBox"></a>
507 <h4>MicroPythonWidget.__populateDeviceTypeComboBox</h4> 514 <h4>MicroPythonWidget.__populateDeviceTypeComboBox</h4>
508 <b>__populateDeviceTypeComboBox</b>(<i></i>) 515 <b>__populateDeviceTypeComboBox</b>(<i></i>)
509
510 <p> 516 <p>
511 Private method to populate the device type selector. 517 Private method to populate the device type selector.
512 </p> 518 </p>
519
513 <a NAME="MicroPythonWidget.__setConnected" ID="MicroPythonWidget.__setConnected"></a> 520 <a NAME="MicroPythonWidget.__setConnected" ID="MicroPythonWidget.__setConnected"></a>
514 <h4>MicroPythonWidget.__setConnected</h4> 521 <h4>MicroPythonWidget.__setConnected</h4>
515 <b>__setConnected</b>(<i>connected</i>) 522 <b>__setConnected</b>(<i>connected</i>)
516
517 <p> 523 <p>
518 Private method to set the connection status LED. 524 Private method to set the connection status LED.
519 </p> 525 </p>
526
520 <dl> 527 <dl>
521 528
522 <dt><i>connected</i> (bool)</dt> 529 <dt><i>connected</i> (bool)</dt>
523 <dd> 530 <dd>
524 connection state 531 connection state
525 </dd> 532 </dd>
526 </dl> 533 </dl>
527 <a NAME="MicroPythonWidget.__showBoardInformation" ID="MicroPythonWidget.__showBoardInformation"></a> 534 <a NAME="MicroPythonWidget.__showBoardInformation" ID="MicroPythonWidget.__showBoardInformation"></a>
528 <h4>MicroPythonWidget.__showBoardInformation</h4> 535 <h4>MicroPythonWidget.__showBoardInformation</h4>
529 <b>__showBoardInformation</b>(<i></i>) 536 <b>__showBoardInformation</b>(<i></i>)
530
531 <p> 537 <p>
532 Private slot to show all available information about a board. 538 Private slot to show all available information about a board.
533 </p> 539 </p>
540
534 <a NAME="MicroPythonWidget.__showBuiltinModules" ID="MicroPythonWidget.__showBuiltinModules"></a> 541 <a NAME="MicroPythonWidget.__showBuiltinModules" ID="MicroPythonWidget.__showBuiltinModules"></a>
535 <h4>MicroPythonWidget.__showBuiltinModules</h4> 542 <h4>MicroPythonWidget.__showBuiltinModules</h4>
536 <b>__showBuiltinModules</b>(<i></i>) 543 <b>__showBuiltinModules</b>(<i></i>)
537
538 <p> 544 <p>
539 Private slot to show a list of builtin modules. 545 Private slot to show a list of builtin modules.
540 </p> 546 </p>
547
541 <a NAME="MicroPythonWidget.__showDeviceTime" ID="MicroPythonWidget.__showDeviceTime"></a> 548 <a NAME="MicroPythonWidget.__showDeviceTime" ID="MicroPythonWidget.__showDeviceTime"></a>
542 <h4>MicroPythonWidget.__showDeviceTime</h4> 549 <h4>MicroPythonWidget.__showDeviceTime</h4>
543 <b>__showDeviceTime</b>(<i></i>) 550 <b>__showDeviceTime</b>(<i></i>)
544
545 <p> 551 <p>
546 Private slot to show the date and time of the connected device. 552 Private slot to show the date and time of the connected device.
547 </p> 553 </p>
554
548 <a NAME="MicroPythonWidget.__showDeviceVersion" ID="MicroPythonWidget.__showDeviceVersion"></a> 555 <a NAME="MicroPythonWidget.__showDeviceVersion" ID="MicroPythonWidget.__showDeviceVersion"></a>
549 <h4>MicroPythonWidget.__showDeviceVersion</h4> 556 <h4>MicroPythonWidget.__showDeviceVersion</h4>
550 <b>__showDeviceVersion</b>(<i></i>) 557 <b>__showDeviceVersion</b>(<i></i>)
551
552 <p> 558 <p>
553 Private slot to show some version info about MicroPython of the device. 559 Private slot to show some version info about MicroPython of the device.
554 </p> 560 </p>
561
555 <a NAME="MicroPythonWidget.__showDocumentation" ID="MicroPythonWidget.__showDocumentation"></a> 562 <a NAME="MicroPythonWidget.__showDocumentation" ID="MicroPythonWidget.__showDocumentation"></a>
556 <h4>MicroPythonWidget.__showDocumentation</h4> 563 <h4>MicroPythonWidget.__showDocumentation</h4>
557 <b>__showDocumentation</b>(<i></i>) 564 <b>__showDocumentation</b>(<i></i>)
558
559 <p> 565 <p>
560 Private slot to open the documentation URL for the selected device. 566 Private slot to open the documentation URL for the selected device.
561 </p> 567 </p>
568
562 <a NAME="MicroPythonWidget.__showImplementation" ID="MicroPythonWidget.__showImplementation"></a> 569 <a NAME="MicroPythonWidget.__showImplementation" ID="MicroPythonWidget.__showImplementation"></a>
563 <h4>MicroPythonWidget.__showImplementation</h4> 570 <h4>MicroPythonWidget.__showImplementation</h4>
564 <b>__showImplementation</b>(<i></i>) 571 <b>__showImplementation</b>(<i></i>)
565
566 <p> 572 <p>
567 Private slot to show some implementation related information. 573 Private slot to show some implementation related information.
568 </p> 574 </p>
575
569 <a NAME="MicroPythonWidget.__showLocalAndDeviceTime" ID="MicroPythonWidget.__showLocalAndDeviceTime"></a> 576 <a NAME="MicroPythonWidget.__showLocalAndDeviceTime" ID="MicroPythonWidget.__showLocalAndDeviceTime"></a>
570 <h4>MicroPythonWidget.__showLocalAndDeviceTime</h4> 577 <h4>MicroPythonWidget.__showLocalAndDeviceTime</h4>
571 <b>__showLocalAndDeviceTime</b>(<i></i>) 578 <b>__showLocalAndDeviceTime</b>(<i></i>)
572
573 <p> 579 <p>
574 Private slot to show the local and device time side-by-side. 580 Private slot to show the local and device time side-by-side.
575 </p> 581 </p>
582
576 <a NAME="MicroPythonWidget.__showLocalTime" ID="MicroPythonWidget.__showLocalTime"></a> 583 <a NAME="MicroPythonWidget.__showLocalTime" ID="MicroPythonWidget.__showLocalTime"></a>
577 <h4>MicroPythonWidget.__showLocalTime</h4> 584 <h4>MicroPythonWidget.__showLocalTime</h4>
578 <b>__showLocalTime</b>(<i></i>) 585 <b>__showLocalTime</b>(<i></i>)
579
580 <p> 586 <p>
581 Private slot to show the local date and time. 587 Private slot to show the local date and time.
582 </p> 588 </p>
589
583 <a NAME="MicroPythonWidget.__showNoDeviceMessage" ID="MicroPythonWidget.__showNoDeviceMessage"></a> 590 <a NAME="MicroPythonWidget.__showNoDeviceMessage" ID="MicroPythonWidget.__showNoDeviceMessage"></a>
584 <h4>MicroPythonWidget.__showNoDeviceMessage</h4> 591 <h4>MicroPythonWidget.__showNoDeviceMessage</h4>
585 <b>__showNoDeviceMessage</b>(<i></i>) 592 <b>__showNoDeviceMessage</b>(<i></i>)
586
587 <p> 593 <p>
588 Private method to show a message dialog indicating a missing device. 594 Private method to show a message dialog indicating a missing device.
589 </p> 595 </p>
596
590 <a NAME="MicroPythonWidget.__synchronizeTime" ID="MicroPythonWidget.__synchronizeTime"></a> 597 <a NAME="MicroPythonWidget.__synchronizeTime" ID="MicroPythonWidget.__synchronizeTime"></a>
591 <h4>MicroPythonWidget.__synchronizeTime</h4> 598 <h4>MicroPythonWidget.__synchronizeTime</h4>
592 <b>__synchronizeTime</b>(<i>quiet=False</i>) 599 <b>__synchronizeTime</b>(<i>quiet=False</i>)
593
594 <p> 600 <p>
595 Private slot to set the time of the connected device to the local 601 Private slot to set the time of the connected device to the local
596 computer's time. 602 computer's time.
597 </p> 603 </p>
604
598 <dl> 605 <dl>
599 606
600 <dt><i>quiet</i> (bool)</dt> 607 <dt><i>quiet</i> (bool)</dt>
601 <dd> 608 <dd>
602 flag indicating to not show a message 609 flag indicating to not show a message
603 </dd> 610 </dd>
604 </dl> 611 </dl>
605 <a NAME="MicroPythonWidget.deviceInterface" ID="MicroPythonWidget.deviceInterface"></a> 612 <a NAME="MicroPythonWidget.deviceInterface" ID="MicroPythonWidget.deviceInterface"></a>
606 <h4>MicroPythonWidget.deviceInterface</h4> 613 <h4>MicroPythonWidget.deviceInterface</h4>
607 <b>deviceInterface</b>(<i></i>) 614 <b>deviceInterface</b>(<i></i>)
608
609 <p> 615 <p>
610 Public method to get a reference to the device interface object. 616 Public method to get a reference to the device interface object.
611 </p> 617 </p>
618
612 <dl> 619 <dl>
613 <dt>Return:</dt> 620 <dt>Return:</dt>
614 <dd> 621 <dd>
615 reference to the commands interface object 622 reference to the commands interface object
616 </dd> 623 </dd>
622 </dd> 629 </dd>
623 </dl> 630 </dl>
624 <a NAME="MicroPythonWidget.deviceSupportsLocalFileAccess" ID="MicroPythonWidget.deviceSupportsLocalFileAccess"></a> 631 <a NAME="MicroPythonWidget.deviceSupportsLocalFileAccess" ID="MicroPythonWidget.deviceSupportsLocalFileAccess"></a>
625 <h4>MicroPythonWidget.deviceSupportsLocalFileAccess</h4> 632 <h4>MicroPythonWidget.deviceSupportsLocalFileAccess</h4>
626 <b>deviceSupportsLocalFileAccess</b>(<i></i>) 633 <b>deviceSupportsLocalFileAccess</b>(<i></i>)
627
628 <p> 634 <p>
629 Public method to indicate that the device access the device file system 635 Public method to indicate that the device access the device file system
630 via a local directory. 636 via a local directory.
631 </p> 637 </p>
638
632 <dl> 639 <dl>
633 <dt>Return:</dt> 640 <dt>Return:</dt>
634 <dd> 641 <dd>
635 flag indicating file access via local directory 642 flag indicating file access via local directory
636 </dd> 643 </dd>
642 </dd> 649 </dd>
643 </dl> 650 </dl>
644 <a NAME="MicroPythonWidget.getCurrentPort" ID="MicroPythonWidget.getCurrentPort"></a> 651 <a NAME="MicroPythonWidget.getCurrentPort" ID="MicroPythonWidget.getCurrentPort"></a>
645 <h4>MicroPythonWidget.getCurrentPort</h4> 652 <h4>MicroPythonWidget.getCurrentPort</h4>
646 <b>getCurrentPort</b>(<i></i>) 653 <b>getCurrentPort</b>(<i></i>)
647
648 <p> 654 <p>
649 Public method to determine the port path of the selected device. 655 Public method to determine the port path of the selected device.
650 </p> 656 </p>
657
651 <dl> 658 <dl>
652 <dt>Return:</dt> 659 <dt>Return:</dt>
653 <dd> 660 <dd>
654 path of the port of the selected device 661 path of the port of the selected device
655 </dd> 662 </dd>
661 </dd> 668 </dd>
662 </dl> 669 </dl>
663 <a NAME="MicroPythonWidget.getDevice" ID="MicroPythonWidget.getDevice"></a> 670 <a NAME="MicroPythonWidget.getDevice" ID="MicroPythonWidget.getDevice"></a>
664 <h4>MicroPythonWidget.getDevice</h4> 671 <h4>MicroPythonWidget.getDevice</h4>
665 <b>getDevice</b>(<i></i>) 672 <b>getDevice</b>(<i></i>)
666
667 <p> 673 <p>
668 Public method to get a reference to the current device. 674 Public method to get a reference to the current device.
669 </p> 675 </p>
676
670 <dl> 677 <dl>
671 <dt>Return:</dt> 678 <dt>Return:</dt>
672 <dd> 679 <dd>
673 reference to the current device 680 reference to the current device
674 </dd> 681 </dd>
680 </dd> 687 </dd>
681 </dl> 688 </dl>
682 <a NAME="MicroPythonWidget.getDeviceWorkspace" ID="MicroPythonWidget.getDeviceWorkspace"></a> 689 <a NAME="MicroPythonWidget.getDeviceWorkspace" ID="MicroPythonWidget.getDeviceWorkspace"></a>
683 <h4>MicroPythonWidget.getDeviceWorkspace</h4> 690 <h4>MicroPythonWidget.getDeviceWorkspace</h4>
684 <b>getDeviceWorkspace</b>(<i></i>) 691 <b>getDeviceWorkspace</b>(<i></i>)
685
686 <p> 692 <p>
687 Public method to get the workspace directory of the device. 693 Public method to get the workspace directory of the device.
688 </p> 694 </p>
695
689 <dl> 696 <dl>
690 <dt>Return:</dt> 697 <dt>Return:</dt>
691 <dd> 698 <dd>
692 workspace directory of the device 699 workspace directory of the device
693 </dd> 700 </dd>
699 </dd> 706 </dd>
700 </dl> 707 </dl>
701 <a NAME="MicroPythonWidget.getFileManager" ID="MicroPythonWidget.getFileManager"></a> 708 <a NAME="MicroPythonWidget.getFileManager" ID="MicroPythonWidget.getFileManager"></a>
702 <h4>MicroPythonWidget.getFileManager</h4> 709 <h4>MicroPythonWidget.getFileManager</h4>
703 <b>getFileManager</b>(<i></i>) 710 <b>getFileManager</b>(<i></i>)
704
705 <p> 711 <p>
706 Public method to get a reference to the file manager interface. 712 Public method to get a reference to the file manager interface.
707 </p> 713 </p>
714
708 <dl> 715 <dl>
709 <dt>Return:</dt> 716 <dt>Return:</dt>
710 <dd> 717 <dd>
711 reference to the file manager interface 718 reference to the file manager interface
712 </dd> 719 </dd>
718 </dd> 725 </dd>
719 </dl> 726 </dl>
720 <a NAME="MicroPythonWidget.handleDataFlood" ID="MicroPythonWidget.handleDataFlood"></a> 727 <a NAME="MicroPythonWidget.handleDataFlood" ID="MicroPythonWidget.handleDataFlood"></a>
721 <h4>MicroPythonWidget.handleDataFlood</h4> 728 <h4>MicroPythonWidget.handleDataFlood</h4>
722 <b>handleDataFlood</b>(<i></i>) 729 <b>handleDataFlood</b>(<i></i>)
723
724 <p> 730 <p>
725 Public slot handling a data flood from the device. 731 Public slot handling a data flood from the device.
726 </p> 732 </p>
733
727 <a NAME="MicroPythonWidget.isConnected" ID="MicroPythonWidget.isConnected"></a> 734 <a NAME="MicroPythonWidget.isConnected" ID="MicroPythonWidget.isConnected"></a>
728 <h4>MicroPythonWidget.isConnected</h4> 735 <h4>MicroPythonWidget.isConnected</h4>
729 <b>isConnected</b>(<i></i>) 736 <b>isConnected</b>(<i></i>)
730
731 <p> 737 <p>
732 Public method to get the MicroPython device connection state. 738 Public method to get the MicroPython device connection state.
733 </p> 739 </p>
740
734 <dl> 741 <dl>
735 <dt>Return:</dt> 742 <dt>Return:</dt>
736 <dd> 743 <dd>
737 connection state 744 connection state
738 </dd> 745 </dd>
744 </dd> 751 </dd>
745 </dl> 752 </dl>
746 <a NAME="MicroPythonWidget.isLinkConnected" ID="MicroPythonWidget.isLinkConnected"></a> 753 <a NAME="MicroPythonWidget.isLinkConnected" ID="MicroPythonWidget.isLinkConnected"></a>
747 <h4>MicroPythonWidget.isLinkConnected</h4> 754 <h4>MicroPythonWidget.isLinkConnected</h4>
748 <b>isLinkConnected</b>(<i></i>) 755 <b>isLinkConnected</b>(<i></i>)
749
750 <p> 756 <p>
751 Public method to get the link connection state. 757 Public method to get the link connection state.
752 </p> 758 </p>
759
753 <dl> 760 <dl>
754 <dt>Return:</dt> 761 <dt>Return:</dt>
755 <dd> 762 <dd>
756 connection state 763 connection state
757 </dd> 764 </dd>
763 </dd> 770 </dd>
764 </dl> 771 </dl>
765 <a NAME="MicroPythonWidget.isMicrobit" ID="MicroPythonWidget.isMicrobit"></a> 772 <a NAME="MicroPythonWidget.isMicrobit" ID="MicroPythonWidget.isMicrobit"></a>
766 <h4>MicroPythonWidget.isMicrobit</h4> 773 <h4>MicroPythonWidget.isMicrobit</h4>
767 <b>isMicrobit</b>(<i></i>) 774 <b>isMicrobit</b>(<i></i>)
768
769 <p> 775 <p>
770 Public method to check, if the connected/selected device is a 776 Public method to check, if the connected/selected device is a
771 BBC micro:bit or Calliope mini. 777 BBC micro:bit or Calliope mini.
772 </p> 778 </p>
779
773 <dl> 780 <dl>
774 <dt>Return:</dt> 781 <dt>Return:</dt>
775 <dd> 782 <dd>
776 flag indicating a micro:bit device 783 flag indicating a micro:bit device
777 </dd> 784 </dd>
783 </dd> 790 </dd>
784 </dl> 791 </dl>
785 <a NAME="MicroPythonWidget.on_chartButton_clicked" ID="MicroPythonWidget.on_chartButton_clicked"></a> 792 <a NAME="MicroPythonWidget.on_chartButton_clicked" ID="MicroPythonWidget.on_chartButton_clicked"></a>
786 <h4>MicroPythonWidget.on_chartButton_clicked</h4> 793 <h4>MicroPythonWidget.on_chartButton_clicked</h4>
787 <b>on_chartButton_clicked</b>(<i>checked</i>) 794 <b>on_chartButton_clicked</b>(<i>checked</i>)
788
789 <p> 795 <p>
790 Private slot to open a chart view to plot data received from the 796 Private slot to open a chart view to plot data received from the
791 connected device. 797 connected device.
792 </p> 798 </p>
793 <p> 799 <p>
794 If the selected device is not connected yet, this will be done now. 800 If the selected device is not connected yet, this will be done now.
795 </p> 801 </p>
802
796 <dl> 803 <dl>
797 804
798 <dt><i>checked</i> (bool)</dt> 805 <dt><i>checked</i> (bool)</dt>
799 <dd> 806 <dd>
800 state of the button 807 state of the button
801 </dd> 808 </dd>
802 </dl> 809 </dl>
803 <a NAME="MicroPythonWidget.on_connectButton_clicked" ID="MicroPythonWidget.on_connectButton_clicked"></a> 810 <a NAME="MicroPythonWidget.on_connectButton_clicked" ID="MicroPythonWidget.on_connectButton_clicked"></a>
804 <h4>MicroPythonWidget.on_connectButton_clicked</h4> 811 <h4>MicroPythonWidget.on_connectButton_clicked</h4>
805 <b>on_connectButton_clicked</b>(<i></i>) 812 <b>on_connectButton_clicked</b>(<i></i>)
806
807 <p> 813 <p>
808 Private slot to connect to the selected device or disconnect from the 814 Private slot to connect to the selected device or disconnect from the
809 currently connected device. 815 currently connected device.
810 </p> 816 </p>
817
811 <a NAME="MicroPythonWidget.on_deviceTypeComboBox_activated" ID="MicroPythonWidget.on_deviceTypeComboBox_activated"></a> 818 <a NAME="MicroPythonWidget.on_deviceTypeComboBox_activated" ID="MicroPythonWidget.on_deviceTypeComboBox_activated"></a>
812 <h4>MicroPythonWidget.on_deviceTypeComboBox_activated</h4> 819 <h4>MicroPythonWidget.on_deviceTypeComboBox_activated</h4>
813 <b>on_deviceTypeComboBox_activated</b>(<i>index</i>) 820 <b>on_deviceTypeComboBox_activated</b>(<i>index</i>)
814
815 <p> 821 <p>
816 Private slot handling the selection of a device type. 822 Private slot handling the selection of a device type.
817 </p> 823 </p>
824
818 <dl> 825 <dl>
819 826
820 <dt><i>index</i> (int)</dt> 827 <dt><i>index</i> (int)</dt>
821 <dd> 828 <dd>
822 index of the selected device 829 index of the selected device
823 </dd> 830 </dd>
824 </dl> 831 </dl>
825 <a NAME="MicroPythonWidget.on_filesButton_clicked" ID="MicroPythonWidget.on_filesButton_clicked"></a> 832 <a NAME="MicroPythonWidget.on_filesButton_clicked" ID="MicroPythonWidget.on_filesButton_clicked"></a>
826 <h4>MicroPythonWidget.on_filesButton_clicked</h4> 833 <h4>MicroPythonWidget.on_filesButton_clicked</h4>
827 <b>on_filesButton_clicked</b>(<i>checked</i>) 834 <b>on_filesButton_clicked</b>(<i>checked</i>)
828
829 <p> 835 <p>
830 Private slot to open a file manager window to the connected device. 836 Private slot to open a file manager window to the connected device.
831 </p> 837 </p>
832 <p> 838 <p>
833 If the selected device is not connected yet, this will be done now. 839 If the selected device is not connected yet, this will be done now.
834 </p> 840 </p>
841
835 <dl> 842 <dl>
836 843
837 <dt><i>checked</i> (bool)</dt> 844 <dt><i>checked</i> (bool)</dt>
838 <dd> 845 <dd>
839 state of the button 846 state of the button
840 </dd> 847 </dd>
841 </dl> 848 </dl>
842 <a NAME="MicroPythonWidget.on_replButton_clicked" ID="MicroPythonWidget.on_replButton_clicked"></a> 849 <a NAME="MicroPythonWidget.on_replButton_clicked" ID="MicroPythonWidget.on_replButton_clicked"></a>
843 <h4>MicroPythonWidget.on_replButton_clicked</h4> 850 <h4>MicroPythonWidget.on_replButton_clicked</h4>
844 <b>on_replButton_clicked</b>(<i>checked</i>) 851 <b>on_replButton_clicked</b>(<i>checked</i>)
845
846 <p> 852 <p>
847 Private slot to connect to enable or disable the REPL widget. 853 Private slot to connect to enable or disable the REPL widget.
848 </p> 854 </p>
849 <p> 855 <p>
850 If the selected device is not connected yet, this will be done now. 856 If the selected device is not connected yet, this will be done now.
851 </p> 857 </p>
858
852 <dl> 859 <dl>
853 860
854 <dt><i>checked</i> (bool)</dt> 861 <dt><i>checked</i> (bool)</dt>
855 <dd> 862 <dd>
856 state of the button 863 state of the button
857 </dd> 864 </dd>
858 </dl> 865 </dl>
859 <a NAME="MicroPythonWidget.on_runButton_clicked" ID="MicroPythonWidget.on_runButton_clicked"></a> 866 <a NAME="MicroPythonWidget.on_runButton_clicked" ID="MicroPythonWidget.on_runButton_clicked"></a>
860 <h4>MicroPythonWidget.on_runButton_clicked</h4> 867 <h4>MicroPythonWidget.on_runButton_clicked</h4>
861 <b>on_runButton_clicked</b>(<i></i>) 868 <b>on_runButton_clicked</b>(<i></i>)
862
863 <p> 869 <p>
864 Private slot to execute the script of the active editor on the 870 Private slot to execute the script of the active editor on the
865 selected device. 871 selected device.
866 </p> 872 </p>
867 <p> 873 <p>
868 If the REPL is not active yet, it will be activated, which might cause 874 If the REPL is not active yet, it will be activated, which might cause
869 an unconnected device to be connected. 875 an unconnected device to be connected.
870 </p> 876 </p>
877
871 <a NAME="MicroPythonWidget.setActionButtons" ID="MicroPythonWidget.setActionButtons"></a> 878 <a NAME="MicroPythonWidget.setActionButtons" ID="MicroPythonWidget.setActionButtons"></a>
872 <h4>MicroPythonWidget.setActionButtons</h4> 879 <h4>MicroPythonWidget.setActionButtons</h4>
873 <b>setActionButtons</b>(<i>**kwargs</i>) 880 <b>setActionButtons</b>(<i>**kwargs</i>)
874
875 <p> 881 <p>
876 Public method to set the enabled state of the various action buttons. 882 Public method to set the enabled state of the various action buttons.
877 </p> 883 </p>
884
878 <dl> 885 <dl>
879 886
880 <dt><i>kwargs=</i> (dict)</dt> 887 <dt><i>kwargs=</i> (dict)</dt>
881 <dd> 888 <dd>
882 keyword arguments containg the enabled states (keys 889 keyword arguments containg the enabled states (keys
884 </dd> 891 </dd>
885 </dl> 892 </dl>
886 <a NAME="MicroPythonWidget.showError" ID="MicroPythonWidget.showError"></a> 893 <a NAME="MicroPythonWidget.showError" ID="MicroPythonWidget.showError"></a>
887 <h4>MicroPythonWidget.showError</h4> 894 <h4>MicroPythonWidget.showError</h4>
888 <b>showError</b>(<i>method, error</i>) 895 <b>showError</b>(<i>method, error</i>)
889
890 <p> 896 <p>
891 Public method to show some error message. 897 Public method to show some error message.
892 </p> 898 </p>
899
893 <dl> 900 <dl>
894 901
895 <dt><i>method</i> (str)</dt> 902 <dt><i>method</i> (str)</dt>
896 <dd> 903 <dd>
897 name of the method the error occured in 904 name of the method the error occured in
902 </dd> 909 </dd>
903 </dl> 910 </dl>
904 <a NAME="MicroPythonWidget.shutdown" ID="MicroPythonWidget.shutdown"></a> 911 <a NAME="MicroPythonWidget.shutdown" ID="MicroPythonWidget.shutdown"></a>
905 <h4>MicroPythonWidget.shutdown</h4> 912 <h4>MicroPythonWidget.shutdown</h4>
906 <b>shutdown</b>(<i></i>) 913 <b>shutdown</b>(<i></i>)
907
908 <p> 914 <p>
909 Public method to perform some shutdown actions. 915 Public method to perform some shutdown actions.
910 </p> 916 </p>
917
911 <div align="right"><a href="#top">Up</a></div> 918 <div align="right"><a href="#top">Up</a></div>
912 <hr /> 919 <hr />
913 </body></html> 920 </body></html>

eric ide

mercurial