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

branch
mpy_network
changeset 9878
a82014a9e57b
parent 9871
4a302b8c4d28
child 9880
f425c58cf8e9
diff -r dad1f6d37366 -r a82014a9e57b src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sat Mar 11 15:28:47 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sun Mar 12 14:56:04 2023 +0100
@@ -142,6 +142,10 @@
 <td>Public method to add device specific entries to the given menu.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.addDeviceEthernetEntries">addDeviceEthernetEntries</a></td>
+<td>Public method to add device specific entries to the given menu.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
 <td>Public method to add device specific entries to the given menu.</td>
 </tr>
@@ -182,6 +186,14 @@
 <td>Public method to check, if the internet can be reached.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.checkInternetViaLan">checkInternetViaLan</a></td>
+<td>Public method to check, if the internet can be reached (LAN variant).</td>
+</tr>
+<tr>
+<td><a href="#BaseDevice.connectToLan">connectToLan</a></td>
+<td>Public method to connect the connected device to the LAN.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.connectWifi">connectWifi</a></td>
 <td>Public method to connect a device to a WiFi network.</td>
 </tr>
@@ -190,6 +202,10 @@
 <td>Public method to deactivate the Bluetooth interface.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.deactivateEthernet">deactivateEthernet</a></td>
+<td>Public method to deactivate the Ethernet interface of the connected device.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td>
 <td>Public method to deactivate a given WiFi interface of the connected device.</td>
 </tr>
@@ -198,6 +214,10 @@
 <td>Public method to get the name of the device.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.disconnectFromLan">disconnectFromLan</a></td>
+<td>Public method  to disconnect from the LAN.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.disconnectWifi">disconnectWifi</a></td>
 <td>Public method to disconnect a device from the WiFi network.</td>
 </tr>
@@ -258,6 +278,10 @@
 <td>Public method to retrieve the entries for the downloads menu.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.getEthernetStatus">getEthernetStatus</a></td>
+<td>Public method to get Ethernet status data of the connected board.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.getFirmwareUrl">getFirmwareUrl</a></td>
 <td>Public method to get the device firmware download URL.</td>
 </tr>
@@ -350,6 +374,10 @@
 <td>Public method to remove the saved credentials from the connected device.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.removeLanAutoConnect">removeLanAutoConnect</a></td>
+<td>Public method to remove the saved IPv4 parameters from the connected device.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.rm">rm</a></td>
 <td>Public method to remove a file from the connected device.</td>
 </tr>
@@ -429,6 +457,10 @@
 <td><a href="#BaseDevice.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="#BaseDevice.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>
 
@@ -566,6 +598,20 @@
 reference to the context menu
 </dd>
 </dl>
+<a NAME="BaseDevice.addDeviceEthernetEntries" ID="BaseDevice.addDeviceEthernetEntries"></a>
+<h4>BaseDevice.addDeviceEthernetEntries</h4>
+<b>addDeviceEthernetEntries</b>(<i>menu</i>)
+
+<p>
+        Public method to add device specific entries to the given menu.
+</p>
+<dl>
+
+<dt><i>menu</i> (QMenu)</dt>
+<dd>
+reference to the context menu
+</dd>
+</dl>
 <a NAME="BaseDevice.addDeviceMenuEntries" ID="BaseDevice.addDeviceMenuEntries"></a>
 <h4>BaseDevice.addDeviceMenuEntries</h4>
 <b>addDeviceMenuEntries</b>(<i>menu</i>)
@@ -772,6 +818,52 @@
 tuple of (bool, str)
 </dd>
 </dl>
+<a NAME="BaseDevice.checkInternetViaLan" ID="BaseDevice.checkInternetViaLan"></a>
+<h4>BaseDevice.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="BaseDevice.connectToLan" ID="BaseDevice.connectToLan"></a>
+<h4>BaseDevice.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="BaseDevice.connectWifi" ID="BaseDevice.connectWifi"></a>
 <h4>BaseDevice.connectWifi</h4>
 <b>connectWifi</b>(<i>ssid, password</i>)
@@ -821,6 +913,25 @@
 bool
 </dd>
 </dl>
+<a NAME="BaseDevice.deactivateEthernet" ID="BaseDevice.deactivateEthernet"></a>
+<h4>BaseDevice.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="BaseDevice.deactivateInterface" ID="BaseDevice.deactivateInterface"></a>
 <h4>BaseDevice.deactivateInterface</h4>
 <b>deactivateInterface</b>(<i>interface</i>)
@@ -867,6 +978,25 @@
 str
 </dd>
 </dl>
+<a NAME="BaseDevice.disconnectFromLan" ID="BaseDevice.disconnectFromLan"></a>
+<h4>BaseDevice.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="BaseDevice.disconnectWifi" ID="BaseDevice.disconnectWifi"></a>
 <h4>BaseDevice.disconnectWifi</h4>
 <b>disconnectWifi</b>(<i></i>)
@@ -1222,6 +1352,26 @@
 list of tuple of (str, str)
 </dd>
 </dl>
+<a NAME="BaseDevice.getEthernetStatus" ID="BaseDevice.getEthernetStatus"></a>
+<h4>BaseDevice.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>
 <a NAME="BaseDevice.getFirmwareUrl" ID="BaseDevice.getFirmwareUrl"></a>
 <h4>BaseDevice.getFirmwareUrl</h4>
 <b>getFirmwareUrl</b>(<i></i>)
@@ -1762,6 +1912,28 @@
 tuple of (bool, str)
 </dd>
 </dl>
+<a NAME="BaseDevice.removeLanAutoConnect" ID="BaseDevice.removeLanAutoConnect"></a>
+<h4>BaseDevice.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="BaseDevice.rm" ID="BaseDevice.rm"></a>
 <h4>BaseDevice.rm</h4>
 <b>rm</b>(<i>filename</i>)
@@ -2198,6 +2370,34 @@
 tuple of (bool, str)
 </dd>
 </dl>
+<a NAME="BaseDevice.writeLanAutoConnect" ID="BaseDevice.writeLanAutoConnect"></a>
+<h4>BaseDevice.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 />
 </body></html>
\ No newline at end of file

eric ide

mercurial