Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html
- branch
- eric7
- changeset 10089
- 5fe9bfafbc7c
- parent 10022
- a95800b414b7
- child 10144
- 45a9177c8e77
equal
deleted
inserted
replaced
| 10088:f7cc01653810 | 10089:5fe9bfafbc7c |
|---|---|
| 94 <tr> | 94 <tr> |
| 95 <td><a href="#RP2040Device._getSetTimeCode">_getSetTimeCode</a></td> | 95 <td><a href="#RP2040Device._getSetTimeCode">_getSetTimeCode</a></td> |
| 96 <td>Protected method to get the device code to set the time.</td> | 96 <td>Protected method to get the device code to set the time.</td> |
| 97 </tr> | 97 </tr> |
| 98 <tr> | 98 <tr> |
| 99 <td><a href="#RP2040Device.activateBluetoothInterface">activateBluetoothInterface</a></td> | |
| 100 <td>Public method to activate the Bluetooth interface.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 99 <td><a href="#RP2040Device.addDeviceMenuEntries">addDeviceMenuEntries</a></td> | 103 <td><a href="#RP2040Device.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
| 100 <td>Public method to add device specific entries to the given menu.</td> | 104 <td>Public method to add device specific entries to the given menu.</td> |
| 101 </tr> | 105 </tr> |
| 102 <tr> | 106 <tr> |
| 103 <td><a href="#RP2040Device.addDeviceWifiEntries">addDeviceWifiEntries</a></td> | 107 <td><a href="#RP2040Device.addDeviceWifiEntries">addDeviceWifiEntries</a></td> |
| 134 <tr> | 138 <tr> |
| 135 <td><a href="#RP2040Device.connectWifi">connectWifi</a></td> | 139 <td><a href="#RP2040Device.connectWifi">connectWifi</a></td> |
| 136 <td>Public method to connect a device to a WiFi network.</td> | 140 <td>Public method to connect a device to a WiFi network.</td> |
| 137 </tr> | 141 </tr> |
| 138 <tr> | 142 <tr> |
| 143 <td><a href="#RP2040Device.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> | |
| 144 <td>Public method to deactivate the Bluetooth interface.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 139 <td><a href="#RP2040Device.deactivateEthernet">deactivateEthernet</a></td> | 147 <td><a href="#RP2040Device.deactivateEthernet">deactivateEthernet</a></td> |
| 140 <td>Public method to deactivate the Ethernet interface of the connected device.</td> | 148 <td>Public method to deactivate the Ethernet interface of the connected device.</td> |
| 141 </tr> | 149 </tr> |
| 142 <tr> | 150 <tr> |
| 143 <td><a href="#RP2040Device.deactivateInterface">deactivateInterface</a></td> | 151 <td><a href="#RP2040Device.deactivateInterface">deactivateInterface</a></td> |
| 166 <tr> | 174 <tr> |
| 167 <td><a href="#RP2040Device.forceInterrupt">forceInterrupt</a></td> | 175 <td><a href="#RP2040Device.forceInterrupt">forceInterrupt</a></td> |
| 168 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | 176 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
| 169 </tr> | 177 </tr> |
| 170 <tr> | 178 <tr> |
| 179 <td><a href="#RP2040Device.getBluetoothStatus">getBluetoothStatus</a></td> | |
| 180 <td>Public method to get Bluetooth status data of the connected board.</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 171 <td><a href="#RP2040Device.getConnectedClients">getConnectedClients</a></td> | 183 <td><a href="#RP2040Device.getConnectedClients">getConnectedClients</a></td> |
| 172 <td>Public method to get a list of connected clients.</td> | 184 <td>Public method to get a list of connected clients.</td> |
| 173 </tr> | 185 </tr> |
| 174 <tr> | 186 <tr> |
| 187 <td><a href="#RP2040Device.getDeviceScan">getDeviceScan</a></td> | |
| 188 <td>Public method to perform a Bluetooth device scan.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 175 <td><a href="#RP2040Device.getDocumentationUrl">getDocumentationUrl</a></td> | 191 <td><a href="#RP2040Device.getDocumentationUrl">getDocumentationUrl</a></td> |
| 176 <td>Public method to get the device documentation URL.</td> | 192 <td>Public method to get the device documentation URL.</td> |
| 177 </tr> | 193 </tr> |
| 178 <tr> | 194 <tr> |
| 179 <td><a href="#RP2040Device.getDownloadMenuEntries">getDownloadMenuEntries</a></td> | 195 <td><a href="#RP2040Device.getDownloadMenuEntries">getDownloadMenuEntries</a></td> |
| 184 <td>Public method to get Ethernet status data of the connected board.</td> | 200 <td>Public method to get Ethernet status data of the connected board.</td> |
| 185 </tr> | 201 </tr> |
| 186 <tr> | 202 <tr> |
| 187 <td><a href="#RP2040Device.getWifiData">getWifiData</a></td> | 203 <td><a href="#RP2040Device.getWifiData">getWifiData</a></td> |
| 188 <td>Public method to get data related to the current WiFi status.</td> | 204 <td>Public method to get data related to the current WiFi status.</td> |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#RP2040Device.hasBluetooth">hasBluetooth</a></td> | |
| 208 <td>Public method to check the availability of Bluetooth.</td> | |
| 189 </tr> | 209 </tr> |
| 190 <tr> | 210 <tr> |
| 191 <td><a href="#RP2040Device.hasEthernet">hasEthernet</a></td> | 211 <td><a href="#RP2040Device.hasEthernet">hasEthernet</a></td> |
| 192 <td>Public method to check the availability of Ethernet.</td> | 212 <td>Public method to check the availability of Ethernet.</td> |
| 193 </tr> | 213 </tr> |
| 353 <dt>Return Type:</dt> | 373 <dt>Return Type:</dt> |
| 354 <dd> | 374 <dd> |
| 355 str | 375 str |
| 356 </dd> | 376 </dd> |
| 357 </dl> | 377 </dl> |
| 378 <a NAME="RP2040Device.activateBluetoothInterface" ID="RP2040Device.activateBluetoothInterface"></a> | |
| 379 <h4>RP2040Device.activateBluetoothInterface</h4> | |
| 380 <b>activateBluetoothInterface</b>(<i></i>) | |
| 381 | |
| 382 <p> | |
| 383 Public method to activate the Bluetooth interface. | |
| 384 </p> | |
| 385 <dl> | |
| 386 <dt>Return:</dt> | |
| 387 <dd> | |
| 388 flag indicating the new state of the Bluetooth interface | |
| 389 </dd> | |
| 390 </dl> | |
| 391 <dl> | |
| 392 <dt>Return Type:</dt> | |
| 393 <dd> | |
| 394 bool | |
| 395 </dd> | |
| 396 </dl> | |
| 397 <dl> | |
| 398 | |
| 399 <dt>Raises <b>OSError</b>:</dt> | |
| 400 <dd> | |
| 401 raised to indicate an issue with the device | |
| 402 </dd> | |
| 403 </dl> | |
| 358 <a NAME="RP2040Device.addDeviceMenuEntries" ID="RP2040Device.addDeviceMenuEntries"></a> | 404 <a NAME="RP2040Device.addDeviceMenuEntries" ID="RP2040Device.addDeviceMenuEntries"></a> |
| 359 <h4>RP2040Device.addDeviceMenuEntries</h4> | 405 <h4>RP2040Device.addDeviceMenuEntries</h4> |
| 360 <b>addDeviceMenuEntries</b>(<i>menu</i>) | 406 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
| 361 | 407 |
| 362 <p> | 408 <p> |
| 556 <dt>Return Type:</dt> | 602 <dt>Return Type:</dt> |
| 557 <dd> | 603 <dd> |
| 558 tuple of (bool, str) | 604 tuple of (bool, str) |
| 559 </dd> | 605 </dd> |
| 560 </dl> | 606 </dl> |
| 607 <a NAME="RP2040Device.deactivateBluetoothInterface" ID="RP2040Device.deactivateBluetoothInterface"></a> | |
| 608 <h4>RP2040Device.deactivateBluetoothInterface</h4> | |
| 609 <b>deactivateBluetoothInterface</b>(<i></i>) | |
| 610 | |
| 611 <p> | |
| 612 Public method to deactivate the Bluetooth interface. | |
| 613 </p> | |
| 614 <dl> | |
| 615 <dt>Return:</dt> | |
| 616 <dd> | |
| 617 flag indicating the new state of the Bluetooth interface | |
| 618 </dd> | |
| 619 </dl> | |
| 620 <dl> | |
| 621 <dt>Return Type:</dt> | |
| 622 <dd> | |
| 623 bool | |
| 624 </dd> | |
| 625 </dl> | |
| 626 <dl> | |
| 627 | |
| 628 <dt>Raises <b>OSError</b>:</dt> | |
| 629 <dd> | |
| 630 raised to indicate an issue with the device | |
| 631 </dd> | |
| 632 </dl> | |
| 561 <a NAME="RP2040Device.deactivateEthernet" ID="RP2040Device.deactivateEthernet"></a> | 633 <a NAME="RP2040Device.deactivateEthernet" ID="RP2040Device.deactivateEthernet"></a> |
| 562 <h4>RP2040Device.deactivateEthernet</h4> | 634 <h4>RP2040Device.deactivateEthernet</h4> |
| 563 <b>deactivateEthernet</b>(<i></i>) | 635 <b>deactivateEthernet</b>(<i></i>) |
| 564 | 636 |
| 565 <p> | 637 <p> |
| 733 <dt>Return Type:</dt> | 805 <dt>Return Type:</dt> |
| 734 <dd> | 806 <dd> |
| 735 bool | 807 bool |
| 736 </dd> | 808 </dd> |
| 737 </dl> | 809 </dl> |
| 810 <a NAME="RP2040Device.getBluetoothStatus" ID="RP2040Device.getBluetoothStatus"></a> | |
| 811 <h4>RP2040Device.getBluetoothStatus</h4> | |
| 812 <b>getBluetoothStatus</b>(<i></i>) | |
| 813 | |
| 814 <p> | |
| 815 Public method to get Bluetooth status data of the connected board. | |
| 816 </p> | |
| 817 <dl> | |
| 818 <dt>Return:</dt> | |
| 819 <dd> | |
| 820 list of tuples containing the translated status data label and | |
| 821 the associated value | |
| 822 </dd> | |
| 823 </dl> | |
| 824 <dl> | |
| 825 <dt>Return Type:</dt> | |
| 826 <dd> | |
| 827 list of tuples of (str, str) | |
| 828 </dd> | |
| 829 </dl> | |
| 830 <dl> | |
| 831 | |
| 832 <dt>Raises <b>OSError</b>:</dt> | |
| 833 <dd> | |
| 834 raised to indicate an issue with the device | |
| 835 </dd> | |
| 836 </dl> | |
| 738 <a NAME="RP2040Device.getConnectedClients" ID="RP2040Device.getConnectedClients"></a> | 837 <a NAME="RP2040Device.getConnectedClients" ID="RP2040Device.getConnectedClients"></a> |
| 739 <h4>RP2040Device.getConnectedClients</h4> | 838 <h4>RP2040Device.getConnectedClients</h4> |
| 740 <b>getConnectedClients</b>(<i></i>) | 839 <b>getConnectedClients</b>(<i></i>) |
| 741 | 840 |
| 742 <p> | 841 <p> |
| 753 <dt>Return Type:</dt> | 852 <dt>Return Type:</dt> |
| 754 <dd> | 853 <dd> |
| 755 tuple of ([(bytes, int)], str) | 854 tuple of ([(bytes, int)], str) |
| 756 </dd> | 855 </dd> |
| 757 </dl> | 856 </dl> |
| 857 <a NAME="RP2040Device.getDeviceScan" ID="RP2040Device.getDeviceScan"></a> | |
| 858 <h4>RP2040Device.getDeviceScan</h4> | |
| 859 <b>getDeviceScan</b>(<i>timeout=10</i>) | |
| 860 | |
| 861 <p> | |
| 862 Public method to perform a Bluetooth device scan. | |
| 863 </p> | |
| 864 <dl> | |
| 865 | |
| 866 <dt><i>timeout</i> (int (optional))</dt> | |
| 867 <dd> | |
| 868 duration of the device scan in seconds (defaults | |
| 869 to 10) | |
| 870 </dd> | |
| 871 </dl> | |
| 872 <dl> | |
| 873 <dt>Return:</dt> | |
| 874 <dd> | |
| 875 tuple containing a dictionary with the scan results and | |
| 876 an error string | |
| 877 </dd> | |
| 878 </dl> | |
| 879 <dl> | |
| 880 <dt>Return Type:</dt> | |
| 881 <dd> | |
| 882 tuple of (dict, str) | |
| 883 </dd> | |
| 884 </dl> | |
| 758 <a NAME="RP2040Device.getDocumentationUrl" ID="RP2040Device.getDocumentationUrl"></a> | 885 <a NAME="RP2040Device.getDocumentationUrl" ID="RP2040Device.getDocumentationUrl"></a> |
| 759 <h4>RP2040Device.getDocumentationUrl</h4> | 886 <h4>RP2040Device.getDocumentationUrl</h4> |
| 760 <b>getDocumentationUrl</b>(<i></i>) | 887 <b>getDocumentationUrl</b>(<i></i>) |
| 761 | 888 |
| 762 <p> | 889 <p> |
| 837 </dl> | 964 </dl> |
| 838 <dl> | 965 <dl> |
| 839 <dt>Return Type:</dt> | 966 <dt>Return Type:</dt> |
| 840 <dd> | 967 <dd> |
| 841 tuple of (dict, dict, dict) | 968 tuple of (dict, dict, dict) |
| 969 </dd> | |
| 970 </dl> | |
| 971 <dl> | |
| 972 | |
| 973 <dt>Raises <b>OSError</b>:</dt> | |
| 974 <dd> | |
| 975 raised to indicate an issue with the device | |
| 976 </dd> | |
| 977 </dl> | |
| 978 <a NAME="RP2040Device.hasBluetooth" ID="RP2040Device.hasBluetooth"></a> | |
| 979 <h4>RP2040Device.hasBluetooth</h4> | |
| 980 <b>hasBluetooth</b>(<i></i>) | |
| 981 | |
| 982 <p> | |
| 983 Public method to check the availability of Bluetooth. | |
| 984 </p> | |
| 985 <dl> | |
| 986 <dt>Return:</dt> | |
| 987 <dd> | |
| 988 flag indicating the availability of Bluetooth | |
| 989 </dd> | |
| 990 </dl> | |
| 991 <dl> | |
| 992 <dt>Return Type:</dt> | |
| 993 <dd> | |
| 994 bool | |
| 842 </dd> | 995 </dd> |
| 843 </dl> | 996 </dl> |
| 844 <dl> | 997 <dl> |
| 845 | 998 |
| 846 <dt>Raises <b>OSError</b>:</dt> | 999 <dt>Raises <b>OSError</b>:</dt> |
