--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html Sat Mar 11 15:28:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html Sun Mar 12 14:56:04 2023 +0100
@@ -124,10 +124,22 @@
<td>Public method to check, if the internet can be reached.</td>
</tr>
<tr>
+<td><a href="#RP2040Device.checkInternetViaLan">checkInternetViaLan</a></td>
+<td>Public method to check, if the internet can be reached (LAN variant).</td>
+</tr>
+<tr>
+<td><a href="#RP2040Device.connectToLan">connectToLan</a></td>
+<td>Public method to connect the connected device to the LAN.</td>
+</tr>
+<tr>
<td><a href="#RP2040Device.connectWifi">connectWifi</a></td>
<td>Public method to connect a device to a WiFi network.</td>
</tr>
<tr>
+<td><a href="#RP2040Device.deactivateEthernet">deactivateEthernet</a></td>
+<td>Public method to deactivate the Ethernet interface of the connected device.</td>
+</tr>
+<tr>
<td><a href="#RP2040Device.deactivateInterface">deactivateInterface</a></td>
<td>Public method to deactivate a given WiFi interface of the connected device.</td>
</tr>
@@ -136,6 +148,10 @@
<td>Public method to get the name of the device.</td>
</tr>
<tr>
+<td><a href="#RP2040Device.disconnectFromLan">disconnectFromLan</a></td>
+<td>Public method to disconnect from the LAN.</td>
+</tr>
+<tr>
<td><a href="#RP2040Device.disconnectWifi">disconnectWifi</a></td>
<td>Public method to disconnect a device from the WiFi network.</td>
</tr>
@@ -156,10 +172,18 @@
<td>Public method to retrieve the entries for the downloads menu.</td>
</tr>
<tr>
+<td><a href="#RP2040Device.getEthernetStatus">getEthernetStatus</a></td>
+<td>Public method to get Ethernet status data of the connected board.</td>
+</tr>
+<tr>
<td><a href="#RP2040Device.getWifiData">getWifiData</a></td>
<td>Public method to get data related to the current WiFi status.</td>
</tr>
<tr>
+<td><a href="#RP2040Device.hasEthernet">hasEthernet</a></td>
+<td>Public method to check the availability of Ethernet.</td>
+</tr>
+<tr>
<td><a href="#RP2040Device.hasFlashMenuEntry">hasFlashMenuEntry</a></td>
<td>Public method to check, if the device has its own flash menu entry.</td>
</tr>
@@ -176,6 +200,10 @@
<td>Public method to remove the saved credentials from the connected device.</td>
</tr>
<tr>
+<td><a href="#RP2040Device.removeLanAutoConnect">removeLanAutoConnect</a></td>
+<td>Public method to remove the saved IPv4 parameters from the connected device.</td>
+</tr>
+<tr>
<td><a href="#RP2040Device.runScript">runScript</a></td>
<td>Public method to run the given Python script.</td>
</tr>
@@ -203,6 +231,10 @@
<td><a href="#RP2040Device.writeCredentials">writeCredentials</a></td>
<td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td>
</tr>
+<tr>
+<td><a href="#RP2040Device.writeLanAutoConnect">writeLanAutoConnect</a></td>
+<td>Public method to generate a script and associated configuration to connect the device to the LAN during boot time.</td>
+</tr>
</table>
<h3>Static Methods</h3>
@@ -442,6 +474,52 @@
tuple of (bool, str)
</dd>
</dl>
+<a NAME="RP2040Device.checkInternetViaLan" ID="RP2040Device.checkInternetViaLan"></a>
+<h4>RP2040Device.checkInternetViaLan</h4>
+<b>checkInternetViaLan</b>(<i></i>)
+
+<p>
+ Public method to check, if the internet can be reached (LAN variant).
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating reachability and an error string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="RP2040Device.connectToLan" ID="RP2040Device.connectToLan"></a>
+<h4>RP2040Device.connectToLan</h4>
+<b>connectToLan</b>(<i>config</i>)
+
+<p>
+ Public method to connect the connected device to the LAN.
+</p>
+<dl>
+
+<dt><i>config</i> (str or 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>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
<a NAME="RP2040Device.connectWifi" ID="RP2040Device.connectWifi"></a>
<h4>RP2040Device.connectWifi</h4>
<b>connectWifi</b>(<i>ssid, password</i>)
@@ -472,6 +550,25 @@
tuple of (bool, str)
</dd>
</dl>
+<a NAME="RP2040Device.deactivateEthernet" ID="RP2040Device.deactivateEthernet"></a>
+<h4>RP2040Device.deactivateEthernet</h4>
+<b>deactivateEthernet</b>(<i></i>)
+
+<p>
+ Public method to deactivate the Ethernet interface of the connected device.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containg a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
<a NAME="RP2040Device.deactivateInterface" ID="RP2040Device.deactivateInterface"></a>
<h4>RP2040Device.deactivateInterface</h4>
<b>deactivateInterface</b>(<i>interface</i>)
@@ -525,6 +622,25 @@
str
</dd>
</dl>
+<a NAME="RP2040Device.disconnectFromLan" ID="RP2040Device.disconnectFromLan"></a>
+<h4>RP2040Device.disconnectFromLan</h4>
+<b>disconnectFromLan</b>(<i></i>)
+
+<p>
+ Public method to disconnect from the LAN.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
<a NAME="RP2040Device.disconnectWifi" ID="RP2040Device.disconnectWifi"></a>
<h4>RP2040Device.disconnectWifi</h4>
<b>disconnectWifi</b>(<i></i>)
@@ -623,6 +739,33 @@
list of tuple of (str, str)
</dd>
</dl>
+<a NAME="RP2040Device.getEthernetStatus" ID="RP2040Device.getEthernetStatus"></a>
+<h4>RP2040Device.getEthernetStatus</h4>
+<b>getEthernetStatus</b>(<i></i>)
+
+<p>
+ Public method to get Ethernet status data of the connected board.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of tuples containing the translated status data label and
+ the associated value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuples of (str, str)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>OSError</b>:</dt>
+<dd>
+raised to indicate an issue with the device
+</dd>
+</dl>
<a NAME="RP2040Device.getWifiData" ID="RP2040Device.getWifiData"></a>
<h4>RP2040Device.getWifiData</h4>
<b>getWifiData</b>(<i></i>)
@@ -650,6 +793,32 @@
raised to indicate an issue with the device
</dd>
</dl>
+<a NAME="RP2040Device.hasEthernet" ID="RP2040Device.hasEthernet"></a>
+<h4>RP2040Device.hasEthernet</h4>
+<b>hasEthernet</b>(<i></i>)
+
+<p>
+ Public method to check the availability of Ethernet.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the availability of Ethernet
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>OSError</b>:</dt>
+<dd>
+raised to indicate an issue with the device
+</dd>
+</dl>
<a NAME="RP2040Device.hasFlashMenuEntry" ID="RP2040Device.hasFlashMenuEntry"></a>
<h4>RP2040Device.hasFlashMenuEntry</h4>
<b>hasFlashMenuEntry</b>(<i></i>)
@@ -741,6 +910,28 @@
tuple of (bool, str)
</dd>
</dl>
+<a NAME="RP2040Device.removeLanAutoConnect" ID="RP2040Device.removeLanAutoConnect"></a>
+<h4>RP2040Device.removeLanAutoConnect</h4>
+<b>removeLanAutoConnect</b>(<i></i>)
+
+<p>
+ Public method to remove the saved IPv4 parameters from the connected device.
+</p>
+<p>
+ Note: This disables the LAN auto-connect feature.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
<a NAME="RP2040Device.runScript" ID="RP2040Device.runScript"></a>
<h4>RP2040Device.runScript</h4>
<b>runScript</b>(<i>script</i>)
@@ -908,6 +1099,34 @@
tuple of (bool, str)
</dd>
</dl>
+<a NAME="RP2040Device.writeLanAutoConnect" ID="RP2040Device.writeLanAutoConnect"></a>
+<h4>RP2040Device.writeLanAutoConnect</h4>
+<b>writeLanAutoConnect</b>(<i>config</i>)
+
+<p>
+ Public method to generate a script and associated configuration to connect the
+ device to the LAN during boot time.
+</p>
+<dl>
+
+<dt><i>config</i> (str or 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>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
