--- a/src/eric7/Documentation/Source/eric7.MicroPython.CircuitPythonDevices.html Thu Feb 02 13:42:50 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.MicroPython.CircuitPythonDevices.html Thu Feb 02 18:01:00 2023 +0100 @@ -67,6 +67,10 @@ <td>Private method to check, if the device volume is mounted.</td> </tr> <tr> +<td><a href="#CircuitPythonDevice.__findDeviceDirectories">__findDeviceDirectories</a></td> +<td>Private method to find the device directories associated with the current board name.</td> +</tr> +<tr> <td><a href="#CircuitPythonDevice.__findWorkspace">__findWorkspace</a></td> <td>Private method to find the workspace directory.</td> </tr> @@ -147,7 +151,7 @@ <a NAME="CircuitPythonDevice.__init__" ID="CircuitPythonDevice.__init__"></a> <h4>CircuitPythonDevice (Constructor)</h4> -<b>CircuitPythonDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>) +<b>CircuitPythonDevice</b>(<i>microPythonWidget, deviceType, boardName, parent=None</i>) <p> Constructor @@ -162,6 +166,10 @@ <dd> device type assigned to this device interface </dd> +<dt><i>boardName</i> (str)</dt> +<dd> +name of the board +</dd> <dt><i>parent</i> (QObject)</dt> <dd> reference to the parent object @@ -186,6 +194,33 @@ bool </dd> </dl> +<a NAME="CircuitPythonDevice.__findDeviceDirectories" ID="CircuitPythonDevice.__findDeviceDirectories"></a> +<h4>CircuitPythonDevice.__findDeviceDirectories</h4> +<b>__findDeviceDirectories</b>(<i>directories</i>) + +<p> + Private method to find the device directories associated with the + current board name. +</p> +<dl> + +<dt><i>directories</i> (list of str)</dt> +<dd> +list of directories to be checked +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of associated directories +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> <a NAME="CircuitPythonDevice.__findWorkspace" ID="CircuitPythonDevice.__findWorkspace"></a> <h4>CircuitPythonDevice.__findWorkspace</h4> <b>__findWorkspace</b>(<i>silent=False</i>) @@ -229,11 +264,19 @@ </p> <a NAME="CircuitPythonDevice.__installLibraryFiles" ID="CircuitPythonDevice.__installLibraryFiles"></a> <h4>CircuitPythonDevice.__installLibraryFiles</h4> -<b>__installLibraryFiles</b>(<i></i>) +<b>__installLibraryFiles</b>(<i>packageMode=False</i>) <p> Private slot to install Python files into the onboard library. </p> +<dl> + +<dt><i>packageMode</i> (bool (optional))</dt> +<dd> +flag indicating to install a library package + (defaults to False) +</dd> +</dl> <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> <h4>CircuitPythonDevice.addDeviceMenuEntries</h4> <b>addDeviceMenuEntries</b>(<i>menu</i>) @@ -496,7 +539,7 @@ <hr /> <a NAME="createDevice" ID="createDevice"></a> <h2>createDevice</h2> -<b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid</i>) +<b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName</i>) <p> Function to instantiate a MicroPython device object. @@ -519,6 +562,10 @@ <dd> product ID </dd> +<dt><i>boardName</i> (str)</dt> +<dd> +name of the board +</dd> </dl> <dl> <dt>Return:</dt>