src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html

branch
eric7
changeset 10153
ffe7432f716b
parent 10144
45a9177c8e77
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html	Wed Aug 02 17:22:20 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.EspDevices.html	Thu Aug 03 17:33:07 2023 +0200
@@ -108,6 +108,10 @@
 <td>Private slot to install the esptool package via pip.</td>
 </tr>
 <tr>
+<td><a href="#EspDevice.__resetCountry">__resetCountry</a></td>
+<td>Private slot to reset the country of the connected ESP32 device.</td>
+</tr>
+<tr>
 <td><a href="#EspDevice.__resetDevice">__resetDevice</a></td>
 <td>Private slot to reset the connected device.</td>
 </tr>
@@ -116,6 +120,10 @@
 <td>Private slot to restore a previously saved firmware.</td>
 </tr>
 <tr>
+<td><a href="#EspDevice.__setCountry">__setCountry</a></td>
+<td>Private slot to configure the country of the connected ESP32 device.</td>
+</tr>
+<tr>
 <td><a href="#EspDevice.__showChipID">__showChipID</a></td>
 <td>Private slot to show the ID of the ESP chip.</td>
 </tr>
@@ -144,6 +152,10 @@
 <td>Public method to add device specific entries to the given menu.</td>
 </tr>
 <tr>
+<td><a href="#EspDevice.addDeviceWifiEntries">addDeviceWifiEntries</a></td>
+<td>Public method to add device specific entries to the given menu.</td>
+</tr>
+<tr>
 <td><a href="#EspDevice.canRunScript">canRunScript</a></td>
 <td>Public method to determine, if a script can be executed.</td>
 </tr>
@@ -236,6 +248,10 @@
 <td>Public method to check the availability of WiFi.</td>
 </tr>
 <tr>
+<td><a href="#EspDevice.hasWifiCountry">hasWifiCountry</a></td>
+<td>Public method to check, if the device has support to set the WiFi country.</td>
+</tr>
+<tr>
 <td><a href="#EspDevice.isWifiApConnected">isWifiApConnected</a></td>
 <td>Public method to check the WiFi connection status as access point.</td>
 </tr>
@@ -371,6 +387,17 @@
 <p>
         Private slot to install the esptool package via pip.
 </p>
+<a NAME="EspDevice.__resetCountry" ID="EspDevice.__resetCountry"></a>
+<h4>EspDevice.__resetCountry</h4>
+<b>__resetCountry</b>(<i></i>)
+
+<p>
+        Private slot to reset the country of the connected ESP32 device.
+</p>
+<p>
+        The country is the two-letter ISO 3166-1 Alpha-2 country code. This method
+        resets it to the default code 'XX' representing the "worldwide" region.
+</p>
 <a NAME="EspDevice.__resetDevice" ID="EspDevice.__resetDevice"></a>
 <h4>EspDevice.__resetDevice</h4>
 <b>__resetDevice</b>(<i></i>)
@@ -385,6 +412,16 @@
 <p>
         Private slot to restore a previously saved firmware.
 </p>
+<a NAME="EspDevice.__setCountry" ID="EspDevice.__setCountry"></a>
+<h4>EspDevice.__setCountry</h4>
+<b>__setCountry</b>(<i></i>)
+
+<p>
+        Private slot to configure the country of the connected ESP32 device.
+</p>
+<p>
+        The country is the two-letter ISO 3166-1 Alpha-2 country code.
+</p>
 <a NAME="EspDevice.__showChipID" ID="EspDevice.__showChipID"></a>
 <h4>EspDevice.__showChipID</h4>
 <b>__showChipID</b>(<i></i>)
@@ -477,6 +514,20 @@
 reference to the context menu
 </dd>
 </dl>
+<a NAME="EspDevice.addDeviceWifiEntries" ID="EspDevice.addDeviceWifiEntries"></a>
+<h4>EspDevice.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>
+<dd>
+reference to the context menu
+</dd>
+</dl>
 <a NAME="EspDevice.canRunScript" ID="EspDevice.canRunScript"></a>
 <h4>EspDevice.canRunScript</h4>
 <b>canRunScript</b>(<i></i>)
@@ -578,7 +629,7 @@
 </dl>
 <a NAME="EspDevice.connectWifi" ID="EspDevice.connectWifi"></a>
 <h4>EspDevice.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.
@@ -593,6 +644,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>
@@ -1002,6 +1057,25 @@
 tuple of (bool, str)
 </dd>
 </dl>
+<a NAME="EspDevice.hasWifiCountry" ID="EspDevice.hasWifiCountry"></a>
+<h4>EspDevice.hasWifiCountry</h4>
+<b>hasWifiCountry</b>(<i></i>)
+
+<p>
+        Public method to check, if the device has support to set the WiFi country.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating the support of WiFi country
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="EspDevice.isWifiApConnected" ID="EspDevice.isWifiApConnected"></a>
 <h4>EspDevice.isWifiApConnected</h4>
 <b>isWifiApConnected</b>(<i></i>)
@@ -1157,7 +1231,7 @@
 </dl>
 <a NAME="EspDevice.startAccessPoint" ID="EspDevice.startAccessPoint"></a>
 <h4>EspDevice.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.
@@ -1176,6 +1250,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
@@ -1215,7 +1293,7 @@
 </dl>
 <a NAME="EspDevice.writeCredentials" ID="EspDevice.writeCredentials"></a>
 <h4>EspDevice.writeCredentials</h4>
-<b>writeCredentials</b>(<i>ssid, password</i>)
+<b>writeCredentials</b>(<i>ssid, password, hostname, country</i>)
 
 <p>
         Public method to write the given credentials to the connected device and modify
@@ -1231,6 +1309,14 @@
 <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>

eric ide

mercurial