src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html

branch
eric7
changeset 10684
58c7f23ae1cb
parent 10515
6e790462348a
child 11167
a3f5af773bc7
equal deleted inserted replaced
10683:779cda568acb 10684:58c7f23ae1cb
918 918
919 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> 919 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt>
920 <dd> 920 <dd>
921 configuration for the connection (either the string 'dhcp' 921 configuration for the connection (either the string 'dhcp'
922 for a dynamic address or a tuple of four strings with the IPv4 parameters. 922 for a dynamic address or a tuple of four strings with the IPv4 parameters.
923 (unused)
923 </dd> 924 </dd>
924 <dt><i>hostname</i> (str)</dt> 925 <dt><i>hostname</i> (str)</dt>
925 <dd> 926 <dd>
926 host name of the device 927 host name of the device (unused)
927 </dd> 928 </dd>
928 </dl> 929 </dl>
929 <dl> 930 <dl>
930 <dt>Return:</dt> 931 <dt>Return:</dt>
931 <dd> 932 <dd>
947 948
948 <dl> 949 <dl>
949 950
950 <dt><i>ssid</i> (str)</dt> 951 <dt><i>ssid</i> (str)</dt>
951 <dd> 952 <dd>
952 name (SSID) of the WiFi network 953 name (SSID) of the WiFi network (unused)
953 </dd> 954 </dd>
954 <dt><i>password</i> (str)</dt> 955 <dt><i>password</i> (str)</dt>
955 <dd> 956 <dd>
956 password needed to connect 957 password needed to connect (unused)
957 </dd> 958 </dd>
958 <dt><i>hostname</i> (str)</dt> 959 <dt><i>hostname</i> (str)</dt>
959 <dd> 960 <dd>
960 host name of the device 961 host name of the device (unused)
961 </dd> 962 </dd>
962 </dl> 963 </dl>
963 <dl> 964 <dl>
964 <dt>Return:</dt> 965 <dt>Return:</dt>
965 <dd> 966 <dd>
1020 <dl> 1021 <dl>
1021 1022
1022 <dt><i>interface</i> (str)</dt> 1023 <dt><i>interface</i> (str)</dt>
1023 <dd> 1024 <dd>
1024 designation of the interface to be deactivated (one of 'AP' 1025 designation of the interface to be deactivated (one of 'AP'
1025 or 'STA') 1026 or 'STA') (unused)
1026 </dd> 1027 </dd>
1027 </dl> 1028 </dl>
1028 <dl> 1029 <dl>
1029 <dt>Return:</dt> 1030 <dt>Return:</dt>
1030 <dd> 1031 <dd>
1131 1132
1132 <dl> 1133 <dl>
1133 1134
1134 <dt><i>password</i> (str)</dt> 1135 <dt><i>password</i> (str)</dt>
1135 <dd> 1136 <dd>
1136 password needed to authenticate 1137 password needed to authenticate (unused)
1137 </dd> 1138 </dd>
1138 </dl> 1139 </dl>
1139 <dl> 1140 <dl>
1140 <dt>Return:</dt> 1141 <dt>Return:</dt>
1141 <dd> 1142 <dd>
1456 <dl> 1457 <dl>
1457 1458
1458 <dt><i>timeout</i> (int (optional))</dt> 1459 <dt><i>timeout</i> (int (optional))</dt>
1459 <dd> 1460 <dd>
1460 duration of the device scan in seconds (defaults 1461 duration of the device scan in seconds (defaults
1461 to 10) 1462 to 10) (unused)
1462 </dd> 1463 </dd>
1463 </dl> 1464 </dl>
1464 <dl> 1465 <dl>
1465 <dt>Return:</dt> 1466 <dt>Return:</dt>
1466 <dd> 1467 <dd>
2485 <dl> 2486 <dl>
2486 2487
2487 <dt><i>server</i> (str (optional))</dt> 2488 <dt><i>server</i> (str (optional))</dt>
2488 <dd> 2489 <dd>
2489 name of the NTP server to get the network time from 2490 name of the NTP server to get the network time from
2490 (defaults to "0.pool.ntp.org") 2491 (defaults to "0.pool.ntp.org") (unused)
2491 </dd> 2492 </dd>
2492 <dt><i>tzOffset</i> (int (optional))</dt> 2493 <dt><i>tzOffset</i> (int (optional))</dt>
2493 <dd> 2494 <dd>
2494 offset with respect to UTC (defaults to 0) 2495 offset with respect to UTC (defaults to 0) (unused)
2495 </dd> 2496 </dd>
2496 <dt><i>timeout</i> (int)</dt> 2497 <dt><i>timeout</i> (int)</dt>
2497 <dd> 2498 <dd>
2498 maximum time to wait for a server response in seconds 2499 maximum time to wait for a server response in seconds
2499 (defaults to 10) 2500 (defaults to 10) (unused)
2500 </dd> 2501 </dd>
2501 </dl> 2502 </dl>
2502 <dl> 2503 <dl>
2503 <dt>Return:</dt> 2504 <dt>Return:</dt>
2504 <dd> 2505 <dd>
2562 2563
2563 <dl> 2564 <dl>
2564 2565
2565 <dt><i>ssid</i> (str)</dt> 2566 <dt><i>ssid</i> (str)</dt>
2566 <dd> 2567 <dd>
2567 SSID of the access point 2568 SSID of the access point (unused)
2568 </dd> 2569 </dd>
2569 <dt><i>security</i> (int (optional))</dt> 2570 <dt><i>security</i> (int (optional))</dt>
2570 <dd> 2571 <dd>
2571 security method (defaults to None) 2572 security method (defaults to None) (unused)
2572 </dd> 2573 </dd>
2573 <dt><i>password</i> (str (optional))</dt> 2574 <dt><i>password</i> (str (optional))</dt>
2574 <dd> 2575 <dd>
2575 password (defaults to None) 2576 password (defaults to None) (unused)
2576 </dd> 2577 </dd>
2577 <dt><i>hostname</i> (str (optional))</dt> 2578 <dt><i>hostname</i> (str (optional))</dt>
2578 <dd> 2579 <dd>
2579 host name of the device (defaults to None) 2580 host name of the device (defaults to None) (unused)
2580 </dd> 2581 </dd>
2581 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt> 2582 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt>
2582 <dd> 2583 <dd>
2583 IPv4 configuration for the access point if not default 2584 IPv4 configuration for the access point if not default
2584 (IPv4 address, netmask, gateway address, DNS server address) 2585 (IPv4 address, netmask, gateway address, DNS server address) (unused)
2585 </dd> 2586 </dd>
2586 </dl> 2587 </dl>
2587 <dl> 2588 <dl>
2588 <dt>Return:</dt> 2589 <dt>Return:</dt>
2589 <dd> 2590 <dd>
2653 bool 2654 bool
2654 </dd> 2655 </dd>
2655 </dl> 2656 </dl>
2656 <a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a> 2657 <a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a>
2657 <h4>BaseDevice.syncTime</h4> 2658 <h4>BaseDevice.syncTime</h4>
2658 <b>syncTime</b>(<i>deviceType, hasCPy=False</i>) 2659 <b>syncTime</b>(<i>_deviceType, hasCPy=False</i>)
2659 <p> 2660 <p>
2660 Public method to set the time of the connected device to the local 2661 Public method to set the time of the connected device to the local
2661 computer's time. 2662 computer's time.
2662 </p> 2663 </p>
2663 2664
2664 <dl> 2665 <dl>
2665 2666
2666 <dt><i>deviceType</i> (str)</dt> 2667 <dt><i>_deviceType</i> (str)</dt>
2667 <dd> 2668 <dd>
2668 type of board to sync time to 2669 type of board to sync time to (unused)
2669 </dd> 2670 </dd>
2670 <dt><i>hasCPy</i> (bool)</dt> 2671 <dt><i>hasCPy</i> (bool)</dt>
2671 <dd> 2672 <dd>
2672 flag indicating that the device has CircuitPython loadede 2673 flag indicating that the device has CircuitPython loadede
2673 (defaults to False) 2674 (defaults to False) (unused)
2674 </dd> 2675 </dd>
2675 </dl> 2676 </dl>
2676 <dl> 2677 <dl>
2677 2678
2678 <dt>Raises <b>OSError</b>:</dt> 2679 <dt>Raises <b>OSError</b>:</dt>
2716 2717
2717 <dl> 2718 <dl>
2718 2719
2719 <dt><i>ssid</i> (str)</dt> 2720 <dt><i>ssid</i> (str)</dt>
2720 <dd> 2721 <dd>
2721 SSID of the network to connect to 2722 SSID of the network to connect to (unused)
2722 </dd> 2723 </dd>
2723 <dt><i>password</i> (str)</dt> 2724 <dt><i>password</i> (str)</dt>
2724 <dd> 2725 <dd>
2725 password needed to authenticate 2726 password needed to authenticate (unused)
2726 </dd> 2727 </dd>
2727 <dt><i>hostname</i> (str)</dt> 2728 <dt><i>hostname</i> (str)</dt>
2728 <dd> 2729 <dd>
2729 host name of the device 2730 host name of the device (unused)
2730 </dd> 2731 </dd>
2731 <dt><i>country</i> (str)</dt> 2732 <dt><i>country</i> (str)</dt>
2732 <dd> 2733 <dd>
2733 WiFi country code 2734 WiFi country code (unused)
2734 </dd> 2735 </dd>
2735 </dl> 2736 </dl>
2736 <dl> 2737 <dl>
2737 <dt>Return:</dt> 2738 <dt>Return:</dt>
2738 <dd> 2739 <dd>
2757 2758
2758 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> 2759 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt>
2759 <dd> 2760 <dd>
2760 configuration for the connection (either the string 'dhcp' 2761 configuration for the connection (either the string 'dhcp'
2761 for a dynamic address or a tuple of four strings with the IPv4 parameters. 2762 for a dynamic address or a tuple of four strings with the IPv4 parameters.
2763 (unused)
2762 </dd> 2764 </dd>
2763 <dt><i>hostname</i> (str)</dt> 2765 <dt><i>hostname</i> (str)</dt>
2764 <dd> 2766 <dd>
2765 host name of the device 2767 host name of the device (unused)
2766 </dd> 2768 </dd>
2767 </dl> 2769 </dl>
2768 <dl> 2770 <dl>
2769 <dt>Return:</dt> 2771 <dt>Return:</dt>
2770 <dd> 2772 <dd>

eric ide

mercurial