Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonSerialPort.html
src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonSerialPort.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10428
- a071d4065202
- child 11190
- f5ffdf0164ab
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.MicroPythonSerialPort</h1> | 9 <h1>eric7.MicroPython.MicroPythonSerialPort</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a QSerialPort with additional functionality for | 11 Module implementing a QSerialPort with additional functionality for |
| 13 MicroPython devices. | 12 MicroPython devices. |
| 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="#MicroPythonSerialPort">MicroPythonSerialPort</a></td> | 23 <td><a href="#MicroPythonSerialPort">MicroPythonSerialPort</a></td> |
| 26 <td>Class implementing a QSerialPort with additional functionality for MicroPython devices.</td> | 24 <td>Class implementing a QSerialPort with additional functionality for MicroPython devices.</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="MicroPythonSerialPort" ID="MicroPythonSerialPort"></a> | 35 <a NAME="MicroPythonSerialPort" ID="MicroPythonSerialPort"></a> |
| 37 <h2>MicroPythonSerialPort</h2> | 36 <h2>MicroPythonSerialPort</h2> |
| 38 | |
| 39 <p> | 37 <p> |
| 40 Class implementing a QSerialPort with additional functionality for | 38 Class implementing a QSerialPort with additional functionality for |
| 41 MicroPython devices. | 39 MicroPython devices. |
| 42 </p> | 40 </p> |
| 41 | |
| 43 <h3>Derived from</h3> | 42 <h3>Derived from</h3> |
| 44 QSerialPort | 43 QSerialPort |
| 45 <h3>Class Attributes</h3> | 44 <h3>Class Attributes</h3> |
| 46 | 45 <table> |
| 47 <table> | 46 <tr><td>None</td></tr> |
| 48 <tr><td>None</td></tr> | 47 </table> |
| 49 </table> | 48 |
| 50 <h3>Class Methods</h3> | 49 <h3>Class Methods</h3> |
| 51 | 50 <table> |
| 52 <table> | 51 <tr><td>None</td></tr> |
| 53 <tr><td>None</td></tr> | 52 </table> |
| 54 </table> | 53 |
| 55 <h3>Methods</h3> | 54 <h3>Methods</h3> |
| 56 | 55 <table> |
| 57 <table> | |
| 58 | |
| 59 <tr> | 56 <tr> |
| 60 <td><a href="#MicroPythonSerialPort.__init__">MicroPythonSerialPort</a></td> | 57 <td><a href="#MicroPythonSerialPort.__init__">MicroPythonSerialPort</a></td> |
| 61 <td>Constructor</td> | 58 <td>Constructor</td> |
| 62 </tr> | 59 </tr> |
| 63 <tr> | 60 <tr> |
| 83 <tr> | 80 <tr> |
| 84 <td><a href="#MicroPythonSerialPort.setTimeout">setTimeout</a></td> | 81 <td><a href="#MicroPythonSerialPort.setTimeout">setTimeout</a></td> |
| 85 <td>Public method to set the timeout for device operations.</td> | 82 <td>Public method to set the timeout for device operations.</td> |
| 86 </tr> | 83 </tr> |
| 87 </table> | 84 </table> |
| 85 | |
| 88 <h3>Static Methods</h3> | 86 <h3>Static Methods</h3> |
| 89 | 87 <table> |
| 90 <table> | 88 <tr><td>None</td></tr> |
| 91 <tr><td>None</td></tr> | 89 </table> |
| 92 </table> | 90 |
| 93 | 91 |
| 94 <a NAME="MicroPythonSerialPort.__init__" ID="MicroPythonSerialPort.__init__"></a> | 92 <a NAME="MicroPythonSerialPort.__init__" ID="MicroPythonSerialPort.__init__"></a> |
| 95 <h4>MicroPythonSerialPort (Constructor)</h4> | 93 <h4>MicroPythonSerialPort (Constructor)</h4> |
| 96 <b>MicroPythonSerialPort</b>(<i>timeout=10000, parent=None</i>) | 94 <b>MicroPythonSerialPort</b>(<i>timeout=10000, parent=None</i>) |
| 97 | |
| 98 <p> | 95 <p> |
| 99 Constructor | 96 Constructor |
| 100 </p> | 97 </p> |
| 98 | |
| 101 <dl> | 99 <dl> |
| 102 | 100 |
| 103 <dt><i>timeout</i> (int)</dt> | 101 <dt><i>timeout</i> (int)</dt> |
| 104 <dd> | 102 <dd> |
| 105 timout in milliseconds to be set | 103 timout in milliseconds to be set |
| 110 </dd> | 108 </dd> |
| 111 </dl> | 109 </dl> |
| 112 <a NAME="MicroPythonSerialPort.closeSerialLink" ID="MicroPythonSerialPort.closeSerialLink"></a> | 110 <a NAME="MicroPythonSerialPort.closeSerialLink" ID="MicroPythonSerialPort.closeSerialLink"></a> |
| 113 <h4>MicroPythonSerialPort.closeSerialLink</h4> | 111 <h4>MicroPythonSerialPort.closeSerialLink</h4> |
| 114 <b>closeSerialLink</b>(<i></i>) | 112 <b>closeSerialLink</b>(<i></i>) |
| 115 | |
| 116 <p> | 113 <p> |
| 117 Public method to close the open serial connection. | 114 Public method to close the open serial connection. |
| 118 </p> | 115 </p> |
| 116 | |
| 119 <a NAME="MicroPythonSerialPort.hasTimedOut" ID="MicroPythonSerialPort.hasTimedOut"></a> | 117 <a NAME="MicroPythonSerialPort.hasTimedOut" ID="MicroPythonSerialPort.hasTimedOut"></a> |
| 120 <h4>MicroPythonSerialPort.hasTimedOut</h4> | 118 <h4>MicroPythonSerialPort.hasTimedOut</h4> |
| 121 <b>hasTimedOut</b>(<i></i>) | 119 <b>hasTimedOut</b>(<i></i>) |
| 122 | |
| 123 <p> | 120 <p> |
| 124 Public method to check, if the last 'readUntil' has timed out. | 121 Public method to check, if the last 'readUntil' has timed out. |
| 125 </p> | 122 </p> |
| 123 | |
| 126 <dl> | 124 <dl> |
| 127 <dt>Return:</dt> | 125 <dt>Return:</dt> |
| 128 <dd> | 126 <dd> |
| 129 flag indicating a timeout | 127 flag indicating a timeout |
| 130 </dd> | 128 </dd> |
| 136 </dd> | 134 </dd> |
| 137 </dl> | 135 </dl> |
| 138 <a NAME="MicroPythonSerialPort.isConnected" ID="MicroPythonSerialPort.isConnected"></a> | 136 <a NAME="MicroPythonSerialPort.isConnected" ID="MicroPythonSerialPort.isConnected"></a> |
| 139 <h4>MicroPythonSerialPort.isConnected</h4> | 137 <h4>MicroPythonSerialPort.isConnected</h4> |
| 140 <b>isConnected</b>(<i></i>) | 138 <b>isConnected</b>(<i></i>) |
| 141 | |
| 142 <p> | 139 <p> |
| 143 Public method to get the connection state. | 140 Public method to get the connection state. |
| 144 </p> | 141 </p> |
| 142 | |
| 145 <dl> | 143 <dl> |
| 146 <dt>Return:</dt> | 144 <dt>Return:</dt> |
| 147 <dd> | 145 <dd> |
| 148 flag indicating the connection state | 146 flag indicating the connection state |
| 149 </dd> | 147 </dd> |
| 155 </dd> | 153 </dd> |
| 156 </dl> | 154 </dl> |
| 157 <a NAME="MicroPythonSerialPort.openSerialLink" ID="MicroPythonSerialPort.openSerialLink"></a> | 155 <a NAME="MicroPythonSerialPort.openSerialLink" ID="MicroPythonSerialPort.openSerialLink"></a> |
| 158 <h4>MicroPythonSerialPort.openSerialLink</h4> | 156 <h4>MicroPythonSerialPort.openSerialLink</h4> |
| 159 <b>openSerialLink</b>(<i>port</i>) | 157 <b>openSerialLink</b>(<i>port</i>) |
| 160 | |
| 161 <p> | 158 <p> |
| 162 Public method to open a serial link to a given serial port. | 159 Public method to open a serial link to a given serial port. |
| 163 </p> | 160 </p> |
| 161 | |
| 164 <dl> | 162 <dl> |
| 165 | 163 |
| 166 <dt><i>port</i> (str)</dt> | 164 <dt><i>port</i> (str)</dt> |
| 167 <dd> | 165 <dd> |
| 168 port name to connect to | 166 port name to connect to |
| 181 </dd> | 179 </dd> |
| 182 </dl> | 180 </dl> |
| 183 <a NAME="MicroPythonSerialPort.readUntil" ID="MicroPythonSerialPort.readUntil"></a> | 181 <a NAME="MicroPythonSerialPort.readUntil" ID="MicroPythonSerialPort.readUntil"></a> |
| 184 <h4>MicroPythonSerialPort.readUntil</h4> | 182 <h4>MicroPythonSerialPort.readUntil</h4> |
| 185 <b>readUntil</b>(<i>expected=b"\n", size=None, timeout=0</i>) | 183 <b>readUntil</b>(<i>expected=b"\n", size=None, timeout=0</i>) |
| 186 | |
| 187 <p> | 184 <p> |
| 188 Public method to read data until an expected sequence is found | 185 Public method to read data until an expected sequence is found |
| 189 (default: \n) or a specific size is exceeded. | 186 (default: \n) or a specific size is exceeded. |
| 190 </p> | 187 </p> |
| 188 | |
| 191 <dl> | 189 <dl> |
| 192 | 190 |
| 193 <dt><i>expected</i> (bytes)</dt> | 191 <dt><i>expected</i> (bytes)</dt> |
| 194 <dd> | 192 <dd> |
| 195 expected bytes sequence | 193 expected bytes sequence |
| 217 </dd> | 215 </dd> |
| 218 </dl> | 216 </dl> |
| 219 <a NAME="MicroPythonSerialPort.setTimeout" ID="MicroPythonSerialPort.setTimeout"></a> | 217 <a NAME="MicroPythonSerialPort.setTimeout" ID="MicroPythonSerialPort.setTimeout"></a> |
| 220 <h4>MicroPythonSerialPort.setTimeout</h4> | 218 <h4>MicroPythonSerialPort.setTimeout</h4> |
| 221 <b>setTimeout</b>(<i>timeout</i>) | 219 <b>setTimeout</b>(<i>timeout</i>) |
| 222 | |
| 223 <p> | 220 <p> |
| 224 Public method to set the timeout for device operations. | 221 Public method to set the timeout for device operations. |
| 225 </p> | 222 </p> |
| 223 | |
| 226 <dl> | 224 <dl> |
| 227 | 225 |
| 228 <dt><i>timeout</i> (int)</dt> | 226 <dt><i>timeout</i> (int)</dt> |
| 229 <dd> | 227 <dd> |
| 230 timout in milliseconds to be set | 228 timout in milliseconds to be set |
