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

branch
eric7
changeset 10144
45a9177c8e77
parent 10138
56614cf9d03c
child 10153
ffe7432f716b
equal deleted inserted replaced
10143:bf84513859ca 10144:45a9177c8e77
85 <ul> 85 <ul>
86 <li>hasWifi: check, if the board has WiFi functionality</li> 86 <li>hasWifi: check, if the board has WiFi functionality</li>
87 <li>getWifiData: get WiFi status data</li> 87 <li>getWifiData: get WiFi status data</li>
88 <li>connectWifi: connect to a WiFi network</li> 88 <li>connectWifi: connect to a WiFi network</li>
89 <li>disconnectWifi: disconnect from a WiFi network</li> 89 <li>disconnectWifi: disconnect from a WiFi network</li>
90 <li>isWifiClientConnected: check the WiFi connection status as client</li>
91 <li>isWifiApConnected: check the WiFi connection status as access point</li>
90 <li>writeCredentials: save the WiFi credentials to the board and create 92 <li>writeCredentials: save the WiFi credentials to the board and create
91 functionality to auto-connect at boot time</li> 93 functionality to auto-connect at boot time</li>
92 <li>removeCredentials: remove the saved credentials</li> 94 <li>removeCredentials: remove the saved credentials</li>
93 <li>checkInternet: check, if internet access is possible</li> 95 <li>checkInternet: check, if internet access is possible</li>
94 <li>scanNetworks: scan for available WiFi networks</li> 96 <li>scanNetworks: scan for available WiFi networks</li>
109 </ul> 111 </ul>
110 </p> 112 </p>
111 <p> 113 <p>
112 Supported Ethernet commands are: 114 Supported Ethernet commands are:
113 <ul> 115 <ul>
114 <li>hasEthernet: check, if the board has Ethernet functionality 116 <li>hasEthernet: check, if the board has Ethernet functionality</li>
115 <li>getEthernetStatus: get Ethernet status data 117 <li>getEthernetStatus: get Ethernet status data</li>
116 <li>connectToLan: connect to an Ethernet network 118 <li>connectToLan: connect to an Ethernet network</li>
117 <li>disconnectFromLan: disconnect from an Ethernet network 119 <li>disconnectFromLan: disconnect from an Ethernet network</li>
118 <li>checkInternetViaLan: check, if internet access via LAN is possible 120 <li>isLanConnected: check the LAN connection status</li>
119 <li>deactivateEthernet: deactivate the Ethernet interface 121 <li>checkInternetViaLan: check, if internet access via LAN is possible</li>
122 <li>deactivateEthernet: deactivate the Ethernet interface</li>
120 <li>writeLanAutoConnect: save IPv4 parameters to the board and create a script 123 <li>writeLanAutoConnect: save IPv4 parameters to the board and create a script
121 to connect the board to the LAN 124 to connect the board to the LAN</li>
122 <li>removeLanAutoConnect: remove the IPv4 parameters and script from the board 125 <li>removeLanAutoConnect: remove the IPv4 parameters and script from the board</li>
123 </ul> 126 </ul>
124 </p> 127 </p>
125 <h3>Derived from</h3> 128 <h3>Derived from</h3>
126 QObject 129 QObject
127 <h3>Class Attributes</h3> 130 <h3>Class Attributes</h3>
381 <tr> 384 <tr>
382 <td><a href="#BaseDevice.hasWifi">hasWifi</a></td> 385 <td><a href="#BaseDevice.hasWifi">hasWifi</a></td>
383 <td>Public method to check the availability of WiFi.</td> 386 <td>Public method to check the availability of WiFi.</td>
384 </tr> 387 </tr>
385 <tr> 388 <tr>
389 <td><a href="#BaseDevice.isLanConnected">isLanConnected</a></td>
390 <td>Public method to check the LAN connection status.</td>
391 </tr>
392 <tr>
386 <td><a href="#BaseDevice.isNetworkConnected">isNetworkConnected</a></td> 393 <td><a href="#BaseDevice.isNetworkConnected">isNetworkConnected</a></td>
387 <td>Public method to check, if the network interface (WiFi or Ethernet) is connected.</td> 394 <td>Public method to check, if the network interface (WiFi or Ethernet) is connected.</td>
395 </tr>
396 <tr>
397 <td><a href="#BaseDevice.isWifiApConnected">isWifiApConnected</a></td>
398 <td>Public method to check the WiFi connection status as access point.</td>
399 </tr>
400 <tr>
401 <td><a href="#BaseDevice.isWifiClientConnected">isWifiClientConnected</a></td>
402 <td>Public method to check the WiFi connection status as client.</td>
388 </tr> 403 </tr>
389 <tr> 404 <tr>
390 <td><a href="#BaseDevice.lls">lls</a></td> 405 <td><a href="#BaseDevice.lls">lls</a></td>
391 <td>Public method to get a long directory listing of the connected device including meta data.</td> 406 <td>Public method to get a long directory listing of the connected device including meta data.</td>
392 </tr> 407 </tr>
1723 <dt>Return Type:</dt> 1738 <dt>Return Type:</dt>
1724 <dd> 1739 <dd>
1725 tuple of (bool, str) 1740 tuple of (bool, str)
1726 </dd> 1741 </dd>
1727 </dl> 1742 </dl>
1743 <a NAME="BaseDevice.isLanConnected" ID="BaseDevice.isLanConnected"></a>
1744 <h4>BaseDevice.isLanConnected</h4>
1745 <b>isLanConnected</b>(<i></i>)
1746
1747 <p>
1748 Public method to check the LAN connection status.
1749 </p>
1750 <dl>
1751 <dt>Return:</dt>
1752 <dd>
1753 flag indicating that the device is connected to the LAN
1754 </dd>
1755 </dl>
1756 <dl>
1757 <dt>Return Type:</dt>
1758 <dd>
1759 bool
1760 </dd>
1761 </dl>
1728 <a NAME="BaseDevice.isNetworkConnected" ID="BaseDevice.isNetworkConnected"></a> 1762 <a NAME="BaseDevice.isNetworkConnected" ID="BaseDevice.isNetworkConnected"></a>
1729 <h4>BaseDevice.isNetworkConnected</h4> 1763 <h4>BaseDevice.isNetworkConnected</h4>
1730 <b>isNetworkConnected</b>(<i></i>) 1764 <b>isNetworkConnected</b>(<i></i>)
1731 1765
1732 <p> 1766 <p>
1735 </p> 1769 </p>
1736 <dl> 1770 <dl>
1737 <dt>Return:</dt> 1771 <dt>Return:</dt>
1738 <dd> 1772 <dd>
1739 flag indicating the network connection state 1773 flag indicating the network connection state
1774 </dd>
1775 </dl>
1776 <dl>
1777 <dt>Return Type:</dt>
1778 <dd>
1779 bool
1780 </dd>
1781 </dl>
1782 <a NAME="BaseDevice.isWifiApConnected" ID="BaseDevice.isWifiApConnected"></a>
1783 <h4>BaseDevice.isWifiApConnected</h4>
1784 <b>isWifiApConnected</b>(<i></i>)
1785
1786 <p>
1787 Public method to check the WiFi connection status as access point.
1788 </p>
1789 <dl>
1790 <dt>Return:</dt>
1791 <dd>
1792 flag indicating the WiFi connection status
1793 </dd>
1794 </dl>
1795 <dl>
1796 <dt>Return Type:</dt>
1797 <dd>
1798 bool
1799 </dd>
1800 </dl>
1801 <a NAME="BaseDevice.isWifiClientConnected" ID="BaseDevice.isWifiClientConnected"></a>
1802 <h4>BaseDevice.isWifiClientConnected</h4>
1803 <b>isWifiClientConnected</b>(<i></i>)
1804
1805 <p>
1806 Public method to check the WiFi connection status as client.
1807 </p>
1808 <dl>
1809 <dt>Return:</dt>
1810 <dd>
1811 flag indicating the WiFi connection status
1740 </dd> 1812 </dd>
1741 </dl> 1813 </dl>
1742 <dl> 1814 <dl>
1743 <dt>Return Type:</dt> 1815 <dt>Return Type:</dt>
1744 <dd> 1816 <dd>

eric ide

mercurial