src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html

branch
mpy_network
changeset 9979
dbafba79461d
parent 9944
011ae0edbcff
child 9989
286c2a21f36f
diff -r f878ae1e6d21 -r dbafba79461d src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sat Apr 15 11:12:30 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Sat Apr 15 18:22:09 2023 +0200
@@ -75,6 +75,9 @@
     <li>getTime: get the current time</li>
     <li>showTime: show the current time of the connected device</li>
     <li>syncTime: synchronize the time of the connected device</li>
+    <li>mipInstall: install a MicroPython package with 'mip'</li>
+    <li>upipInstall: install a MicroPython package with 'upip'</li>
+    <li>getLibPaths: get a list of library paths contained in sys.path</li>
     </ul>
 </p>
 <p>
@@ -244,6 +247,10 @@
 <td>Public method to download the device firmware.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.ensurePath">ensurePath</a></td>
+<td>Public method to ensure, that the given target path exists.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.exists">exists</a></td>
 <td>Public method to check the existence of a file or directory.</td>
 </tr>
@@ -304,6 +311,10 @@
 <td>Public method to get the device firmware download URL.</td>
 </tr>
 <tr>
+<td><a href="#BaseDevice.getLibPaths">getLibPaths</a></td>
+<td>Public method to get the list of library paths contained in 'sys.path'.</td>
+</tr>
+<tr>
 <td><a href="#BaseDevice.getModules">getModules</a></td>
 <td>Public method to show a list of modules built into the firmware.</td>
 </tr>
@@ -1045,6 +1056,20 @@
 <p>
         Public method to download the device firmware.
 </p>
+<a NAME="BaseDevice.ensurePath" ID="BaseDevice.ensurePath"></a>
+<h4>BaseDevice.ensurePath</h4>
+<b>ensurePath</b>(<i>target</i>)
+
+<p>
+        Public method to ensure, that the given target path exists.
+</p>
+<dl>
+
+<dt><i>target</i> (str)</dt>
+<dd>
+target directory
+</dd>
+</dl>
 <a NAME="BaseDevice.exists" ID="BaseDevice.exists"></a>
 <h4>BaseDevice.exists</h4>
 <b>exists</b>(<i>pathname</i>)
@@ -1413,6 +1438,32 @@
 str
 </dd>
 </dl>
+<a NAME="BaseDevice.getLibPaths" ID="BaseDevice.getLibPaths"></a>
+<h4>BaseDevice.getLibPaths</h4>
+<b>getLibPaths</b>(<i></i>)
+
+<p>
+        Public method to get the list of library paths contained in 'sys.path'.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of library paths
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>OSError</b>:</dt>
+<dd>
+raised to indicate an issue with the device
+</dd>
+</dl>
 <a NAME="BaseDevice.getModules" ID="BaseDevice.getModules"></a>
 <h4>BaseDevice.getModules</h4>
 <b>getModules</b>(<i></i>)
@@ -1769,7 +1820,7 @@
 </dl>
 <a NAME="BaseDevice.mipInstall" ID="BaseDevice.mipInstall"></a>
 <h4>BaseDevice.mipInstall</h4>
-<b>mipInstall</b>(<i>package, version, mpy</i>)
+<b>mipInstall</b>(<i>package, index=None, target=None, version=None, mpy=True</i>)
 
 <p>
         Public method to install packages using 'mip'.
@@ -1780,13 +1831,21 @@
 <dd>
 package name
 </dd>
-<dt><i>version</i> (str)</dt>
+<dt><i>index</i> (str (optional))</dt>
 <dd>
-package version
+URL of the package index to be used (defaults to None)
+</dd>
+<dt><i>target</i> (str (optional))</dt>
+<dd>
+target directory on the device (defaults to None)
 </dd>
-<dt><i>mpy</i> (bool)</dt>
+<dt><i>version</i> (str (optional))</dt>
 <dd>
-flag indicating to install as '.mpy' file
+package version (defaults to None)
+</dd>
+<dt><i>mpy</i> (bool (optional))</dt>
+<dd>
+flag indicating to install as '.mpy' file (defaults to True)
 </dd>
 </dl>
 <dl>

eric ide

mercurial