Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.MicrobitDevices.html
- branch
- mpy_network
- changeset 9864
- f848aacf3447
- parent 9840
- d41ee69fa69b
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9863:5f2377b32716 | 9864:f848aacf3447 |
|---|---|
| 102 <tr> | 102 <tr> |
| 103 <td><a href="#MicrobitDevice._getSetTimeCode">_getSetTimeCode</a></td> | 103 <td><a href="#MicrobitDevice._getSetTimeCode">_getSetTimeCode</a></td> |
| 104 <td>Protected method to get the device code to set the time.</td> | 104 <td>Protected method to get the device code to set the time.</td> |
| 105 </tr> | 105 </tr> |
| 106 <tr> | 106 <tr> |
| 107 <td><a href="#MicrobitDevice.activateBluetoothInterface">activateBluetoothInterface</a></td> | |
| 108 <td>Public method to activate the Bluetooth interface.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 107 <td><a href="#MicrobitDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> | 111 <td><a href="#MicrobitDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
| 108 <td>Public method to add device specific entries to the given menu.</td> | 112 <td>Public method to add device specific entries to the given menu.</td> |
| 109 </tr> | 113 </tr> |
| 110 <tr> | 114 <tr> |
| 111 <td><a href="#MicrobitDevice.canRunScript">canRunScript</a></td> | 115 <td><a href="#MicrobitDevice.canRunScript">canRunScript</a></td> |
| 122 <tr> | 126 <tr> |
| 123 <td><a href="#MicrobitDevice.canStartRepl">canStartRepl</a></td> | 127 <td><a href="#MicrobitDevice.canStartRepl">canStartRepl</a></td> |
| 124 <td>Public method to determine, if a REPL can be started.</td> | 128 <td>Public method to determine, if a REPL can be started.</td> |
| 125 </tr> | 129 </tr> |
| 126 <tr> | 130 <tr> |
| 131 <td><a href="#MicrobitDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> | |
| 132 <td>Public method to deactivate the Bluetooth interface.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 127 <td><a href="#MicrobitDevice.deviceName">deviceName</a></td> | 135 <td><a href="#MicrobitDevice.deviceName">deviceName</a></td> |
| 128 <td>Public method to get the name of the device.</td> | 136 <td>Public method to get the name of the device.</td> |
| 129 </tr> | 137 </tr> |
| 130 <tr> | 138 <tr> |
| 131 <td><a href="#MicrobitDevice.forceInterrupt">forceInterrupt</a></td> | 139 <td><a href="#MicrobitDevice.forceInterrupt">forceInterrupt</a></td> |
| 132 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | 140 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
| 133 </tr> | 141 </tr> |
| 134 <tr> | 142 <tr> |
| 143 <td><a href="#MicrobitDevice.getBluetoothStatus">getBluetoothStatus</a></td> | |
| 144 <td>Public method to get Bluetooth status data of the connected board.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#MicrobitDevice.getDeviceScan">getDeviceScan</a></td> | |
| 148 <td>Public method to perform a Bluetooth device scan.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 135 <td><a href="#MicrobitDevice.getDocumentationUrl">getDocumentationUrl</a></td> | 151 <td><a href="#MicrobitDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
| 136 <td>Public method to get the device documentation URL.</td> | 152 <td>Public method to get the device documentation URL.</td> |
| 137 </tr> | 153 </tr> |
| 138 <tr> | 154 <tr> |
| 139 <td><a href="#MicrobitDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> | 155 <td><a href="#MicrobitDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> |
| 140 <td>Public method to retrieve the entries for the downloads menu.</td> | 156 <td>Public method to retrieve the entries for the downloads menu.</td> |
| 157 </tr> | |
| 158 <tr> | |
| 159 <td><a href="#MicrobitDevice.hasBluetooth">hasBluetooth</a></td> | |
| 160 <td>Public method to check the availability of Bluetooth.</td> | |
| 141 </tr> | 161 </tr> |
| 142 <tr> | 162 <tr> |
| 143 <td><a href="#MicrobitDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> | 163 <td><a href="#MicrobitDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> |
| 144 <td>Public method to check, if the device has its own flash menu entry.</td> | 164 <td>Public method to check, if the device has its own flash menu entry.</td> |
| 145 </tr> | 165 </tr> |
| 341 <dt>Return Type:</dt> | 361 <dt>Return Type:</dt> |
| 342 <dd> | 362 <dd> |
| 343 str | 363 str |
| 344 </dd> | 364 </dd> |
| 345 </dl> | 365 </dl> |
| 366 <a NAME="MicrobitDevice.activateBluetoothInterface" ID="MicrobitDevice.activateBluetoothInterface"></a> | |
| 367 <h4>MicrobitDevice.activateBluetoothInterface</h4> | |
| 368 <b>activateBluetoothInterface</b>(<i></i>) | |
| 369 | |
| 370 <p> | |
| 371 Public method to activate the Bluetooth interface. | |
| 372 </p> | |
| 373 <dl> | |
| 374 <dt>Return:</dt> | |
| 375 <dd> | |
| 376 flag indicating the new state of the Bluetooth interface | |
| 377 </dd> | |
| 378 </dl> | |
| 379 <dl> | |
| 380 <dt>Return Type:</dt> | |
| 381 <dd> | |
| 382 bool | |
| 383 </dd> | |
| 384 </dl> | |
| 385 <dl> | |
| 386 | |
| 387 <dt>Raises <b>OSError</b>:</dt> | |
| 388 <dd> | |
| 389 raised to indicate an issue with the device | |
| 390 </dd> | |
| 391 </dl> | |
| 346 <a NAME="MicrobitDevice.addDeviceMenuEntries" ID="MicrobitDevice.addDeviceMenuEntries"></a> | 392 <a NAME="MicrobitDevice.addDeviceMenuEntries" ID="MicrobitDevice.addDeviceMenuEntries"></a> |
| 347 <h4>MicrobitDevice.addDeviceMenuEntries</h4> | 393 <h4>MicrobitDevice.addDeviceMenuEntries</h4> |
| 348 <b>addDeviceMenuEntries</b>(<i>menu</i>) | 394 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
| 349 | 395 |
| 350 <p> | 396 <p> |
| 435 <dt>Return Type:</dt> | 481 <dt>Return Type:</dt> |
| 436 <dd> | 482 <dd> |
| 437 tuple of (bool, str) | 483 tuple of (bool, str) |
| 438 </dd> | 484 </dd> |
| 439 </dl> | 485 </dl> |
| 486 <a NAME="MicrobitDevice.deactivateBluetoothInterface" ID="MicrobitDevice.deactivateBluetoothInterface"></a> | |
| 487 <h4>MicrobitDevice.deactivateBluetoothInterface</h4> | |
| 488 <b>deactivateBluetoothInterface</b>(<i></i>) | |
| 489 | |
| 490 <p> | |
| 491 Public method to deactivate the Bluetooth interface. | |
| 492 </p> | |
| 493 <dl> | |
| 494 <dt>Return:</dt> | |
| 495 <dd> | |
| 496 flag indicating the new state of the Bluetooth interface | |
| 497 </dd> | |
| 498 </dl> | |
| 499 <dl> | |
| 500 <dt>Return Type:</dt> | |
| 501 <dd> | |
| 502 bool | |
| 503 </dd> | |
| 504 </dl> | |
| 505 <dl> | |
| 506 | |
| 507 <dt>Raises <b>OSError</b>:</dt> | |
| 508 <dd> | |
| 509 raised to indicate an issue with the device | |
| 510 </dd> | |
| 511 </dl> | |
| 440 <a NAME="MicrobitDevice.deviceName" ID="MicrobitDevice.deviceName"></a> | 512 <a NAME="MicrobitDevice.deviceName" ID="MicrobitDevice.deviceName"></a> |
| 441 <h4>MicrobitDevice.deviceName</h4> | 513 <h4>MicrobitDevice.deviceName</h4> |
| 442 <b>deviceName</b>(<i></i>) | 514 <b>deviceName</b>(<i></i>) |
| 443 | 515 |
| 444 <p> | 516 <p> |
| 474 <dt>Return Type:</dt> | 546 <dt>Return Type:</dt> |
| 475 <dd> | 547 <dd> |
| 476 bool | 548 bool |
| 477 </dd> | 549 </dd> |
| 478 </dl> | 550 </dl> |
| 551 <a NAME="MicrobitDevice.getBluetoothStatus" ID="MicrobitDevice.getBluetoothStatus"></a> | |
| 552 <h4>MicrobitDevice.getBluetoothStatus</h4> | |
| 553 <b>getBluetoothStatus</b>(<i></i>) | |
| 554 | |
| 555 <p> | |
| 556 Public method to get Bluetooth status data of the connected board. | |
| 557 </p> | |
| 558 <dl> | |
| 559 <dt>Return:</dt> | |
| 560 <dd> | |
| 561 list of tuples containing the translated status data label and | |
| 562 the associated value | |
| 563 </dd> | |
| 564 </dl> | |
| 565 <dl> | |
| 566 <dt>Return Type:</dt> | |
| 567 <dd> | |
| 568 list of tuples of (str, str) | |
| 569 </dd> | |
| 570 </dl> | |
| 571 <dl> | |
| 572 | |
| 573 <dt>Raises <b>OSError</b>:</dt> | |
| 574 <dd> | |
| 575 raised to indicate an issue with the device | |
| 576 </dd> | |
| 577 </dl> | |
| 578 <a NAME="MicrobitDevice.getDeviceScan" ID="MicrobitDevice.getDeviceScan"></a> | |
| 579 <h4>MicrobitDevice.getDeviceScan</h4> | |
| 580 <b>getDeviceScan</b>(<i>timeout=10</i>) | |
| 581 | |
| 582 <p> | |
| 583 Public method to perform a Bluetooth device scan. | |
| 584 </p> | |
| 585 <dl> | |
| 586 | |
| 587 <dt><i>timeout</i> (int (optional))</dt> | |
| 588 <dd> | |
| 589 duration of the device scan in seconds (defaults | |
| 590 to 10) | |
| 591 </dd> | |
| 592 </dl> | |
| 593 <dl> | |
| 594 <dt>Return:</dt> | |
| 595 <dd> | |
| 596 tuple containing a dictionary with the scan results and | |
| 597 an error string | |
| 598 </dd> | |
| 599 </dl> | |
| 600 <dl> | |
| 601 <dt>Return Type:</dt> | |
| 602 <dd> | |
| 603 tuple of (dict, str) | |
| 604 </dd> | |
| 605 </dl> | |
| 479 <a NAME="MicrobitDevice.getDocumentationUrl" ID="MicrobitDevice.getDocumentationUrl"></a> | 606 <a NAME="MicrobitDevice.getDocumentationUrl" ID="MicrobitDevice.getDocumentationUrl"></a> |
| 480 <h4>MicrobitDevice.getDocumentationUrl</h4> | 607 <h4>MicrobitDevice.getDocumentationUrl</h4> |
| 481 <b>getDocumentationUrl</b>(<i></i>) | 608 <b>getDocumentationUrl</b>(<i></i>) |
| 482 | 609 |
| 483 <p> | 610 <p> |
| 511 </dl> | 638 </dl> |
| 512 <dl> | 639 <dl> |
| 513 <dt>Return Type:</dt> | 640 <dt>Return Type:</dt> |
| 514 <dd> | 641 <dd> |
| 515 list of tuple of (str, str) | 642 list of tuple of (str, str) |
| 643 </dd> | |
| 644 </dl> | |
| 645 <a NAME="MicrobitDevice.hasBluetooth" ID="MicrobitDevice.hasBluetooth"></a> | |
| 646 <h4>MicrobitDevice.hasBluetooth</h4> | |
| 647 <b>hasBluetooth</b>(<i></i>) | |
| 648 | |
| 649 <p> | |
| 650 Public method to check the availability of Bluetooth. | |
| 651 </p> | |
| 652 <dl> | |
| 653 <dt>Return:</dt> | |
| 654 <dd> | |
| 655 flag indicating the availability of Bluetooth | |
| 656 </dd> | |
| 657 </dl> | |
| 658 <dl> | |
| 659 <dt>Return Type:</dt> | |
| 660 <dd> | |
| 661 bool | |
| 662 </dd> | |
| 663 </dl> | |
| 664 <dl> | |
| 665 | |
| 666 <dt>Raises <b>OSError</b>:</dt> | |
| 667 <dd> | |
| 668 raised to indicate an issue with the device | |
| 516 </dd> | 669 </dd> |
| 517 </dl> | 670 </dl> |
| 518 <a NAME="MicrobitDevice.hasFlashMenuEntry" ID="MicrobitDevice.hasFlashMenuEntry"></a> | 671 <a NAME="MicrobitDevice.hasFlashMenuEntry" ID="MicrobitDevice.hasFlashMenuEntry"></a> |
| 519 <h4>MicrobitDevice.hasFlashMenuEntry</h4> | 672 <h4>MicrobitDevice.hasFlashMenuEntry</h4> |
| 520 <b>hasFlashMenuEntry</b>(<i></i>) | 673 <b>hasFlashMenuEntry</b>(<i></i>) |
