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
- eric7
- changeset 10479
- 856476537696
- parent 10022
- a95800b414b7
- child 11006
- a671918232f3
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.MicroPython.WifiDialogs.WifiController</h1> | 9 <h1>eric7.MicroPython.WifiDialogs.WifiController</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the WiFi related functionality. | 11 Module implementing the WiFi related functionality. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>None</td></tr> |
| 17 <tr><td>None</td></tr> | 17 </table> |
| 18 </table> | 18 |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#WifiController">WifiController</a></td> | 22 <td><a href="#WifiController">WifiController</a></td> |
| 25 <td>Class implementing the WiFi related functionality.</td> | 23 <td>Class implementing the WiFi related functionality.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | 29 <tr><td>None</td></tr> |
| 31 <tr><td>None</td></tr> | 30 </table> |
| 32 </table> | 31 |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="WifiController" ID="WifiController"></a> | 34 <a NAME="WifiController" ID="WifiController"></a> |
| 36 <h2>WifiController</h2> | 35 <h2>WifiController</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing the WiFi related functionality. | 37 Class implementing the WiFi related functionality. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QObject | 41 QObject |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | 43 <table> |
| 45 <table> | 44 <tr><td>None</td></tr> |
| 46 <tr><td>None</td></tr> | 45 </table> |
| 47 </table> | 46 |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | 48 <table> |
| 50 <table> | 49 <tr><td>None</td></tr> |
| 51 <tr><td>None</td></tr> | 50 </table> |
| 52 </table> | 51 |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#WifiController.__init__">WifiController</a></td> | 55 <td><a href="#WifiController.__init__">WifiController</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 121 <tr> | 118 <tr> |
| 122 <td><a href="#WifiController.createMenu">createMenu</a></td> | 119 <td><a href="#WifiController.createMenu">createMenu</a></td> |
| 123 <td>Public method to create the WiFi submenu.</td> | 120 <td>Public method to create the WiFi submenu.</td> |
| 124 </tr> | 121 </tr> |
| 125 </table> | 122 </table> |
| 123 | |
| 126 <h3>Static Methods</h3> | 124 <h3>Static Methods</h3> |
| 127 | 125 <table> |
| 128 <table> | 126 <tr><td>None</td></tr> |
| 129 <tr><td>None</td></tr> | 127 </table> |
| 130 </table> | 128 |
| 131 | 129 |
| 132 <a NAME="WifiController.__init__" ID="WifiController.__init__"></a> | 130 <a NAME="WifiController.__init__" ID="WifiController.__init__"></a> |
| 133 <h4>WifiController (Constructor)</h4> | 131 <h4>WifiController (Constructor)</h4> |
| 134 <b>WifiController</b>(<i>microPython, parent=None</i>) | 132 <b>WifiController</b>(<i>microPython, parent=None</i>) |
| 135 | |
| 136 <p> | 133 <p> |
| 137 Constructor | 134 Constructor |
| 138 </p> | 135 </p> |
| 136 | |
| 139 <dl> | 137 <dl> |
| 140 | 138 |
| 141 <dt><i>microPython</i> (MicroPythonWidgep)</dt> | 139 <dt><i>microPython</i> (MicroPythonWidgep)</dt> |
| 142 <dd> | 140 <dd> |
| 143 reference to the MicroPython widget | 141 reference to the MicroPython widget |
| 148 </dd> | 146 </dd> |
| 149 </dl> | 147 </dl> |
| 150 <a NAME="WifiController.__checkInternet" ID="WifiController.__checkInternet"></a> | 148 <a NAME="WifiController.__checkInternet" ID="WifiController.__checkInternet"></a> |
| 151 <h4>WifiController.__checkInternet</h4> | 149 <h4>WifiController.__checkInternet</h4> |
| 152 <b>__checkInternet</b>(<i></i>) | 150 <b>__checkInternet</b>(<i></i>) |
| 153 | |
| 154 <p> | 151 <p> |
| 155 Private slot to check the availability of an internet connection. | 152 Private slot to check the availability of an internet connection. |
| 156 </p> | 153 </p> |
| 154 | |
| 157 <a NAME="WifiController.__connectWifi" ID="WifiController.__connectWifi"></a> | 155 <a NAME="WifiController.__connectWifi" ID="WifiController.__connectWifi"></a> |
| 158 <h4>WifiController.__connectWifi</h4> | 156 <h4>WifiController.__connectWifi</h4> |
| 159 <b>__connectWifi</b>(<i></i>) | 157 <b>__connectWifi</b>(<i></i>) |
| 160 | |
| 161 <p> | 158 <p> |
| 162 Private slot to connect the current device to a WiFi network. | 159 Private slot to connect the current device to a WiFi network. |
| 163 </p> | 160 </p> |
| 161 | |
| 164 <a NAME="WifiController.__deactivateInterface" ID="WifiController.__deactivateInterface"></a> | 162 <a NAME="WifiController.__deactivateInterface" ID="WifiController.__deactivateInterface"></a> |
| 165 <h4>WifiController.__deactivateInterface</h4> | 163 <h4>WifiController.__deactivateInterface</h4> |
| 166 <b>__deactivateInterface</b>(<i>interface</i>) | 164 <b>__deactivateInterface</b>(<i>interface</i>) |
| 167 | |
| 168 <p> | 165 <p> |
| 169 Private method to deactivate a given WiFi interface of the connected device. | 166 Private method to deactivate a given WiFi interface of the connected device. |
| 170 </p> | 167 </p> |
| 168 | |
| 171 <dl> | 169 <dl> |
| 172 | 170 |
| 173 <dt><i>interface</i> (str)</dt> | 171 <dt><i>interface</i> (str)</dt> |
| 174 <dd> | 172 <dd> |
| 175 designation of the interface to be deactivated (one of 'AP' | 173 designation of the interface to be deactivated (one of 'AP' |
| 177 </dd> | 175 </dd> |
| 178 </dl> | 176 </dl> |
| 179 <a NAME="WifiController.__disableWebrepl" ID="WifiController.__disableWebrepl"></a> | 177 <a NAME="WifiController.__disableWebrepl" ID="WifiController.__disableWebrepl"></a> |
| 180 <h4>WifiController.__disableWebrepl</h4> | 178 <h4>WifiController.__disableWebrepl</h4> |
| 181 <b>__disableWebrepl</b>(<i></i>) | 179 <b>__disableWebrepl</b>(<i></i>) |
| 182 | |
| 183 <p> | 180 <p> |
| 184 Private slot to disable the WebREPL server of the device. | 181 Private slot to disable the WebREPL server of the device. |
| 185 </p> | 182 </p> |
| 186 <p> | 183 <p> |
| 187 This will not remove the 'webrepl_cfg.py' file. It will just modify the boot | 184 This will not remove the 'webrepl_cfg.py' file. It will just modify the boot |
| 188 script. | 185 script. |
| 189 </p> | 186 </p> |
| 187 | |
| 190 <a NAME="WifiController.__disconnectWifi" ID="WifiController.__disconnectWifi"></a> | 188 <a NAME="WifiController.__disconnectWifi" ID="WifiController.__disconnectWifi"></a> |
| 191 <h4>WifiController.__disconnectWifi</h4> | 189 <h4>WifiController.__disconnectWifi</h4> |
| 192 <b>__disconnectWifi</b>(<i></i>) | 190 <b>__disconnectWifi</b>(<i></i>) |
| 193 | |
| 194 <p> | 191 <p> |
| 195 Private slot to disconnect the current device from the WiFi network. | 192 Private slot to disconnect the current device from the WiFi network. |
| 196 </p> | 193 </p> |
| 194 | |
| 197 <a NAME="WifiController.__enableWebrepl" ID="WifiController.__enableWebrepl"></a> | 195 <a NAME="WifiController.__enableWebrepl" ID="WifiController.__enableWebrepl"></a> |
| 198 <h4>WifiController.__enableWebrepl</h4> | 196 <h4>WifiController.__enableWebrepl</h4> |
| 199 <b>__enableWebrepl</b>(<i></i>) | 197 <b>__enableWebrepl</b>(<i></i>) |
| 200 | |
| 201 <p> | 198 <p> |
| 202 Private slot to enable the WebREPL server of the device. | 199 Private slot to enable the WebREPL server of the device. |
| 203 </p> | 200 </p> |
| 204 <p> | 201 <p> |
| 205 This will also modify the boot script. | 202 This will also modify the boot script. |
| 206 </p> | 203 </p> |
| 204 | |
| 207 <a NAME="WifiController.__removeCredentials" ID="WifiController.__removeCredentials"></a> | 205 <a NAME="WifiController.__removeCredentials" ID="WifiController.__removeCredentials"></a> |
| 208 <h4>WifiController.__removeCredentials</h4> | 206 <h4>WifiController.__removeCredentials</h4> |
| 209 <b>__removeCredentials</b>(<i></i>) | 207 <b>__removeCredentials</b>(<i></i>) |
| 210 | |
| 211 <p> | 208 <p> |
| 212 Private slot to remove the saved WiFi credentials from the connected device. | 209 Private slot to remove the saved WiFi credentials from the connected device. |
| 213 </p> | 210 </p> |
| 214 <p> | 211 <p> |
| 215 This will not remove the auto-connect part of the boot script. This needs to be | 212 This will not remove the auto-connect part of the boot script. This needs to be |
| 216 done manually if desired. | 213 done manually if desired. |
| 217 </p> | 214 </p> |
| 215 | |
| 218 <a NAME="WifiController.__scanNetwork" ID="WifiController.__scanNetwork"></a> | 216 <a NAME="WifiController.__scanNetwork" ID="WifiController.__scanNetwork"></a> |
| 219 <h4>WifiController.__scanNetwork</h4> | 217 <h4>WifiController.__scanNetwork</h4> |
| 220 <b>__scanNetwork</b>(<i></i>) | 218 <b>__scanNetwork</b>(<i></i>) |
| 221 | |
| 222 <p> | 219 <p> |
| 223 Private slot to scan for visible WiFi networks. | 220 Private slot to scan for visible WiFi networks. |
| 224 </p> | 221 </p> |
| 222 | |
| 225 <a NAME="WifiController.__setNetworkTime" ID="WifiController.__setNetworkTime"></a> | 223 <a NAME="WifiController.__setNetworkTime" ID="WifiController.__setNetworkTime"></a> |
| 226 <h4>WifiController.__setNetworkTime</h4> | 224 <h4>WifiController.__setNetworkTime</h4> |
| 227 <b>__setNetworkTime</b>(<i></i>) | 225 <b>__setNetworkTime</b>(<i></i>) |
| 228 | |
| 229 <p> | 226 <p> |
| 230 Private slot to synchronize the device clock to network time. | 227 Private slot to synchronize the device clock to network time. |
| 231 </p> | 228 </p> |
| 229 | |
| 232 <a NAME="WifiController.__showConnectedClients" ID="WifiController.__showConnectedClients"></a> | 230 <a NAME="WifiController.__showConnectedClients" ID="WifiController.__showConnectedClients"></a> |
| 233 <h4>WifiController.__showConnectedClients</h4> | 231 <h4>WifiController.__showConnectedClients</h4> |
| 234 <b>__showConnectedClients</b>(<i></i>) | 232 <b>__showConnectedClients</b>(<i></i>) |
| 235 | |
| 236 <p> | 233 <p> |
| 237 Private slot to show a list of WiFi clients connected to the Access Point | 234 Private slot to show a list of WiFi clients connected to the Access Point |
| 238 interface. | 235 interface. |
| 239 </p> | 236 </p> |
| 237 | |
| 240 <a NAME="WifiController.__showWifiStatus" ID="WifiController.__showWifiStatus"></a> | 238 <a NAME="WifiController.__showWifiStatus" ID="WifiController.__showWifiStatus"></a> |
| 241 <h4>WifiController.__showWifiStatus</h4> | 239 <h4>WifiController.__showWifiStatus</h4> |
| 242 <b>__showWifiStatus</b>(<i></i>) | 240 <b>__showWifiStatus</b>(<i></i>) |
| 243 | |
| 244 <p> | 241 <p> |
| 245 Private slot to show a dialog with the WiFi status of the current device. | 242 Private slot to show a dialog with the WiFi status of the current device. |
| 246 </p> | 243 </p> |
| 244 | |
| 247 <a NAME="WifiController.__startAccessPoint" ID="WifiController.__startAccessPoint"></a> | 245 <a NAME="WifiController.__startAccessPoint" ID="WifiController.__startAccessPoint"></a> |
| 248 <h4>WifiController.__startAccessPoint</h4> | 246 <h4>WifiController.__startAccessPoint</h4> |
| 249 <b>__startAccessPoint</b>(<i>withIP=False</i>) | 247 <b>__startAccessPoint</b>(<i>withIP=False</i>) |
| 250 | |
| 251 <p> | 248 <p> |
| 252 Private slot to start the Access Point interface of the connected device. | 249 Private slot to start the Access Point interface of the connected device. |
| 253 </p> | 250 </p> |
| 251 | |
| 254 <dl> | 252 <dl> |
| 255 | 253 |
| 256 <dt><i>withIP</i> (bool)</dt> | 254 <dt><i>withIP</i> (bool)</dt> |
| 257 <dd> | 255 <dd> |
| 258 flag indicating to start the access point with an IP configuration | 256 flag indicating to start the access point with an IP configuration |
| 259 </dd> | 257 </dd> |
| 260 </dl> | 258 </dl> |
| 261 <a NAME="WifiController.__startAccessPointIP" ID="WifiController.__startAccessPointIP"></a> | 259 <a NAME="WifiController.__startAccessPointIP" ID="WifiController.__startAccessPointIP"></a> |
| 262 <h4>WifiController.__startAccessPointIP</h4> | 260 <h4>WifiController.__startAccessPointIP</h4> |
| 263 <b>__startAccessPointIP</b>(<i></i>) | 261 <b>__startAccessPointIP</b>(<i></i>) |
| 264 | |
| 265 <p> | 262 <p> |
| 266 Private slot to start the Access Point interface of the connected device | 263 Private slot to start the Access Point interface of the connected device |
| 267 with given IP parameters. | 264 with given IP parameters. |
| 268 </p> | 265 </p> |
| 266 | |
| 269 <a NAME="WifiController.__stopAccessPoint" ID="WifiController.__stopAccessPoint"></a> | 267 <a NAME="WifiController.__stopAccessPoint" ID="WifiController.__stopAccessPoint"></a> |
| 270 <h4>WifiController.__stopAccessPoint</h4> | 268 <h4>WifiController.__stopAccessPoint</h4> |
| 271 <b>__stopAccessPoint</b>(<i></i>) | 269 <b>__stopAccessPoint</b>(<i></i>) |
| 272 | |
| 273 <p> | 270 <p> |
| 274 Private slot to stop the Access Point interface of the connected device. | 271 Private slot to stop the Access Point interface of the connected device. |
| 275 </p> | 272 </p> |
| 273 | |
| 276 <a NAME="WifiController.__writeCredentials" ID="WifiController.__writeCredentials"></a> | 274 <a NAME="WifiController.__writeCredentials" ID="WifiController.__writeCredentials"></a> |
| 277 <h4>WifiController.__writeCredentials</h4> | 275 <h4>WifiController.__writeCredentials</h4> |
| 278 <b>__writeCredentials</b>(<i></i>) | 276 <b>__writeCredentials</b>(<i></i>) |
| 279 | |
| 280 <p> | 277 <p> |
| 281 Private slot to save the WiFi login credentials to the connected device. | 278 Private slot to save the WiFi login credentials to the connected device. |
| 282 </p> | 279 </p> |
| 283 <p> | 280 <p> |
| 284 This will also modify the boot script to perform an automatic WiFi connection. | 281 This will also modify the boot script to perform an automatic WiFi connection. |
| 285 </p> | 282 </p> |
| 283 | |
| 286 <a NAME="WifiController.createMenu" ID="WifiController.createMenu"></a> | 284 <a NAME="WifiController.createMenu" ID="WifiController.createMenu"></a> |
| 287 <h4>WifiController.createMenu</h4> | 285 <h4>WifiController.createMenu</h4> |
| 288 <b>createMenu</b>(<i>menu</i>) | 286 <b>createMenu</b>(<i>menu</i>) |
| 289 | |
| 290 <p> | 287 <p> |
| 291 Public method to create the WiFi submenu. | 288 Public method to create the WiFi submenu. |
| 292 </p> | 289 </p> |
| 290 | |
| 293 <dl> | 291 <dl> |
| 294 | 292 |
| 295 <dt><i>menu</i> (QMenu)</dt> | 293 <dt><i>menu</i> (QMenu)</dt> |
| 296 <dd> | 294 <dd> |
| 297 reference to the parent menu | 295 reference to the parent menu |
