--- a/eric6/Documentation/Source/eric6.MicroPython.MicroPythonSerialPort.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.MicroPython.MicroPythonSerialPort.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,30 +18,38 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.MicroPython.MicroPythonSerialPort</h1> + <p> Module implementing a QSerialPort with additional functionality for MicroPython devices. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#MicroPythonSerialPort">MicroPythonSerialPort</a></td> <td>Class implementing a QSerialPort with additional functionality for MicroPython devices.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="MicroPythonSerialPort" ID="MicroPythonSerialPort"></a> <h2>MicroPythonSerialPort</h2> + <p> Class implementing a QSerialPort with additional functionality for MicroPython devices. @@ -49,136 +57,178 @@ <h3>Derived from</h3> QSerialPort <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="#MicroPythonSerialPort.__init__">MicroPythonSerialPort</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#MicroPythonSerialPort.closeSerialLink">closeSerialLink</a></td> <td>Public method to close the open serial connection.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MicroPythonSerialPort.hasTimedOut">hasTimedOut</a></td> <td>Public method to check, if the last 'readUntil' has timed out.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MicroPythonSerialPort.isConnected">isConnected</a></td> <td>Public method to get the connection state.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MicroPythonSerialPort.openSerialLink">openSerialLink</a></td> <td>Public method to open a serial link to a given serial port.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MicroPythonSerialPort.readUntil">readUntil</a></td> <td>Public method to read data until an expected sequence is found (default: \n) or a specific size is exceeded.</td> -</tr><tr> +</tr> +<tr> <td><a href="#MicroPythonSerialPort.setTimeout">setTimeout</a></td> <td>Public method to set the timeout for device operations.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="MicroPythonSerialPort.__init__" ID="MicroPythonSerialPort.__init__"></a> <h4>MicroPythonSerialPort (Constructor)</h4> <b>MicroPythonSerialPort</b>(<i>timeout=10000, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>timeout</i> (int)</dt> <dd> timout in milliseconds to be set -</dd><dt><i>parent</i> (QObject)</dt> +</dd> +<dt><i>parent</i> (QObject)</dt> <dd> reference to the parent object </dd> -</dl><a NAME="MicroPythonSerialPort.closeSerialLink" ID="MicroPythonSerialPort.closeSerialLink"></a> +</dl> +<a NAME="MicroPythonSerialPort.closeSerialLink" ID="MicroPythonSerialPort.closeSerialLink"></a> <h4>MicroPythonSerialPort.closeSerialLink</h4> <b>closeSerialLink</b>(<i></i>) + <p> Public method to close the open serial connection. -</p><a NAME="MicroPythonSerialPort.hasTimedOut" ID="MicroPythonSerialPort.hasTimedOut"></a> +</p> +<a NAME="MicroPythonSerialPort.hasTimedOut" ID="MicroPythonSerialPort.hasTimedOut"></a> <h4>MicroPythonSerialPort.hasTimedOut</h4> <b>hasTimedOut</b>(<i></i>) + <p> Public method to check, if the last 'readUntil' has timed out. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating a timeout @rtype bool </dd> -</dl><a NAME="MicroPythonSerialPort.isConnected" ID="MicroPythonSerialPort.isConnected"></a> +</dl> +<a NAME="MicroPythonSerialPort.isConnected" ID="MicroPythonSerialPort.isConnected"></a> <h4>MicroPythonSerialPort.isConnected</h4> <b>isConnected</b>(<i></i>) + <p> Public method to get the connection state. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating the connection state </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="MicroPythonSerialPort.openSerialLink" ID="MicroPythonSerialPort.openSerialLink"></a> +</dl> +<a NAME="MicroPythonSerialPort.openSerialLink" ID="MicroPythonSerialPort.openSerialLink"></a> <h4>MicroPythonSerialPort.openSerialLink</h4> <b>openSerialLink</b>(<i>port</i>) + <p> Public method to open a serial link to a given serial port. -</p><dl> +</p> +<dl> + <dt><i>port</i> (str)</dt> <dd> port name to connect to </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="MicroPythonSerialPort.readUntil" ID="MicroPythonSerialPort.readUntil"></a> +</dl> +<a NAME="MicroPythonSerialPort.readUntil" ID="MicroPythonSerialPort.readUntil"></a> <h4>MicroPythonSerialPort.readUntil</h4> <b>readUntil</b>(<i>expected=b"\n", size=None</i>) + <p> Public method to read data until an expected sequence is found (default: \n) or a specific size is exceeded. -</p><dl> +</p> +<dl> + <dt><i>expected</i> (bytes)</dt> <dd> expected bytes sequence -</dd><dt><i>size</i> (int)</dt> +</dd> +<dt><i>size</i> (int)</dt> <dd> maximum data to be read </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> bytes read from the device including the expected sequence </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bytes </dd> -</dl><a NAME="MicroPythonSerialPort.setTimeout" ID="MicroPythonSerialPort.setTimeout"></a> +</dl> +<a NAME="MicroPythonSerialPort.setTimeout" ID="MicroPythonSerialPort.setTimeout"></a> <h4>MicroPythonSerialPort.setTimeout</h4> <b>setTimeout</b>(<i>timeout</i>) + <p> Public method to set the timeout for device operations. -</p><dl> +</p> +<dl> + <dt><i>timeout</i> (int)</dt> <dd> timout in milliseconds to be set