Sat, 25 Feb 2023 19:18:43 +0100
MicroPython
- updated the source documentation
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.EricNetwork.EricIPv4InputWidget.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,241 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricNetwork.EricIPv4InputWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.EricNetwork.EricIPv4InputWidget</h1> + +<p> +Module implementing a widget to enter an IPv4 address. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#EricIPv4InputWidget">EricIPv4InputWidget</a></td> +<td>Class implementing a widget to enter an IPv4 address.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="EricIPv4InputWidget" ID="EricIPv4InputWidget"></a> +<h2>EricIPv4InputWidget</h2> + +<p> + Class implementing a widget to enter an IPv4 address. +</p> +<h3>Signals</h3> +<dl> + +<dt>addressChanged()</dt> +<dd> +emitted to indicate a change of the entered IPv4 address +</dd> +</dl> +<h3>Derived from</h3> +QWidget, Ui_EricIPv4InputWidget +<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="#EricIPv4InputWidget.__init__">EricIPv4InputWidget</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.__clear">__clear</a></td> +<td>Private slot to handle the clear button press.</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.address">address</a></td> +<td>Public method to get the IPv4 address as an ipaddress.IPv4Address object.</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.clear">clear</a></td> +<td>Public slot to clear the input fields.</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.eventFilter">eventFilter</a></td> +<td>Public method to filter pressing '.' to give focus to the next input field.</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.hasAcceptableInput">hasAcceptableInput</a></td> +<td>Public method to check, if the input is acceptable.</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.setAddress">setAddress</a></td> +<td>Public method to set the IPv4 address given an ipaddress.IPv4Address object.</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.setText">setText</a></td> +<td>Public method to set the IPv4 address given a string.</td> +</tr> +<tr> +<td><a href="#EricIPv4InputWidget.text">text</a></td> +<td>Public method to get the IPv4 address as a string.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="EricIPv4InputWidget.__init__" ID="EricIPv4InputWidget.__init__"></a> +<h4>EricIPv4InputWidget (Constructor)</h4> +<b>EricIPv4InputWidget</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="EricIPv4InputWidget.__clear" ID="EricIPv4InputWidget.__clear"></a> +<h4>EricIPv4InputWidget.__clear</h4> +<b>__clear</b>(<i></i>) + +<p> + Private slot to handle the clear button press. +</p> +<a NAME="EricIPv4InputWidget.address" ID="EricIPv4InputWidget.address"></a> +<h4>EricIPv4InputWidget.address</h4> +<b>address</b>(<i></i>) + +<p> + Public method to get the IPv4 address as an ipaddress.IPv4Address object. +</p> +<dl> +<dt>Return:</dt> +<dd> +IPv4 address +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +ipaddress.IPv4Address +</dd> +</dl> +<a NAME="EricIPv4InputWidget.clear" ID="EricIPv4InputWidget.clear"></a> +<h4>EricIPv4InputWidget.clear</h4> +<b>clear</b>(<i></i>) + +<p> + Public slot to clear the input fields. +</p> +<a NAME="EricIPv4InputWidget.eventFilter" ID="EricIPv4InputWidget.eventFilter"></a> +<h4>EricIPv4InputWidget.eventFilter</h4> +<b>eventFilter</b>(<i>obj, evt</i>) + +<p> + Public method to filter pressing '.' to give focus to the next input field. +</p> +<dl> + +<dt><i>obj</i> (QObject)</dt> +<dd> +reference to the object +</dd> +<dt><i>evt</i> (QEvent)</dt> +<dd> +reference to the event object +</dd> +</dl> +<a NAME="EricIPv4InputWidget.hasAcceptableInput" ID="EricIPv4InputWidget.hasAcceptableInput"></a> +<h4>EricIPv4InputWidget.hasAcceptableInput</h4> +<b>hasAcceptableInput</b>(<i></i>) + +<p> + Public method to check, if the input is acceptable. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating acceptable input +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="EricIPv4InputWidget.setAddress" ID="EricIPv4InputWidget.setAddress"></a> +<h4>EricIPv4InputWidget.setAddress</h4> +<b>setAddress</b>(<i>address</i>) + +<p> + Public method to set the IPv4 address given an ipaddress.IPv4Address object. +</p> +<dl> + +<dt><i>address</i> (ipaddress.IPv4Address)</dt> +<dd> +IPv4 address +</dd> +</dl> +<a NAME="EricIPv4InputWidget.setText" ID="EricIPv4InputWidget.setText"></a> +<h4>EricIPv4InputWidget.setText</h4> +<b>setText</b>(<i>address</i>) + +<p> + Public method to set the IPv4 address given a string. +</p> +<dl> + +<dt><i>address</i> (str)</dt> +<dd> +IPv4 address +</dd> +</dl> +<a NAME="EricIPv4InputWidget.text" ID="EricIPv4InputWidget.text"></a> +<h4>EricIPv4InputWidget.text</h4> +<b>text</b>(<i></i>) + +<p> + Public method to get the IPv4 address as a string. +</p> +<dl> +<dt>Return:</dt> +<dd> +IPv4 address +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MCUScripts.esp32WiFiConnect.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,38 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.Devices.MCUScripts.esp32WiFiConnect</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.Devices.MCUScripts.esp32WiFiConnect</h1> + +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#connectWiFi">connectWiFi</a></td> +<td></td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="connectWiFi" ID="connectWiFi"></a> +<h2>connectWiFi</h2> +<b>connectWiFi</b>(<i></i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.MCUScripts.picowWiFiConnect.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,38 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.Devices.MCUScripts.picowWiFiConnect</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.Devices.MCUScripts.picowWiFiConnect</h1> + +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> + +<table> + +<tr> +<td><a href="#connectWiFi">connectWiFi</a></td> +<td></td> +</tr> +</table> +<hr /> +<hr /> +<a NAME="connectWiFi" ID="connectWiFi"></a> +<h2>connectWiFi</h2> +<b>connectWiFi</b>(<i></i>) + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiApConfigDialog.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,141 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiApConfigDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiApConfigDialog</h1> + +<p> +Module implementing a dialog to configure the Access Point interface. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiApConfigDialog">WifiApConfigDialog</a></td> +<td>Class implementing a dialog to configure the Access Point interface.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiApConfigDialog" ID="WifiApConfigDialog"></a> +<h2>WifiApConfigDialog</h2> + +<p> + Class implementing a dialog to configure the Access Point interface. +</p> +<h3>Derived from</h3> +QDialog, Ui_WifiApConfigDialog +<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="#WifiApConfigDialog.__init__">WifiApConfigDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WifiApConfigDialog.__updateOk">__updateOk</a></td> +<td>Private method to update the enabled state of the OK button.</td> +</tr> +<tr> +<td><a href="#WifiApConfigDialog.getApConfig">getApConfig</a></td> +<td>Public method to get the entered access point configuration data.</td> +</tr> +<tr> +<td><a href="#WifiApConfigDialog.on_apShowPasswordButton_clicked">on_apShowPasswordButton_clicked</a></td> +<td>Private slot to show or hide the WiFi Access Point password.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiApConfigDialog.__init__" ID="WifiApConfigDialog.__init__"></a> +<h4>WifiApConfigDialog (Constructor)</h4> +<b>WifiApConfigDialog</b>(<i>withIP, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>withIP</i> (bool)</dt> +<dd> +flag indicating to ask the user for an IP configuration +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="WifiApConfigDialog.__updateOk" ID="WifiApConfigDialog.__updateOk"></a> +<h4>WifiApConfigDialog.__updateOk</h4> +<b>__updateOk</b>(<i></i>) + +<p> + Private method to update the enabled state of the OK button. +</p> +<a NAME="WifiApConfigDialog.getApConfig" ID="WifiApConfigDialog.getApConfig"></a> +<h4>WifiApConfigDialog.getApConfig</h4> +<b>getApConfig</b>(<i></i>) + +<p> + Public method to get the entered access point configuration data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the SSID, the password, the selected security mode + and a flag indicating to save the parameters to the settings +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, int, bool) +</dd> +</dl> +<a NAME="WifiApConfigDialog.on_apShowPasswordButton_clicked" ID="WifiApConfigDialog.on_apShowPasswordButton_clicked"></a> +<h4>WifiApConfigDialog.on_apShowPasswordButton_clicked</h4> +<b>on_apShowPasswordButton_clicked</b>(<i>checked</i>) + +<p> + Private slot to show or hide the WiFi Access Point password. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiApStationsDialog.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,89 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiApStationsDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiApStationsDialog</h1> + +<p> +Module implementing a dialog showing the currently connected stations (clients). +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiApStationsDialog">WifiApStationsDialog</a></td> +<td>Class documentation goes here.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiApStationsDialog" ID="WifiApStationsDialog"></a> +<h2>WifiApStationsDialog</h2> + +<p> + Class documentation goes here. +</p> +<h3>Derived from</h3> +QDialog, Ui_WifiApStationsDialog +<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="#WifiApStationsDialog.__init__">WifiApStationsDialog</a></td> +<td>Constructor</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiApStationsDialog.__init__" ID="WifiApStationsDialog.__init__"></a> +<h4>WifiApStationsDialog (Constructor)</h4> +<b>WifiApStationsDialog</b>(<i>stations, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>stations</i></dt> +<dd> +list of connected stations. Each entry is a tuple containing the + station's MAC-Address and the RSSI (if supported and available) +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiConnectionDialog.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,146 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiConnectionDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiConnectionDialog</h1> + +<p> +Module implementing a dialog to enter the parameters needed to connect to a WiFi +network. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiConnectionDialog">WifiConnectionDialog</a></td> +<td>Class implementing a dialog to enter the parameters needed to connect to a WiFi network.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiConnectionDialog" ID="WifiConnectionDialog"></a> +<h2>WifiConnectionDialog</h2> + +<p> + Class implementing a dialog to enter the parameters needed to connect to a WiFi + network. +</p> +<h3>Derived from</h3> +QDialog, Ui_WifiConnectionDialog +<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="#WifiConnectionDialog.__init__">WifiConnectionDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WifiConnectionDialog.getConnectionParameters">getConnectionParameters</a></td> +<td>Public method to get the entered connection parameters.</td> +</tr> +<tr> +<td><a href="#WifiConnectionDialog.on_showPasswordButton_clicked">on_showPasswordButton_clicked</a></td> +<td>Private slot to show or hide the password.</td> +</tr> +<tr> +<td><a href="#WifiConnectionDialog.on_ssidEdit_textChanged">on_ssidEdit_textChanged</a></td> +<td>Private slot handling a change of the SSID.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiConnectionDialog.__init__" ID="WifiConnectionDialog.__init__"></a> +<h4>WifiConnectionDialog (Constructor)</h4> +<b>WifiConnectionDialog</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="WifiConnectionDialog.getConnectionParameters" ID="WifiConnectionDialog.getConnectionParameters"></a> +<h4>WifiConnectionDialog.getConnectionParameters</h4> +<b>getConnectionParameters</b>(<i></i>) + +<p> + Public method to get the entered connection parameters. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the SSID, password and a flag indicating, if the + parameters shall be saved to the preferences +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, str, bool) +</dd> +</dl> +<a NAME="WifiConnectionDialog.on_showPasswordButton_clicked" ID="WifiConnectionDialog.on_showPasswordButton_clicked"></a> +<h4>WifiConnectionDialog.on_showPasswordButton_clicked</h4> +<b>on_showPasswordButton_clicked</b>(<i>checked</i>) + +<p> + Private slot to show or hide the password. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +state of the button +</dd> +</dl> +<a NAME="WifiConnectionDialog.on_ssidEdit_textChanged" ID="WifiConnectionDialog.on_ssidEdit_textChanged"></a> +<h4>WifiConnectionDialog.on_ssidEdit_textChanged</h4> +<b>on_ssidEdit_textChanged</b>(<i>ssid</i>) + +<p> + Private slot handling a change of the SSID. +</p> +<dl> + +<dt><i>ssid</i> (str)</dt> +<dd> +entered SSID +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiController.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,274 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiController</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiController</h1> + +<p> +Module implementing the WiFi related functionality. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiController">WifiController</a></td> +<td>Class implementing the WiFi related functionality.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiController" ID="WifiController"></a> +<h2>WifiController</h2> + +<p> + Class implementing the WiFi 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="#WifiController.__init__">WifiController</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WifiController.__checkInternet">__checkInternet</a></td> +<td>Private slot to check the availability of an internet connection.</td> +</tr> +<tr> +<td><a href="#WifiController.__connectWifi">__connectWifi</a></td> +<td>Private slot to connect the current device to a WiFi network.</td> +</tr> +<tr> +<td><a href="#WifiController.__deactivateInterface">__deactivateInterface</a></td> +<td>Private method to deactivate a given WiFi interface of the connected device.</td> +</tr> +<tr> +<td><a href="#WifiController.__disconnectWifi">__disconnectWifi</a></td> +<td>Private slot to disconnect the current device from the WiFi network.</td> +</tr> +<tr> +<td><a href="#WifiController.__removeCredentials">__removeCredentials</a></td> +<td>Private slot to remove the saved WiFi credentials from the connected device.</td> +</tr> +<tr> +<td><a href="#WifiController.__scanNetwork">__scanNetwork</a></td> +<td>Private slot to scan for visible WiFi networks.</td> +</tr> +<tr> +<td><a href="#WifiController.__showConnectedClients">__showConnectedClients</a></td> +<td>Private slot to show a list of WiFi clients connected to the Access Point interface.</td> +</tr> +<tr> +<td><a href="#WifiController.__showWifiStatus">__showWifiStatus</a></td> +<td>Private slot to show a dialog with the WiFi status of the current device.</td> +</tr> +<tr> +<td><a href="#WifiController.__startAccessPoint">__startAccessPoint</a></td> +<td>Private slot to start the Access Point interface of the connected device.</td> +</tr> +<tr> +<td><a href="#WifiController.__startAccessPointIP">__startAccessPointIP</a></td> +<td>Private slot to start the Access Point interface of the connected device with given IP parameters.</td> +</tr> +<tr> +<td><a href="#WifiController.__stopAccessPoint">__stopAccessPoint</a></td> +<td>Private slot to stop the Access Point interface of the connected device.</td> +</tr> +<tr> +<td><a href="#WifiController.__writeCredentials">__writeCredentials</a></td> +<td>Private slot to save the WiFi login credentials to the connected device.</td> +</tr> +<tr> +<td><a href="#WifiController.createMenu">createMenu</a></td> +<td>Public method to create the WiFi submenu.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiController.__init__" ID="WifiController.__init__"></a> +<h4>WifiController (Constructor)</h4> +<b>WifiController</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="WifiController.__checkInternet" ID="WifiController.__checkInternet"></a> +<h4>WifiController.__checkInternet</h4> +<b>__checkInternet</b>(<i></i>) + +<p> + Private slot to check the availability of an internet connection. +</p> +<a NAME="WifiController.__connectWifi" ID="WifiController.__connectWifi"></a> +<h4>WifiController.__connectWifi</h4> +<b>__connectWifi</b>(<i></i>) + +<p> + Private slot to connect the current device to a WiFi network. +</p> +<a NAME="WifiController.__deactivateInterface" ID="WifiController.__deactivateInterface"></a> +<h4>WifiController.__deactivateInterface</h4> +<b>__deactivateInterface</b>(<i>interface</i>) + +<p> + Private method to deactivate a given WiFi interface of the connected device. +</p> +<dl> + +<dt><i>interface</i> (str)</dt> +<dd> +designation of the interface to be deactivated (one of 'AP' + or 'STA') +</dd> +</dl> +<a NAME="WifiController.__disconnectWifi" ID="WifiController.__disconnectWifi"></a> +<h4>WifiController.__disconnectWifi</h4> +<b>__disconnectWifi</b>(<i></i>) + +<p> + Private slot to disconnect the current device from the WiFi network. +</p> +<a NAME="WifiController.__removeCredentials" ID="WifiController.__removeCredentials"></a> +<h4>WifiController.__removeCredentials</h4> +<b>__removeCredentials</b>(<i></i>) + +<p> + Private slot to remove the saved WiFi credentials from the connected device. +</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="WifiController.__scanNetwork" ID="WifiController.__scanNetwork"></a> +<h4>WifiController.__scanNetwork</h4> +<b>__scanNetwork</b>(<i></i>) + +<p> + Private slot to scan for visible WiFi networks. +</p> +<a NAME="WifiController.__showConnectedClients" ID="WifiController.__showConnectedClients"></a> +<h4>WifiController.__showConnectedClients</h4> +<b>__showConnectedClients</b>(<i></i>) + +<p> + Private slot to show a list of WiFi clients connected to the Access Point + interface. +</p> +<a NAME="WifiController.__showWifiStatus" ID="WifiController.__showWifiStatus"></a> +<h4>WifiController.__showWifiStatus</h4> +<b>__showWifiStatus</b>(<i></i>) + +<p> + Private slot to show a dialog with the WiFi status of the current device. +</p> +<a NAME="WifiController.__startAccessPoint" ID="WifiController.__startAccessPoint"></a> +<h4>WifiController.__startAccessPoint</h4> +<b>__startAccessPoint</b>(<i>withIP=False</i>) + +<p> + Private slot to start the Access Point interface of the connected device. +</p> +<dl> + +<dt><i>withIP</i> (bool)</dt> +<dd> +flag indicating to start the access point with an IP configuration +</dd> +</dl> +<a NAME="WifiController.__startAccessPointIP" ID="WifiController.__startAccessPointIP"></a> +<h4>WifiController.__startAccessPointIP</h4> +<b>__startAccessPointIP</b>(<i></i>) + +<p> + Private slot to start the Access Point interface of the connected device + with given IP parameters. +</p> +<a NAME="WifiController.__stopAccessPoint" ID="WifiController.__stopAccessPoint"></a> +<h4>WifiController.__stopAccessPoint</h4> +<b>__stopAccessPoint</b>(<i></i>) + +<p> + Private slot to stop the Access Point interface of the connected device. +</p> +<a NAME="WifiController.__writeCredentials" ID="WifiController.__writeCredentials"></a> +<h4>WifiController.__writeCredentials</h4> +<b>__writeCredentials</b>(<i></i>) + +<p> + Private slot to save the WiFi login credentials to the connected device. +</p> +<p> + This will also modify the boot script to perform an automatic WiFi connection. +</p> +<a NAME="WifiController.createMenu" ID="WifiController.createMenu"></a> +<h4>WifiController.createMenu</h4> +<b>createMenu</b>(<i>menu</i>) + +<p> + Public method to create the WiFi 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> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiCountryDialog.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,126 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiCountryDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiCountryDialog</h1> + +<p> +Module implementing a dialog to enter the country code for the WiFi interface. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiCountryDialog">WifiCountryDialog</a></td> +<td>Class implementing a dialog to enter the country code for the WiFi interface.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiCountryDialog" ID="WifiCountryDialog"></a> +<h2>WifiCountryDialog</h2> + +<p> + Class implementing a dialog to enter the country code for the WiFi interface. +</p> +<h3>Derived from</h3> +QDialog, Ui_WifiCountryDialog +<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="#WifiCountryDialog.__init__">WifiCountryDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WifiCountryDialog.getCountry">getCountry</a></td> +<td>Public method to get the entered country code.</td> +</tr> +<tr> +<td><a href="#WifiCountryDialog.on_countryEdit_textChanged">on_countryEdit_textChanged</a></td> +<td>Private slot handling a change of the country.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiCountryDialog.__init__" ID="WifiCountryDialog.__init__"></a> +<h4>WifiCountryDialog (Constructor)</h4> +<b>WifiCountryDialog</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="WifiCountryDialog.getCountry" ID="WifiCountryDialog.getCountry"></a> +<h4>WifiCountryDialog.getCountry</h4> +<b>getCountry</b>(<i></i>) + +<p> + Public method to get the entered country code. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the country code and a flag indicating to save it to + the settings +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (str, bool) +</dd> +</dl> +<a NAME="WifiCountryDialog.on_countryEdit_textChanged" ID="WifiCountryDialog.on_countryEdit_textChanged"></a> +<h4>WifiCountryDialog.on_countryEdit_textChanged</h4> +<b>on_countryEdit_textChanged</b>(<i>country</i>) + +<p> + Private slot handling a change of the country. +</p> +<dl> + +<dt><i>country</i> (str)</dt> +<dd> +entered country code +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiNetworksWindow.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,175 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiNetworksWindow</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiNetworksWindow</h1> + +<p> +Module implementing a dialog showing the available WiFi networks. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiNetworksWindow">WifiNetworksWindow</a></td> +<td>Class implementing a dialog showing the available WiFi networks.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiNetworksWindow" ID="WifiNetworksWindow"></a> +<h2>WifiNetworksWindow</h2> + +<p> + Class implementing a dialog showing the available WiFi networks. +</p> +<h3>Derived from</h3> +QWidget, Ui_WifiNetworksWindow +<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="#WifiNetworksWindow.__init__">WifiNetworksWindow</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WifiNetworksWindow.__resizeColumns">__resizeColumns</a></td> +<td>Private method to resize the columns of the result list.</td> +</tr> +<tr> +<td><a href="#WifiNetworksWindow.__resort">__resort</a></td> +<td>Private method to resort the networks list.</td> +</tr> +<tr> +<td><a href="#WifiNetworksWindow.closeEvent">closeEvent</a></td> +<td>Protected method to handle a window close event.</td> +</tr> +<tr> +<td><a href="#WifiNetworksWindow.on_intervalSpinBox_valueChanged">on_intervalSpinBox_valueChanged</a></td> +<td>Private slot handling a change of the periodic scan interval.</td> +</tr> +<tr> +<td><a href="#WifiNetworksWindow.on_periodicCheckBox_toggled">on_periodicCheckBox_toggled</a></td> +<td>Private slot handling the selection of a periodic scan.</td> +</tr> +<tr> +<td><a href="#WifiNetworksWindow.scanNetworks">scanNetworks</a></td> +<td>Public method to ask the device for a network scan and display the result.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiNetworksWindow.__init__" ID="WifiNetworksWindow.__init__"></a> +<h4>WifiNetworksWindow (Constructor)</h4> +<b>WifiNetworksWindow</b>(<i>device, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>device</i> (BaseDevice)</dt> +<dd> +reference to the connected device +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="WifiNetworksWindow.__resizeColumns" ID="WifiNetworksWindow.__resizeColumns"></a> +<h4>WifiNetworksWindow.__resizeColumns</h4> +<b>__resizeColumns</b>(<i></i>) + +<p> + Private method to resize the columns of the result list. +</p> +<a NAME="WifiNetworksWindow.__resort" ID="WifiNetworksWindow.__resort"></a> +<h4>WifiNetworksWindow.__resort</h4> +<b>__resort</b>(<i></i>) + +<p> + Private method to resort the networks list. +</p> +<a NAME="WifiNetworksWindow.closeEvent" ID="WifiNetworksWindow.closeEvent"></a> +<h4>WifiNetworksWindow.closeEvent</h4> +<b>closeEvent</b>(<i>evt</i>) + +<p> + Protected method to handle a window close event. +</p> +<dl> + +<dt><i>evt</i> (QCloseEvent)</dt> +<dd> +reference to the close event +</dd> +</dl> +<a NAME="WifiNetworksWindow.on_intervalSpinBox_valueChanged" ID="WifiNetworksWindow.on_intervalSpinBox_valueChanged"></a> +<h4>WifiNetworksWindow.on_intervalSpinBox_valueChanged</h4> +<b>on_intervalSpinBox_valueChanged</b>(<i>interval</i>) + +<p> + Private slot handling a change of the periodic scan interval. +</p> +<dl> + +<dt><i>interval</i> (int)</dt> +<dd> +periodic scan interval +</dd> +</dl> +<a NAME="WifiNetworksWindow.on_periodicCheckBox_toggled" ID="WifiNetworksWindow.on_periodicCheckBox_toggled"></a> +<h4>WifiNetworksWindow.on_periodicCheckBox_toggled</h4> +<b>on_periodicCheckBox_toggled</b>(<i>checked</i>) + +<p> + Private slot handling the selection of a periodic scan. +</p> +<dl> + +<dt><i>checked</i> (bool)</dt> +<dd> +flag indicating a periodic scan +</dd> +</dl> +<a NAME="WifiNetworksWindow.scanNetworks" ID="WifiNetworksWindow.scanNetworks"></a> +<h4>WifiNetworksWindow.scanNetworks</h4> +<b>scanNetworks</b>(<i></i>) + +<p> + Public method to ask the device for a network scan and display the result. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiStatusDialog.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,128 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs.WifiStatusDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.MicroPython.WifiDialogs.WifiStatusDialog</h1> + +<p> +Module implementing a dialog to show the WiFi status of the connected device. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#WifiStatusDialog">WifiStatusDialog</a></td> +<td>Class implementing a dialog to show the WiFi status of the connected device.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="WifiStatusDialog" ID="WifiStatusDialog"></a> +<h2>WifiStatusDialog</h2> + +<p> + Class implementing a dialog to show the WiFi status of the connected device. +</p> +<h3>Derived from</h3> +QDialog, Ui_WifiStatusDialog +<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="#WifiStatusDialog.__init__">WifiStatusDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#WifiStatusDialog.__createHeader">__createHeader</a></td> +<td>Private method to create a header item.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="WifiStatusDialog.__init__" ID="WifiStatusDialog.__init__"></a> +<h4>WifiStatusDialog (Constructor)</h4> +<b>WifiStatusDialog</b>(<i>clientStatus, apStatus, overallStatus, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>clientStatus</i> (dict)</dt> +<dd> +dictionary containing the WiFi status data of the + client interface +</dd> +<dt><i>apStatus</i> (dict)</dt> +<dd> +dictionary containing the WiFi status data of the + access point interface +</dd> +<dt><i>overallStatus</i> (dict)</dt> +<dd> +dictionary containing the overall WiFi status data +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="WifiStatusDialog.__createHeader" ID="WifiStatusDialog.__createHeader"></a> +<h4>WifiStatusDialog.__createHeader</h4> +<b>__createHeader</b>(<i>headerText</i>) + +<p> + Private method to create a header item. +</p> +<dl> + +<dt><i>headerText</i> (str)</dt> +<dd> +text for the header item +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +reference to the created header item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QTreeWidgetItem +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/index-eric7.MicroPython.Devices.MCUScripts.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,27 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.Devices.MCUScripts</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<h1>eric7.MicroPython.Devices.MCUScripts</h1> + +<p> +Package containing scripts for copying to the micro controller board. +</p> + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="eric7.MicroPython.Devices.MCUScripts.esp32WiFiConnect.html">esp32WiFiConnect</a></td> +<td></td> +</tr> +<tr> +<td><a href="eric7.MicroPython.Devices.MCUScripts.picowWiFiConnect.html">picowWiFiConnect</a></td> +<td></td> +</tr> +</table> +</body></html> \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/index-eric7.MicroPython.WifiDialogs.html Sat Feb 25 19:18:43 2023 +0100 @@ -0,0 +1,47 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.MicroPython.WifiDialogs</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<h1>eric7.MicroPython.WifiDialogs</h1> + +<p> +Package implementing WiFi related dialogs. +</p> + + +<h3>Modules</h3> +<table> + +<tr> +<td><a href="eric7.MicroPython.WifiDialogs.WifiApConfigDialog.html">WifiApConfigDialog</a></td> +<td>Module implementing a dialog to configure the Access Point interface.</td> +</tr> +<tr> +<td><a href="eric7.MicroPython.WifiDialogs.WifiApStationsDialog.html">WifiApStationsDialog</a></td> +<td>Module implementing a dialog showing the currently connected stations (clients).</td> +</tr> +<tr> +<td><a href="eric7.MicroPython.WifiDialogs.WifiConnectionDialog.html">WifiConnectionDialog</a></td> +<td>Module implementing a dialog to enter the parameters needed to connect to a WiFi network.</td> +</tr> +<tr> +<td><a href="eric7.MicroPython.WifiDialogs.WifiController.html">WifiController</a></td> +<td>Module implementing the WiFi related functionality.</td> +</tr> +<tr> +<td><a href="eric7.MicroPython.WifiDialogs.WifiCountryDialog.html">WifiCountryDialog</a></td> +<td>Module implementing a dialog to enter the country code for the WiFi interface.</td> +</tr> +<tr> +<td><a href="eric7.MicroPython.WifiDialogs.WifiNetworksWindow.html">WifiNetworksWindow</a></td> +<td>Module implementing a dialog showing the available WiFi networks.</td> +</tr> +<tr> +<td><a href="eric7.MicroPython.WifiDialogs.WifiStatusDialog.html">WifiStatusDialog</a></td> +<td>Module implementing a dialog to show the WiFi status of the connected device.</td> +</tr> +</table> +</body></html> \ No newline at end of file