Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html
- branch
- mpy_network
- changeset 9860
- d34667faa686
- parent 9840
- d41ee69fa69b
- child 9866
- 0cf5dda5512f
equal
deleted
inserted
replaced
| 9859:829c1edbf253 | 9860:d34667faa686 |
|---|---|
| 125 <tr> | 125 <tr> |
| 126 <td><a href="#CircuitPythonDevice.__startTeensyLoader">__startTeensyLoader</a></td> | 126 <td><a href="#CircuitPythonDevice.__startTeensyLoader">__startTeensyLoader</a></td> |
| 127 <td>Private slot to start the 'Teensy Loader' application.</td> | 127 <td>Private slot to start the 'Teensy Loader' application.</td> |
| 128 </tr> | 128 </tr> |
| 129 <tr> | 129 <tr> |
| 130 <td><a href="#CircuitPythonDevice.activateBluetoothInterface">activateBluetoothInterface</a></td> | |
| 131 <td>Public method to activate the Bluetooth interface.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 130 <td><a href="#CircuitPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> | 134 <td><a href="#CircuitPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
| 131 <td>Public method to add device specific entries to the given menu.</td> | 135 <td>Public method to add device specific entries to the given menu.</td> |
| 132 </tr> | 136 </tr> |
| 133 <tr> | 137 <tr> |
| 134 <td><a href="#CircuitPythonDevice.canRunScript">canRunScript</a></td> | 138 <td><a href="#CircuitPythonDevice.canRunScript">canRunScript</a></td> |
| 153 <tr> | 157 <tr> |
| 154 <td><a href="#CircuitPythonDevice.connectWifi">connectWifi</a></td> | 158 <td><a href="#CircuitPythonDevice.connectWifi">connectWifi</a></td> |
| 155 <td>Public method to connect a device to a WiFi network.</td> | 159 <td>Public method to connect a device to a WiFi network.</td> |
| 156 </tr> | 160 </tr> |
| 157 <tr> | 161 <tr> |
| 162 <td><a href="#CircuitPythonDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> | |
| 163 <td>Public method to deactivate the Bluetooth interface.</td> | |
| 164 </tr> | |
| 165 <tr> | |
| 158 <td><a href="#CircuitPythonDevice.deactivateInterface">deactivateInterface</a></td> | 166 <td><a href="#CircuitPythonDevice.deactivateInterface">deactivateInterface</a></td> |
| 159 <td>Public method to deactivate a given WiFi interface of the connected device.</td> | 167 <td>Public method to deactivate a given WiFi interface of the connected device.</td> |
| 160 </tr> | 168 </tr> |
| 161 <tr> | 169 <tr> |
| 162 <td><a href="#CircuitPythonDevice.deviceName">deviceName</a></td> | 170 <td><a href="#CircuitPythonDevice.deviceName">deviceName</a></td> |
| 169 <tr> | 177 <tr> |
| 170 <td><a href="#CircuitPythonDevice.forceInterrupt">forceInterrupt</a></td> | 178 <td><a href="#CircuitPythonDevice.forceInterrupt">forceInterrupt</a></td> |
| 171 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | 179 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
| 172 </tr> | 180 </tr> |
| 173 <tr> | 181 <tr> |
| 182 <td><a href="#CircuitPythonDevice.getBluetoothStatus">getBluetoothStatus</a></td> | |
| 183 <td>Public method to get Bluetooth status data of the connected board.</td> | |
| 184 </tr> | |
| 185 <tr> | |
| 174 <td><a href="#CircuitPythonDevice.getConnectedClients">getConnectedClients</a></td> | 186 <td><a href="#CircuitPythonDevice.getConnectedClients">getConnectedClients</a></td> |
| 175 <td>Public method to get a list of connected clients.</td> | 187 <td>Public method to get a list of connected clients.</td> |
| 176 </tr> | 188 </tr> |
| 177 <tr> | 189 <tr> |
| 190 <td><a href="#CircuitPythonDevice.getDeviceScan">getDeviceScan</a></td> | |
| 191 <td>Public method to perform a Bluetooth device scan.</td> | |
| 192 </tr> | |
| 193 <tr> | |
| 178 <td><a href="#CircuitPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> | 194 <td><a href="#CircuitPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
| 179 <td>Public method to get the device documentation URL.</td> | 195 <td>Public method to get the device documentation URL.</td> |
| 180 </tr> | 196 </tr> |
| 181 <tr> | 197 <tr> |
| 182 <td><a href="#CircuitPythonDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> | 198 <td><a href="#CircuitPythonDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> |
| 187 <td>Public method to get data related to the current WiFi status.</td> | 203 <td>Public method to get data related to the current WiFi status.</td> |
| 188 </tr> | 204 </tr> |
| 189 <tr> | 205 <tr> |
| 190 <td><a href="#CircuitPythonDevice.getWorkspace">getWorkspace</a></td> | 206 <td><a href="#CircuitPythonDevice.getWorkspace">getWorkspace</a></td> |
| 191 <td>Public method to get the workspace directory.</td> | 207 <td>Public method to get the workspace directory.</td> |
| 208 </tr> | |
| 209 <tr> | |
| 210 <td><a href="#CircuitPythonDevice.hasBluetooth">hasBluetooth</a></td> | |
| 211 <td>Public method to check the availability of Bluetooth.</td> | |
| 192 </tr> | 212 </tr> |
| 193 <tr> | 213 <tr> |
| 194 <td><a href="#CircuitPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> | 214 <td><a href="#CircuitPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> |
| 195 <td>Public method to check, if the device has its own flash menu entry.</td> | 215 <td>Public method to check, if the device has its own flash menu entry.</td> |
| 196 </tr> | 216 </tr> |
| 461 Private slot to start the 'Teensy Loader' application. | 481 Private slot to start the 'Teensy Loader' application. |
| 462 </p> | 482 </p> |
| 463 <p> | 483 <p> |
| 464 Note: The application must be accessible via the application search path. | 484 Note: The application must be accessible via the application search path. |
| 465 </p> | 485 </p> |
| 486 <a NAME="CircuitPythonDevice.activateBluetoothInterface" ID="CircuitPythonDevice.activateBluetoothInterface"></a> | |
| 487 <h4>CircuitPythonDevice.activateBluetoothInterface</h4> | |
| 488 <b>activateBluetoothInterface</b>(<i></i>) | |
| 489 | |
| 490 <p> | |
| 491 Public method to activate 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> | |
| 466 <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> | 512 <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> |
| 467 <h4>CircuitPythonDevice.addDeviceMenuEntries</h4> | 513 <h4>CircuitPythonDevice.addDeviceMenuEntries</h4> |
| 468 <b>addDeviceMenuEntries</b>(<i>menu</i>) | 514 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
| 469 | 515 |
| 470 <p> | 516 <p> |
| 604 <dt>Return Type:</dt> | 650 <dt>Return Type:</dt> |
| 605 <dd> | 651 <dd> |
| 606 tuple of (bool, str) | 652 tuple of (bool, str) |
| 607 </dd> | 653 </dd> |
| 608 </dl> | 654 </dl> |
| 655 <a NAME="CircuitPythonDevice.deactivateBluetoothInterface" ID="CircuitPythonDevice.deactivateBluetoothInterface"></a> | |
| 656 <h4>CircuitPythonDevice.deactivateBluetoothInterface</h4> | |
| 657 <b>deactivateBluetoothInterface</b>(<i></i>) | |
| 658 | |
| 659 <p> | |
| 660 Public method to deactivate the Bluetooth interface. | |
| 661 </p> | |
| 662 <dl> | |
| 663 <dt>Return:</dt> | |
| 664 <dd> | |
| 665 flag indicating the new state of the Bluetooth interface | |
| 666 </dd> | |
| 667 </dl> | |
| 668 <dl> | |
| 669 <dt>Return Type:</dt> | |
| 670 <dd> | |
| 671 bool | |
| 672 </dd> | |
| 673 </dl> | |
| 674 <dl> | |
| 675 | |
| 676 <dt>Raises <b>OSError</b>:</dt> | |
| 677 <dd> | |
| 678 raised to indicate an issue with the device | |
| 679 </dd> | |
| 680 </dl> | |
| 609 <a NAME="CircuitPythonDevice.deactivateInterface" ID="CircuitPythonDevice.deactivateInterface"></a> | 681 <a NAME="CircuitPythonDevice.deactivateInterface" ID="CircuitPythonDevice.deactivateInterface"></a> |
| 610 <h4>CircuitPythonDevice.deactivateInterface</h4> | 682 <h4>CircuitPythonDevice.deactivateInterface</h4> |
| 611 <b>deactivateInterface</b>(<i>interface</i>) | 683 <b>deactivateInterface</b>(<i>interface</i>) |
| 612 | 684 |
| 613 <p> | 685 <p> |
| 700 <dt>Return Type:</dt> | 772 <dt>Return Type:</dt> |
| 701 <dd> | 773 <dd> |
| 702 bool | 774 bool |
| 703 </dd> | 775 </dd> |
| 704 </dl> | 776 </dl> |
| 777 <a NAME="CircuitPythonDevice.getBluetoothStatus" ID="CircuitPythonDevice.getBluetoothStatus"></a> | |
| 778 <h4>CircuitPythonDevice.getBluetoothStatus</h4> | |
| 779 <b>getBluetoothStatus</b>(<i></i>) | |
| 780 | |
| 781 <p> | |
| 782 Public method to get Bluetooth status data of the connected board. | |
| 783 </p> | |
| 784 <dl> | |
| 785 <dt>Return:</dt> | |
| 786 <dd> | |
| 787 list of tuples containing the translated status data label and | |
| 788 the associated value | |
| 789 </dd> | |
| 790 </dl> | |
| 791 <dl> | |
| 792 <dt>Return Type:</dt> | |
| 793 <dd> | |
| 794 list of tuples of (str, str) | |
| 795 </dd> | |
| 796 </dl> | |
| 797 <dl> | |
| 798 | |
| 799 <dt>Raises <b>OSError</b>:</dt> | |
| 800 <dd> | |
| 801 raised to indicate an issue with the device | |
| 802 </dd> | |
| 803 </dl> | |
| 705 <a NAME="CircuitPythonDevice.getConnectedClients" ID="CircuitPythonDevice.getConnectedClients"></a> | 804 <a NAME="CircuitPythonDevice.getConnectedClients" ID="CircuitPythonDevice.getConnectedClients"></a> |
| 706 <h4>CircuitPythonDevice.getConnectedClients</h4> | 805 <h4>CircuitPythonDevice.getConnectedClients</h4> |
| 707 <b>getConnectedClients</b>(<i></i>) | 806 <b>getConnectedClients</b>(<i></i>) |
| 708 | 807 |
| 709 <p> | 808 <p> |
| 720 <dt>Return Type:</dt> | 819 <dt>Return Type:</dt> |
| 721 <dd> | 820 <dd> |
| 722 tuple of ([(bytes, int)], str) | 821 tuple of ([(bytes, int)], str) |
| 723 </dd> | 822 </dd> |
| 724 </dl> | 823 </dl> |
| 824 <a NAME="CircuitPythonDevice.getDeviceScan" ID="CircuitPythonDevice.getDeviceScan"></a> | |
| 825 <h4>CircuitPythonDevice.getDeviceScan</h4> | |
| 826 <b>getDeviceScan</b>(<i>timeout=10</i>) | |
| 827 | |
| 828 <p> | |
| 829 Public method to perform a Bluetooth device scan. | |
| 830 </p> | |
| 831 <dl> | |
| 832 | |
| 833 <dt><i>timeout</i> (int (optional))</dt> | |
| 834 <dd> | |
| 835 duration of the device scan in seconds (defaults | |
| 836 to 10) | |
| 837 </dd> | |
| 838 </dl> | |
| 839 <dl> | |
| 840 <dt>Return:</dt> | |
| 841 <dd> | |
| 842 tuple containing a dictionary with the scan results and | |
| 843 an error string | |
| 844 </dd> | |
| 845 </dl> | |
| 846 <dl> | |
| 847 <dt>Return Type:</dt> | |
| 848 <dd> | |
| 849 tuple of (dict, str) | |
| 850 </dd> | |
| 851 </dl> | |
| 725 <a NAME="CircuitPythonDevice.getDocumentationUrl" ID="CircuitPythonDevice.getDocumentationUrl"></a> | 852 <a NAME="CircuitPythonDevice.getDocumentationUrl" ID="CircuitPythonDevice.getDocumentationUrl"></a> |
| 726 <h4>CircuitPythonDevice.getDocumentationUrl</h4> | 853 <h4>CircuitPythonDevice.getDocumentationUrl</h4> |
| 727 <b>getDocumentationUrl</b>(<i></i>) | 854 <b>getDocumentationUrl</b>(<i></i>) |
| 728 | 855 |
| 729 <p> | 856 <p> |
| 810 </dl> | 937 </dl> |
| 811 <dl> | 938 <dl> |
| 812 <dt>Return Type:</dt> | 939 <dt>Return Type:</dt> |
| 813 <dd> | 940 <dd> |
| 814 str | 941 str |
| 942 </dd> | |
| 943 </dl> | |
| 944 <a NAME="CircuitPythonDevice.hasBluetooth" ID="CircuitPythonDevice.hasBluetooth"></a> | |
| 945 <h4>CircuitPythonDevice.hasBluetooth</h4> | |
| 946 <b>hasBluetooth</b>(<i></i>) | |
| 947 | |
| 948 <p> | |
| 949 Public method to check the availability of Bluetooth. | |
| 950 </p> | |
| 951 <dl> | |
| 952 <dt>Return:</dt> | |
| 953 <dd> | |
| 954 flag indicating the availability of Bluetooth | |
| 955 </dd> | |
| 956 </dl> | |
| 957 <dl> | |
| 958 <dt>Return Type:</dt> | |
| 959 <dd> | |
| 960 bool | |
| 961 </dd> | |
| 962 </dl> | |
| 963 <dl> | |
| 964 | |
| 965 <dt>Raises <b>OSError</b>:</dt> | |
| 966 <dd> | |
| 967 raised to indicate an issue with the device | |
| 815 </dd> | 968 </dd> |
| 816 </dl> | 969 </dl> |
| 817 <a NAME="CircuitPythonDevice.hasFlashMenuEntry" ID="CircuitPythonDevice.hasFlashMenuEntry"></a> | 970 <a NAME="CircuitPythonDevice.hasFlashMenuEntry" ID="CircuitPythonDevice.hasFlashMenuEntry"></a> |
| 818 <h4>CircuitPythonDevice.hasFlashMenuEntry</h4> | 971 <h4>CircuitPythonDevice.hasFlashMenuEntry</h4> |
| 819 <b>hasFlashMenuEntry</b>(<i></i>) | 972 <b>hasFlashMenuEntry</b>(<i></i>) |
