eric: comparison src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html

-:33e7b9d3f91c
+:ffe7432f716b
 <tr>
 <td><a href="#RP2040Device.__flashPython">__flashPython</a></td>
 <td>Private slot to flash a MicroPython firmware to the device.</td>
 </tr>
 <tr>
+<td><a href="#RP2040Device.__resetCountry">__resetCountry</a></td>
+<td>Private slot to reset the country of the connected ESP32 device.</td>
+</tr>
+<tr>
 <td><a href="#RP2040Device.__resetDevice">__resetDevice</a></td>
 <td>Private slot to reset the connected device.</td>
 </tr>
 <tr>
 <td><a href="#RP2040Device.__setCountry">__setCountry</a></td>
 <td>Public method to check the availability of network time functions.</td>
 </tr>
 <tr>
 <td><a href="#RP2040Device.hasWifi">hasWifi</a></td>
 <td>Public method to check the availability of WiFi.</td>
+</tr>
+<tr>
+<td><a href="#RP2040Device.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="#RP2040Device.isLanConnected">isLanConnected</a></td>
 <td>Public method to check the LAN connection status.</td>
 </tr>
 <b>__flashPython</b>(<i></i>)
 <p>
 Private slot to flash a MicroPython firmware to the device.
 </p>
+<a NAME="RP2040Device.__resetCountry" ID="RP2040Device.__resetCountry"></a>
+<h4>RP2040Device.__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="RP2040Device.__resetDevice" ID="RP2040Device.__resetDevice"></a>
 <h4>RP2040Device.__resetDevice</h4>
 <b>__resetDevice</b>(<i></i>)
 <p>
 <p>
 Private slot to configure the country of the connected RP2040 device.
 </p>
 <p>
-The country is the two letter country code.
+The country is the two-letter ISO 3166-1 Alpha-2 country code.
 </p>
 <a NAME="RP2040Device.__showFirmwareVersions" ID="RP2040Device.__showFirmwareVersions"></a>
 <h4>RP2040Device.__showFirmwareVersions</h4>
 <b>__showFirmwareVersions</b>(<i></i>)
 tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="RP2040Device.connectToLan" ID="RP2040Device.connectToLan"></a>
 <h4>RP2040Device.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.
 </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
 tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="RP2040Device.connectWifi" ID="RP2040Device.connectWifi"></a>
 <h4>RP2040Device.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.
 </p>
 <dl>
 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>
 <dt>Raises <b>OSError</b>:</dt>
 <dd>
 raised to indicate an issue with the device
 </dd>
 </dl>
+<a NAME="RP2040Device.hasWifiCountry" ID="RP2040Device.hasWifiCountry"></a>
+<h4>RP2040Device.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="RP2040Device.isLanConnected" ID="RP2040Device.isLanConnected"></a>
 <h4>RP2040Device.isLanConnected</h4>
 <b>isLanConnected</b>(<i></i>)
 <p>
 tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="RP2040Device.startAccessPoint" ID="RP2040Device.startAccessPoint"></a>
 <h4>RP2040Device.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.
 </p>
 <dl>
 security method (defaults to None)
 </dd>
 <dt><i>password</i> (str (optional))</dt>
 <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
 (IPv4 address, netmask, gateway address, DNS server address)
 tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="RP2040Device.writeCredentials" ID="RP2040Device.writeCredentials"></a>
 <h4>RP2040Device.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
 the start script to connect automatically.
 </p>
 </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
 tuple of (bool, str)
 </dd>
 </dl>
 <a NAME="RP2040Device.writeLanAutoConnect" ID="RP2040Device.writeLanAutoConnect"></a>
 <h4>RP2040Device.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
 device to the LAN during boot time.
 </p>
 <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>

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.RP2040Devices.html

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