Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplSocket.html

src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonWebreplSocket.html

branch
eric7
changeset 10479
856476537696
parent 10428
a071d4065202
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.MicroPythonWebreplSocket</h1> 9 <h1>eric7.MicroPython.MicroPythonWebreplSocket</h1>
10
11 <p> 10 <p>
12 Module implementing a websocket class to be connect to the MicroPython webrepl 11 Module implementing a websocket class to be connect to the MicroPython webrepl
13 interface. 12 interface.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16 16 <table>
17 <table> 17 <tr><td>None</td></tr>
18 <tr><td>None</td></tr> 18 </table>
19 </table> 19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#MicroPythonWebreplSocket">MicroPythonWebreplSocket</a></td> 23 <td><a href="#MicroPythonWebreplSocket">MicroPythonWebreplSocket</a></td>
26 <td>Class implementing a websocket client to be connected to the MicroPython webrepl interface.</td> 24 <td>Class implementing a websocket client to be connected to the MicroPython webrepl interface.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30 29 <table>
31 <table> 30 <tr><td>None</td></tr>
32 <tr><td>None</td></tr> 31 </table>
33 </table> 32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="MicroPythonWebreplSocket" ID="MicroPythonWebreplSocket"></a> 35 <a NAME="MicroPythonWebreplSocket" ID="MicroPythonWebreplSocket"></a>
37 <h2>MicroPythonWebreplSocket</h2> 36 <h2>MicroPythonWebreplSocket</h2>
38
39 <p> 37 <p>
40 Class implementing a websocket client to be connected to the MicroPython webrepl 38 Class implementing a websocket client to be connected to the MicroPython webrepl
41 interface. 39 interface.
42 </p> 40 </p>
41
43 <h3>Signals</h3> 42 <h3>Signals</h3>
44 <dl> 43 <dl>
45 44
46 <dt>readyRead()</dt> 45 <dt>readyRead()</dt>
47 <dd> 46 <dd>
49 </dd> 48 </dd>
50 </dl> 49 </dl>
51 <h3>Derived from</h3> 50 <h3>Derived from</h3>
52 QWebSocket 51 QWebSocket
53 <h3>Class Attributes</h3> 52 <h3>Class Attributes</h3>
54 53 <table>
55 <table> 54 <tr><td>None</td></tr>
56 <tr><td>None</td></tr> 55 </table>
57 </table> 56
58 <h3>Class Methods</h3> 57 <h3>Class Methods</h3>
59 58 <table>
60 <table> 59 <tr><td>None</td></tr>
61 <tr><td>None</td></tr> 60 </table>
62 </table> 61
63 <h3>Methods</h3> 62 <h3>Methods</h3>
64 63 <table>
65 <table>
66
67 <tr> 64 <tr>
68 <td><a href="#MicroPythonWebreplSocket.__init__">MicroPythonWebreplSocket</a></td> 65 <td><a href="#MicroPythonWebreplSocket.__init__">MicroPythonWebreplSocket</a></td>
69 <td>Constructor</td> 66 <td>Constructor</td>
70 </tr> 67 </tr>
71 <tr> 68 <tr>
115 <tr> 112 <tr>
116 <td><a href="#MicroPythonWebreplSocket.writeTextMessage">writeTextMessage</a></td> 113 <td><a href="#MicroPythonWebreplSocket.writeTextMessage">writeTextMessage</a></td>
117 <td>Public method write some text data to the webrepl server of the connected device.</td> 114 <td>Public method write some text data to the webrepl server of the connected device.</td>
118 </tr> 115 </tr>
119 </table> 116 </table>
117
120 <h3>Static Methods</h3> 118 <h3>Static Methods</h3>
121 119 <table>
122 <table> 120 <tr><td>None</td></tr>
123 <tr><td>None</td></tr> 121 </table>
124 </table> 122
125 123
126 <a NAME="MicroPythonWebreplSocket.__init__" ID="MicroPythonWebreplSocket.__init__"></a> 124 <a NAME="MicroPythonWebreplSocket.__init__" ID="MicroPythonWebreplSocket.__init__"></a>
127 <h4>MicroPythonWebreplSocket (Constructor)</h4> 125 <h4>MicroPythonWebreplSocket (Constructor)</h4>
128 <b>MicroPythonWebreplSocket</b>(<i>timeout=10000, parent=None</i>) 126 <b>MicroPythonWebreplSocket</b>(<i>timeout=10000, parent=None</i>)
129
130 <p> 127 <p>
131 Constructor 128 Constructor
132 </p> 129 </p>
130
133 <dl> 131 <dl>
134 132
135 <dt><i>timeout</i> (int)</dt> 133 <dt><i>timeout</i> (int)</dt>
136 <dd> 134 <dd>
137 timout in milliseconds to be set 135 timout in milliseconds to be set
142 </dd> 140 </dd>
143 </dl> 141 </dl>
144 <a NAME="MicroPythonWebreplSocket.__textDataReceived" ID="MicroPythonWebreplSocket.__textDataReceived"></a> 142 <a NAME="MicroPythonWebreplSocket.__textDataReceived" ID="MicroPythonWebreplSocket.__textDataReceived"></a>
145 <h4>MicroPythonWebreplSocket.__textDataReceived</h4> 143 <h4>MicroPythonWebreplSocket.__textDataReceived</h4>
146 <b>__textDataReceived</b>(<i>strMessage</i>) 144 <b>__textDataReceived</b>(<i>strMessage</i>)
147
148 <p> 145 <p>
149 Private slot handling a received text message. 146 Private slot handling a received text message.
150 </p> 147 </p>
148
151 <dl> 149 <dl>
152 150
153 <dt><i>strMessage</i> (str)</dt> 151 <dt><i>strMessage</i> (str)</dt>
154 <dd> 152 <dd>
155 received text message 153 received text message
156 </dd> 154 </dd>
157 </dl> 155 </dl>
158 <a NAME="MicroPythonWebreplSocket.connectToDevice" ID="MicroPythonWebreplSocket.connectToDevice"></a> 156 <a NAME="MicroPythonWebreplSocket.connectToDevice" ID="MicroPythonWebreplSocket.connectToDevice"></a>
159 <h4>MicroPythonWebreplSocket.connectToDevice</h4> 157 <h4>MicroPythonWebreplSocket.connectToDevice</h4>
160 <b>connectToDevice</b>(<i>host, port</i>) 158 <b>connectToDevice</b>(<i>host, port</i>)
161
162 <p> 159 <p>
163 Public method to connect to the given host and port. 160 Public method to connect to the given host and port.
164 </p> 161 </p>
162
165 <dl> 163 <dl>
166 164
167 <dt><i>host</i> (str)</dt> 165 <dt><i>host</i> (str)</dt>
168 <dd> 166 <dd>
169 host name or IP address 167 host name or IP address
186 </dd> 184 </dd>
187 </dl> 185 </dl>
188 <a NAME="MicroPythonWebreplSocket.disconnect" ID="MicroPythonWebreplSocket.disconnect"></a> 186 <a NAME="MicroPythonWebreplSocket.disconnect" ID="MicroPythonWebreplSocket.disconnect"></a>
189 <h4>MicroPythonWebreplSocket.disconnect</h4> 187 <h4>MicroPythonWebreplSocket.disconnect</h4>
190 <b>disconnect</b>(<i></i>) 188 <b>disconnect</b>(<i></i>)
191
192 <p> 189 <p>
193 Public method to disconnect the websocket. 190 Public method to disconnect the websocket.
194 </p> 191 </p>
192
195 <a NAME="MicroPythonWebreplSocket.hasTimedOut" ID="MicroPythonWebreplSocket.hasTimedOut"></a> 193 <a NAME="MicroPythonWebreplSocket.hasTimedOut" ID="MicroPythonWebreplSocket.hasTimedOut"></a>
196 <h4>MicroPythonWebreplSocket.hasTimedOut</h4> 194 <h4>MicroPythonWebreplSocket.hasTimedOut</h4>
197 <b>hasTimedOut</b>(<i></i>) 195 <b>hasTimedOut</b>(<i></i>)
198
199 <p> 196 <p>
200 Public method to check, if the last 'readUntil()' has timed out. 197 Public method to check, if the last 'readUntil()' has timed out.
201 </p> 198 </p>
199
202 <dl> 200 <dl>
203 <dt>Return:</dt> 201 <dt>Return:</dt>
204 <dd> 202 <dd>
205 flag indicating a timeout 203 flag indicating a timeout
206 </dd> 204 </dd>
212 </dd> 210 </dd>
213 </dl> 211 </dl>
214 <a NAME="MicroPythonWebreplSocket.isConnected" ID="MicroPythonWebreplSocket.isConnected"></a> 212 <a NAME="MicroPythonWebreplSocket.isConnected" ID="MicroPythonWebreplSocket.isConnected"></a>
215 <h4>MicroPythonWebreplSocket.isConnected</h4> 213 <h4>MicroPythonWebreplSocket.isConnected</h4>
216 <b>isConnected</b>(<i></i>) 214 <b>isConnected</b>(<i></i>)
217
218 <p> 215 <p>
219 Public method to check the connected state of the websocket. 216 Public method to check the connected state of the websocket.
220 </p> 217 </p>
218
221 <dl> 219 <dl>
222 <dt>Return:</dt> 220 <dt>Return:</dt>
223 <dd> 221 <dd>
224 flag indicating the connected state 222 flag indicating the connected state
225 </dd> 223 </dd>
231 </dd> 229 </dd>
232 </dl> 230 </dl>
233 <a NAME="MicroPythonWebreplSocket.login" ID="MicroPythonWebreplSocket.login"></a> 231 <a NAME="MicroPythonWebreplSocket.login" ID="MicroPythonWebreplSocket.login"></a>
234 <h4>MicroPythonWebreplSocket.login</h4> 232 <h4>MicroPythonWebreplSocket.login</h4>
235 <b>login</b>(<i>password</i>) 233 <b>login</b>(<i>password</i>)
236
237 <p> 234 <p>
238 Public method to login to the webrepl console of the device. 235 Public method to login to the webrepl console of the device.
239 </p> 236 </p>
237
240 <dl> 238 <dl>
241 239
242 <dt><i>password</i> (str)</dt> 240 <dt><i>password</i> (str)</dt>
243 <dd> 241 <dd>
244 password 242 password
257 </dd> 255 </dd>
258 </dl> 256 </dl>
259 <a NAME="MicroPythonWebreplSocket.readAll" ID="MicroPythonWebreplSocket.readAll"></a> 257 <a NAME="MicroPythonWebreplSocket.readAll" ID="MicroPythonWebreplSocket.readAll"></a>
260 <h4>MicroPythonWebreplSocket.readAll</h4> 258 <h4>MicroPythonWebreplSocket.readAll</h4>
261 <b>readAll</b>(<i>timeout=0</i>) 259 <b>readAll</b>(<i>timeout=0</i>)
262
263 <p> 260 <p>
264 Public method to read all available data. 261 Public method to read all available data.
265 </p> 262 </p>
263
266 <dl> 264 <dl>
267 265
268 <dt><i>timeout</i> (int (optional))</dt> 266 <dt><i>timeout</i> (int (optional))</dt>
269 <dd> 267 <dd>
270 timeout in milliseconds (0 for no timeout) 268 timeout in milliseconds (0 for no timeout)
284 </dd> 282 </dd>
285 </dl> 283 </dl>
286 <a NAME="MicroPythonWebreplSocket.readUntil" ID="MicroPythonWebreplSocket.readUntil"></a> 284 <a NAME="MicroPythonWebreplSocket.readUntil" ID="MicroPythonWebreplSocket.readUntil"></a>
287 <h4>MicroPythonWebreplSocket.readUntil</h4> 285 <h4>MicroPythonWebreplSocket.readUntil</h4>
288 <b>readUntil</b>(<i>expected=b"\n", size=None, timeout=0</i>) 286 <b>readUntil</b>(<i>expected=b"\n", size=None, timeout=0</i>)
289
290 <p> 287 <p>
291 Public method to read data until an expected sequence is found 288 Public method to read data until an expected sequence is found
292 (default: \n) or a specific size is exceeded. 289 (default: \n) or a specific size is exceeded.
293 </p> 290 </p>
291
294 <dl> 292 <dl>
295 293
296 <dt><i>expected</i> (bytes)</dt> 294 <dt><i>expected</i> (bytes)</dt>
297 <dd> 295 <dd>
298 expected bytes sequence 296 expected bytes sequence
320 </dd> 318 </dd>
321 </dl> 319 </dl>
322 <a NAME="MicroPythonWebreplSocket.setTimeout" ID="MicroPythonWebreplSocket.setTimeout"></a> 320 <a NAME="MicroPythonWebreplSocket.setTimeout" ID="MicroPythonWebreplSocket.setTimeout"></a>
323 <h4>MicroPythonWebreplSocket.setTimeout</h4> 321 <h4>MicroPythonWebreplSocket.setTimeout</h4>
324 <b>setTimeout</b>(<i>timeout</i>) 322 <b>setTimeout</b>(<i>timeout</i>)
325
326 <p> 323 <p>
327 Public method to set the socket timeout value. 324 Public method to set the socket timeout value.
328 </p> 325 </p>
326
329 <dl> 327 <dl>
330 328
331 <dt><i>timeout</i> (int)</dt> 329 <dt><i>timeout</i> (int)</dt>
332 <dd> 330 <dd>
333 timout in milliseconds to be set 331 timout in milliseconds to be set
338 <b>timeout</b>(<i></i>) 336 <b>timeout</b>(<i></i>)
339 337
340 <a NAME="MicroPythonWebreplSocket.waitForConnected" ID="MicroPythonWebreplSocket.waitForConnected"></a> 338 <a NAME="MicroPythonWebreplSocket.waitForConnected" ID="MicroPythonWebreplSocket.waitForConnected"></a>
341 <h4>MicroPythonWebreplSocket.waitForConnected</h4> 339 <h4>MicroPythonWebreplSocket.waitForConnected</h4>
342 <b>waitForConnected</b>(<i></i>) 340 <b>waitForConnected</b>(<i></i>)
343
344 <p> 341 <p>
345 Public method to wait for the websocket being connected. 342 Public method to wait for the websocket being connected.
346 </p> 343 </p>
344
347 <dl> 345 <dl>
348 <dt>Return:</dt> 346 <dt>Return:</dt>
349 <dd> 347 <dd>
350 flag indicating the connect result 348 flag indicating the connect result
351 </dd> 349 </dd>
357 </dd> 355 </dd>
358 </dl> 356 </dl>
359 <a NAME="MicroPythonWebreplSocket.writeTextMessage" ID="MicroPythonWebreplSocket.writeTextMessage"></a> 357 <a NAME="MicroPythonWebreplSocket.writeTextMessage" ID="MicroPythonWebreplSocket.writeTextMessage"></a>
360 <h4>MicroPythonWebreplSocket.writeTextMessage</h4> 358 <h4>MicroPythonWebreplSocket.writeTextMessage</h4>
361 <b>writeTextMessage</b>(<i>data</i>) 359 <b>writeTextMessage</b>(<i>data</i>)
362
363 <p> 360 <p>
364 Public method write some text data to the webrepl server of the connected 361 Public method write some text data to the webrepl server of the connected
365 device. 362 device.
366 </p> 363 </p>
364
367 <dl> 365 <dl>
368 366
369 <dt><i>data</i> (bytes)</dt> 367 <dt><i>data</i> (bytes)</dt>
370 <dd> 368 <dd>
371 text data to be sent 369 text data to be sent

Mercurial Repository: eric

eric ide

mercurial