Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Fri Oct 27 14:09:40 2023 +0200
@@ -215,11 +215,11 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.connectToLan">connectToLan</a></td>
-<td></td>
+<td>Public method to connect the connected device to the LAN.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.connectWifi">connectWifi</a></td>
-<td></td>
+<td>Public method to connect a device to a WiFi network.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.deactivateBluetoothInterface">deactivateBluetoothInterface</a></td>
@@ -231,7 +231,7 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.deactivateInterface">deactivateInterface</a></td>
-<td></td>
+<td>Public method to deactivate a given WiFi interface of the connected device.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.deviceName">deviceName</a></td>
@@ -255,7 +255,7 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.enableWebrepl">enableWebrepl</a></td>
-<td></td>
+<td>Public method to write the given WebREPL password to the connected device and modify the start script to start the WebREPL server.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.ensurePath">ensurePath</a></td>
@@ -303,7 +303,7 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.getDeviceScan">getDeviceScan</a></td>
-<td></td>
+<td>Public method to perform a Bluetooth device scan.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.getDeviceType">getDeviceType</a></td>
@@ -515,7 +515,7 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.syncTime">syncTime</a></td>
-<td></td>
+<td>Public method to set the time of the connected device to the local computer's time.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.upipInstall">upipInstall</a></td>
@@ -523,11 +523,11 @@
 </tr>
 <tr>
 <td><a href="#BaseDevice.writeCredentials">writeCredentials</a></td>
-<td></td>
+<td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td>
 </tr>
 <tr>
 <td><a href="#BaseDevice.writeLanAutoConnect">writeLanAutoConnect</a></td>
-<td></td>
+<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>
@@ -909,10 +909,67 @@
 <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>
+<dd>
+configuration for the connection (either the string 'dhcp'
+            for a dynamic address or a tuple of four strings with the IPv4 parameters.
+</dd>
+<dt><i>hostname</i> (str)</dt>
+<dd>
+host name of the device
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <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>
+<dd>
+name (SSID) of the WiFi network
+</dd>
+<dt><i>password</i> (str)</dt>
+<dd>
+password needed to connect
+</dd>
+<dt><i>hostname</i> (str)</dt>
+<dd>
+host name of the device
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the connection status and an error string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <a NAME="BaseDevice.deactivateBluetoothInterface" ID="BaseDevice.deactivateBluetoothInterface"></a>
 <h4>BaseDevice.deactivateBluetoothInterface</h4>
 <b>deactivateBluetoothInterface</b>(<i></i>)
@@ -955,6 +1012,29 @@
 <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>
+<dd>
+designation of the interface to be deactivated (one of 'AP'
+            or 'STA')
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containg a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <a NAME="BaseDevice.deviceName" ID="BaseDevice.deviceName"></a>
 <h4>BaseDevice.deviceName</h4>
 <b>deviceName</b>(<i></i>)
@@ -1043,6 +1123,29 @@
 <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>
+<dd>
+password needed to authenticate
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <a NAME="BaseDevice.ensurePath" ID="BaseDevice.ensurePath"></a>
 <h4>BaseDevice.ensurePath</h4>
 <b>ensurePath</b>(<i>target</i>)
@@ -1345,6 +1448,30 @@
 <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>
+<dd>
+duration of the device scan in seconds (defaults
+            to 10)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a dictionary with the scan results and
+            an error string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (dict, str)
+</dd>
+</dl>
 <a NAME="BaseDevice.getDeviceType" ID="BaseDevice.getDeviceType"></a>
 <h4>BaseDevice.getDeviceType</h4>
 <b>getDeviceType</b>(<i></i>)
@@ -2497,6 +2624,29 @@
 <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>
+<dd>
+type of board to sync time to
+</dd>
+<dt><i>hasCPy</i> (bool)</dt>
+<dd>
+flag indicating that the device has CircuitPython loadede
+            (defaults to False)
+</dd>
+</dl>
+<dl>
+
+<dt>Raises <b>OSError</b>:</dt>
+<dd>
+raised to indicate an issue with the device
+</dd>
+</dl>
 <a NAME="BaseDevice.upipInstall" ID="BaseDevice.upipInstall"></a>
 <h4>BaseDevice.upipInstall</h4>
 <b>upipInstall</b>(<i>packages</i>)
@@ -2521,10 +2671,73 @@
 <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>
+<dd>
+SSID of the network to connect to
+</dd>
+<dt><i>password</i> (str)</dt>
+<dd>
+password needed to authenticate
+</dd>
+<dt><i>hostname</i> (str)</dt>
+<dd>
+host name of the device
+</dd>
+<dt><i>country</i> (str)</dt>
+<dd>
+WiFi country code
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <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>
+<dd>
+configuration for the connection (either the string 'dhcp'
+            for a dynamic address or a tuple of four strings with the IPv4 parameters.
+</dd>
+<dt><i>hostname</i> (str)</dt>
+<dd>
+host name of the device
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>
\ No newline at end of file