src/eric7/Documentation/Source/eric7.MicroPython.EthernetDialogs.EthernetController.html

<!DOCTYPE html>
<html><head>
<title>eric7.MicroPython.EthernetDialogs.EthernetController</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.EthernetDialogs.EthernetController</h1>

<p>
Module implementing the Ethernet related functionality.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#EthernetController">EthernetController</a></td>
<td>Class implementing the Ethernet related functionality.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="EthernetController" ID="EthernetController"></a>
<h2>EthernetController</h2>

<p>
    Class implementing the Ethernet related functionality.
</p>
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#EthernetController.__init__">EthernetController</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#EthernetController.__checkInternet">__checkInternet</a></td>
<td>Private slot to check the availability of an internet connection.</td>
</tr>
<tr>
<td><a href="#EthernetController.__connectLan">__connectLan</a></td>
<td>Private method to connect the connected device to the LAN.</td>
</tr>
<tr>
<td><a href="#EthernetController.__connectLanDhcp">__connectLanDhcp</a></td>
<td>Private slot to connect to the LAN with a dynamic IPv4 address (DHCP mode).</td>
</tr>
<tr>
<td><a href="#EthernetController.__connectLanIp">__connectLanIp</a></td>
<td>Private slot to connect to the LAN with a fixed IPv4 address (fixed address mode).</td>
</tr>
<tr>
<td><a href="#EthernetController.__deactivateEthernet">__deactivateEthernet</a></td>
<td>Private slot to deactivate the Ethernet interface.</td>
</tr>
<tr>
<td><a href="#EthernetController.__disconnectLan">__disconnectLan</a></td>
<td>Private slot to disconnect from the LAN.</td>
</tr>
<tr>
<td><a href="#EthernetController.__removeAutoConnect">__removeAutoConnect</a></td>
<td>Private slot to remove the boot time connect capability.</td>
</tr>
<tr>
<td><a href="#EthernetController.__setNetworkTime">__setNetworkTime</a></td>
<td>Private slot to synchronize the device clock to network time.</td>
</tr>
<tr>
<td><a href="#EthernetController.__showEthernetStatus">__showEthernetStatus</a></td>
<td>Private slot to show a dialog with the WiFi status of the current device.</td>
</tr>
<tr>
<td><a href="#EthernetController.__writeAutoConnect">__writeAutoConnect</a></td>
<td>Private slot to generate a script and associated configuration to connect the device during boot time.</td>
</tr>
<tr>
<td><a href="#EthernetController.createMenu">createMenu</a></td>
<td>Public method to create the Ethernet submenu.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="EthernetController.__init__" ID="EthernetController.__init__"></a>
<h4>EthernetController (Constructor)</h4>
<b>EthernetController</b>(<i>microPython, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>microPython</i> (MicroPythonWidgep)</dt>
<dd>
reference to the MicroPython widget
</dd>
<dt><i>parent</i> (QObject (optional))</dt>
<dd>
reference to the parent object (defaults to None)
</dd>
</dl>
<a NAME="EthernetController.__checkInternet" ID="EthernetController.__checkInternet"></a>
<h4>EthernetController.__checkInternet</h4>
<b>__checkInternet</b>(<i></i>)

<p>
        Private slot to check the availability of an internet connection.
</p>
<a NAME="EthernetController.__connectLan" ID="EthernetController.__connectLan"></a>
<h4>EthernetController.__connectLan</h4>
<b>__connectLan</b>(<i>config, hostname</i>)

<p>
        Private method to connect the connected device to the LAN.
</p>
<dl>

<dt><i>config</i> (str of tuple of (str, str, str, str))</dt>
<dd>
configuration for the connection (either the string 'dhcp'
            for a dynamic address or a tuple of four strings with the IPv4 parameters.
</dd>
<dt><i>hostname</i> (str)</dt>
<dd>
host name of the device
</dd>
</dl>
<a NAME="EthernetController.__connectLanDhcp" ID="EthernetController.__connectLanDhcp"></a>
<h4>EthernetController.__connectLanDhcp</h4>
<b>__connectLanDhcp</b>(<i></i>)

<p>
        Private slot to connect to the LAN with a dynamic IPv4 address (DHCP mode).
</p>
<a NAME="EthernetController.__connectLanIp" ID="EthernetController.__connectLanIp"></a>
<h4>EthernetController.__connectLanIp</h4>
<b>__connectLanIp</b>(<i></i>)

<p>
        Private slot to connect to the LAN with a fixed IPv4 address (fixed address
        mode).
</p>
<a NAME="EthernetController.__deactivateEthernet" ID="EthernetController.__deactivateEthernet"></a>
<h4>EthernetController.__deactivateEthernet</h4>
<b>__deactivateEthernet</b>(<i></i>)

<p>
        Private slot to deactivate the Ethernet interface.
</p>
<a NAME="EthernetController.__disconnectLan" ID="EthernetController.__disconnectLan"></a>
<h4>EthernetController.__disconnectLan</h4>
<b>__disconnectLan</b>(<i></i>)

<p>
        Private slot to disconnect from the LAN.
</p>
<a NAME="EthernetController.__removeAutoConnect" ID="EthernetController.__removeAutoConnect"></a>
<h4>EthernetController.__removeAutoConnect</h4>
<b>__removeAutoConnect</b>(<i></i>)

<p>
        Private slot to remove the boot time connect capability.
</p>
<p>
        This will not remove the auto-connect part of the boot script. This needs to be
        done manually if desired.
</p>
<a NAME="EthernetController.__setNetworkTime" ID="EthernetController.__setNetworkTime"></a>
<h4>EthernetController.__setNetworkTime</h4>
<b>__setNetworkTime</b>(<i></i>)

<p>
        Private slot to synchronize the device clock to network time.
</p>
<a NAME="EthernetController.__showEthernetStatus" ID="EthernetController.__showEthernetStatus"></a>
<h4>EthernetController.__showEthernetStatus</h4>
<b>__showEthernetStatus</b>(<i></i>)

<p>
        Private slot to show a dialog with the WiFi status of the current device.
</p>
<a NAME="EthernetController.__writeAutoConnect" ID="EthernetController.__writeAutoConnect"></a>
<h4>EthernetController.__writeAutoConnect</h4>
<b>__writeAutoConnect</b>(<i></i>)

<p>
        Private slot to generate a script and associated configuration to connect the
        device during boot time.
</p>
<p>
        This will also modify the boot script to perform the automatic connection.
</p>
<a NAME="EthernetController.createMenu" ID="EthernetController.createMenu"></a>
<h4>EthernetController.createMenu</h4>
<b>createMenu</b>(<i>menu</i>)

<p>
        Public method to create the Ethernet submenu.
</p>
<dl>

<dt><i>menu</i> (QMenu)</dt>
<dd>
reference to the parent menu
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the created menu
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
QMenu
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>