--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,58 +7,54 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.Devices.RP2040Devices</h1>
-
<p>
Module implementing the device interface class for RP2040 based boards
(e.g. Raspberry Pi Pico).
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#RP2040Device">RP2040Device</a></td>
<td>Class implementing the device for RP2040 based boards.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#createDevice">createDevice</a></td>
<td>Function to instantiate a MicroPython device object.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="RP2040Device" ID="RP2040Device"></a>
<h2>RP2040Device</h2>
-
<p>
Class implementing the device for RP2040 based boards.
</p>
+
<h3>Derived from</h3>
BaseDevice
<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="#RP2040Device.__init__">RP2040Device</a></td>
<td>Constructor</td>
@@ -284,19 +280,20 @@
<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>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="RP2040Device.__init__" ID="RP2040Device.__init__"></a>
<h4>RP2040Device (Constructor)</h4>
<b>RP2040Device</b>(<i>microPythonWidget, deviceType, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -315,24 +312,24 @@
<a NAME="RP2040Device.__activateBootloader" ID="RP2040Device.__activateBootloader"></a>
<h4>RP2040Device.__activateBootloader</h4>
<b>__activateBootloader</b>(<i></i>)
-
<p>
Private slot to switch the board into 'bootloader' mode.
</p>
+
<a NAME="RP2040Device.__createRP2040Menu" ID="RP2040Device.__createRP2040Menu"></a>
<h4>RP2040Device.__createRP2040Menu</h4>
<b>__createRP2040Menu</b>(<i></i>)
-
<p>
Private method to create the RP2040 submenu.
</p>
+
<a NAME="RP2040Device.__firmwareVersionResponse" ID="RP2040Device.__firmwareVersionResponse"></a>
<h4>RP2040Device.__firmwareVersionResponse</h4>
<b>__firmwareVersionResponse</b>(<i>reply</i>)
-
<p>
Private slot handling the response of the latest version request.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -343,14 +340,13 @@
<a NAME="RP2040Device.__flashPython" ID="RP2040Device.__flashPython"></a>
<h4>RP2040Device.__flashPython</h4>
<b>__flashPython</b>(<i></i>)
-
<p>
Private slot to flash a MicroPython firmware to the device.
</p>
+
<a NAME="RP2040Device.__resetCountry" ID="RP2040Device.__resetCountry"></a>
<h4>RP2040Device.__resetCountry</h4>
<b>__resetCountry</b>(<i></i>)
-
<p>
Private slot to reset the country of the connected ESP32 device.
</p>
@@ -358,35 +354,35 @@
The country is the two-letter ISO 3166-1 Alpha-2 country code. This method
resets it to the default code 'XX' representing the "worldwide" region.
</p>
+
<a NAME="RP2040Device.__resetDevice" ID="RP2040Device.__resetDevice"></a>
<h4>RP2040Device.__resetDevice</h4>
<b>__resetDevice</b>(<i></i>)
-
<p>
Private slot to reset the connected device.
</p>
+
<a NAME="RP2040Device.__setCountry" ID="RP2040Device.__setCountry"></a>
<h4>RP2040Device.__setCountry</h4>
<b>__setCountry</b>(<i></i>)
-
<p>
Private slot to configure the country of the connected RP2040 device.
</p>
<p>
The country is the two-letter ISO 3166-1 Alpha-2 country code.
</p>
+
<a NAME="RP2040Device.__showFirmwareVersions" ID="RP2040Device.__showFirmwareVersions"></a>
<h4>RP2040Device.__showFirmwareVersions</h4>
<b>__showFirmwareVersions</b>(<i></i>)
-
<p>
Private slot to show the firmware version of the connected device and the
available firmware version.
</p>
+
<a NAME="RP2040Device._getSetTimeCode" ID="RP2040Device._getSetTimeCode"></a>
<h4>RP2040Device._getSetTimeCode</h4>
<b>_getSetTimeCode</b>(<i></i>)
-
<p>
Protected method to get the device code to set the time.
</p>
@@ -394,6 +390,7 @@
Note: This method must be implemented in the various device specific
subclasses.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -409,10 +406,10 @@
<a NAME="RP2040Device.activateBluetoothInterface" ID="RP2040Device.activateBluetoothInterface"></a>
<h4>RP2040Device.activateBluetoothInterface</h4>
<b>activateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to activate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -435,10 +432,10 @@
<a NAME="RP2040Device.addDeviceMenuEntries" ID="RP2040Device.addDeviceMenuEntries"></a>
<h4>RP2040Device.addDeviceMenuEntries</h4>
<b>addDeviceMenuEntries</b>(<i>menu</i>)
-
<p>
Public method to add device specific entries to the given menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -449,10 +446,10 @@
<a NAME="RP2040Device.addDeviceWifiEntries" ID="RP2040Device.addDeviceWifiEntries"></a>
<h4>RP2040Device.addDeviceWifiEntries</h4>
<b>addDeviceWifiEntries</b>(<i>menu</i>)
-
<p>
Public method to add device specific entries to the given menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -463,10 +460,10 @@
<a NAME="RP2040Device.canRunScript" ID="RP2040Device.canRunScript"></a>
<h4>RP2040Device.canRunScript</h4>
<b>canRunScript</b>(<i></i>)
-
<p>
Public method to determine, if a script can be executed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -483,10 +480,10 @@
<a NAME="RP2040Device.canStartFileManager" ID="RP2040Device.canStartFileManager"></a>
<h4>RP2040Device.canStartFileManager</h4>
<b>canStartFileManager</b>(<i></i>)
-
<p>
Public method to determine, if a File Manager can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -503,10 +500,10 @@
<a NAME="RP2040Device.canStartPlotter" ID="RP2040Device.canStartPlotter"></a>
<h4>RP2040Device.canStartPlotter</h4>
<b>canStartPlotter</b>(<i></i>)
-
<p>
Public method to determine, if a Plotter can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -523,10 +520,10 @@
<a NAME="RP2040Device.canStartRepl" ID="RP2040Device.canStartRepl"></a>
<h4>RP2040Device.canStartRepl</h4>
<b>canStartRepl</b>(<i></i>)
-
<p>
Public method to determine, if a REPL can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -543,10 +540,10 @@
<a NAME="RP2040Device.checkInternet" ID="RP2040Device.checkInternet"></a>
<h4>RP2040Device.checkInternet</h4>
<b>checkInternet</b>(<i></i>)
-
<p>
Public method to check, if the internet can be reached.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -562,10 +559,10 @@
<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>
@@ -581,10 +578,10 @@
<a NAME="RP2040Device.connectToLan" ID="RP2040Device.connectToLan"></a>
<h4>RP2040Device.connectToLan</h4>
<b>connectToLan</b>(<i>config, hostname</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>
@@ -612,10 +609,10 @@
<a NAME="RP2040Device.connectWifi" ID="RP2040Device.connectWifi"></a>
<h4>RP2040Device.connectWifi</h4>
<b>connectWifi</b>(<i>ssid, password, hostname</i>)
-
<p>
Public method to connect a device to a WiFi network.
</p>
+
<dl>
<dt><i>ssid</i> (str)</dt>
@@ -646,10 +643,10 @@
<a NAME="RP2040Device.deactivateBluetoothInterface" ID="RP2040Device.deactivateBluetoothInterface"></a>
<h4>RP2040Device.deactivateBluetoothInterface</h4>
<b>deactivateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to deactivate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -672,10 +669,10 @@
<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>
@@ -691,10 +688,10 @@
<a NAME="RP2040Device.deactivateInterface" ID="RP2040Device.deactivateInterface"></a>
<h4>RP2040Device.deactivateInterface</h4>
<b>deactivateInterface</b>(<i>interface</i>)
-
<p>
Public method to deactivate a given WiFi interface of the connected device.
</p>
+
<dl>
<dt><i>interface</i> (str)</dt>
@@ -725,10 +722,10 @@
<a NAME="RP2040Device.deviceName" ID="RP2040Device.deviceName"></a>
<h4>RP2040Device.deviceName</h4>
<b>deviceName</b>(<i></i>)
-
<p>
Public method to get the name of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -744,11 +741,11 @@
<a NAME="RP2040Device.disableWebrepl" ID="RP2040Device.disableWebrepl"></a>
<h4>RP2040Device.disableWebrepl</h4>
<b>disableWebrepl</b>(<i></i>)
-
<p>
Public method to write the given WebREPL password to the connected device and
modify the start script to start the WebREPL server.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -764,10 +761,10 @@
<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>
@@ -783,10 +780,10 @@
<a NAME="RP2040Device.disconnectWifi" ID="RP2040Device.disconnectWifi"></a>
<h4>RP2040Device.disconnectWifi</h4>
<b>disconnectWifi</b>(<i></i>)
-
<p>
Public method to disconnect a device from the WiFi network.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -802,11 +799,11 @@
<a NAME="RP2040Device.enableWebrepl" ID="RP2040Device.enableWebrepl"></a>
<h4>RP2040Device.enableWebrepl</h4>
<b>enableWebrepl</b>(<i>password</i>)
-
<p>
Public method to write the given WebREPL password to the connected device and
modify the start script to start the WebREPL server.
</p>
+
<dl>
<dt><i>password</i> (str)</dt>
@@ -829,11 +826,11 @@
<a NAME="RP2040Device.forceInterrupt" ID="RP2040Device.forceInterrupt"></a>
<h4>RP2040Device.forceInterrupt</h4>
<b>forceInterrupt</b>(<i></i>)
-
<p>
Public method to determine the need for an interrupt when opening the
serial connection.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -849,10 +846,10 @@
<a NAME="RP2040Device.getBluetoothStatus" ID="RP2040Device.getBluetoothStatus"></a>
<h4>RP2040Device.getBluetoothStatus</h4>
<b>getBluetoothStatus</b>(<i></i>)
-
<p>
Public method to get Bluetooth status data of the connected board.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -876,10 +873,10 @@
<a NAME="RP2040Device.getConnectedClients" ID="RP2040Device.getConnectedClients"></a>
<h4>RP2040Device.getConnectedClients</h4>
<b>getConnectedClients</b>(<i></i>)
-
<p>
Public method to get a list of connected clients.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -896,10 +893,10 @@
<a NAME="RP2040Device.getDeviceScan" ID="RP2040Device.getDeviceScan"></a>
<h4>RP2040Device.getDeviceScan</h4>
<b>getDeviceScan</b>(<i>timeout=10</i>)
-
<p>
Public method to perform a Bluetooth device scan.
</p>
+
<dl>
<dt><i>timeout</i> (int (optional))</dt>
@@ -924,10 +921,10 @@
<a NAME="RP2040Device.getDocumentationUrl" ID="RP2040Device.getDocumentationUrl"></a>
<h4>RP2040Device.getDocumentationUrl</h4>
<b>getDocumentationUrl</b>(<i></i>)
-
<p>
Public method to get the device documentation URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -943,10 +940,10 @@
<a NAME="RP2040Device.getDownloadMenuEntries" ID="RP2040Device.getDownloadMenuEntries"></a>
<h4>RP2040Device.getDownloadMenuEntries</h4>
<b>getDownloadMenuEntries</b>(<i></i>)
-
<p>
Public method to retrieve the entries for the downloads menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -963,10 +960,10 @@
<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>
@@ -990,10 +987,10 @@
<a NAME="RP2040Device.getWifiData" ID="RP2040Device.getWifiData"></a>
<h4>RP2040Device.getWifiData</h4>
<b>getWifiData</b>(<i></i>)
-
<p>
Public method to get data related to the current WiFi status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1017,10 +1014,10 @@
<a NAME="RP2040Device.hasBluetooth" ID="RP2040Device.hasBluetooth"></a>
<h4>RP2040Device.hasBluetooth</h4>
<b>hasBluetooth</b>(<i></i>)
-
<p>
Public method to check the availability of Bluetooth.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1043,10 +1040,10 @@
<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>
@@ -1070,10 +1067,10 @@
<a NAME="RP2040Device.hasFlashMenuEntry" ID="RP2040Device.hasFlashMenuEntry"></a>
<h4>RP2040Device.hasFlashMenuEntry</h4>
<b>hasFlashMenuEntry</b>(<i></i>)
-
<p>
Public method to check, if the device has its own flash menu entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1089,10 +1086,10 @@
<a NAME="RP2040Device.hasNetworkTime" ID="RP2040Device.hasNetworkTime"></a>
<h4>RP2040Device.hasNetworkTime</h4>
<b>hasNetworkTime</b>(<i></i>)
-
<p>
Public method to check the availability of network time functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1115,10 +1112,10 @@
<a NAME="RP2040Device.hasWifi" ID="RP2040Device.hasWifi"></a>
<h4>RP2040Device.hasWifi</h4>
<b>hasWifi</b>(<i></i>)
-
<p>
Public method to check the availability of WiFi.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1142,10 +1139,10 @@
<a NAME="RP2040Device.hasWifiCountry" ID="RP2040Device.hasWifiCountry"></a>
<h4>RP2040Device.hasWifiCountry</h4>
<b>hasWifiCountry</b>(<i></i>)
-
<p>
Public method to check, if the device has support to set the WiFi country.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1161,10 +1158,10 @@
<a NAME="RP2040Device.isLanConnected" ID="RP2040Device.isLanConnected"></a>
<h4>RP2040Device.isLanConnected</h4>
<b>isLanConnected</b>(<i></i>)
-
<p>
Public method to check the LAN connection status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1180,10 +1177,10 @@
<a NAME="RP2040Device.isWifiApConnected" ID="RP2040Device.isWifiApConnected"></a>
<h4>RP2040Device.isWifiApConnected</h4>
<b>isWifiApConnected</b>(<i></i>)
-
<p>
Public method to check the WiFi connection status as access point.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1199,10 +1196,10 @@
<a NAME="RP2040Device.isWifiClientConnected" ID="RP2040Device.isWifiClientConnected"></a>
<h4>RP2040Device.isWifiClientConnected</h4>
<b>isWifiClientConnected</b>(<i></i>)
-
<p>
Public method to check the WiFi connection status as client.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1218,10 +1215,10 @@
<a NAME="RP2040Device.removeCredentials" ID="RP2040Device.removeCredentials"></a>
<h4>RP2040Device.removeCredentials</h4>
<b>removeCredentials</b>(<i></i>)
-
<p>
Public method to remove the saved credentials from the connected device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1237,13 +1234,13 @@
<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>
@@ -1259,10 +1256,10 @@
<a NAME="RP2040Device.runScript" ID="RP2040Device.runScript"></a>
<h4>RP2040Device.runScript</h4>
<b>runScript</b>(<i>script</i>)
-
<p>
Public method to run the given Python script.
</p>
+
<dl>
<dt><i>script</i> (str)</dt>
@@ -1273,10 +1270,10 @@
<a NAME="RP2040Device.scanNetworks" ID="RP2040Device.scanNetworks"></a>
<h4>RP2040Device.scanNetworks</h4>
<b>scanNetworks</b>(<i></i>)
-
<p>
Public method to scan for available WiFi networks.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1293,18 +1290,18 @@
<a NAME="RP2040Device.setButtons" ID="RP2040Device.setButtons"></a>
<h4>RP2040Device.setButtons</h4>
<b>setButtons</b>(<i></i>)
-
<p>
Public method to enable the supported action buttons.
</p>
+
<a NAME="RP2040Device.setNetworkTime" ID="RP2040Device.setNetworkTime"></a>
<h4>RP2040Device.setNetworkTime</h4>
<b>setNetworkTime</b>(<i>server="pool.ntp.org", tzOffset=0, timeout=10</i>)
-
<p>
Public method to set the time to the network time retrieved from an
NTP server.
</p>
+
<dl>
<dt><i>server</i> (str (optional))</dt>
@@ -1337,10 +1334,10 @@
<a NAME="RP2040Device.startAccessPoint" ID="RP2040Device.startAccessPoint"></a>
<h4>RP2040Device.startAccessPoint</h4>
<b>startAccessPoint</b>(<i>ssid, security=None, password=None, hostname=None, ifconfig=None, </i>)
-
<p>
Public method to start the access point interface.
</p>
+
<dl>
<dt><i>ssid</i> (str)</dt>
@@ -1380,10 +1377,10 @@
<a NAME="RP2040Device.stopAccessPoint" ID="RP2040Device.stopAccessPoint"></a>
<h4>RP2040Device.stopAccessPoint</h4>
<b>stopAccessPoint</b>(<i></i>)
-
<p>
Public method to stop the access point interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1399,11 +1396,11 @@
<a NAME="RP2040Device.writeCredentials" ID="RP2040Device.writeCredentials"></a>
<h4>RP2040Device.writeCredentials</h4>
<b>writeCredentials</b>(<i>ssid, password, hostname, country</i>)
-
<p>
Public method to write the given credentials to the connected device and modify
the start script to connect automatically.
</p>
+
<dl>
<dt><i>ssid</i> (str)</dt>
@@ -1438,11 +1435,11 @@
<a NAME="RP2040Device.writeLanAutoConnect" ID="RP2040Device.writeLanAutoConnect"></a>
<h4>RP2040Device.writeLanAutoConnect</h4>
<b>writeLanAutoConnect</b>(<i>config, hostname</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>
@@ -1473,10 +1470,10 @@
<a NAME="createDevice" ID="createDevice"></a>
<h2>createDevice</h2>
<b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName, serialNumber</i>)
-
<p>
Function to instantiate a MicroPython device object.
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -1518,4 +1515,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
