Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Wed Aug 02 17:22:20 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Thu Aug 03 17:33:07 2023 +0200
@@ -320,7 +320,7 @@
 </tr>
 <tr>
 <td><a href="#CircuitPythonDevice.writeCredentials">writeCredentials</a></td>
-<td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td>
+<td></td>
 </tr>
 <tr>
 <td><a href="#CircuitPythonDevice.writeLanAutoConnect">writeLanAutoConnect</a></td>
@@ -768,7 +768,7 @@
 </dl>
 <a NAME="CircuitPythonDevice.connectToLan" ID="CircuitPythonDevice.connectToLan"></a>
 <h4>CircuitPythonDevice.connectToLan</h4>
-<b>connectToLan</b>(<i>config</i>)
+<b>connectToLan</b>(<i>config, hostname</i>)
 
 <p>
         Public method to connect the connected device to the LAN.
@@ -783,6 +783,10 @@
 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>
@@ -798,7 +802,7 @@
 </dl>
 <a NAME="CircuitPythonDevice.connectWifi" ID="CircuitPythonDevice.connectWifi"></a>
 <h4>CircuitPythonDevice.connectWifi</h4>
-<b>connectWifi</b>(<i>ssid, password</i>)
+<b>connectWifi</b>(<i>ssid, password, hostname</i>)
 
 <p>
         Public method to connect a device to a WiFi network.
@@ -813,6 +817,10 @@
 <dd>
 password needed to connect
 </dd>
+<dt><i>hostname</i> (str)</dt>
+<dd>
+host name of the device
+</dd>
 </dl>
 <dl>
 <dt>Return:</dt>
@@ -1519,7 +1527,7 @@
 </p>
 <a NAME="CircuitPythonDevice.startAccessPoint" ID="CircuitPythonDevice.startAccessPoint"></a>
 <h4>CircuitPythonDevice.startAccessPoint</h4>
-<b>startAccessPoint</b>(<i>ssid, security=None, password=None, ifconfig=None</i>)
+<b>startAccessPoint</b>(<i>ssid, security=None, password=None, hostname=None, ifconfig=None, </i>)
 
 <p>
         Public method to start the access point interface.
@@ -1538,6 +1546,10 @@
 <dd>
 password (defaults to None)
 </dd>
+<dt><i>hostname</i> (str (optional))</dt>
+<dd>
+host name of the device (defaults to None)
+</dd>
 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt>
 <dd>
 IPv4 configuration for the access point if not default
@@ -1596,38 +1608,11 @@
 </dl>
 <a NAME="CircuitPythonDevice.writeCredentials" ID="CircuitPythonDevice.writeCredentials"></a>
 <h4>CircuitPythonDevice.writeCredentials</h4>
-<b>writeCredentials</b>(<i>ssid, password</i>)
-
-<p>
-        Public method to write the given credentials to the connected device and modify
-        the start script to connect automatically.
-</p>
-<dl>
+<b>writeCredentials</b>(<i>ssid, password, hostname, country</i>)
 
-<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>
-</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="CircuitPythonDevice.writeLanAutoConnect" ID="CircuitPythonDevice.writeLanAutoConnect"></a>
 <h4>CircuitPythonDevice.writeLanAutoConnect</h4>
-<b>writeLanAutoConnect</b>(<i>config</i>)
+<b>writeLanAutoConnect</b>(<i>config, hostname</i>)
 
 <p>
         Public method to generate a script and associated configuration to connect the
@@ -1640,6 +1625,10 @@
 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>