diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,29 +7,26 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.Devices.EspDevices</h1>
-
<p>
Module implementing the device interface class for ESP32 and ESP8266 based
boards.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EspDevice">EspDevice</a></td>
<td>Class implementing the device for ESP32 and ESP8266 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>
@@ -47,30 +44,29 @@
<td>Slot to flash a MicroPython firmware to the device.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="EspDevice" ID="EspDevice"></a>
<h2>EspDevice</h2>
-
<p>
Class implementing the device for ESP32 and ESP8266 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="#EspDevice.__init__">EspDevice</a></td>
<td>Constructor</td>
@@ -296,19 +292,20 @@
<td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EspDevice.__init__" ID="EspDevice.__init__"></a>
<h4>EspDevice (Constructor)</h4>
<b>EspDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -327,38 +324,38 @@
<a NAME="EspDevice.__backupFlash" ID="EspDevice.__backupFlash"></a>
<h4>EspDevice.__backupFlash</h4>
<b>__backupFlash</b>(<i></i>)
-
<p>
Private slot to backup the currently flashed firmware.
</p>
+
<a NAME="EspDevice.__createCpyDevice" ID="EspDevice.__createCpyDevice"></a>
<h4>EspDevice.__createCpyDevice</h4>
<b>__createCpyDevice</b>(<i></i>)
-
<p>
Private method to create a CircuitPython device interface.
</p>
+
<a NAME="EspDevice.__createEsp32Submenu" ID="EspDevice.__createEsp32Submenu"></a>
<h4>EspDevice.__createEsp32Submenu</h4>
<b>__createEsp32Submenu</b>(<i></i>)
-
<p>
Private method to create the ESP32 submenu.
</p>
+
<a NAME="EspDevice.__eraseFlash" ID="EspDevice.__eraseFlash"></a>
<h4>EspDevice.__eraseFlash</h4>
<b>__eraseFlash</b>(<i></i>)
-
<p>
Private slot to erase the device flash memory.
</p>
+
<a NAME="EspDevice.__firmwareVersionResponse" ID="EspDevice.__firmwareVersionResponse"></a>
<h4>EspDevice.__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>
@@ -369,28 +366,27 @@
<a NAME="EspDevice.__flashAddons" ID="EspDevice.__flashAddons"></a>
<h4>EspDevice.__flashAddons</h4>
<b>__flashAddons</b>(<i></i>)
-
<p>
Private slot to flash some additional firmware images.
</p>
+
<a NAME="EspDevice.__flashMicroPython" ID="EspDevice.__flashMicroPython"></a>
<h4>EspDevice.__flashMicroPython</h4>
<b>__flashMicroPython</b>(<i></i>)
-
<p>
Private slot to flash a MicroPython firmware to the device.
</p>
+
<a NAME="EspDevice.__installEspTool" ID="EspDevice.__installEspTool"></a>
<h4>EspDevice.__installEspTool</h4>
<b>__installEspTool</b>(<i></i>)
-
<p>
Private slot to install the esptool package via pip.
</p>
+
<a NAME="EspDevice.__resetCountry" ID="EspDevice.__resetCountry"></a>
<h4>EspDevice.__resetCountry</h4>
<b>__resetCountry</b>(<i></i>)
-
<p>
Private slot to reset the country of the connected ESP32 device.
</p>
@@ -398,63 +394,63 @@
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="EspDevice.__resetDevice" ID="EspDevice.__resetDevice"></a>
<h4>EspDevice.__resetDevice</h4>
<b>__resetDevice</b>(<i></i>)
-
<p>
Private slot to reset the connected device.
</p>
+
<a NAME="EspDevice.__restoreFlash" ID="EspDevice.__restoreFlash"></a>
<h4>EspDevice.__restoreFlash</h4>
<b>__restoreFlash</b>(<i></i>)
-
<p>
Private slot to restore a previously saved firmware.
</p>
+
<a NAME="EspDevice.__setCountry" ID="EspDevice.__setCountry"></a>
<h4>EspDevice.__setCountry</h4>
<b>__setCountry</b>(<i></i>)
-
<p>
Private slot to configure the country of the connected ESP32 device.
</p>
<p>
The country is the two-letter ISO 3166-1 Alpha-2 country code.
</p>
+
<a NAME="EspDevice.__showChipID" ID="EspDevice.__showChipID"></a>
<h4>EspDevice.__showChipID</h4>
<b>__showChipID</b>(<i></i>)
-
<p>
Private slot to show the ID of the ESP chip.
</p>
+
<a NAME="EspDevice.__showFirmwareVersions" ID="EspDevice.__showFirmwareVersions"></a>
<h4>EspDevice.__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="EspDevice.__showFlashID" ID="EspDevice.__showFlashID"></a>
<h4>EspDevice.__showFlashID</h4>
<b>__showFlashID</b>(<i></i>)
-
<p>
Private slot to show the ID of the ESP flash chip.
</p>
+
<a NAME="EspDevice.__showMACAddress" ID="EspDevice.__showMACAddress"></a>
<h4>EspDevice.__showMACAddress</h4>
<b>__showMACAddress</b>(<i></i>)
-
<p>
Private slot to show the MAC address of the ESP chip.
</p>
+
<a NAME="EspDevice._getSetTimeCode" ID="EspDevice._getSetTimeCode"></a>
<h4>EspDevice._getSetTimeCode</h4>
<b>_getSetTimeCode</b>(<i></i>)
-
<p>
Protected method to get the device code to set the time.
</p>
@@ -462,6 +458,7 @@
Note: This method must be implemented in the various device specific
subclasses.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -477,10 +474,10 @@
<a NAME="EspDevice.activateBluetoothInterface" ID="EspDevice.activateBluetoothInterface"></a>
<h4>EspDevice.activateBluetoothInterface</h4>
<b>activateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to activate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -503,10 +500,10 @@
<a NAME="EspDevice.addDeviceMenuEntries" ID="EspDevice.addDeviceMenuEntries"></a>
<h4>EspDevice.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>
@@ -517,10 +514,10 @@
<a NAME="EspDevice.addDeviceWifiEntries" ID="EspDevice.addDeviceWifiEntries"></a>
<h4>EspDevice.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>
@@ -531,10 +528,10 @@
<a NAME="EspDevice.canRunScript" ID="EspDevice.canRunScript"></a>
<h4>EspDevice.canRunScript</h4>
<b>canRunScript</b>(<i></i>)
-
<p>
Public method to determine, if a script can be executed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -551,10 +548,10 @@
<a NAME="EspDevice.canStartFileManager" ID="EspDevice.canStartFileManager"></a>
<h4>EspDevice.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>
@@ -571,10 +568,10 @@
<a NAME="EspDevice.canStartPlotter" ID="EspDevice.canStartPlotter"></a>
<h4>EspDevice.canStartPlotter</h4>
<b>canStartPlotter</b>(<i></i>)
-
<p>
Public method to determine, if a Plotter can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -591,10 +588,10 @@
<a NAME="EspDevice.canStartRepl" ID="EspDevice.canStartRepl"></a>
<h4>EspDevice.canStartRepl</h4>
<b>canStartRepl</b>(<i></i>)
-
<p>
Public method to determine, if a REPL can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -611,10 +608,10 @@
<a NAME="EspDevice.checkInternet" ID="EspDevice.checkInternet"></a>
<h4>EspDevice.checkInternet</h4>
<b>checkInternet</b>(<i></i>)
-
<p>
Public method to check, if the internet can be reached.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -630,10 +627,10 @@
<a NAME="EspDevice.connectWifi" ID="EspDevice.connectWifi"></a>
<h4>EspDevice.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>
@@ -664,10 +661,10 @@
<a NAME="EspDevice.deactivateBluetoothInterface" ID="EspDevice.deactivateBluetoothInterface"></a>
<h4>EspDevice.deactivateBluetoothInterface</h4>
<b>deactivateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to deactivate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -690,10 +687,10 @@
<a NAME="EspDevice.deactivateInterface" ID="EspDevice.deactivateInterface"></a>
<h4>EspDevice.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>
@@ -724,10 +721,10 @@
<a NAME="EspDevice.deviceName" ID="EspDevice.deviceName"></a>
<h4>EspDevice.deviceName</h4>
<b>deviceName</b>(<i></i>)
-
<p>
Public method to get the name of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -743,11 +740,11 @@
<a NAME="EspDevice.disableWebrepl" ID="EspDevice.disableWebrepl"></a>
<h4>EspDevice.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>
@@ -763,10 +760,10 @@
<a NAME="EspDevice.disconnectWifi" ID="EspDevice.disconnectWifi"></a>
<h4>EspDevice.disconnectWifi</h4>
<b>disconnectWifi</b>(<i></i>)
-
<p>
Public method to disconnect a device from the WiFi network.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -782,11 +779,11 @@
<a NAME="EspDevice.enableWebrepl" ID="EspDevice.enableWebrepl"></a>
<h4>EspDevice.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>
@@ -809,11 +806,11 @@
<a NAME="EspDevice.forceInterrupt" ID="EspDevice.forceInterrupt"></a>
<h4>EspDevice.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>
@@ -829,10 +826,10 @@
<a NAME="EspDevice.getBluetoothStatus" ID="EspDevice.getBluetoothStatus"></a>
<h4>EspDevice.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>
@@ -856,10 +853,10 @@
<a NAME="EspDevice.getConnectedClients" ID="EspDevice.getConnectedClients"></a>
<h4>EspDevice.getConnectedClients</h4>
<b>getConnectedClients</b>(<i></i>)
-
<p>
Public method to get a list of connected clients.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -876,10 +873,10 @@
<a NAME="EspDevice.getDeviceScan" ID="EspDevice.getDeviceScan"></a>
<h4>EspDevice.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>
@@ -904,10 +901,10 @@
<a NAME="EspDevice.getDocumentationUrl" ID="EspDevice.getDocumentationUrl"></a>
<h4>EspDevice.getDocumentationUrl</h4>
<b>getDocumentationUrl</b>(<i></i>)
-
<p>
Public method to get the device documentation URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -923,10 +920,10 @@
<a NAME="EspDevice.getFirmwareUrl" ID="EspDevice.getFirmwareUrl"></a>
<h4>EspDevice.getFirmwareUrl</h4>
<b>getFirmwareUrl</b>(<i></i>)
-
<p>
Public method to get the device firmware download URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -942,10 +939,10 @@
<a NAME="EspDevice.getWifiData" ID="EspDevice.getWifiData"></a>
<h4>EspDevice.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>
@@ -969,10 +966,10 @@
<a NAME="EspDevice.hasBluetooth" ID="EspDevice.hasBluetooth"></a>
<h4>EspDevice.hasBluetooth</h4>
<b>hasBluetooth</b>(<i></i>)
-
<p>
Public method to check the availability of Bluetooth.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -995,10 +992,10 @@
<a NAME="EspDevice.hasFlashMenuEntry" ID="EspDevice.hasFlashMenuEntry"></a>
<h4>EspDevice.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>
@@ -1014,10 +1011,10 @@
<a NAME="EspDevice.hasNetworkTime" ID="EspDevice.hasNetworkTime"></a>
<h4>EspDevice.hasNetworkTime</h4>
<b>hasNetworkTime</b>(<i></i>)
-
<p>
Public method to check the availability of network time functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1040,10 +1037,10 @@
<a NAME="EspDevice.hasWifi" ID="EspDevice.hasWifi"></a>
<h4>EspDevice.hasWifi</h4>
<b>hasWifi</b>(<i></i>)
-
<p>
Public method to check the availability of WiFi.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1060,10 +1057,10 @@
<a NAME="EspDevice.hasWifiCountry" ID="EspDevice.hasWifiCountry"></a>
<h4>EspDevice.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>
@@ -1079,10 +1076,10 @@
<a NAME="EspDevice.isWifiApConnected" ID="EspDevice.isWifiApConnected"></a>
<h4>EspDevice.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>
@@ -1098,10 +1095,10 @@
<a NAME="EspDevice.isWifiClientConnected" ID="EspDevice.isWifiClientConnected"></a>
<h4>EspDevice.isWifiClientConnected</h4>
<b>isWifiClientConnected</b>(<i></i>)
-
<p>
Public method to check the WiFi connection status as client.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1117,10 +1114,10 @@
<a NAME="EspDevice.removeCredentials" ID="EspDevice.removeCredentials"></a>
<h4>EspDevice.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>
@@ -1136,10 +1133,10 @@
<a NAME="EspDevice.runScript" ID="EspDevice.runScript"></a>
<h4>EspDevice.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>
@@ -1150,10 +1147,10 @@
<a NAME="EspDevice.scanNetworks" ID="EspDevice.scanNetworks"></a>
<h4>EspDevice.scanNetworks</h4>
<b>scanNetworks</b>(<i></i>)
-
<p>
Public method to scan for available WiFi networks.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1170,14 +1167,13 @@
<a NAME="EspDevice.setButtons" ID="EspDevice.setButtons"></a>
<h4>EspDevice.setButtons</h4>
<b>setButtons</b>(<i></i>)
-
<p>
Public method to enable the supported action buttons.
</p>
+
<a NAME="EspDevice.setConnected" ID="EspDevice.setConnected"></a>
<h4>EspDevice.setConnected</h4>
<b>setConnected</b>(<i>connected</i>)
-
<p>
Public method to set the connection state.
</p>
@@ -1185,6 +1181,7 @@
Note: This method can be overwritten to perform actions upon connect
or disconnect of the device.
</p>
+
<dl>
<dt><i>connected</i> (bool)</dt>
@@ -1195,11 +1192,11 @@
<a NAME="EspDevice.setNetworkTime" ID="EspDevice.setNetworkTime"></a>
<h4>EspDevice.setNetworkTime</h4>
<b>setNetworkTime</b>(<i>server="0.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>
@@ -1232,10 +1229,10 @@
<a NAME="EspDevice.startAccessPoint" ID="EspDevice.startAccessPoint"></a>
<h4>EspDevice.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>
@@ -1275,10 +1272,10 @@
<a NAME="EspDevice.stopAccessPoint" ID="EspDevice.stopAccessPoint"></a>
<h4>EspDevice.stopAccessPoint</h4>
<b>stopAccessPoint</b>(<i></i>)
-
<p>
Public method to stop the access point interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1294,11 +1291,11 @@
<a NAME="EspDevice.writeCredentials" ID="EspDevice.writeCredentials"></a>
<h4>EspDevice.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>
@@ -1336,10 +1333,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>
@@ -1385,10 +1382,10 @@
<a NAME="eraseFlash" ID="eraseFlash"></a>
<h2>eraseFlash</h2>
<b>eraseFlash</b>(<i>port</i>)
-
<p>
Slot to erase the device flash memory.
</p>
+
<dl>
<dt><i>port</i> (str)</dt>
@@ -1402,10 +1399,10 @@
<a NAME="flashAddonFirmware" ID="flashAddonFirmware"></a>
<h2>flashAddonFirmware</h2>
<b>flashAddonFirmware</b>(<i>port</i>)
-
<p>
Slot to flash some additional firmware images.
</p>
+
<dl>
<dt><i>port</i> (str)</dt>
@@ -1419,10 +1416,10 @@
<a NAME="flashPythonFirmware" ID="flashPythonFirmware"></a>
<h2>flashPythonFirmware</h2>
<b>flashPythonFirmware</b>(<i>port</i>)
-
<p>
Slot to flash a MicroPython firmware to the device.
</p>
+
<dl>
<dt><i>port</i> (str)</dt>
@@ -1432,4 +1429,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
