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
eric7
changeset 10070
9f5758c0fec1
parent 10035
3a423b723a99
child 10138
56614cf9d03c
equal deleted inserted replaced
10069:435cc5875135 10070:9f5758c0fec1
210 <td><a href="#BaseDevice.checkInternetViaLan">checkInternetViaLan</a></td> 210 <td><a href="#BaseDevice.checkInternetViaLan">checkInternetViaLan</a></td>
211 <td>Public method to check, if the internet can be reached (LAN variant).</td> 211 <td>Public method to check, if the internet can be reached (LAN variant).</td>
212 </tr> 212 </tr>
213 <tr> 213 <tr>
214 <td><a href="#BaseDevice.connectToLan">connectToLan</a></td> 214 <td><a href="#BaseDevice.connectToLan">connectToLan</a></td>
215 <td>Public method to connect the connected device to the LAN.</td> 215 <td></td>
216 </tr> 216 </tr>
217 <tr> 217 <tr>
218 <td><a href="#BaseDevice.connectWifi">connectWifi</a></td> 218 <td><a href="#BaseDevice.connectWifi">connectWifi</a></td>
219 <td>Public method to connect a device to a WiFi network.</td> 219 <td></td>
220 </tr> 220 </tr>
221 <tr> 221 <tr>
222 <td><a href="#BaseDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td> 222 <td><a href="#BaseDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td>
223 <td>Public method to deactivate the Bluetooth interface.</td> 223 <td>Public method to deactivate the Bluetooth interface.</td>
224 </tr> 224 </tr>
226 <td><a href="#BaseDevice.deactivateEthernet">deactivateEthernet</a></td> 226 <td><a href="#BaseDevice.deactivateEthernet">deactivateEthernet</a></td>
227 <td>Public method to deactivate the Ethernet interface of the connected device.</td> 227 <td>Public method to deactivate the Ethernet interface of the connected device.</td>
228 </tr> 228 </tr>
229 <tr> 229 <tr>
230 <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td> 230 <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td>
231 <td>Public method to deactivate a given WiFi interface of the connected device.</td> 231 <td></td>
232 </tr> 232 </tr>
233 <tr> 233 <tr>
234 <td><a href="#BaseDevice.deviceName">deviceName</a></td> 234 <td><a href="#BaseDevice.deviceName">deviceName</a></td>
235 <td>Public method to get the name of the device.</td> 235 <td>Public method to get the name of the device.</td>
236 </tr> 236 </tr>
250 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td> 250 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td>
251 <td>Public method to download the device firmware.</td> 251 <td>Public method to download the device firmware.</td>
252 </tr> 252 </tr>
253 <tr> 253 <tr>
254 <td><a href="#BaseDevice.enableWebrepl">enableWebrepl</a></td> 254 <td><a href="#BaseDevice.enableWebrepl">enableWebrepl</a></td>
255 <td>Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server.</td> 255 <td></td>
256 </tr> 256 </tr>
257 <tr> 257 <tr>
258 <td><a href="#BaseDevice.ensurePath">ensurePath</a></td> 258 <td><a href="#BaseDevice.ensurePath">ensurePath</a></td>
259 <td>Public method to ensure, that the given target path exists.</td> 259 <td>Public method to ensure, that the given target path exists.</td>
260 </tr> 260 </tr>
298 <td><a href="#BaseDevice.getDeviceData">getDeviceData</a></td> 298 <td><a href="#BaseDevice.getDeviceData">getDeviceData</a></td>
299 <td>Public method to get a copy of the determined device data or part of them.</td> 299 <td>Public method to get a copy of the determined device data or part of them.</td>
300 </tr> 300 </tr>
301 <tr> 301 <tr>
302 <td><a href="#BaseDevice.getDeviceScan">getDeviceScan</a></td> 302 <td><a href="#BaseDevice.getDeviceScan">getDeviceScan</a></td>
303 <td>Public method to perform a Bluetooth device scan.</td> 303 <td></td>
304 </tr> 304 </tr>
305 <tr> 305 <tr>
306 <td><a href="#BaseDevice.getDeviceType">getDeviceType</a></td> 306 <td><a href="#BaseDevice.getDeviceType">getDeviceType</a></td>
307 <td>Public method to get the device type.</td> 307 <td>Public method to get the device type.</td>
308 </tr> 308 </tr>
490 <td><a href="#BaseDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> 490 <td><a href="#BaseDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td>
491 <td>Public method to indicate file access via a local directory.</td> 491 <td>Public method to indicate file access via a local directory.</td>
492 </tr> 492 </tr>
493 <tr> 493 <tr>
494 <td><a href="#BaseDevice.syncTime">syncTime</a></td> 494 <td><a href="#BaseDevice.syncTime">syncTime</a></td>
495 <td>Public method to set the time of the connected device to the local computer's time.</td> 495 <td></td>
496 </tr> 496 </tr>
497 <tr> 497 <tr>
498 <td><a href="#BaseDevice.upipInstall">upipInstall</a></td> 498 <td><a href="#BaseDevice.upipInstall">upipInstall</a></td>
499 <td>Public method to install packages using 'upip'.</td> 499 <td>Public method to install packages using 'upip'.</td>
500 </tr> 500 </tr>
501 <tr> 501 <tr>
502 <td><a href="#BaseDevice.writeCredentials">writeCredentials</a></td> 502 <td><a href="#BaseDevice.writeCredentials">writeCredentials</a></td>
503 <td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td> 503 <td></td>
504 </tr> 504 </tr>
505 <tr> 505 <tr>
506 <td><a href="#BaseDevice.writeLanAutoConnect">writeLanAutoConnect</a></td> 506 <td><a href="#BaseDevice.writeLanAutoConnect">writeLanAutoConnect</a></td>
507 <td>Public method to generate a script and associated configuration to connect the device to the LAN during boot time.</td> 507 <td></td>
508 </tr> 508 </tr>
509 </table> 509 </table>
510 <h3>Static Methods</h3> 510 <h3>Static Methods</h3>
511 511
512 <table> 512 <table>
884 </dl> 884 </dl>
885 <a NAME="BaseDevice.connectToLan" ID="BaseDevice.connectToLan"></a> 885 <a NAME="BaseDevice.connectToLan" ID="BaseDevice.connectToLan"></a>
886 <h4>BaseDevice.connectToLan</h4> 886 <h4>BaseDevice.connectToLan</h4>
887 <b>connectToLan</b>(<i>config</i>) 887 <b>connectToLan</b>(<i>config</i>)
888 888
889 <p>
890 Public method to connect the connected device to the LAN.
891 </p>
892 <dl>
893
894 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt>
895 <dd>
896 configuration for the connection (either the string 'dhcp'
897 for a dynamic address or a tuple of four strings with the IPv4 parameters.
898 </dd>
899 </dl>
900 <dl>
901 <dt>Return:</dt>
902 <dd>
903 tuple containing a flag indicating success and an error message
904 </dd>
905 </dl>
906 <dl>
907 <dt>Return Type:</dt>
908 <dd>
909 tuple of (bool, str)
910 </dd>
911 </dl>
912 <a NAME="BaseDevice.connectWifi" ID="BaseDevice.connectWifi"></a> 889 <a NAME="BaseDevice.connectWifi" ID="BaseDevice.connectWifi"></a>
913 <h4>BaseDevice.connectWifi</h4> 890 <h4>BaseDevice.connectWifi</h4>
914 <b>connectWifi</b>(<i>ssid, password</i>) 891 <b>connectWifi</b>(<i>ssid, password</i>)
915 892
916 <p>
917 Public method to connect a device to a WiFi network.
918 </p>
919 <dl>
920
921 <dt><i>ssid</i> (str)</dt>
922 <dd>
923 name (SSID) of the WiFi network
924 </dd>
925 <dt><i>password</i> (str)</dt>
926 <dd>
927 password needed to connect
928 </dd>
929 </dl>
930 <dl>
931 <dt>Return:</dt>
932 <dd>
933 tuple containing the connection status and an error string
934 </dd>
935 </dl>
936 <dl>
937 <dt>Return Type:</dt>
938 <dd>
939 tuple of (bool, str)
940 </dd>
941 </dl>
942 <a NAME="BaseDevice.deactivateBluetoothInterface" ID="BaseDevice.deactivateBluetoothInterface"></a> 893 <a NAME="BaseDevice.deactivateBluetoothInterface" ID="BaseDevice.deactivateBluetoothInterface"></a>
943 <h4>BaseDevice.deactivateBluetoothInterface</h4> 894 <h4>BaseDevice.deactivateBluetoothInterface</h4>
944 <b>deactivateBluetoothInterface</b>(<i></i>) 895 <b>deactivateBluetoothInterface</b>(<i></i>)
945 896
946 <p> 897 <p>
979 </dl> 930 </dl>
980 <a NAME="BaseDevice.deactivateInterface" ID="BaseDevice.deactivateInterface"></a> 931 <a NAME="BaseDevice.deactivateInterface" ID="BaseDevice.deactivateInterface"></a>
981 <h4>BaseDevice.deactivateInterface</h4> 932 <h4>BaseDevice.deactivateInterface</h4>
982 <b>deactivateInterface</b>(<i>interface</i>) 933 <b>deactivateInterface</b>(<i>interface</i>)
983 934
984 <p>
985 Public method to deactivate a given WiFi interface of the connected device.
986 </p>
987 <dl>
988
989 <dt><i>interface</i> (str)</dt>
990 <dd>
991 designation of the interface to be deactivated (one of 'AP'
992 or 'STA')
993 </dd>
994 </dl>
995 <dl>
996 <dt>Return:</dt>
997 <dd>
998 tuple containg a flag indicating success and an error message
999 </dd>
1000 </dl>
1001 <dl>
1002 <dt>Return Type:</dt>
1003 <dd>
1004 tuple of (bool, str)
1005 </dd>
1006 </dl>
1007 <a NAME="BaseDevice.deviceName" ID="BaseDevice.deviceName"></a> 935 <a NAME="BaseDevice.deviceName" ID="BaseDevice.deviceName"></a>
1008 <h4>BaseDevice.deviceName</h4> 936 <h4>BaseDevice.deviceName</h4>
1009 <b>deviceName</b>(<i></i>) 937 <b>deviceName</b>(<i></i>)
1010 938
1011 <p> 939 <p>
1090 </p> 1018 </p>
1091 <a NAME="BaseDevice.enableWebrepl" ID="BaseDevice.enableWebrepl"></a> 1019 <a NAME="BaseDevice.enableWebrepl" ID="BaseDevice.enableWebrepl"></a>
1092 <h4>BaseDevice.enableWebrepl</h4> 1020 <h4>BaseDevice.enableWebrepl</h4>
1093 <b>enableWebrepl</b>(<i>password</i>) 1021 <b>enableWebrepl</b>(<i>password</i>)
1094 1022
1095 <p>
1096 Public method to write the given WebREPL password to the connected device and
1097 modify the start script to start the WebREPL server.
1098 </p>
1099 <dl>
1100
1101 <dt><i>password</i> (str)</dt>
1102 <dd>
1103 password needed to authenticate
1104 </dd>
1105 </dl>
1106 <dl>
1107 <dt>Return:</dt>
1108 <dd>
1109 tuple containing a flag indicating success and an error message
1110 </dd>
1111 </dl>
1112 <dl>
1113 <dt>Return Type:</dt>
1114 <dd>
1115 tuple of (bool, str)
1116 </dd>
1117 </dl>
1118 <a NAME="BaseDevice.ensurePath" ID="BaseDevice.ensurePath"></a> 1023 <a NAME="BaseDevice.ensurePath" ID="BaseDevice.ensurePath"></a>
1119 <h4>BaseDevice.ensurePath</h4> 1024 <h4>BaseDevice.ensurePath</h4>
1120 <b>ensurePath</b>(<i>target</i>) 1025 <b>ensurePath</b>(<i>target</i>)
1121 1026
1122 <p> 1027 <p>
1415 </dl> 1320 </dl>
1416 <a NAME="BaseDevice.getDeviceScan" ID="BaseDevice.getDeviceScan"></a> 1321 <a NAME="BaseDevice.getDeviceScan" ID="BaseDevice.getDeviceScan"></a>
1417 <h4>BaseDevice.getDeviceScan</h4> 1322 <h4>BaseDevice.getDeviceScan</h4>
1418 <b>getDeviceScan</b>(<i>timeout=10</i>) 1323 <b>getDeviceScan</b>(<i>timeout=10</i>)
1419 1324
1420 <p>
1421 Public method to perform a Bluetooth device scan.
1422 </p>
1423 <dl>
1424
1425 <dt><i>timeout</i> (int (optional))</dt>
1426 <dd>
1427 duration of the device scan in seconds (defaults
1428 to 10)
1429 </dd>
1430 </dl>
1431 <dl>
1432 <dt>Return:</dt>
1433 <dd>
1434 tuple containing a dictionary with the scan results and
1435 an error string
1436 </dd>
1437 </dl>
1438 <dl>
1439 <dt>Return Type:</dt>
1440 <dd>
1441 tuple of (dict, str)
1442 </dd>
1443 </dl>
1444 <a NAME="BaseDevice.getDeviceType" ID="BaseDevice.getDeviceType"></a> 1325 <a NAME="BaseDevice.getDeviceType" ID="BaseDevice.getDeviceType"></a>
1445 <h4>BaseDevice.getDeviceType</h4> 1326 <h4>BaseDevice.getDeviceType</h4>
1446 <b>getDeviceType</b>(<i></i>) 1327 <b>getDeviceType</b>(<i></i>)
1447 1328
1448 <p> 1329 <p>
2490 </dl> 2371 </dl>
2491 <a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a> 2372 <a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a>
2492 <h4>BaseDevice.syncTime</h4> 2373 <h4>BaseDevice.syncTime</h4>
2493 <b>syncTime</b>(<i>deviceType, hasCPy=False</i>) 2374 <b>syncTime</b>(<i>deviceType, hasCPy=False</i>)
2494 2375
2495 <p>
2496 Public method to set the time of the connected device to the local
2497 computer's time.
2498 </p>
2499 <dl>
2500
2501 <dt><i>deviceType</i> (str)</dt>
2502 <dd>
2503 type of board to sync time to
2504 </dd>
2505 <dt><i>hasCPy</i> (bool)</dt>
2506 <dd>
2507 flag indicating that the device has CircuitPython loadede
2508 (defaults to False)
2509 </dd>
2510 </dl>
2511 <dl>
2512
2513 <dt>Raises <b>OSError</b>:</dt>
2514 <dd>
2515 raised to indicate an issue with the device
2516 </dd>
2517 </dl>
2518 <a NAME="BaseDevice.upipInstall" ID="BaseDevice.upipInstall"></a> 2376 <a NAME="BaseDevice.upipInstall" ID="BaseDevice.upipInstall"></a>
2519 <h4>BaseDevice.upipInstall</h4> 2377 <h4>BaseDevice.upipInstall</h4>
2520 <b>upipInstall</b>(<i>packages</i>) 2378 <b>upipInstall</b>(<i>packages</i>)
2521 2379
2522 <p> 2380 <p>
2537 </dl> 2395 </dl>
2538 <a NAME="BaseDevice.writeCredentials" ID="BaseDevice.writeCredentials"></a> 2396 <a NAME="BaseDevice.writeCredentials" ID="BaseDevice.writeCredentials"></a>
2539 <h4>BaseDevice.writeCredentials</h4> 2397 <h4>BaseDevice.writeCredentials</h4>
2540 <b>writeCredentials</b>(<i>ssid, password</i>) 2398 <b>writeCredentials</b>(<i>ssid, password</i>)
2541 2399
2542 <p>
2543 Public method to write the given credentials to the connected device and modify
2544 the start script to connect automatically.
2545 </p>
2546 <dl>
2547
2548 <dt><i>ssid</i> (str)</dt>
2549 <dd>
2550 SSID of the network to connect to
2551 </dd>
2552 <dt><i>password</i> (str)</dt>
2553 <dd>
2554 password needed to authenticate
2555 </dd>
2556 </dl>
2557 <dl>
2558 <dt>Return:</dt>
2559 <dd>
2560 tuple containing a flag indicating success and an error message
2561 </dd>
2562 </dl>
2563 <dl>
2564 <dt>Return Type:</dt>
2565 <dd>
2566 tuple of (bool, str)
2567 </dd>
2568 </dl>
2569 <a NAME="BaseDevice.writeLanAutoConnect" ID="BaseDevice.writeLanAutoConnect"></a> 2400 <a NAME="BaseDevice.writeLanAutoConnect" ID="BaseDevice.writeLanAutoConnect"></a>
2570 <h4>BaseDevice.writeLanAutoConnect</h4> 2401 <h4>BaseDevice.writeLanAutoConnect</h4>
2571 <b>writeLanAutoConnect</b>(<i>config</i>) 2402 <b>writeLanAutoConnect</b>(<i>config</i>)
2572 2403
2573 <p>
2574 Public method to generate a script and associated configuration to connect the
2575 device to the LAN during boot time.
2576 </p>
2577 <dl>
2578
2579 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt>
2580 <dd>
2581 configuration for the connection (either the string 'dhcp'
2582 for a dynamic address or a tuple of four strings with the IPv4 parameters.
2583 </dd>
2584 </dl>
2585 <dl>
2586 <dt>Return:</dt>
2587 <dd>
2588 tuple containing a flag indicating success and an error message
2589 </dd>
2590 </dl>
2591 <dl>
2592 <dt>Return Type:</dt>
2593 <dd>
2594 tuple of (bool, str)
2595 </dd>
2596 </dl>
2597 <div align="right"><a href="#top">Up</a></div> 2404 <div align="right"><a href="#top">Up</a></div>
2598 <hr /> 2405 <hr />
2599 </body></html> 2406 </body></html>

Mercurial Repository: eric

eric ide

mercurial