73 information</li> |
73 information</li> |
74 <li>getModules: get a list of built-in modules</li> |
74 <li>getModules: get a list of built-in modules</li> |
75 <li>getTime: get the current time</li> |
75 <li>getTime: get the current time</li> |
76 <li>showTime: show the current time of the connected device</li> |
76 <li>showTime: show the current time of the connected device</li> |
77 <li>syncTime: synchronize the time of the connected device</li> |
77 <li>syncTime: synchronize the time of the connected device</li> |
|
78 <li>mipInstall: install a MicroPython package with 'mip'</li> |
|
79 <li>upipInstall: install a MicroPython package with 'upip'</li> |
|
80 <li>getLibPaths: get a list of library paths contained in sys.path</li> |
78 </ul> |
81 </ul> |
79 </p> |
82 </p> |
80 <p> |
83 <p> |
81 Supported WiFi commands are: |
84 Supported WiFi commands are: |
82 <ul> |
85 <ul> |
242 <tr> |
245 <tr> |
243 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td> |
246 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td> |
244 <td>Public method to download the device firmware.</td> |
247 <td>Public method to download the device firmware.</td> |
245 </tr> |
248 </tr> |
246 <tr> |
249 <tr> |
|
250 <td><a href="#BaseDevice.ensurePath">ensurePath</a></td> |
|
251 <td>Public method to ensure, that the given target path exists.</td> |
|
252 </tr> |
|
253 <tr> |
247 <td><a href="#BaseDevice.exists">exists</a></td> |
254 <td><a href="#BaseDevice.exists">exists</a></td> |
248 <td>Public method to check the existence of a file or directory.</td> |
255 <td>Public method to check the existence of a file or directory.</td> |
249 </tr> |
256 </tr> |
250 <tr> |
257 <tr> |
251 <td><a href="#BaseDevice.fileSystemInfo">fileSystemInfo</a></td> |
258 <td><a href="#BaseDevice.fileSystemInfo">fileSystemInfo</a></td> |
300 <td>Public method to get Ethernet status data of the connected board.</td> |
307 <td>Public method to get Ethernet status data of the connected board.</td> |
301 </tr> |
308 </tr> |
302 <tr> |
309 <tr> |
303 <td><a href="#BaseDevice.getFirmwareUrl">getFirmwareUrl</a></td> |
310 <td><a href="#BaseDevice.getFirmwareUrl">getFirmwareUrl</a></td> |
304 <td>Public method to get the device firmware download URL.</td> |
311 <td>Public method to get the device firmware download URL.</td> |
|
312 </tr> |
|
313 <tr> |
|
314 <td><a href="#BaseDevice.getLibPaths">getLibPaths</a></td> |
|
315 <td>Public method to get the list of library paths contained in 'sys.path'.</td> |
305 </tr> |
316 </tr> |
306 <tr> |
317 <tr> |
307 <td><a href="#BaseDevice.getModules">getModules</a></td> |
318 <td><a href="#BaseDevice.getModules">getModules</a></td> |
308 <td>Public method to show a list of modules built into the firmware.</td> |
319 <td>Public method to show a list of modules built into the firmware.</td> |
309 </tr> |
320 </tr> |
1043 <b>downloadFirmware</b>(<i></i>) |
1054 <b>downloadFirmware</b>(<i></i>) |
1044 |
1055 |
1045 <p> |
1056 <p> |
1046 Public method to download the device firmware. |
1057 Public method to download the device firmware. |
1047 </p> |
1058 </p> |
|
1059 <a NAME="BaseDevice.ensurePath" ID="BaseDevice.ensurePath"></a> |
|
1060 <h4>BaseDevice.ensurePath</h4> |
|
1061 <b>ensurePath</b>(<i>target</i>) |
|
1062 |
|
1063 <p> |
|
1064 Public method to ensure, that the given target path exists. |
|
1065 </p> |
|
1066 <dl> |
|
1067 |
|
1068 <dt><i>target</i> (str)</dt> |
|
1069 <dd> |
|
1070 target directory |
|
1071 </dd> |
|
1072 </dl> |
1048 <a NAME="BaseDevice.exists" ID="BaseDevice.exists"></a> |
1073 <a NAME="BaseDevice.exists" ID="BaseDevice.exists"></a> |
1049 <h4>BaseDevice.exists</h4> |
1074 <h4>BaseDevice.exists</h4> |
1050 <b>exists</b>(<i>pathname</i>) |
1075 <b>exists</b>(<i>pathname</i>) |
1051 |
1076 |
1052 <p> |
1077 <p> |
1409 </dl> |
1434 </dl> |
1410 <dl> |
1435 <dl> |
1411 <dt>Return Type:</dt> |
1436 <dt>Return Type:</dt> |
1412 <dd> |
1437 <dd> |
1413 str |
1438 str |
|
1439 </dd> |
|
1440 </dl> |
|
1441 <a NAME="BaseDevice.getLibPaths" ID="BaseDevice.getLibPaths"></a> |
|
1442 <h4>BaseDevice.getLibPaths</h4> |
|
1443 <b>getLibPaths</b>(<i></i>) |
|
1444 |
|
1445 <p> |
|
1446 Public method to get the list of library paths contained in 'sys.path'. |
|
1447 </p> |
|
1448 <dl> |
|
1449 <dt>Return:</dt> |
|
1450 <dd> |
|
1451 list of library paths |
|
1452 </dd> |
|
1453 </dl> |
|
1454 <dl> |
|
1455 <dt>Return Type:</dt> |
|
1456 <dd> |
|
1457 list of str |
|
1458 </dd> |
|
1459 </dl> |
|
1460 <dl> |
|
1461 |
|
1462 <dt>Raises <b>OSError</b>:</dt> |
|
1463 <dd> |
|
1464 raised to indicate an issue with the device |
1414 </dd> |
1465 </dd> |
1415 </dl> |
1466 </dl> |
1416 <a NAME="BaseDevice.getModules" ID="BaseDevice.getModules"></a> |
1467 <a NAME="BaseDevice.getModules" ID="BaseDevice.getModules"></a> |
1417 <h4>BaseDevice.getModules</h4> |
1468 <h4>BaseDevice.getModules</h4> |
1418 <b>getModules</b>(<i></i>) |
1469 <b>getModules</b>(<i></i>) |
1767 raised to indicate an issue with the device |
1818 raised to indicate an issue with the device |
1768 </dd> |
1819 </dd> |
1769 </dl> |
1820 </dl> |
1770 <a NAME="BaseDevice.mipInstall" ID="BaseDevice.mipInstall"></a> |
1821 <a NAME="BaseDevice.mipInstall" ID="BaseDevice.mipInstall"></a> |
1771 <h4>BaseDevice.mipInstall</h4> |
1822 <h4>BaseDevice.mipInstall</h4> |
1772 <b>mipInstall</b>(<i>package, version, mpy</i>) |
1823 <b>mipInstall</b>(<i>package, index=None, target=None, version=None, mpy=True</i>) |
1773 |
1824 |
1774 <p> |
1825 <p> |
1775 Public method to install packages using 'mip'. |
1826 Public method to install packages using 'mip'. |
1776 </p> |
1827 </p> |
1777 <dl> |
1828 <dl> |
1778 |
1829 |
1779 <dt><i>package</i> (str)</dt> |
1830 <dt><i>package</i> (str)</dt> |
1780 <dd> |
1831 <dd> |
1781 package name |
1832 package name |
1782 </dd> |
1833 </dd> |
1783 <dt><i>version</i> (str)</dt> |
1834 <dt><i>index</i> (str (optional))</dt> |
1784 <dd> |
1835 <dd> |
1785 package version |
1836 URL of the package index to be used (defaults to None) |
1786 </dd> |
1837 </dd> |
1787 <dt><i>mpy</i> (bool)</dt> |
1838 <dt><i>target</i> (str (optional))</dt> |
1788 <dd> |
1839 <dd> |
1789 flag indicating to install as '.mpy' file |
1840 target directory on the device (defaults to None) |
|
1841 </dd> |
|
1842 <dt><i>version</i> (str (optional))</dt> |
|
1843 <dd> |
|
1844 package version (defaults to None) |
|
1845 </dd> |
|
1846 <dt><i>mpy</i> (bool (optional))</dt> |
|
1847 <dd> |
|
1848 flag indicating to install as '.mpy' file (defaults to True) |
1790 </dd> |
1849 </dd> |
1791 </dl> |
1850 </dl> |
1792 <dl> |
1851 <dl> |
1793 <dt>Return:</dt> |
1852 <dt>Return:</dt> |
1794 <dd> |
1853 <dd> |