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
- eric7
- changeset 10153
- ffe7432f716b
- parent 10144
- 45a9177c8e77
- child 10259
- b51dfacef37f
equal
deleted
inserted
replaced
| 10152:33e7b9d3f91c | 10153:ffe7432f716b |
|---|---|
| 318 <td><a href="#CircuitPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> | 318 <td><a href="#CircuitPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> |
| 319 <td>Public method to indicate file access via a local directory.</td> | 319 <td>Public method to indicate file access via a local directory.</td> |
| 320 </tr> | 320 </tr> |
| 321 <tr> | 321 <tr> |
| 322 <td><a href="#CircuitPythonDevice.writeCredentials">writeCredentials</a></td> | 322 <td><a href="#CircuitPythonDevice.writeCredentials">writeCredentials</a></td> |
| 323 <td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td> | 323 <td></td> |
| 324 </tr> | 324 </tr> |
| 325 <tr> | 325 <tr> |
| 326 <td><a href="#CircuitPythonDevice.writeLanAutoConnect">writeLanAutoConnect</a></td> | 326 <td><a href="#CircuitPythonDevice.writeLanAutoConnect">writeLanAutoConnect</a></td> |
| 327 <td>Public method to generate a script and associated configuration to connect the device to the LAN during boot time.</td> | 327 <td>Public method to generate a script and associated configuration to connect the device to the LAN during boot time.</td> |
| 328 </tr> | 328 </tr> |
| 766 tuple of (bool, str) | 766 tuple of (bool, str) |
| 767 </dd> | 767 </dd> |
| 768 </dl> | 768 </dl> |
| 769 <a NAME="CircuitPythonDevice.connectToLan" ID="CircuitPythonDevice.connectToLan"></a> | 769 <a NAME="CircuitPythonDevice.connectToLan" ID="CircuitPythonDevice.connectToLan"></a> |
| 770 <h4>CircuitPythonDevice.connectToLan</h4> | 770 <h4>CircuitPythonDevice.connectToLan</h4> |
| 771 <b>connectToLan</b>(<i>config</i>) | 771 <b>connectToLan</b>(<i>config, hostname</i>) |
| 772 | 772 |
| 773 <p> | 773 <p> |
| 774 Public method to connect the connected device to the LAN. | 774 Public method to connect the connected device to the LAN. |
| 775 </p> | 775 </p> |
| 776 <p> | 776 <p> |
| 781 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> | 781 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> |
| 782 <dd> | 782 <dd> |
| 783 configuration for the connection (either the string 'dhcp' | 783 configuration for the connection (either the string 'dhcp' |
| 784 for a dynamic address or a tuple of four strings with the IPv4 parameters. | 784 for a dynamic address or a tuple of four strings with the IPv4 parameters. |
| 785 </dd> | 785 </dd> |
| 786 <dt><i>hostname</i> (str)</dt> | |
| 787 <dd> | |
| 788 host name of the device | |
| 789 </dd> | |
| 786 </dl> | 790 </dl> |
| 787 <dl> | 791 <dl> |
| 788 <dt>Return:</dt> | 792 <dt>Return:</dt> |
| 789 <dd> | 793 <dd> |
| 790 tuple containing a flag indicating success and an error message | 794 tuple containing a flag indicating success and an error message |
| 796 tuple of (bool, str) | 800 tuple of (bool, str) |
| 797 </dd> | 801 </dd> |
| 798 </dl> | 802 </dl> |
| 799 <a NAME="CircuitPythonDevice.connectWifi" ID="CircuitPythonDevice.connectWifi"></a> | 803 <a NAME="CircuitPythonDevice.connectWifi" ID="CircuitPythonDevice.connectWifi"></a> |
| 800 <h4>CircuitPythonDevice.connectWifi</h4> | 804 <h4>CircuitPythonDevice.connectWifi</h4> |
| 801 <b>connectWifi</b>(<i>ssid, password</i>) | 805 <b>connectWifi</b>(<i>ssid, password, hostname</i>) |
| 802 | 806 |
| 803 <p> | 807 <p> |
| 804 Public method to connect a device to a WiFi network. | 808 Public method to connect a device to a WiFi network. |
| 805 </p> | 809 </p> |
| 806 <dl> | 810 <dl> |
| 810 name (SSID) of the WiFi network | 814 name (SSID) of the WiFi network |
| 811 </dd> | 815 </dd> |
| 812 <dt><i>password</i> (str)</dt> | 816 <dt><i>password</i> (str)</dt> |
| 813 <dd> | 817 <dd> |
| 814 password needed to connect | 818 password needed to connect |
| 819 </dd> | |
| 820 <dt><i>hostname</i> (str)</dt> | |
| 821 <dd> | |
| 822 host name of the device | |
| 815 </dd> | 823 </dd> |
| 816 </dl> | 824 </dl> |
| 817 <dl> | 825 <dl> |
| 818 <dt>Return:</dt> | 826 <dt>Return:</dt> |
| 819 <dd> | 827 <dd> |
| 1517 Public slot to show the CircuitPython version of a connected device and | 1525 Public slot to show the CircuitPython version of a connected device and |
| 1518 the latest available one (from Github). | 1526 the latest available one (from Github). |
| 1519 </p> | 1527 </p> |
| 1520 <a NAME="CircuitPythonDevice.startAccessPoint" ID="CircuitPythonDevice.startAccessPoint"></a> | 1528 <a NAME="CircuitPythonDevice.startAccessPoint" ID="CircuitPythonDevice.startAccessPoint"></a> |
| 1521 <h4>CircuitPythonDevice.startAccessPoint</h4> | 1529 <h4>CircuitPythonDevice.startAccessPoint</h4> |
| 1522 <b>startAccessPoint</b>(<i>ssid, security=None, password=None, ifconfig=None</i>) | 1530 <b>startAccessPoint</b>(<i>ssid, security=None, password=None, hostname=None, ifconfig=None, </i>) |
| 1523 | 1531 |
| 1524 <p> | 1532 <p> |
| 1525 Public method to start the access point interface. | 1533 Public method to start the access point interface. |
| 1526 </p> | 1534 </p> |
| 1527 <dl> | 1535 <dl> |
| 1535 security method (defaults to None) | 1543 security method (defaults to None) |
| 1536 </dd> | 1544 </dd> |
| 1537 <dt><i>password</i> (str (optional))</dt> | 1545 <dt><i>password</i> (str (optional))</dt> |
| 1538 <dd> | 1546 <dd> |
| 1539 password (defaults to None) | 1547 password (defaults to None) |
| 1548 </dd> | |
| 1549 <dt><i>hostname</i> (str (optional))</dt> | |
| 1550 <dd> | |
| 1551 host name of the device (defaults to None) | |
| 1540 </dd> | 1552 </dd> |
| 1541 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt> | 1553 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt> |
| 1542 <dd> | 1554 <dd> |
| 1543 IPv4 configuration for the access point if not default | 1555 IPv4 configuration for the access point if not default |
| 1544 (IPv4 address, netmask, gateway address, DNS server address) | 1556 (IPv4 address, netmask, gateway address, DNS server address) |
| 1594 bool | 1606 bool |
| 1595 </dd> | 1607 </dd> |
| 1596 </dl> | 1608 </dl> |
| 1597 <a NAME="CircuitPythonDevice.writeCredentials" ID="CircuitPythonDevice.writeCredentials"></a> | 1609 <a NAME="CircuitPythonDevice.writeCredentials" ID="CircuitPythonDevice.writeCredentials"></a> |
| 1598 <h4>CircuitPythonDevice.writeCredentials</h4> | 1610 <h4>CircuitPythonDevice.writeCredentials</h4> |
| 1599 <b>writeCredentials</b>(<i>ssid, password</i>) | 1611 <b>writeCredentials</b>(<i>ssid, password, hostname, country</i>) |
| 1600 | 1612 |
| 1601 <p> | |
| 1602 Public method to write the given credentials to the connected device and modify | |
| 1603 the start script to connect automatically. | |
| 1604 </p> | |
| 1605 <dl> | |
| 1606 | |
| 1607 <dt><i>ssid</i> (str)</dt> | |
| 1608 <dd> | |
| 1609 SSID of the network to connect to | |
| 1610 </dd> | |
| 1611 <dt><i>password</i> (str)</dt> | |
| 1612 <dd> | |
| 1613 password needed to authenticate | |
| 1614 </dd> | |
| 1615 </dl> | |
| 1616 <dl> | |
| 1617 <dt>Return:</dt> | |
| 1618 <dd> | |
| 1619 tuple containing a flag indicating success and an error message | |
| 1620 </dd> | |
| 1621 </dl> | |
| 1622 <dl> | |
| 1623 <dt>Return Type:</dt> | |
| 1624 <dd> | |
| 1625 tuple of (bool, str) | |
| 1626 </dd> | |
| 1627 </dl> | |
| 1628 <a NAME="CircuitPythonDevice.writeLanAutoConnect" ID="CircuitPythonDevice.writeLanAutoConnect"></a> | 1613 <a NAME="CircuitPythonDevice.writeLanAutoConnect" ID="CircuitPythonDevice.writeLanAutoConnect"></a> |
| 1629 <h4>CircuitPythonDevice.writeLanAutoConnect</h4> | 1614 <h4>CircuitPythonDevice.writeLanAutoConnect</h4> |
| 1630 <b>writeLanAutoConnect</b>(<i>config</i>) | 1615 <b>writeLanAutoConnect</b>(<i>config, hostname</i>) |
| 1631 | 1616 |
| 1632 <p> | 1617 <p> |
| 1633 Public method to generate a script and associated configuration to connect the | 1618 Public method to generate a script and associated configuration to connect the |
| 1634 device to the LAN during boot time. | 1619 device to the LAN during boot time. |
| 1635 </p> | 1620 </p> |
| 1637 | 1622 |
| 1638 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> | 1623 <dt><i>config</i> (str or tuple of (str, str, str, str))</dt> |
| 1639 <dd> | 1624 <dd> |
| 1640 configuration for the connection (either the string 'dhcp' | 1625 configuration for the connection (either the string 'dhcp' |
| 1641 for a dynamic address or a tuple of four strings with the IPv4 parameters. | 1626 for a dynamic address or a tuple of four strings with the IPv4 parameters. |
| 1627 </dd> | |
| 1628 <dt><i>hostname</i> (str)</dt> | |
| 1629 <dd> | |
| 1630 host name of the device | |
| 1642 </dd> | 1631 </dd> |
| 1643 </dl> | 1632 </dl> |
| 1644 <dl> | 1633 <dl> |
| 1645 <dt>Return:</dt> | 1634 <dt>Return:</dt> |
| 1646 <dd> | 1635 <dd> |
