Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiController.html
src/eric7/Documentation/Source/eric7.MicroPython.WifiDialogs.WifiController.html
- branch
- mpy_network
- changeset 9800
- 25f388536caf
- child 9871
- 4a302b8c4d28
equal
deleted
inserted
replaced
| 9799:a79430a8811d | 9800:25f388536caf |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.MicroPython.WifiDialogs.WifiController</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.MicroPython.WifiDialogs.WifiController</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the WiFi related functionality. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#WifiController">WifiController</a></td> | |
| 25 <td>Class implementing the WiFi related functionality.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="WifiController" ID="WifiController"></a> | |
| 36 <h2>WifiController</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the WiFi related functionality. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QObject | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#WifiController.__init__">WifiController</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#WifiController.__checkInternet">__checkInternet</a></td> | |
| 63 <td>Private slot to check the availability of an internet connection.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#WifiController.__connectWifi">__connectWifi</a></td> | |
| 67 <td>Private slot to connect the current device to a WiFi network.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#WifiController.__deactivateInterface">__deactivateInterface</a></td> | |
| 71 <td>Private method to deactivate a given WiFi interface of the connected device.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#WifiController.__disconnectWifi">__disconnectWifi</a></td> | |
| 75 <td>Private slot to disconnect the current device from the WiFi network.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#WifiController.__removeCredentials">__removeCredentials</a></td> | |
| 79 <td>Private slot to remove the saved WiFi credentials from the connected device.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#WifiController.__scanNetwork">__scanNetwork</a></td> | |
| 83 <td>Private slot to scan for visible WiFi networks.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#WifiController.__showConnectedClients">__showConnectedClients</a></td> | |
| 87 <td>Private slot to show a list of WiFi clients connected to the Access Point interface.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#WifiController.__showWifiStatus">__showWifiStatus</a></td> | |
| 91 <td>Private slot to show a dialog with the WiFi status of the current device.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#WifiController.__startAccessPoint">__startAccessPoint</a></td> | |
| 95 <td>Private slot to start the Access Point interface of the connected device.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#WifiController.__startAccessPointIP">__startAccessPointIP</a></td> | |
| 99 <td>Private slot to start the Access Point interface of the connected device with given IP parameters.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#WifiController.__stopAccessPoint">__stopAccessPoint</a></td> | |
| 103 <td>Private slot to stop the Access Point interface of the connected device.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#WifiController.__writeCredentials">__writeCredentials</a></td> | |
| 107 <td>Private slot to save the WiFi login credentials to the connected device.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#WifiController.createMenu">createMenu</a></td> | |
| 111 <td>Public method to create the WiFi submenu.</td> | |
| 112 </tr> | |
| 113 </table> | |
| 114 <h3>Static Methods</h3> | |
| 115 | |
| 116 <table> | |
| 117 <tr><td>None</td></tr> | |
| 118 </table> | |
| 119 | |
| 120 <a NAME="WifiController.__init__" ID="WifiController.__init__"></a> | |
| 121 <h4>WifiController (Constructor)</h4> | |
| 122 <b>WifiController</b>(<i>microPython, parent=None</i>) | |
| 123 | |
| 124 <p> | |
| 125 Constructor | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt><i>microPython</i> (MicroPythonWidgep)</dt> | |
| 130 <dd> | |
| 131 reference to the MicroPython widget | |
| 132 </dd> | |
| 133 <dt><i>parent</i> (QObject (optional))</dt> | |
| 134 <dd> | |
| 135 reference to the parent object (defaults to None) | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <a NAME="WifiController.__checkInternet" ID="WifiController.__checkInternet"></a> | |
| 139 <h4>WifiController.__checkInternet</h4> | |
| 140 <b>__checkInternet</b>(<i></i>) | |
| 141 | |
| 142 <p> | |
| 143 Private slot to check the availability of an internet connection. | |
| 144 </p> | |
| 145 <a NAME="WifiController.__connectWifi" ID="WifiController.__connectWifi"></a> | |
| 146 <h4>WifiController.__connectWifi</h4> | |
| 147 <b>__connectWifi</b>(<i></i>) | |
| 148 | |
| 149 <p> | |
| 150 Private slot to connect the current device to a WiFi network. | |
| 151 </p> | |
| 152 <a NAME="WifiController.__deactivateInterface" ID="WifiController.__deactivateInterface"></a> | |
| 153 <h4>WifiController.__deactivateInterface</h4> | |
| 154 <b>__deactivateInterface</b>(<i>interface</i>) | |
| 155 | |
| 156 <p> | |
| 157 Private method to deactivate a given WiFi interface of the connected device. | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>interface</i> (str)</dt> | |
| 162 <dd> | |
| 163 designation of the interface to be deactivated (one of 'AP' | |
| 164 or 'STA') | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <a NAME="WifiController.__disconnectWifi" ID="WifiController.__disconnectWifi"></a> | |
| 168 <h4>WifiController.__disconnectWifi</h4> | |
| 169 <b>__disconnectWifi</b>(<i></i>) | |
| 170 | |
| 171 <p> | |
| 172 Private slot to disconnect the current device from the WiFi network. | |
| 173 </p> | |
| 174 <a NAME="WifiController.__removeCredentials" ID="WifiController.__removeCredentials"></a> | |
| 175 <h4>WifiController.__removeCredentials</h4> | |
| 176 <b>__removeCredentials</b>(<i></i>) | |
| 177 | |
| 178 <p> | |
| 179 Private slot to remove the saved WiFi credentials from the connected device. | |
| 180 </p> | |
| 181 <p> | |
| 182 This will not remove the auto-connect part of the boot script. This needs to be | |
| 183 done manually if desired. | |
| 184 </p> | |
| 185 <a NAME="WifiController.__scanNetwork" ID="WifiController.__scanNetwork"></a> | |
| 186 <h4>WifiController.__scanNetwork</h4> | |
| 187 <b>__scanNetwork</b>(<i></i>) | |
| 188 | |
| 189 <p> | |
| 190 Private slot to scan for visible WiFi networks. | |
| 191 </p> | |
| 192 <a NAME="WifiController.__showConnectedClients" ID="WifiController.__showConnectedClients"></a> | |
| 193 <h4>WifiController.__showConnectedClients</h4> | |
| 194 <b>__showConnectedClients</b>(<i></i>) | |
| 195 | |
| 196 <p> | |
| 197 Private slot to show a list of WiFi clients connected to the Access Point | |
| 198 interface. | |
| 199 </p> | |
| 200 <a NAME="WifiController.__showWifiStatus" ID="WifiController.__showWifiStatus"></a> | |
| 201 <h4>WifiController.__showWifiStatus</h4> | |
| 202 <b>__showWifiStatus</b>(<i></i>) | |
| 203 | |
| 204 <p> | |
| 205 Private slot to show a dialog with the WiFi status of the current device. | |
| 206 </p> | |
| 207 <a NAME="WifiController.__startAccessPoint" ID="WifiController.__startAccessPoint"></a> | |
| 208 <h4>WifiController.__startAccessPoint</h4> | |
| 209 <b>__startAccessPoint</b>(<i>withIP=False</i>) | |
| 210 | |
| 211 <p> | |
| 212 Private slot to start the Access Point interface of the connected device. | |
| 213 </p> | |
| 214 <dl> | |
| 215 | |
| 216 <dt><i>withIP</i> (bool)</dt> | |
| 217 <dd> | |
| 218 flag indicating to start the access point with an IP configuration | |
| 219 </dd> | |
| 220 </dl> | |
| 221 <a NAME="WifiController.__startAccessPointIP" ID="WifiController.__startAccessPointIP"></a> | |
| 222 <h4>WifiController.__startAccessPointIP</h4> | |
| 223 <b>__startAccessPointIP</b>(<i></i>) | |
| 224 | |
| 225 <p> | |
| 226 Private slot to start the Access Point interface of the connected device | |
| 227 with given IP parameters. | |
| 228 </p> | |
| 229 <a NAME="WifiController.__stopAccessPoint" ID="WifiController.__stopAccessPoint"></a> | |
| 230 <h4>WifiController.__stopAccessPoint</h4> | |
| 231 <b>__stopAccessPoint</b>(<i></i>) | |
| 232 | |
| 233 <p> | |
| 234 Private slot to stop the Access Point interface of the connected device. | |
| 235 </p> | |
| 236 <a NAME="WifiController.__writeCredentials" ID="WifiController.__writeCredentials"></a> | |
| 237 <h4>WifiController.__writeCredentials</h4> | |
| 238 <b>__writeCredentials</b>(<i></i>) | |
| 239 | |
| 240 <p> | |
| 241 Private slot to save the WiFi login credentials to the connected device. | |
| 242 </p> | |
| 243 <p> | |
| 244 This will also modify the boot script to perform an automatic WiFi connection. | |
| 245 </p> | |
| 246 <a NAME="WifiController.createMenu" ID="WifiController.createMenu"></a> | |
| 247 <h4>WifiController.createMenu</h4> | |
| 248 <b>createMenu</b>(<i>menu</i>) | |
| 249 | |
| 250 <p> | |
| 251 Public method to create the WiFi submenu. | |
| 252 </p> | |
| 253 <dl> | |
| 254 | |
| 255 <dt><i>menu</i> (QMenu)</dt> | |
| 256 <dd> | |
| 257 reference to the parent menu | |
| 258 </dd> | |
| 259 </dl> | |
| 260 <dl> | |
| 261 <dt>Return:</dt> | |
| 262 <dd> | |
| 263 reference to the created menu | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <dl> | |
| 267 <dt>Return Type:</dt> | |
| 268 <dd> | |
| 269 QMenu | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <div align="right"><a href="#top">Up</a></div> | |
| 273 <hr /> | |
| 274 </body></html> |
