Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html
- branch
- mpy_network
- changeset 9878
- a82014a9e57b
- parent 9871
- 4a302b8c4d28
- child 9880
- f425c58cf8e9
equal
deleted
inserted
replaced
| 9877:dad1f6d37366 | 9878:a82014a9e57b |
|---|---|
| 140 <tr> | 140 <tr> |
| 141 <td><a href="#BaseDevice.addDeviceBluetoothEntries">addDeviceBluetoothEntries</a></td> | 141 <td><a href="#BaseDevice.addDeviceBluetoothEntries">addDeviceBluetoothEntries</a></td> |
| 142 <td>Public method to add device specific entries to the given menu.</td> | 142 <td>Public method to add device specific entries to the given menu.</td> |
| 143 </tr> | 143 </tr> |
| 144 <tr> | 144 <tr> |
| 145 <td><a href="#BaseDevice.addDeviceEthernetEntries">addDeviceEthernetEntries</a></td> | |
| 146 <td>Public method to add device specific entries to the given menu.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 145 <td><a href="#BaseDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> | 149 <td><a href="#BaseDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
| 146 <td>Public method to add device specific entries to the given menu.</td> | 150 <td>Public method to add device specific entries to the given menu.</td> |
| 147 </tr> | 151 </tr> |
| 148 <tr> | 152 <tr> |
| 149 <td><a href="#BaseDevice.addDeviceWifiEntries">addDeviceWifiEntries</a></td> | 153 <td><a href="#BaseDevice.addDeviceWifiEntries">addDeviceWifiEntries</a></td> |
| 180 <tr> | 184 <tr> |
| 181 <td><a href="#BaseDevice.checkInternet">checkInternet</a></td> | 185 <td><a href="#BaseDevice.checkInternet">checkInternet</a></td> |
| 182 <td>Public method to check, if the internet can be reached.</td> | 186 <td>Public method to check, if the internet can be reached.</td> |
| 183 </tr> | 187 </tr> |
| 184 <tr> | 188 <tr> |
| 189 <td><a href="#BaseDevice.checkInternetViaLan">checkInternetViaLan</a></td> | |
| 190 <td>Public method to check, if the internet can be reached (LAN variant).</td> | |
| 191 </tr> | |
| 192 <tr> | |
| 193 <td><a href="#BaseDevice.connectToLan">connectToLan</a></td> | |
| 194 <td>Public method to connect the connected device to the LAN.</td> | |
| 195 </tr> | |
| 196 <tr> | |
| 185 <td><a href="#BaseDevice.connectWifi">connectWifi</a></td> | 197 <td><a href="#BaseDevice.connectWifi">connectWifi</a></td> |
| 186 <td>Public method to connect a device to a WiFi network.</td> | 198 <td>Public method to connect a device to a WiFi network.</td> |
| 187 </tr> | 199 </tr> |
| 188 <tr> | 200 <tr> |
| 189 <td><a href="#BaseDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> | 201 <td><a href="#BaseDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> |
| 190 <td>Public method to deactivate the Bluetooth interface.</td> | 202 <td>Public method to deactivate the Bluetooth interface.</td> |
| 191 </tr> | 203 </tr> |
| 192 <tr> | 204 <tr> |
| 205 <td><a href="#BaseDevice.deactivateEthernet">deactivateEthernet</a></td> | |
| 206 <td>Public method to deactivate the Ethernet interface of the connected device.</td> | |
| 207 </tr> | |
| 208 <tr> | |
| 193 <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td> | 209 <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td> |
| 194 <td>Public method to deactivate a given WiFi interface of the connected device.</td> | 210 <td>Public method to deactivate a given WiFi interface of the connected device.</td> |
| 195 </tr> | 211 </tr> |
| 196 <tr> | 212 <tr> |
| 197 <td><a href="#BaseDevice.deviceName">deviceName</a></td> | 213 <td><a href="#BaseDevice.deviceName">deviceName</a></td> |
| 198 <td>Public method to get the name of the device.</td> | 214 <td>Public method to get the name of the device.</td> |
| 199 </tr> | 215 </tr> |
| 200 <tr> | 216 <tr> |
| 217 <td><a href="#BaseDevice.disconnectFromLan">disconnectFromLan</a></td> | |
| 218 <td>Public method to disconnect from the LAN.</td> | |
| 219 </tr> | |
| 220 <tr> | |
| 201 <td><a href="#BaseDevice.disconnectWifi">disconnectWifi</a></td> | 221 <td><a href="#BaseDevice.disconnectWifi">disconnectWifi</a></td> |
| 202 <td>Public method to disconnect a device from the WiFi network.</td> | 222 <td>Public method to disconnect a device from the WiFi network.</td> |
| 203 </tr> | 223 </tr> |
| 204 <tr> | 224 <tr> |
| 205 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td> | 225 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td> |
| 256 <tr> | 276 <tr> |
| 257 <td><a href="#BaseDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> | 277 <td><a href="#BaseDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> |
| 258 <td>Public method to retrieve the entries for the downloads menu.</td> | 278 <td>Public method to retrieve the entries for the downloads menu.</td> |
| 259 </tr> | 279 </tr> |
| 260 <tr> | 280 <tr> |
| 281 <td><a href="#BaseDevice.getEthernetStatus">getEthernetStatus</a></td> | |
| 282 <td>Public method to get Ethernet status data of the connected board.</td> | |
| 283 </tr> | |
| 284 <tr> | |
| 261 <td><a href="#BaseDevice.getFirmwareUrl">getFirmwareUrl</a></td> | 285 <td><a href="#BaseDevice.getFirmwareUrl">getFirmwareUrl</a></td> |
| 262 <td>Public method to get the device firmware download URL.</td> | 286 <td>Public method to get the device firmware download URL.</td> |
| 263 </tr> | 287 </tr> |
| 264 <tr> | 288 <tr> |
| 265 <td><a href="#BaseDevice.getModules">getModules</a></td> | 289 <td><a href="#BaseDevice.getModules">getModules</a></td> |
| 348 <tr> | 372 <tr> |
| 349 <td><a href="#BaseDevice.removeCredentials">removeCredentials</a></td> | 373 <td><a href="#BaseDevice.removeCredentials">removeCredentials</a></td> |
| 350 <td>Public method to remove the saved credentials from the connected device.</td> | 374 <td>Public method to remove the saved credentials from the connected device.</td> |
| 351 </tr> | 375 </tr> |
| 352 <tr> | 376 <tr> |
| 377 <td><a href="#BaseDevice.removeLanAutoConnect">removeLanAutoConnect</a></td> | |
| 378 <td>Public method to remove the saved IPv4 parameters from the connected device.</td> | |
| 379 </tr> | |
| 380 <tr> | |
| 353 <td><a href="#BaseDevice.rm">rm</a></td> | 381 <td><a href="#BaseDevice.rm">rm</a></td> |
| 354 <td>Public method to remove a file from the connected device.</td> | 382 <td>Public method to remove a file from the connected device.</td> |
| 355 </tr> | 383 </tr> |
| 356 <tr> | 384 <tr> |
| 357 <td><a href="#BaseDevice.rmdir">rmdir</a></td> | 385 <td><a href="#BaseDevice.rmdir">rmdir</a></td> |
| 426 <td>Public method to install packages using 'upip'.</td> | 454 <td>Public method to install packages using 'upip'.</td> |
| 427 </tr> | 455 </tr> |
| 428 <tr> | 456 <tr> |
| 429 <td><a href="#BaseDevice.writeCredentials">writeCredentials</a></td> | 457 <td><a href="#BaseDevice.writeCredentials">writeCredentials</a></td> |
| 430 <td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td> | 458 <td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td> |
| 459 </tr> | |
| 460 <tr> | |
| 461 <td><a href="#BaseDevice.writeLanAutoConnect">writeLanAutoConnect</a></td> | |
| 462 <td>Public method to generate a script and associated configuration to connect the device to the LAN during boot time.</td> | |
| 431 </tr> | 463 </tr> |
| 432 </table> | 464 </table> |
| 433 <h3>Static Methods</h3> | 465 <h3>Static Methods</h3> |
| 434 | 466 |
| 435 <table> | 467 <table> |
| 564 <dt><i>menu</i> (QMenu)</dt> | 596 <dt><i>menu</i> (QMenu)</dt> |
| 565 <dd> | 597 <dd> |
| 566 reference to the context menu | 598 reference to the context menu |
| 567 </dd> | 599 </dd> |
| 568 </dl> | 600 </dl> |
| 601 <a NAME="BaseDevice.addDeviceEthernetEntries" ID="BaseDevice.addDeviceEthernetEntries"></a> | |
| 602 <h4>BaseDevice.addDeviceEthernetEntries</h4> | |
| 603 <b>addDeviceEthernetEntries</b>(<i>menu</i>) | |
| 604 | |
| 605 <p> | |
| 606 Public method to add device specific entries to the given menu. | |
| 607 </p> | |
| 608 <dl> | |
| 609 | |
| 610 <dt><i>menu</i> (QMenu)</dt> | |
| 611 <dd> | |
| 612 reference to the context menu | |
| 613 </dd> | |
| 614 </dl> | |
| 569 <a NAME="BaseDevice.addDeviceMenuEntries" ID="BaseDevice.addDeviceMenuEntries"></a> | 615 <a NAME="BaseDevice.addDeviceMenuEntries" ID="BaseDevice.addDeviceMenuEntries"></a> |
| 570 <h4>BaseDevice.addDeviceMenuEntries</h4> | 616 <h4>BaseDevice.addDeviceMenuEntries</h4> |
| 571 <b>addDeviceMenuEntries</b>(<i>menu</i>) | 617 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
| 572 | 618 |
| 573 <p> | 619 <p> |
| 770 <dt>Return Type:</dt> | 816 <dt>Return Type:</dt> |
| 771 <dd> | 817 <dd> |
| 772 tuple of (bool, str) | 818 tuple of (bool, str) |
| 773 </dd> | 819 </dd> |
| 774 </dl> | 820 </dl> |
| 821 <a NAME="BaseDevice.checkInternetViaLan" ID="BaseDevice.checkInternetViaLan"></a> | |
| 822 <h4>BaseDevice.checkInternetViaLan</h4> | |
| 823 <b>checkInternetViaLan</b>(<i></i>) | |
| 824 | |
| 825 <p> | |
| 826 Public method to check, if the internet can be reached (LAN variant). | |
| 827 </p> | |
| 828 <dl> | |
| 829 <dt>Return:</dt> | |
| 830 <dd> | |
| 831 tuple containing a flag indicating reachability and an error string | |
| 832 </dd> | |
| 833 </dl> | |
| 834 <dl> | |
| 835 <dt>Return Type:</dt> | |
| 836 <dd> | |
| 837 tuple of (bool, str) | |
| 838 </dd> | |
| 839 </dl> | |
| 840 <a NAME="BaseDevice.connectToLan" ID="BaseDevice.connectToLan"></a> | |
| 841 <h4>BaseDevice.connectToLan</h4> | |
| 842 <b>connectToLan</b>(<i>config</i>) | |
| 843 | |
| 844 <p> | |
| 845 Public method to connect the connected device to the LAN. | |
| 846 </p> | |
| 847 <dl> | |
| 848 | |
| 849 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> | |
| 850 <dd> | |
| 851 configuration for the connection (either the string 'dhcp' | |
| 852 for a dynamic address or a tuple of four strings with the IPv4 parameters. | |
| 853 </dd> | |
| 854 </dl> | |
| 855 <dl> | |
| 856 <dt>Return:</dt> | |
| 857 <dd> | |
| 858 tuple containing a flag indicating success and an error message | |
| 859 </dd> | |
| 860 </dl> | |
| 861 <dl> | |
| 862 <dt>Return Type:</dt> | |
| 863 <dd> | |
| 864 tuple of (bool, str) | |
| 865 </dd> | |
| 866 </dl> | |
| 775 <a NAME="BaseDevice.connectWifi" ID="BaseDevice.connectWifi"></a> | 867 <a NAME="BaseDevice.connectWifi" ID="BaseDevice.connectWifi"></a> |
| 776 <h4>BaseDevice.connectWifi</h4> | 868 <h4>BaseDevice.connectWifi</h4> |
| 777 <b>connectWifi</b>(<i>ssid, password</i>) | 869 <b>connectWifi</b>(<i>ssid, password</i>) |
| 778 | 870 |
| 779 <p> | 871 <p> |
| 819 <dt>Return Type:</dt> | 911 <dt>Return Type:</dt> |
| 820 <dd> | 912 <dd> |
| 821 bool | 913 bool |
| 822 </dd> | 914 </dd> |
| 823 </dl> | 915 </dl> |
| 916 <a NAME="BaseDevice.deactivateEthernet" ID="BaseDevice.deactivateEthernet"></a> | |
| 917 <h4>BaseDevice.deactivateEthernet</h4> | |
| 918 <b>deactivateEthernet</b>(<i></i>) | |
| 919 | |
| 920 <p> | |
| 921 Public method to deactivate the Ethernet interface of the connected device. | |
| 922 </p> | |
| 923 <dl> | |
| 924 <dt>Return:</dt> | |
| 925 <dd> | |
| 926 tuple containg a flag indicating success and an error message | |
| 927 </dd> | |
| 928 </dl> | |
| 929 <dl> | |
| 930 <dt>Return Type:</dt> | |
| 931 <dd> | |
| 932 tuple of (bool, str) | |
| 933 </dd> | |
| 934 </dl> | |
| 824 <a NAME="BaseDevice.deactivateInterface" ID="BaseDevice.deactivateInterface"></a> | 935 <a NAME="BaseDevice.deactivateInterface" ID="BaseDevice.deactivateInterface"></a> |
| 825 <h4>BaseDevice.deactivateInterface</h4> | 936 <h4>BaseDevice.deactivateInterface</h4> |
| 826 <b>deactivateInterface</b>(<i>interface</i>) | 937 <b>deactivateInterface</b>(<i>interface</i>) |
| 827 | 938 |
| 828 <p> | 939 <p> |
| 865 <dt>Return Type:</dt> | 976 <dt>Return Type:</dt> |
| 866 <dd> | 977 <dd> |
| 867 str | 978 str |
| 868 </dd> | 979 </dd> |
| 869 </dl> | 980 </dl> |
| 981 <a NAME="BaseDevice.disconnectFromLan" ID="BaseDevice.disconnectFromLan"></a> | |
| 982 <h4>BaseDevice.disconnectFromLan</h4> | |
| 983 <b>disconnectFromLan</b>(<i></i>) | |
| 984 | |
| 985 <p> | |
| 986 Public method to disconnect from the LAN. | |
| 987 </p> | |
| 988 <dl> | |
| 989 <dt>Return:</dt> | |
| 990 <dd> | |
| 991 tuple containing a flag indicating success and an error message | |
| 992 </dd> | |
| 993 </dl> | |
| 994 <dl> | |
| 995 <dt>Return Type:</dt> | |
| 996 <dd> | |
| 997 tuple of (bool, str) | |
| 998 </dd> | |
| 999 </dl> | |
| 870 <a NAME="BaseDevice.disconnectWifi" ID="BaseDevice.disconnectWifi"></a> | 1000 <a NAME="BaseDevice.disconnectWifi" ID="BaseDevice.disconnectWifi"></a> |
| 871 <h4>BaseDevice.disconnectWifi</h4> | 1001 <h4>BaseDevice.disconnectWifi</h4> |
| 872 <b>disconnectWifi</b>(<i></i>) | 1002 <b>disconnectWifi</b>(<i></i>) |
| 873 | 1003 |
| 874 <p> | 1004 <p> |
| 1218 </dl> | 1348 </dl> |
| 1219 <dl> | 1349 <dl> |
| 1220 <dt>Return Type:</dt> | 1350 <dt>Return Type:</dt> |
| 1221 <dd> | 1351 <dd> |
| 1222 list of tuple of (str, str) | 1352 list of tuple of (str, str) |
| 1353 </dd> | |
| 1354 </dl> | |
| 1355 <a NAME="BaseDevice.getEthernetStatus" ID="BaseDevice.getEthernetStatus"></a> | |
| 1356 <h4>BaseDevice.getEthernetStatus</h4> | |
| 1357 <b>getEthernetStatus</b>(<i></i>) | |
| 1358 | |
| 1359 <p> | |
| 1360 Public method to get Ethernet status data of the connected board. | |
| 1361 </p> | |
| 1362 <dl> | |
| 1363 <dt>Return:</dt> | |
| 1364 <dd> | |
| 1365 list of tuples containing the translated status data label and | |
| 1366 the associated value | |
| 1367 </dd> | |
| 1368 </dl> | |
| 1369 <dl> | |
| 1370 <dt>Return Type:</dt> | |
| 1371 <dd> | |
| 1372 list of tuples of (str, str) | |
| 1223 </dd> | 1373 </dd> |
| 1224 </dl> | 1374 </dl> |
| 1225 <a NAME="BaseDevice.getFirmwareUrl" ID="BaseDevice.getFirmwareUrl"></a> | 1375 <a NAME="BaseDevice.getFirmwareUrl" ID="BaseDevice.getFirmwareUrl"></a> |
| 1226 <h4>BaseDevice.getFirmwareUrl</h4> | 1376 <h4>BaseDevice.getFirmwareUrl</h4> |
| 1227 <b>getFirmwareUrl</b>(<i></i>) | 1377 <b>getFirmwareUrl</b>(<i></i>) |
| 1760 <dt>Return Type:</dt> | 1910 <dt>Return Type:</dt> |
| 1761 <dd> | 1911 <dd> |
| 1762 tuple of (bool, str) | 1912 tuple of (bool, str) |
| 1763 </dd> | 1913 </dd> |
| 1764 </dl> | 1914 </dl> |
| 1915 <a NAME="BaseDevice.removeLanAutoConnect" ID="BaseDevice.removeLanAutoConnect"></a> | |
| 1916 <h4>BaseDevice.removeLanAutoConnect</h4> | |
| 1917 <b>removeLanAutoConnect</b>(<i></i>) | |
| 1918 | |
| 1919 <p> | |
| 1920 Public method to remove the saved IPv4 parameters from the connected device. | |
| 1921 </p> | |
| 1922 <p> | |
| 1923 Note: This disables the LAN auto-connect feature. | |
| 1924 </p> | |
| 1925 <dl> | |
| 1926 <dt>Return:</dt> | |
| 1927 <dd> | |
| 1928 tuple containing a flag indicating success and an error message | |
| 1929 </dd> | |
| 1930 </dl> | |
| 1931 <dl> | |
| 1932 <dt>Return Type:</dt> | |
| 1933 <dd> | |
| 1934 tuple of (bool, str) | |
| 1935 </dd> | |
| 1936 </dl> | |
| 1765 <a NAME="BaseDevice.rm" ID="BaseDevice.rm"></a> | 1937 <a NAME="BaseDevice.rm" ID="BaseDevice.rm"></a> |
| 1766 <h4>BaseDevice.rm</h4> | 1938 <h4>BaseDevice.rm</h4> |
| 1767 <b>rm</b>(<i>filename</i>) | 1939 <b>rm</b>(<i>filename</i>) |
| 1768 | 1940 |
| 1769 <p> | 1941 <p> |
| 2196 <dt>Return Type:</dt> | 2368 <dt>Return Type:</dt> |
| 2197 <dd> | 2369 <dd> |
| 2198 tuple of (bool, str) | 2370 tuple of (bool, str) |
| 2199 </dd> | 2371 </dd> |
| 2200 </dl> | 2372 </dl> |
| 2373 <a NAME="BaseDevice.writeLanAutoConnect" ID="BaseDevice.writeLanAutoConnect"></a> | |
| 2374 <h4>BaseDevice.writeLanAutoConnect</h4> | |
| 2375 <b>writeLanAutoConnect</b>(<i>config</i>) | |
| 2376 | |
| 2377 <p> | |
| 2378 Public method to generate a script and associated configuration to connect the | |
| 2379 device to the LAN during boot time. | |
| 2380 </p> | |
| 2381 <dl> | |
| 2382 | |
| 2383 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> | |
| 2384 <dd> | |
| 2385 configuration for the connection (either the string 'dhcp' | |
| 2386 for a dynamic address or a tuple of four strings with the IPv4 parameters. | |
| 2387 </dd> | |
| 2388 </dl> | |
| 2389 <dl> | |
| 2390 <dt>Return:</dt> | |
| 2391 <dd> | |
| 2392 tuple containing a flag indicating success and an error message | |
| 2393 </dd> | |
| 2394 </dl> | |
| 2395 <dl> | |
| 2396 <dt>Return Type:</dt> | |
| 2397 <dd> | |
| 2398 tuple of (bool, str) | |
| 2399 </dd> | |
| 2400 </dl> | |
| 2201 <div align="right"><a href="#top">Up</a></div> | 2401 <div align="right"><a href="#top">Up</a></div> |
| 2202 <hr /> | 2402 <hr /> |
| 2203 </body></html> | 2403 </body></html> |
