Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html
- branch
- mpy_network
- changeset 9860
- d34667faa686
- parent 9840
- d41ee69fa69b
- child 9866
- 0cf5dda5512f
equal
deleted
inserted
replaced
| 9859:829c1edbf253 | 9860:d34667faa686 |
|---|---|
| 130 <tr> | 130 <tr> |
| 131 <td><a href="#EspDevice._getSetTimeCode">_getSetTimeCode</a></td> | 131 <td><a href="#EspDevice._getSetTimeCode">_getSetTimeCode</a></td> |
| 132 <td>Protected method to get the device code to set the time.</td> | 132 <td>Protected method to get the device code to set the time.</td> |
| 133 </tr> | 133 </tr> |
| 134 <tr> | 134 <tr> |
| 135 <td><a href="#EspDevice.activateBluetoothInterface">activateBluetoothInterface</a></td> | |
| 136 <td>Public method to activate the Bluetooth interface.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 135 <td><a href="#EspDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> | 139 <td><a href="#EspDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
| 136 <td>Public method to add device specific entries to the given menu.</td> | 140 <td>Public method to add device specific entries to the given menu.</td> |
| 137 </tr> | 141 </tr> |
| 138 <tr> | 142 <tr> |
| 139 <td><a href="#EspDevice.canRunScript">canRunScript</a></td> | 143 <td><a href="#EspDevice.canRunScript">canRunScript</a></td> |
| 158 <tr> | 162 <tr> |
| 159 <td><a href="#EspDevice.connectWifi">connectWifi</a></td> | 163 <td><a href="#EspDevice.connectWifi">connectWifi</a></td> |
| 160 <td>Public method to connect a device to a WiFi network.</td> | 164 <td>Public method to connect a device to a WiFi network.</td> |
| 161 </tr> | 165 </tr> |
| 162 <tr> | 166 <tr> |
| 167 <td><a href="#EspDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> | |
| 168 <td>Public method to deactivate the Bluetooth interface.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 163 <td><a href="#EspDevice.deactivateInterface">deactivateInterface</a></td> | 171 <td><a href="#EspDevice.deactivateInterface">deactivateInterface</a></td> |
| 164 <td>Public method to deactivate a given WiFi interface of the connected device.</td> | 172 <td>Public method to deactivate a given WiFi interface of the connected device.</td> |
| 165 </tr> | 173 </tr> |
| 166 <tr> | 174 <tr> |
| 167 <td><a href="#EspDevice.deviceName">deviceName</a></td> | 175 <td><a href="#EspDevice.deviceName">deviceName</a></td> |
| 174 <tr> | 182 <tr> |
| 175 <td><a href="#EspDevice.forceInterrupt">forceInterrupt</a></td> | 183 <td><a href="#EspDevice.forceInterrupt">forceInterrupt</a></td> |
| 176 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | 184 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
| 177 </tr> | 185 </tr> |
| 178 <tr> | 186 <tr> |
| 187 <td><a href="#EspDevice.getBluetoothStatus">getBluetoothStatus</a></td> | |
| 188 <td>Public method to get Bluetooth status data of the connected board.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 179 <td><a href="#EspDevice.getConnectedClients">getConnectedClients</a></td> | 191 <td><a href="#EspDevice.getConnectedClients">getConnectedClients</a></td> |
| 180 <td>Public method to get a list of connected clients.</td> | 192 <td>Public method to get a list of connected clients.</td> |
| 181 </tr> | 193 </tr> |
| 182 <tr> | 194 <tr> |
| 195 <td><a href="#EspDevice.getDeviceScan">getDeviceScan</a></td> | |
| 196 <td>Public method to perform a Bluetooth device scan.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 183 <td><a href="#EspDevice.getDocumentationUrl">getDocumentationUrl</a></td> | 199 <td><a href="#EspDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
| 184 <td>Public method to get the device documentation URL.</td> | 200 <td>Public method to get the device documentation URL.</td> |
| 185 </tr> | 201 </tr> |
| 186 <tr> | 202 <tr> |
| 187 <td><a href="#EspDevice.getFirmwareUrl">getFirmwareUrl</a></td> | 203 <td><a href="#EspDevice.getFirmwareUrl">getFirmwareUrl</a></td> |
| 188 <td>Public method to get the device firmware download URL.</td> | 204 <td>Public method to get the device firmware download URL.</td> |
| 189 </tr> | 205 </tr> |
| 190 <tr> | 206 <tr> |
| 191 <td><a href="#EspDevice.getWifiData">getWifiData</a></td> | 207 <td><a href="#EspDevice.getWifiData">getWifiData</a></td> |
| 192 <td>Public method to get data related to the current WiFi status.</td> | 208 <td>Public method to get data related to the current WiFi status.</td> |
| 209 </tr> | |
| 210 <tr> | |
| 211 <td><a href="#EspDevice.hasBluetooth">hasBluetooth</a></td> | |
| 212 <td>Public method to check the availability of Bluetooth.</td> | |
| 193 </tr> | 213 </tr> |
| 194 <tr> | 214 <tr> |
| 195 <td><a href="#EspDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> | 215 <td><a href="#EspDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> |
| 196 <td>Public method to check, if the device has its own flash menu entry.</td> | 216 <td>Public method to check, if the device has its own flash menu entry.</td> |
| 197 </tr> | 217 </tr> |
| 376 <dt>Return Type:</dt> | 396 <dt>Return Type:</dt> |
| 377 <dd> | 397 <dd> |
| 378 str | 398 str |
| 379 </dd> | 399 </dd> |
| 380 </dl> | 400 </dl> |
| 401 <a NAME="EspDevice.activateBluetoothInterface" ID="EspDevice.activateBluetoothInterface"></a> | |
| 402 <h4>EspDevice.activateBluetoothInterface</h4> | |
| 403 <b>activateBluetoothInterface</b>(<i></i>) | |
| 404 | |
| 405 <p> | |
| 406 Public method to activate the Bluetooth interface. | |
| 407 </p> | |
| 408 <dl> | |
| 409 <dt>Return:</dt> | |
| 410 <dd> | |
| 411 flag indicating the new state of the Bluetooth interface | |
| 412 </dd> | |
| 413 </dl> | |
| 414 <dl> | |
| 415 <dt>Return Type:</dt> | |
| 416 <dd> | |
| 417 bool | |
| 418 </dd> | |
| 419 </dl> | |
| 420 <dl> | |
| 421 | |
| 422 <dt>Raises <b>OSError</b>:</dt> | |
| 423 <dd> | |
| 424 raised to indicate an issue with the device | |
| 425 </dd> | |
| 426 </dl> | |
| 381 <a NAME="EspDevice.addDeviceMenuEntries" ID="EspDevice.addDeviceMenuEntries"></a> | 427 <a NAME="EspDevice.addDeviceMenuEntries" ID="EspDevice.addDeviceMenuEntries"></a> |
| 382 <h4>EspDevice.addDeviceMenuEntries</h4> | 428 <h4>EspDevice.addDeviceMenuEntries</h4> |
| 383 <b>addDeviceMenuEntries</b>(<i>menu</i>) | 429 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
| 384 | 430 |
| 385 <p> | 431 <p> |
| 519 <dt>Return Type:</dt> | 565 <dt>Return Type:</dt> |
| 520 <dd> | 566 <dd> |
| 521 tuple of (bool, str) | 567 tuple of (bool, str) |
| 522 </dd> | 568 </dd> |
| 523 </dl> | 569 </dl> |
| 570 <a NAME="EspDevice.deactivateBluetoothInterface" ID="EspDevice.deactivateBluetoothInterface"></a> | |
| 571 <h4>EspDevice.deactivateBluetoothInterface</h4> | |
| 572 <b>deactivateBluetoothInterface</b>(<i></i>) | |
| 573 | |
| 574 <p> | |
| 575 Public method to deactivate the Bluetooth interface. | |
| 576 </p> | |
| 577 <dl> | |
| 578 <dt>Return:</dt> | |
| 579 <dd> | |
| 580 flag indicating the new state of the Bluetooth interface | |
| 581 </dd> | |
| 582 </dl> | |
| 583 <dl> | |
| 584 <dt>Return Type:</dt> | |
| 585 <dd> | |
| 586 bool | |
| 587 </dd> | |
| 588 </dl> | |
| 589 <dl> | |
| 590 | |
| 591 <dt>Raises <b>OSError</b>:</dt> | |
| 592 <dd> | |
| 593 raised to indicate an issue with the device | |
| 594 </dd> | |
| 595 </dl> | |
| 524 <a NAME="EspDevice.deactivateInterface" ID="EspDevice.deactivateInterface"></a> | 596 <a NAME="EspDevice.deactivateInterface" ID="EspDevice.deactivateInterface"></a> |
| 525 <h4>EspDevice.deactivateInterface</h4> | 597 <h4>EspDevice.deactivateInterface</h4> |
| 526 <b>deactivateInterface</b>(<i>interface</i>) | 598 <b>deactivateInterface</b>(<i>interface</i>) |
| 527 | 599 |
| 528 <p> | 600 <p> |
| 611 <dt>Return Type:</dt> | 683 <dt>Return Type:</dt> |
| 612 <dd> | 684 <dd> |
| 613 bool | 685 bool |
| 614 </dd> | 686 </dd> |
| 615 </dl> | 687 </dl> |
| 688 <a NAME="EspDevice.getBluetoothStatus" ID="EspDevice.getBluetoothStatus"></a> | |
| 689 <h4>EspDevice.getBluetoothStatus</h4> | |
| 690 <b>getBluetoothStatus</b>(<i></i>) | |
| 691 | |
| 692 <p> | |
| 693 Public method to get Bluetooth status data of the connected board. | |
| 694 </p> | |
| 695 <dl> | |
| 696 <dt>Return:</dt> | |
| 697 <dd> | |
| 698 list of tuples containing the translated status data label and | |
| 699 the associated value | |
| 700 </dd> | |
| 701 </dl> | |
| 702 <dl> | |
| 703 <dt>Return Type:</dt> | |
| 704 <dd> | |
| 705 list of tuples of (str, str) | |
| 706 </dd> | |
| 707 </dl> | |
| 708 <dl> | |
| 709 | |
| 710 <dt>Raises <b>OSError</b>:</dt> | |
| 711 <dd> | |
| 712 raised to indicate an issue with the device | |
| 713 </dd> | |
| 714 </dl> | |
| 616 <a NAME="EspDevice.getConnectedClients" ID="EspDevice.getConnectedClients"></a> | 715 <a NAME="EspDevice.getConnectedClients" ID="EspDevice.getConnectedClients"></a> |
| 617 <h4>EspDevice.getConnectedClients</h4> | 716 <h4>EspDevice.getConnectedClients</h4> |
| 618 <b>getConnectedClients</b>(<i></i>) | 717 <b>getConnectedClients</b>(<i></i>) |
| 619 | 718 |
| 620 <p> | 719 <p> |
| 631 <dt>Return Type:</dt> | 730 <dt>Return Type:</dt> |
| 632 <dd> | 731 <dd> |
| 633 tuple of ([(bytes, int)], str) | 732 tuple of ([(bytes, int)], str) |
| 634 </dd> | 733 </dd> |
| 635 </dl> | 734 </dl> |
| 735 <a NAME="EspDevice.getDeviceScan" ID="EspDevice.getDeviceScan"></a> | |
| 736 <h4>EspDevice.getDeviceScan</h4> | |
| 737 <b>getDeviceScan</b>(<i>timeout=10</i>) | |
| 738 | |
| 739 <p> | |
| 740 Public method to perform a Bluetooth device scan. | |
| 741 </p> | |
| 742 <dl> | |
| 743 | |
| 744 <dt><i>timeout</i> (int (optional))</dt> | |
| 745 <dd> | |
| 746 duration of the device scan in seconds (defaults | |
| 747 to 10) | |
| 748 </dd> | |
| 749 </dl> | |
| 750 <dl> | |
| 751 <dt>Return:</dt> | |
| 752 <dd> | |
| 753 tuple containing a dictionary with the scan results and | |
| 754 an error string | |
| 755 </dd> | |
| 756 </dl> | |
| 757 <dl> | |
| 758 <dt>Return Type:</dt> | |
| 759 <dd> | |
| 760 tuple of (dict, str) | |
| 761 </dd> | |
| 762 </dl> | |
| 636 <a NAME="EspDevice.getDocumentationUrl" ID="EspDevice.getDocumentationUrl"></a> | 763 <a NAME="EspDevice.getDocumentationUrl" ID="EspDevice.getDocumentationUrl"></a> |
| 637 <h4>EspDevice.getDocumentationUrl</h4> | 764 <h4>EspDevice.getDocumentationUrl</h4> |
| 638 <b>getDocumentationUrl</b>(<i></i>) | 765 <b>getDocumentationUrl</b>(<i></i>) |
| 639 | 766 |
| 640 <p> | 767 <p> |
| 687 </dl> | 814 </dl> |
| 688 <dl> | 815 <dl> |
| 689 <dt>Return Type:</dt> | 816 <dt>Return Type:</dt> |
| 690 <dd> | 817 <dd> |
| 691 tuple of (dict, dict, dict) | 818 tuple of (dict, dict, dict) |
| 819 </dd> | |
| 820 </dl> | |
| 821 <dl> | |
| 822 | |
| 823 <dt>Raises <b>OSError</b>:</dt> | |
| 824 <dd> | |
| 825 raised to indicate an issue with the device | |
| 826 </dd> | |
| 827 </dl> | |
| 828 <a NAME="EspDevice.hasBluetooth" ID="EspDevice.hasBluetooth"></a> | |
| 829 <h4>EspDevice.hasBluetooth</h4> | |
| 830 <b>hasBluetooth</b>(<i></i>) | |
| 831 | |
| 832 <p> | |
| 833 Public method to check the availability of Bluetooth. | |
| 834 </p> | |
| 835 <dl> | |
| 836 <dt>Return:</dt> | |
| 837 <dd> | |
| 838 flag indicating the availability of Bluetooth | |
| 839 </dd> | |
| 840 </dl> | |
| 841 <dl> | |
| 842 <dt>Return Type:</dt> | |
| 843 <dd> | |
| 844 bool | |
| 692 </dd> | 845 </dd> |
| 693 </dl> | 846 </dl> |
| 694 <dl> | 847 <dl> |
| 695 | 848 |
| 696 <dt>Raises <b>OSError</b>:</dt> | 849 <dt>Raises <b>OSError</b>:</dt> |
