--- a/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplSocket.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplSocket.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,39 +7,38 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.MicroPythonWebreplSocket</h1>
-
<p>
Module implementing a websocket class to be connect to the MicroPython webrepl
interface.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MicroPythonWebreplSocket">MicroPythonWebreplSocket</a></td>
<td>Class implementing a websocket client to be connected to the MicroPython webrepl interface.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MicroPythonWebreplSocket" ID="MicroPythonWebreplSocket"></a>
<h2>MicroPythonWebreplSocket</h2>
-
<p>
Class implementing a websocket client to be connected to the MicroPython webrepl
interface.
</p>
+
<h3>Signals</h3>
<dl>
@@ -51,19 +50,17 @@
<h3>Derived from</h3>
QWebSocket
<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="#MicroPythonWebreplSocket.__init__">MicroPythonWebreplSocket</a></td>
<td>Constructor</td>
@@ -117,19 +114,20 @@
<td>Public method write some text data to the webrepl server of the connected device.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MicroPythonWebreplSocket.__init__" ID="MicroPythonWebreplSocket.__init__"></a>
<h4>MicroPythonWebreplSocket (Constructor)</h4>
<b>MicroPythonWebreplSocket</b>(<i>timeout=10000, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>timeout</i> (int)</dt>
@@ -144,10 +142,10 @@
<a NAME="MicroPythonWebreplSocket.__textDataReceived" ID="MicroPythonWebreplSocket.__textDataReceived"></a>
<h4>MicroPythonWebreplSocket.__textDataReceived</h4>
<b>__textDataReceived</b>(<i>strMessage</i>)
-
<p>
Private slot handling a received text message.
</p>
+
<dl>
<dt><i>strMessage</i> (str)</dt>
@@ -158,10 +156,10 @@
<a NAME="MicroPythonWebreplSocket.connectToDevice" ID="MicroPythonWebreplSocket.connectToDevice"></a>
<h4>MicroPythonWebreplSocket.connectToDevice</h4>
<b>connectToDevice</b>(<i>host, port</i>)
-
<p>
Public method to connect to the given host and port.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -188,17 +186,17 @@
<a NAME="MicroPythonWebreplSocket.disconnect" ID="MicroPythonWebreplSocket.disconnect"></a>
<h4>MicroPythonWebreplSocket.disconnect</h4>
<b>disconnect</b>(<i></i>)
-
<p>
Public method to disconnect the websocket.
</p>
+
<a NAME="MicroPythonWebreplSocket.hasTimedOut" ID="MicroPythonWebreplSocket.hasTimedOut"></a>
<h4>MicroPythonWebreplSocket.hasTimedOut</h4>
<b>hasTimedOut</b>(<i></i>)
-
<p>
Public method to check, if the last 'readUntil()' has timed out.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -214,10 +212,10 @@
<a NAME="MicroPythonWebreplSocket.isConnected" ID="MicroPythonWebreplSocket.isConnected"></a>
<h4>MicroPythonWebreplSocket.isConnected</h4>
<b>isConnected</b>(<i></i>)
-
<p>
Public method to check the connected state of the websocket.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -233,10 +231,10 @@
<a NAME="MicroPythonWebreplSocket.login" ID="MicroPythonWebreplSocket.login"></a>
<h4>MicroPythonWebreplSocket.login</h4>
<b>login</b>(<i>password</i>)
-
<p>
Public method to login to the webrepl console of the device.
</p>
+
<dl>
<dt><i>password</i> (str)</dt>
@@ -259,10 +257,10 @@
<a NAME="MicroPythonWebreplSocket.readAll" ID="MicroPythonWebreplSocket.readAll"></a>
<h4>MicroPythonWebreplSocket.readAll</h4>
<b>readAll</b>(<i>timeout=0</i>)
-
<p>
Public method to read all available data.
</p>
+
<dl>
<dt><i>timeout</i> (int (optional))</dt>
@@ -286,11 +284,11 @@
<a NAME="MicroPythonWebreplSocket.readUntil" ID="MicroPythonWebreplSocket.readUntil"></a>
<h4>MicroPythonWebreplSocket.readUntil</h4>
<b>readUntil</b>(<i>expected=b"\n", size=None, timeout=0</i>)
-
<p>
Public method to read data until an expected sequence is found
(default: \n) or a specific size is exceeded.
</p>
+
<dl>
<dt><i>expected</i> (bytes)</dt>
@@ -322,10 +320,10 @@
<a NAME="MicroPythonWebreplSocket.setTimeout" ID="MicroPythonWebreplSocket.setTimeout"></a>
<h4>MicroPythonWebreplSocket.setTimeout</h4>
<b>setTimeout</b>(<i>timeout</i>)
-
<p>
Public method to set the socket timeout value.
</p>
+
<dl>
<dt><i>timeout</i> (int)</dt>
@@ -340,10 +338,10 @@
<a NAME="MicroPythonWebreplSocket.waitForConnected" ID="MicroPythonWebreplSocket.waitForConnected"></a>
<h4>MicroPythonWebreplSocket.waitForConnected</h4>
<b>waitForConnected</b>(<i></i>)
-
<p>
Public method to wait for the websocket being connected.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -359,11 +357,11 @@
<a NAME="MicroPythonWebreplSocket.writeTextMessage" ID="MicroPythonWebreplSocket.writeTextMessage"></a>
<h4>MicroPythonWebreplSocket.writeTextMessage</h4>
<b>writeTextMessage</b>(<i>data</i>)
-
<p>
Public method write some text data to the webrepl server of the connected
device.
</p>
+
<dl>
<dt><i>data</i> (bytes)</dt>
@@ -373,4 +371,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
