Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonDevices.html	Fri Oct 27 14:09:40 2023 +0200
@@ -320,7 +320,7 @@
 </tr>
 <tr>
 <td><a href="#CircuitPythonDevice.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="#CircuitPythonDevice.writeLanAutoConnect">writeLanAutoConnect</a></td>
@@ -1610,6 +1610,41 @@
 <h4>CircuitPythonDevice.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 (unused)
+</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, hostname</i>)