Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10153
ffe7432f716b
parent 10144
45a9177c8e77
child 10479
856476537696
equal deleted inserted replaced
10152:33e7b9d3f91c 10153:ffe7432f716b
106 <tr> 106 <tr>
107 <td><a href="#EspDevice.__installEspTool">__installEspTool</a></td> 107 <td><a href="#EspDevice.__installEspTool">__installEspTool</a></td>
108 <td>Private slot to install the esptool package via pip.</td> 108 <td>Private slot to install the esptool package via pip.</td>
109 </tr> 109 </tr>
110 <tr> 110 <tr>
111 <td><a href="#EspDevice.__resetCountry">__resetCountry</a></td>
112 <td>Private slot to reset the country of the connected ESP32 device.</td>
113 </tr>
114 <tr>
111 <td><a href="#EspDevice.__resetDevice">__resetDevice</a></td> 115 <td><a href="#EspDevice.__resetDevice">__resetDevice</a></td>
112 <td>Private slot to reset the connected device.</td> 116 <td>Private slot to reset the connected device.</td>
113 </tr> 117 </tr>
114 <tr> 118 <tr>
115 <td><a href="#EspDevice.__restoreFlash">__restoreFlash</a></td> 119 <td><a href="#EspDevice.__restoreFlash">__restoreFlash</a></td>
116 <td>Private slot to restore a previously saved firmware.</td> 120 <td>Private slot to restore a previously saved firmware.</td>
117 </tr> 121 </tr>
118 <tr> 122 <tr>
123 <td><a href="#EspDevice.__setCountry">__setCountry</a></td>
124 <td>Private slot to configure the country of the connected ESP32 device.</td>
125 </tr>
126 <tr>
119 <td><a href="#EspDevice.__showChipID">__showChipID</a></td> 127 <td><a href="#EspDevice.__showChipID">__showChipID</a></td>
120 <td>Private slot to show the ID of the ESP chip.</td> 128 <td>Private slot to show the ID of the ESP chip.</td>
121 </tr> 129 </tr>
122 <tr> 130 <tr>
123 <td><a href="#EspDevice.__showFirmwareVersions">__showFirmwareVersions</a></td> 131 <td><a href="#EspDevice.__showFirmwareVersions">__showFirmwareVersions</a></td>
142 <tr> 150 <tr>
143 <td><a href="#EspDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> 151 <td><a href="#EspDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
144 <td>Public method to add device specific entries to the given menu.</td> 152 <td>Public method to add device specific entries to the given menu.</td>
145 </tr> 153 </tr>
146 <tr> 154 <tr>
155 <td><a href="#EspDevice.addDeviceWifiEntries">addDeviceWifiEntries</a></td>
156 <td>Public method to add device specific entries to the given menu.</td>
157 </tr>
158 <tr>
147 <td><a href="#EspDevice.canRunScript">canRunScript</a></td> 159 <td><a href="#EspDevice.canRunScript">canRunScript</a></td>
148 <td>Public method to determine, if a script can be executed.</td> 160 <td>Public method to determine, if a script can be executed.</td>
149 </tr> 161 </tr>
150 <tr> 162 <tr>
151 <td><a href="#EspDevice.canStartFileManager">canStartFileManager</a></td> 163 <td><a href="#EspDevice.canStartFileManager">canStartFileManager</a></td>
232 <td>Public method to check the availability of network time functions.</td> 244 <td>Public method to check the availability of network time functions.</td>
233 </tr> 245 </tr>
234 <tr> 246 <tr>
235 <td><a href="#EspDevice.hasWifi">hasWifi</a></td> 247 <td><a href="#EspDevice.hasWifi">hasWifi</a></td>
236 <td>Public method to check the availability of WiFi.</td> 248 <td>Public method to check the availability of WiFi.</td>
249 </tr>
250 <tr>
251 <td><a href="#EspDevice.hasWifiCountry">hasWifiCountry</a></td>
252 <td>Public method to check, if the device has support to set the WiFi country.</td>
237 </tr> 253 </tr>
238 <tr> 254 <tr>
239 <td><a href="#EspDevice.isWifiApConnected">isWifiApConnected</a></td> 255 <td><a href="#EspDevice.isWifiApConnected">isWifiApConnected</a></td>
240 <td>Public method to check the WiFi connection status as access point.</td> 256 <td>Public method to check the WiFi connection status as access point.</td>
241 </tr> 257 </tr>
369 <b>__installEspTool</b>(<i></i>) 385 <b>__installEspTool</b>(<i></i>)
370 386
371 <p> 387 <p>
372 Private slot to install the esptool package via pip. 388 Private slot to install the esptool package via pip.
373 </p> 389 </p>
390 <a NAME="EspDevice.__resetCountry" ID="EspDevice.__resetCountry"></a>
391 <h4>EspDevice.__resetCountry</h4>
392 <b>__resetCountry</b>(<i></i>)
393
394 <p>
395 Private slot to reset the country of the connected ESP32 device.
396 </p>
397 <p>
398 The country is the two-letter ISO 3166-1 Alpha-2 country code. This method
399 resets it to the default code 'XX' representing the "worldwide" region.
400 </p>
374 <a NAME="EspDevice.__resetDevice" ID="EspDevice.__resetDevice"></a> 401 <a NAME="EspDevice.__resetDevice" ID="EspDevice.__resetDevice"></a>
375 <h4>EspDevice.__resetDevice</h4> 402 <h4>EspDevice.__resetDevice</h4>
376 <b>__resetDevice</b>(<i></i>) 403 <b>__resetDevice</b>(<i></i>)
377 404
378 <p> 405 <p>
383 <b>__restoreFlash</b>(<i></i>) 410 <b>__restoreFlash</b>(<i></i>)
384 411
385 <p> 412 <p>
386 Private slot to restore a previously saved firmware. 413 Private slot to restore a previously saved firmware.
387 </p> 414 </p>
415 <a NAME="EspDevice.__setCountry" ID="EspDevice.__setCountry"></a>
416 <h4>EspDevice.__setCountry</h4>
417 <b>__setCountry</b>(<i></i>)
418
419 <p>
420 Private slot to configure the country of the connected ESP32 device.
421 </p>
422 <p>
423 The country is the two-letter ISO 3166-1 Alpha-2 country code.
424 </p>
388 <a NAME="EspDevice.__showChipID" ID="EspDevice.__showChipID"></a> 425 <a NAME="EspDevice.__showChipID" ID="EspDevice.__showChipID"></a>
389 <h4>EspDevice.__showChipID</h4> 426 <h4>EspDevice.__showChipID</h4>
390 <b>__showChipID</b>(<i></i>) 427 <b>__showChipID</b>(<i></i>)
391 428
392 <p> 429 <p>
475 <dt><i>menu</i> (QMenu)</dt> 512 <dt><i>menu</i> (QMenu)</dt>
476 <dd> 513 <dd>
477 reference to the context menu 514 reference to the context menu
478 </dd> 515 </dd>
479 </dl> 516 </dl>
517 <a NAME="EspDevice.addDeviceWifiEntries" ID="EspDevice.addDeviceWifiEntries"></a>
518 <h4>EspDevice.addDeviceWifiEntries</h4>
519 <b>addDeviceWifiEntries</b>(<i>menu</i>)
520
521 <p>
522 Public method to add device specific entries to the given menu.
523 </p>
524 <dl>
525
526 <dt><i>menu</i> (QMenu)</dt>
527 <dd>
528 reference to the context menu
529 </dd>
530 </dl>
480 <a NAME="EspDevice.canRunScript" ID="EspDevice.canRunScript"></a> 531 <a NAME="EspDevice.canRunScript" ID="EspDevice.canRunScript"></a>
481 <h4>EspDevice.canRunScript</h4> 532 <h4>EspDevice.canRunScript</h4>
482 <b>canRunScript</b>(<i></i>) 533 <b>canRunScript</b>(<i></i>)
483 534
484 <p> 535 <p>
576 tuple of (bool, str) 627 tuple of (bool, str)
577 </dd> 628 </dd>
578 </dl> 629 </dl>
579 <a NAME="EspDevice.connectWifi" ID="EspDevice.connectWifi"></a> 630 <a NAME="EspDevice.connectWifi" ID="EspDevice.connectWifi"></a>
580 <h4>EspDevice.connectWifi</h4> 631 <h4>EspDevice.connectWifi</h4>
581 <b>connectWifi</b>(<i>ssid, password</i>) 632 <b>connectWifi</b>(<i>ssid, password, hostname</i>)
582 633
583 <p> 634 <p>
584 Public method to connect a device to a WiFi network. 635 Public method to connect a device to a WiFi network.
585 </p> 636 </p>
586 <dl> 637 <dl>
590 name (SSID) of the WiFi network 641 name (SSID) of the WiFi network
591 </dd> 642 </dd>
592 <dt><i>password</i> (str)</dt> 643 <dt><i>password</i> (str)</dt>
593 <dd> 644 <dd>
594 password needed to connect 645 password needed to connect
646 </dd>
647 <dt><i>hostname</i> (str)</dt>
648 <dd>
649 host name of the device
595 </dd> 650 </dd>
596 </dl> 651 </dl>
597 <dl> 652 <dl>
598 <dt>Return:</dt> 653 <dt>Return:</dt>
599 <dd> 654 <dd>
1000 <dt>Return Type:</dt> 1055 <dt>Return Type:</dt>
1001 <dd> 1056 <dd>
1002 tuple of (bool, str) 1057 tuple of (bool, str)
1003 </dd> 1058 </dd>
1004 </dl> 1059 </dl>
1060 <a NAME="EspDevice.hasWifiCountry" ID="EspDevice.hasWifiCountry"></a>
1061 <h4>EspDevice.hasWifiCountry</h4>
1062 <b>hasWifiCountry</b>(<i></i>)
1063
1064 <p>
1065 Public method to check, if the device has support to set the WiFi country.
1066 </p>
1067 <dl>
1068 <dt>Return:</dt>
1069 <dd>
1070 flag indicating the support of WiFi country
1071 </dd>
1072 </dl>
1073 <dl>
1074 <dt>Return Type:</dt>
1075 <dd>
1076 bool
1077 </dd>
1078 </dl>
1005 <a NAME="EspDevice.isWifiApConnected" ID="EspDevice.isWifiApConnected"></a> 1079 <a NAME="EspDevice.isWifiApConnected" ID="EspDevice.isWifiApConnected"></a>
1006 <h4>EspDevice.isWifiApConnected</h4> 1080 <h4>EspDevice.isWifiApConnected</h4>
1007 <b>isWifiApConnected</b>(<i></i>) 1081 <b>isWifiApConnected</b>(<i></i>)
1008 1082
1009 <p> 1083 <p>
1155 tuple of (bool, str) 1229 tuple of (bool, str)
1156 </dd> 1230 </dd>
1157 </dl> 1231 </dl>
1158 <a NAME="EspDevice.startAccessPoint" ID="EspDevice.startAccessPoint"></a> 1232 <a NAME="EspDevice.startAccessPoint" ID="EspDevice.startAccessPoint"></a>
1159 <h4>EspDevice.startAccessPoint</h4> 1233 <h4>EspDevice.startAccessPoint</h4>
1160 <b>startAccessPoint</b>(<i>ssid, security=None, password=None, ifconfig=None</i>) 1234 <b>startAccessPoint</b>(<i>ssid, security=None, password=None, hostname=None, ifconfig=None, </i>)
1161 1235
1162 <p> 1236 <p>
1163 Public method to start the access point interface. 1237 Public method to start the access point interface.
1164 </p> 1238 </p>
1165 <dl> 1239 <dl>
1173 security method (defaults to None) 1247 security method (defaults to None)
1174 </dd> 1248 </dd>
1175 <dt><i>password</i> (str (optional))</dt> 1249 <dt><i>password</i> (str (optional))</dt>
1176 <dd> 1250 <dd>
1177 password (defaults to None) 1251 password (defaults to None)
1252 </dd>
1253 <dt><i>hostname</i> (str (optional))</dt>
1254 <dd>
1255 host name of the device (defaults to None)
1178 </dd> 1256 </dd>
1179 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt> 1257 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt>
1180 <dd> 1258 <dd>
1181 IPv4 configuration for the access point if not default 1259 IPv4 configuration for the access point if not default
1182 (IPv4 address, netmask, gateway address, DNS server address) 1260 (IPv4 address, netmask, gateway address, DNS server address)
1213 tuple of (bool, str) 1291 tuple of (bool, str)
1214 </dd> 1292 </dd>
1215 </dl> 1293 </dl>
1216 <a NAME="EspDevice.writeCredentials" ID="EspDevice.writeCredentials"></a> 1294 <a NAME="EspDevice.writeCredentials" ID="EspDevice.writeCredentials"></a>
1217 <h4>EspDevice.writeCredentials</h4> 1295 <h4>EspDevice.writeCredentials</h4>
1218 <b>writeCredentials</b>(<i>ssid, password</i>) 1296 <b>writeCredentials</b>(<i>ssid, password, hostname, country</i>)
1219 1297
1220 <p> 1298 <p>
1221 Public method to write the given credentials to the connected device and modify 1299 Public method to write the given credentials to the connected device and modify
1222 the start script to connect automatically. 1300 the start script to connect automatically.
1223 </p> 1301 </p>
1228 SSID of the network to connect to 1306 SSID of the network to connect to
1229 </dd> 1307 </dd>
1230 <dt><i>password</i> (str)</dt> 1308 <dt><i>password</i> (str)</dt>
1231 <dd> 1309 <dd>
1232 password needed to authenticate 1310 password needed to authenticate
1311 </dd>
1312 <dt><i>hostname</i> (str)</dt>
1313 <dd>
1314 host name of the device
1315 </dd>
1316 <dt><i>country</i> (str)</dt>
1317 <dd>
1318 WiFi country code
1233 </dd> 1319 </dd>
1234 </dl> 1320 </dl>
1235 <dl> 1321 <dl>
1236 <dt>Return:</dt> 1322 <dt>Return:</dt>
1237 <dd> 1323 <dd>

Mercurial Repository: eric

eric ide

mercurial