--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,35 +7,33 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MicroPython.Devices.DeviceBase</h1>
-
<p>
Module implementing some utility functions and the MicroPythonDevice base
class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#BaseDevice">BaseDevice</a></td>
<td>Base class for the more specific MicroPython devices.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="BaseDevice" ID="BaseDevice"></a>
<h2>BaseDevice</h2>
-
<p>
Base class for the more specific MicroPython devices.
</p>
@@ -125,22 +123,21 @@
<li>removeLanAutoConnect: remove the IPv4 parameters and script from the board</li>
</ul>
</p>
+
<h3>Derived from</h3>
QObject
<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="#BaseDevice.__init__">BaseDevice</a></td>
<td>Constructor</td>
@@ -530,19 +527,20 @@
<td>Public method to generate a script and associated configuration to connect the device to the LAN during boot time.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="BaseDevice.__init__" ID="BaseDevice.__init__"></a>
<h4>BaseDevice (Constructor)</h4>
<b>BaseDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
@@ -561,10 +559,10 @@
<a NAME="BaseDevice.__getDeviceData" ID="BaseDevice.__getDeviceData"></a>
<h4>BaseDevice.__getDeviceData</h4>
<b>__getDeviceData</b>(<i></i>)
-
<p>
Private method to get some essential data for the connected board.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -587,7 +585,6 @@
<a NAME="BaseDevice._getSetTimeCode" ID="BaseDevice._getSetTimeCode"></a>
<h4>BaseDevice._getSetTimeCode</h4>
<b>_getSetTimeCode</b>(<i></i>)
-
<p>
Protected method to get the device code to set the time.
</p>
@@ -595,6 +592,7 @@
Note: This method must be implemented in the various device specific
subclasses.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -610,10 +608,10 @@
<a NAME="BaseDevice._shortError" ID="BaseDevice._shortError"></a>
<h4>BaseDevice._shortError</h4>
<b>_shortError</b>(<i>error</i>)
-
<p>
Protected method to create a shortened error message.
</p>
+
<dl>
<dt><i>error</i> (bytes)</dt>
@@ -636,10 +634,10 @@
<a NAME="BaseDevice.activateBluetoothInterface" ID="BaseDevice.activateBluetoothInterface"></a>
<h4>BaseDevice.activateBluetoothInterface</h4>
<b>activateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to activate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -655,10 +653,10 @@
<a NAME="BaseDevice.addDeviceBluetoothEntries" ID="BaseDevice.addDeviceBluetoothEntries"></a>
<h4>BaseDevice.addDeviceBluetoothEntries</h4>
<b>addDeviceBluetoothEntries</b>(<i>menu</i>)
-
<p>
Public method to add device specific entries to the given menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -669,10 +667,10 @@
<a NAME="BaseDevice.addDeviceEthernetEntries" ID="BaseDevice.addDeviceEthernetEntries"></a>
<h4>BaseDevice.addDeviceEthernetEntries</h4>
<b>addDeviceEthernetEntries</b>(<i>menu</i>)
-
<p>
Public method to add device specific entries to the given menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -683,10 +681,10 @@
<a NAME="BaseDevice.addDeviceMenuEntries" ID="BaseDevice.addDeviceMenuEntries"></a>
<h4>BaseDevice.addDeviceMenuEntries</h4>
<b>addDeviceMenuEntries</b>(<i>menu</i>)
-
<p>
Public method to add device specific entries to the given menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -697,10 +695,10 @@
<a NAME="BaseDevice.addDeviceWifiEntries" ID="BaseDevice.addDeviceWifiEntries"></a>
<h4>BaseDevice.addDeviceWifiEntries</h4>
<b>addDeviceWifiEntries</b>(<i>menu</i>)
-
<p>
Public method to add device specific entries to the given menu.
</p>
+
<dl>
<dt><i>menu</i> (QMenu)</dt>
@@ -711,10 +709,10 @@
<a NAME="BaseDevice.bool2str" ID="BaseDevice.bool2str"></a>
<h4>BaseDevice.bool2str</h4>
<b>bool2str</b>(<i>val, capitalized=True</i>)
-
<p>
Public method to generate a yes/no string given a truth value.
</p>
+
<dl>
<dt><i>val</i> (bool)</dt>
@@ -741,10 +739,10 @@
<a NAME="BaseDevice.canRunScript" ID="BaseDevice.canRunScript"></a>
<h4>BaseDevice.canRunScript</h4>
<b>canRunScript</b>(<i></i>)
-
<p>
Public method to determine, if a script can be executed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -761,10 +759,10 @@
<a NAME="BaseDevice.canStartFileManager" ID="BaseDevice.canStartFileManager"></a>
<h4>BaseDevice.canStartFileManager</h4>
<b>canStartFileManager</b>(<i></i>)
-
<p>
Public method to determine, if a File Manager can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -781,10 +779,10 @@
<a NAME="BaseDevice.canStartPlotter" ID="BaseDevice.canStartPlotter"></a>
<h4>BaseDevice.canStartPlotter</h4>
<b>canStartPlotter</b>(<i></i>)
-
<p>
Public method to determine, if a Plotter can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -801,10 +799,10 @@
<a NAME="BaseDevice.canStartRepl" ID="BaseDevice.canStartRepl"></a>
<h4>BaseDevice.canStartRepl</h4>
<b>canStartRepl</b>(<i></i>)
-
<p>
Public method to determine, if a REPL can be started.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -821,10 +819,10 @@
<a NAME="BaseDevice.cd" ID="BaseDevice.cd"></a>
<h4>BaseDevice.cd</h4>
<b>cd</b>(<i>dirname</i>)
-
<p>
Public method to change the current directory on the connected device.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -842,11 +840,11 @@
<a NAME="BaseDevice.checkDeviceData" ID="BaseDevice.checkDeviceData"></a>
<h4>BaseDevice.checkDeviceData</h4>
<b>checkDeviceData</b>(<i>quiet=True</i>)
-
<p>
Public method to check the validity of the device data determined during
connecting the device.
</p>
+
<dl>
<dt><i>quiet</i> (bool (optional))</dt>
@@ -870,10 +868,10 @@
<a NAME="BaseDevice.checkInternet" ID="BaseDevice.checkInternet"></a>
<h4>BaseDevice.checkInternet</h4>
<b>checkInternet</b>(<i></i>)
-
<p>
Public method to check, if the internet can be reached.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -889,10 +887,10 @@
<a NAME="BaseDevice.checkInternetViaLan" ID="BaseDevice.checkInternetViaLan"></a>
<h4>BaseDevice.checkInternetViaLan</h4>
<b>checkInternetViaLan</b>(<i></i>)
-
<p>
Public method to check, if the internet can be reached (LAN variant).
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -908,10 +906,10 @@
<a NAME="BaseDevice.connectToLan" ID="BaseDevice.connectToLan"></a>
<h4>BaseDevice.connectToLan</h4>
<b>connectToLan</b>(<i>config, hostname</i>)
-
<p>
Public method to connect the connected device to the LAN.
</p>
+
<dl>
<dt><i>config</i> (str or tuple of (str, str, str, str))</dt>
@@ -939,10 +937,10 @@
<a NAME="BaseDevice.connectWifi" ID="BaseDevice.connectWifi"></a>
<h4>BaseDevice.connectWifi</h4>
<b>connectWifi</b>(<i>ssid, password, hostname</i>)
-
<p>
Public method to connect a device to a WiFi network.
</p>
+
<dl>
<dt><i>ssid</i> (str)</dt>
@@ -973,10 +971,10 @@
<a NAME="BaseDevice.deactivateBluetoothInterface" ID="BaseDevice.deactivateBluetoothInterface"></a>
<h4>BaseDevice.deactivateBluetoothInterface</h4>
<b>deactivateBluetoothInterface</b>(<i></i>)
-
<p>
Public method to deactivate the Bluetooth interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -992,10 +990,10 @@
<a NAME="BaseDevice.deactivateEthernet" ID="BaseDevice.deactivateEthernet"></a>
<h4>BaseDevice.deactivateEthernet</h4>
<b>deactivateEthernet</b>(<i></i>)
-
<p>
Public method to deactivate the Ethernet interface of the connected device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1011,10 +1009,10 @@
<a NAME="BaseDevice.deactivateInterface" ID="BaseDevice.deactivateInterface"></a>
<h4>BaseDevice.deactivateInterface</h4>
<b>deactivateInterface</b>(<i>interface</i>)
-
<p>
Public method to deactivate a given WiFi interface of the connected device.
</p>
+
<dl>
<dt><i>interface</i> (str)</dt>
@@ -1038,10 +1036,10 @@
<a NAME="BaseDevice.deviceName" ID="BaseDevice.deviceName"></a>
<h4>BaseDevice.deviceName</h4>
<b>deviceName</b>(<i></i>)
-
<p>
Public method to get the name of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1057,11 +1055,11 @@
<a NAME="BaseDevice.disableWebrepl" ID="BaseDevice.disableWebrepl"></a>
<h4>BaseDevice.disableWebrepl</h4>
<b>disableWebrepl</b>(<i></i>)
-
<p>
Public method to write the given WebREPL password to the connected device and
modify the start script to start the WebREPL server.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1077,10 +1075,10 @@
<a NAME="BaseDevice.disconnectFromLan" ID="BaseDevice.disconnectFromLan"></a>
<h4>BaseDevice.disconnectFromLan</h4>
<b>disconnectFromLan</b>(<i></i>)
-
<p>
Public method to disconnect from the LAN.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1096,10 +1094,10 @@
<a NAME="BaseDevice.disconnectWifi" ID="BaseDevice.disconnectWifi"></a>
<h4>BaseDevice.disconnectWifi</h4>
<b>disconnectWifi</b>(<i></i>)
-
<p>
Public method to disconnect a device from the WiFi network.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1115,18 +1113,18 @@
<a NAME="BaseDevice.downloadFirmware" ID="BaseDevice.downloadFirmware"></a>
<h4>BaseDevice.downloadFirmware</h4>
<b>downloadFirmware</b>(<i></i>)
-
<p>
Public method to download the device firmware.
</p>
+
<a NAME="BaseDevice.enableWebrepl" ID="BaseDevice.enableWebrepl"></a>
<h4>BaseDevice.enableWebrepl</h4>
<b>enableWebrepl</b>(<i>password</i>)
-
<p>
Public method to write the given WebREPL password to the connected device and
modify the start script to start the WebREPL server.
</p>
+
<dl>
<dt><i>password</i> (str)</dt>
@@ -1149,10 +1147,10 @@
<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>
@@ -1163,7 +1161,6 @@
<a NAME="BaseDevice.executeCommands" ID="BaseDevice.executeCommands"></a>
<h4>BaseDevice.executeCommands</h4>
<b>executeCommands</b>(<i>commands, *, mode="raw", timeout=0</i>)
-
<p>
Public method to send commands to the connected device and return the
result.
@@ -1171,6 +1168,7 @@
<p>
If no connected interface is available, empty results will be returned.
</p>
+
<dl>
<dt><i>commands</i> (str or list of str)</dt>
@@ -1203,10 +1201,10 @@
<a NAME="BaseDevice.exists" ID="BaseDevice.exists"></a>
<h4>BaseDevice.exists</h4>
<b>exists</b>(<i>pathname</i>)
-
<p>
Public method to check the existence of a file or directory.
</p>
+
<dl>
<dt><i>pathname</i> (str)</dt>
@@ -1236,11 +1234,11 @@
<a NAME="BaseDevice.fileSystemInfo" ID="BaseDevice.fileSystemInfo"></a>
<h4>BaseDevice.fileSystemInfo</h4>
<b>fileSystemInfo</b>(<i></i>)
-
<p>
Public method to obtain information about the currently mounted file
systems.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1264,11 +1262,11 @@
<a NAME="BaseDevice.forceInterrupt" ID="BaseDevice.forceInterrupt"></a>
<h4>BaseDevice.forceInterrupt</h4>
<b>forceInterrupt</b>(<i></i>)
-
<p>
Public method to determine the need for an interrupt when opening the
serial connection.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1284,10 +1282,10 @@
<a NAME="BaseDevice.get" ID="BaseDevice.get"></a>
<h4>BaseDevice.get</h4>
<b>get</b>(<i>deviceFileName, hostFileName=None</i>)
-
<p>
Public method to copy a file from the connected device.
</p>
+
<dl>
<dt><i>deviceFileName</i> (str)</dt>
@@ -1321,10 +1319,10 @@
<a NAME="BaseDevice.getBluetoothStatus" ID="BaseDevice.getBluetoothStatus"></a>
<h4>BaseDevice.getBluetoothStatus</h4>
<b>getBluetoothStatus</b>(<i></i>)
-
<p>
Public method to get Bluetooth status data of the connected board.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1341,10 +1339,10 @@
<a NAME="BaseDevice.getBoardInformation" ID="BaseDevice.getBoardInformation"></a>
<h4>BaseDevice.getBoardInformation</h4>
<b>getBoardInformation</b>(<i></i>)
-
<p>
Public method to get some information data of the connected board.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1367,10 +1365,10 @@
<a NAME="BaseDevice.getConnectedClients" ID="BaseDevice.getConnectedClients"></a>
<h4>BaseDevice.getConnectedClients</h4>
<b>getConnectedClients</b>(<i></i>)
-
<p>
Public method to get a list of connected clients.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1387,10 +1385,10 @@
<a NAME="BaseDevice.getData" ID="BaseDevice.getData"></a>
<h4>BaseDevice.getData</h4>
<b>getData</b>(<i>deviceFileName</i>)
-
<p>
Public method to read data from the connected device.
</p>
+
<dl>
<dt><i>deviceFileName</i> (str)</dt>
@@ -1420,10 +1418,10 @@
<a NAME="BaseDevice.getDeviceData" ID="BaseDevice.getDeviceData"></a>
<h4>BaseDevice.getDeviceData</h4>
<b>getDeviceData</b>(<i>key=None</i>)
-
<p>
Public method to get a copy of the determined device data or part of them.
</p>
+
<dl>
<dt><i>key</i> (str or list of str (optional))</dt>
@@ -1447,10 +1445,10 @@
<a NAME="BaseDevice.getDeviceScan" ID="BaseDevice.getDeviceScan"></a>
<h4>BaseDevice.getDeviceScan</h4>
<b>getDeviceScan</b>(<i>timeout=10</i>)
-
<p>
Public method to perform a Bluetooth device scan.
</p>
+
<dl>
<dt><i>timeout</i> (int (optional))</dt>
@@ -1475,10 +1473,10 @@
<a NAME="BaseDevice.getDeviceType" ID="BaseDevice.getDeviceType"></a>
<h4>BaseDevice.getDeviceType</h4>
<b>getDeviceType</b>(<i></i>)
-
<p>
Public method to get the device type.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1494,10 +1492,10 @@
<a NAME="BaseDevice.getDocumentationUrl" ID="BaseDevice.getDocumentationUrl"></a>
<h4>BaseDevice.getDocumentationUrl</h4>
<b>getDocumentationUrl</b>(<i></i>)
-
<p>
Public method to get the device documentation URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1513,10 +1511,10 @@
<a NAME="BaseDevice.getDownloadMenuEntries" ID="BaseDevice.getDownloadMenuEntries"></a>
<h4>BaseDevice.getDownloadMenuEntries</h4>
<b>getDownloadMenuEntries</b>(<i></i>)
-
<p>
Public method to retrieve the entries for the downloads menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1533,10 +1531,10 @@
<a NAME="BaseDevice.getEthernetStatus" ID="BaseDevice.getEthernetStatus"></a>
<h4>BaseDevice.getEthernetStatus</h4>
<b>getEthernetStatus</b>(<i></i>)
-
<p>
Public method to get Ethernet status data of the connected board.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1553,10 +1551,10 @@
<a NAME="BaseDevice.getFirmwareUrl" ID="BaseDevice.getFirmwareUrl"></a>
<h4>BaseDevice.getFirmwareUrl</h4>
<b>getFirmwareUrl</b>(<i></i>)
-
<p>
Public method to get the device firmware download URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1572,10 +1570,10 @@
<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>
@@ -1598,10 +1596,10 @@
<a NAME="BaseDevice.getModules" ID="BaseDevice.getModules"></a>
<h4>BaseDevice.getModules</h4>
<b>getModules</b>(<i></i>)
-
<p>
Public method to show a list of modules built into the firmware.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1624,10 +1622,10 @@
<a NAME="BaseDevice.getTime" ID="BaseDevice.getTime"></a>
<h4>BaseDevice.getTime</h4>
<b>getTime</b>(<i></i>)
-
<p>
Public method to get the current time of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1650,10 +1648,10 @@
<a NAME="BaseDevice.getWifiData" ID="BaseDevice.getWifiData"></a>
<h4>BaseDevice.getWifiData</h4>
<b>getWifiData</b>(<i></i>)
-
<p>
Public method to get data related to the current WiFi status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1670,10 +1668,10 @@
<a NAME="BaseDevice.getWorkspace" ID="BaseDevice.getWorkspace"></a>
<h4>BaseDevice.getWorkspace</h4>
<b>getWorkspace</b>(<i></i>)
-
<p>
Public method to get the workspace directory.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1689,17 +1687,17 @@
<a NAME="BaseDevice.handleDataFlood" ID="BaseDevice.handleDataFlood"></a>
<h4>BaseDevice.handleDataFlood</h4>
<b>handleDataFlood</b>(<i></i>)
-
<p>
Public slot handling a data floof from the device.
</p>
+
<a NAME="BaseDevice.hasBluetooth" ID="BaseDevice.hasBluetooth"></a>
<h4>BaseDevice.hasBluetooth</h4>
<b>hasBluetooth</b>(<i></i>)
-
<p>
Public method to check the availability of Bluetooth.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1715,10 +1713,10 @@
<a NAME="BaseDevice.hasCircuitPython" ID="BaseDevice.hasCircuitPython"></a>
<h4>BaseDevice.hasCircuitPython</h4>
<b>hasCircuitPython</b>(<i></i>)
-
<p>
Public method to check, if the connected device is flashed with CircuitPython.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1734,11 +1732,11 @@
<a NAME="BaseDevice.hasDocumentationUrl" ID="BaseDevice.hasDocumentationUrl"></a>
<h4>BaseDevice.hasDocumentationUrl</h4>
<b>hasDocumentationUrl</b>(<i></i>)
-
<p>
Public method to check, if the device has a configured documentation
URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1754,10 +1752,10 @@
<a NAME="BaseDevice.hasEthernet" ID="BaseDevice.hasEthernet"></a>
<h4>BaseDevice.hasEthernet</h4>
<b>hasEthernet</b>(<i></i>)
-
<p>
Public method to check the availability of Ethernet.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1774,11 +1772,11 @@
<a NAME="BaseDevice.hasFirmwareUrl" ID="BaseDevice.hasFirmwareUrl"></a>
<h4>BaseDevice.hasFirmwareUrl</h4>
<b>hasFirmwareUrl</b>(<i></i>)
-
<p>
Public method to check, if the device has a configured firmware
download URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1794,10 +1792,10 @@
<a NAME="BaseDevice.hasFlashMenuEntry" ID="BaseDevice.hasFlashMenuEntry"></a>
<h4>BaseDevice.hasFlashMenuEntry</h4>
<b>hasFlashMenuEntry</b>(<i></i>)
-
<p>
Public method to check, if the device has its own flash menu entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1813,10 +1811,10 @@
<a NAME="BaseDevice.hasNetworkTime" ID="BaseDevice.hasNetworkTime"></a>
<h4>BaseDevice.hasNetworkTime</h4>
<b>hasNetworkTime</b>(<i></i>)
-
<p>
Public method to check the availability of network time functions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1832,13 +1830,13 @@
<a NAME="BaseDevice.hasTimeCommands" ID="BaseDevice.hasTimeCommands"></a>
<h4>BaseDevice.hasTimeCommands</h4>
<b>hasTimeCommands</b>(<i></i>)
-
<p>
Public method to check, if the device supports time commands.
</p>
<p>
The default returns True.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1854,10 +1852,10 @@
<a NAME="BaseDevice.hasWifi" ID="BaseDevice.hasWifi"></a>
<h4>BaseDevice.hasWifi</h4>
<b>hasWifi</b>(<i></i>)
-
<p>
Public method to check the availability of WiFi.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1874,11 +1872,11 @@
<a NAME="BaseDevice.hasWifiCountry" ID="BaseDevice.hasWifiCountry"></a>
<h4>BaseDevice.hasWifiCountry</h4>
<b>hasWifiCountry</b>(<i></i>)
-
<p>
Public method to check, if the device (potentially) has support to set the
WiFi country.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1894,10 +1892,10 @@
<a NAME="BaseDevice.isLanConnected" ID="BaseDevice.isLanConnected"></a>
<h4>BaseDevice.isLanConnected</h4>
<b>isLanConnected</b>(<i></i>)
-
<p>
Public method to check the LAN connection status.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1913,11 +1911,11 @@
<a NAME="BaseDevice.isNetworkConnected" ID="BaseDevice.isNetworkConnected"></a>
<h4>BaseDevice.isNetworkConnected</h4>
<b>isNetworkConnected</b>(<i></i>)
-
<p>
Public method to check, if the network interface (WiFi or Ethernet) is
connected.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1933,10 +1931,10 @@
<a NAME="BaseDevice.isWifiApConnected" ID="BaseDevice.isWifiApConnected"></a>
<h4>BaseDevice.isWifiApConnected</h4>
<b>isWifiApConnected</b>(<i></i>)
-
<p>
Public method to check the WiFi connection status as access point.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1952,10 +1950,10 @@
<a NAME="BaseDevice.isWifiClientConnected" ID="BaseDevice.isWifiClientConnected"></a>
<h4>BaseDevice.isWifiClientConnected</h4>
<b>isWifiClientConnected</b>(<i></i>)
-
<p>
Public method to check the WiFi connection status as client.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1971,11 +1969,11 @@
<a NAME="BaseDevice.lls" ID="BaseDevice.lls"></a>
<h4>BaseDevice.lls</h4>
<b>lls</b>(<i>dirname="", fullstat=False, showHidden=False</i>)
-
<p>
Public method to get a long directory listing of the connected device
including meta data.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -2016,10 +2014,10 @@
<a NAME="BaseDevice.ls" ID="BaseDevice.ls"></a>
<h4>BaseDevice.ls</h4>
<b>ls</b>(<i>dirname=""</i>)
-
<p>
Public method to get a directory listing of the connected device.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -2049,10 +2047,10 @@
<a NAME="BaseDevice.mipInstall" ID="BaseDevice.mipInstall"></a>
<h4>BaseDevice.mipInstall</h4>
<b>mipInstall</b>(<i>package, index=None, target=None, version=None, mpy=True</i>)
-
<p>
Public method to install packages using 'mip'.
</p>
+
<dl>
<dt><i>package</i> (str)</dt>
@@ -2091,10 +2089,10 @@
<a NAME="BaseDevice.mkdir" ID="BaseDevice.mkdir"></a>
<h4>BaseDevice.mkdir</h4>
<b>mkdir</b>(<i>dirname</i>)
-
<p>
Public method to create a new directory.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -2112,10 +2110,10 @@
<a NAME="BaseDevice.put" ID="BaseDevice.put"></a>
<h4>BaseDevice.put</h4>
<b>put</b>(<i>hostFileName, deviceFileName=None</i>)
-
<p>
Public method to copy a local file to the connected device.
</p>
+
<dl>
<dt><i>hostFileName</i> (str)</dt>
@@ -2149,10 +2147,10 @@
<a NAME="BaseDevice.putData" ID="BaseDevice.putData"></a>
<h4>BaseDevice.putData</h4>
<b>putData</b>(<i>deviceFileName, content</i>)
-
<p>
Public method to write the given data to the connected device.
</p>
+
<dl>
<dt><i>deviceFileName</i> (str)</dt>
@@ -2186,10 +2184,10 @@
<a NAME="BaseDevice.pwd" ID="BaseDevice.pwd"></a>
<h4>BaseDevice.pwd</h4>
<b>pwd</b>(<i></i>)
-
<p>
Public method to get the current directory of the connected device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2212,10 +2210,10 @@
<a NAME="BaseDevice.removeCredentials" ID="BaseDevice.removeCredentials"></a>
<h4>BaseDevice.removeCredentials</h4>
<b>removeCredentials</b>(<i></i>)
-
<p>
Public method to remove the saved credentials from the connected device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2231,13 +2229,13 @@
<a NAME="BaseDevice.removeLanAutoConnect" ID="BaseDevice.removeLanAutoConnect"></a>
<h4>BaseDevice.removeLanAutoConnect</h4>
<b>removeLanAutoConnect</b>(<i></i>)
-
<p>
Public method to remove the saved IPv4 parameters from the connected device.
</p>
<p>
Note: This disables the LAN auto-connect feature.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2253,10 +2251,10 @@
<a NAME="BaseDevice.rm" ID="BaseDevice.rm"></a>
<h4>BaseDevice.rm</h4>
<b>rm</b>(<i>filename</i>)
-
<p>
Public method to remove a file from the connected device.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -2274,10 +2272,10 @@
<a NAME="BaseDevice.rmdir" ID="BaseDevice.rmdir"></a>
<h4>BaseDevice.rmdir</h4>
<b>rmdir</b>(<i>dirname</i>)
-
<p>
Public method to remove a directory.
</p>
+
<dl>
<dt><i>dirname</i> (str)</dt>
@@ -2295,10 +2293,10 @@
<a NAME="BaseDevice.rmrf" ID="BaseDevice.rmrf"></a>
<h4>BaseDevice.rmrf</h4>
<b>rmrf</b>(<i>name, recursive=False, force=False</i>)
-
<p>
Public method to remove a file or directory recursively.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -2336,10 +2334,10 @@
<a NAME="BaseDevice.runScript" ID="BaseDevice.runScript"></a>
<h4>BaseDevice.runScript</h4>
<b>runScript</b>(<i>script</i>)
-
<p>
Public method to run the given Python script.
</p>
+
<dl>
<dt><i>script</i> (str)</dt>
@@ -2350,10 +2348,10 @@
<a NAME="BaseDevice.scanNetworks" ID="BaseDevice.scanNetworks"></a>
<h4>BaseDevice.scanNetworks</h4>
<b>scanNetworks</b>(<i></i>)
-
<p>
Public method to scan for available WiFi networks.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2370,11 +2368,11 @@
<a NAME="BaseDevice.selectDeviceDirectory" ID="BaseDevice.selectDeviceDirectory"></a>
<h4>BaseDevice.selectDeviceDirectory</h4>
<b>selectDeviceDirectory</b>(<i>deviceDirectories</i>)
-
<p>
Public method to select the device directory from a list of detected
ones.
</p>
+
<dl>
<dt><i>deviceDirectories</i> (list of str)</dt>
@@ -2397,10 +2395,10 @@
<a NAME="BaseDevice.sendCommands" ID="BaseDevice.sendCommands"></a>
<h4>BaseDevice.sendCommands</h4>
<b>sendCommands</b>(<i>commandsList</i>)
-
<p>
Public method to send a list of commands to the device.
</p>
+
<dl>
<dt><i>commandsList</i> (list of str)</dt>
@@ -2411,14 +2409,13 @@
<a NAME="BaseDevice.setButtons" ID="BaseDevice.setButtons"></a>
<h4>BaseDevice.setButtons</h4>
<b>setButtons</b>(<i></i>)
-
<p>
Public method to enable the supported action buttons.
</p>
+
<a NAME="BaseDevice.setConnected" ID="BaseDevice.setConnected"></a>
<h4>BaseDevice.setConnected</h4>
<b>setConnected</b>(<i>connected</i>)
-
<p>
Public method to set the connection state.
</p>
@@ -2426,6 +2423,7 @@
Note: This method can be overwritten to perform actions upon connect
or disconnect of the device.
</p>
+
<dl>
<dt><i>connected</i> (bool)</dt>
@@ -2436,10 +2434,10 @@
<a NAME="BaseDevice.setFileManager" ID="BaseDevice.setFileManager"></a>
<h4>BaseDevice.setFileManager</h4>
<b>setFileManager</b>(<i>on</i>)
-
<p>
Public method to set the File Manager status and dependent status.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -2450,11 +2448,11 @@
<a NAME="BaseDevice.setNetworkTime" ID="BaseDevice.setNetworkTime"></a>
<h4>BaseDevice.setNetworkTime</h4>
<b>setNetworkTime</b>(<i>server="pool.ntp.org", tzOffset=0, timeout=10</i>)
-
<p>
Public method to set the time to the network time retrieved from an
NTP server.
</p>
+
<dl>
<dt><i>server</i> (str (optional))</dt>
@@ -2487,10 +2485,10 @@
<a NAME="BaseDevice.setPlotter" ID="BaseDevice.setPlotter"></a>
<h4>BaseDevice.setPlotter</h4>
<b>setPlotter</b>(<i>on</i>)
-
<p>
Public method to set the Plotter status and dependent status.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -2501,10 +2499,10 @@
<a NAME="BaseDevice.setRepl" ID="BaseDevice.setRepl"></a>
<h4>BaseDevice.setRepl</h4>
<b>setRepl</b>(<i>on</i>)
-
<p>
Public method to set the REPL status and dependent status.
</p>
+
<dl>
<dt><i>on</i> (bool)</dt>
@@ -2515,10 +2513,10 @@
<a NAME="BaseDevice.setWorkspace" ID="BaseDevice.setWorkspace"></a>
<h4>BaseDevice.setWorkspace</h4>
<b>setWorkspace</b>(<i>workspacePath</i>)
-
<p>
Public method to set the device workspace directory.
</p>
+
<dl>
<dt><i>workspacePath</i> (str)</dt>
@@ -2529,10 +2527,10 @@
<a NAME="BaseDevice.startAccessPoint" ID="BaseDevice.startAccessPoint"></a>
<h4>BaseDevice.startAccessPoint</h4>
<b>startAccessPoint</b>(<i>ssid, security=None, password=None, hostname=None, ifconfig=None, </i>)
-
<p>
Public method to start the access point interface.
</p>
+
<dl>
<dt><i>ssid</i> (str)</dt>
@@ -2572,10 +2570,10 @@
<a NAME="BaseDevice.stopAccessPoint" ID="BaseDevice.stopAccessPoint"></a>
<h4>BaseDevice.stopAccessPoint</h4>
<b>stopAccessPoint</b>(<i></i>)
-
<p>
Public method to stop the access point interface.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2591,10 +2589,10 @@
<a NAME="BaseDevice.submitMode" ID="BaseDevice.submitMode"></a>
<h4>BaseDevice.submitMode</h4>
<b>submitMode</b>(<i></i>)
-
<p>
Public method to get the submit mode of the device.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2610,10 +2608,10 @@
<a NAME="BaseDevice.supportsLocalFileAccess" ID="BaseDevice.supportsLocalFileAccess"></a>
<h4>BaseDevice.supportsLocalFileAccess</h4>
<b>supportsLocalFileAccess</b>(<i></i>)
-
<p>
Public method to indicate file access via a local directory.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -2629,11 +2627,11 @@
<a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a>
<h4>BaseDevice.syncTime</h4>
<b>syncTime</b>(<i>deviceType, hasCPy=False</i>)
-
<p>
Public method to set the time of the connected device to the local
computer's time.
</p>
+
<dl>
<dt><i>deviceType</i> (str)</dt>
@@ -2656,10 +2654,10 @@
<a NAME="BaseDevice.upipInstall" ID="BaseDevice.upipInstall"></a>
<h4>BaseDevice.upipInstall</h4>
<b>upipInstall</b>(<i>packages</i>)
-
<p>
Public method to install packages using 'upip'.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -2682,11 +2680,11 @@
<a NAME="BaseDevice.writeCredentials" ID="BaseDevice.writeCredentials"></a>
<h4>BaseDevice.writeCredentials</h4>
<b>writeCredentials</b>(<i>ssid, password, hostname, country</i>)
-
<p>
Public method to write the given credentials to the connected device and modify
the start script to connect automatically.
</p>
+
<dl>
<dt><i>ssid</i> (str)</dt>
@@ -2721,11 +2719,11 @@
<a NAME="BaseDevice.writeLanAutoConnect" ID="BaseDevice.writeLanAutoConnect"></a>
<h4>BaseDevice.writeLanAutoConnect</h4>
<b>writeLanAutoConnect</b>(<i>config, hostname</i>)
-
<p>
Public method to generate a script and associated configuration to connect the
device to the LAN during boot time.
</p>
+
<dl>
<dt><i>config</i> (str or tuple of (str, str, str, str))</dt>
@@ -2752,4 +2750,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
