Mercurial Repositories > eric / file comparison

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

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

branch
mpy_network
changeset 9840
d41ee69fa69b
parent 9785
84684a40187d
child 9860
d34667faa686
equal deleted inserted replaced
9839:fc60e382b67a 9840:d41ee69fa69b
66 <td><a href="#CircuitPythonDevice.__aboutToShowLibraryMenu">__aboutToShowLibraryMenu</a></td> 66 <td><a href="#CircuitPythonDevice.__aboutToShowLibraryMenu">__aboutToShowLibraryMenu</a></td>
67 <td>Private slot to populate the 'Library Management' menu.</td> 67 <td>Private slot to populate the 'Library Management' menu.</td>
68 </tr> 68 </tr>
69 <tr> 69 <tr>
70 <td><a href="#CircuitPythonDevice.__cpyVersionResponse">__cpyVersionResponse</a></td> 70 <td><a href="#CircuitPythonDevice.__cpyVersionResponse">__cpyVersionResponse</a></td>
71 <td>Private method handling the response of the latest version request.</td> 71 <td>Private slot handling the response of the latest version request.</td>
72 </tr> 72 </tr>
73 <tr> 73 <tr>
74 <td><a href="#CircuitPythonDevice.__createCPyMenu">__createCPyMenu</a></td> 74 <td><a href="#CircuitPythonDevice.__createCPyMenu">__createCPyMenu</a></td>
75 <td>Private method to create the CircuitPython submenu.</td> 75 <td>Private method to create the CircuitPython submenu.</td>
76 </tr> 76 </tr>
77 <tr> 77 <tr>
78 <td><a href="#CircuitPythonDevice.__createFlashMenus">__createFlashMenus</a></td>
79 <td>Private method to create the various menus to flash a CircuitPython firmware.</td>
80 </tr>
81 <tr>
78 <td><a href="#CircuitPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td> 82 <td><a href="#CircuitPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td>
79 <td>Private method to check, if the device volume is mounted.</td> 83 <td>Private method to check, if the device volume is mounted.</td>
80 </tr> 84 </tr>
81 <tr> 85 <tr>
86 <td><a href="#CircuitPythonDevice.__esp32EraseFlash">__esp32EraseFlash</a></td>
87 <td>Private slot to erase the flash of an ESP32 device.</td>
88 </tr>
89 <tr>
90 <td><a href="#CircuitPythonDevice.__esp32FlashAddons">__esp32FlashAddons</a></td>
91 <td>Private slot to flash additional firmware to an ESP32 device.</td>
92 </tr>
93 <tr>
94 <td><a href="#CircuitPythonDevice.__esp32FlashPython">__esp32FlashPython</a></td>
95 <td>Private slot to flash a MicroPython or CircuitPython firmware to an ESP32 device.</td>
96 </tr>
97 <tr>
82 <td><a href="#CircuitPythonDevice.__findDeviceDirectories">__findDeviceDirectories</a></td> 98 <td><a href="#CircuitPythonDevice.__findDeviceDirectories">__findDeviceDirectories</a></td>
83 <td>Private method to find the device directories associated with the current board name.</td> 99 <td>Private method to find the device directories associated with the current board name.</td>
84 </tr> 100 </tr>
85 <tr> 101 <tr>
86 <td><a href="#CircuitPythonDevice.__findWorkspace">__findWorkspace</a></td> 102 <td><a href="#CircuitPythonDevice.__findWorkspace">__findWorkspace</a></td>
93 <tr> 109 <tr>
94 <td><a href="#CircuitPythonDevice.__installLibraryFiles">__installLibraryFiles</a></td> 110 <td><a href="#CircuitPythonDevice.__installLibraryFiles">__installLibraryFiles</a></td>
95 <td>Private slot to install Python files into the onboard library.</td> 111 <td>Private slot to install Python files into the onboard library.</td>
96 </tr> 112 </tr>
97 <tr> 113 <tr>
114 <td><a href="#CircuitPythonDevice.__resetDevice">__resetDevice</a></td>
115 <td>Private slot to reset the connected device.</td>
116 </tr>
117 <tr>
98 <td><a href="#CircuitPythonDevice.__showCircuitPythonVersions">__showCircuitPythonVersions</a></td> 118 <td><a href="#CircuitPythonDevice.__showCircuitPythonVersions">__showCircuitPythonVersions</a></td>
99 <td>Private slot to show the CircuitPython version of a connected device and the latest available one (from Github).</td> 119 <td>Private slot to show the CircuitPython version of a connected device and the latest available one (from Github).</td>
100 </tr> 120 </tr>
101 <tr> 121 <tr>
102 <td><a href="#CircuitPythonDevice.__showTeensyFlashInstructions">__showTeensyFlashInstructions</a></td> 122 <td><a href="#CircuitPythonDevice.__showTeensyFlashInstructions">__showTeensyFlashInstructions</a></td>
103 <td>Private method to show a message box because Teensy does not support the UF2 bootloader yet.</td> 123 <td>Private slot to show a message box because Teensy does not support the UF2 bootloader yet.</td>
104 </tr> 124 </tr>
105 <tr> 125 <tr>
106 <td><a href="#CircuitPythonDevice.__startTeensyLoader">__startTeensyLoader</a></td> 126 <td><a href="#CircuitPythonDevice.__startTeensyLoader">__startTeensyLoader</a></td>
107 <td>Private method to start the 'Teensy Loader' application.</td> 127 <td>Private slot to start the 'Teensy Loader' application.</td>
108 </tr> 128 </tr>
109 <tr> 129 <tr>
110 <td><a href="#CircuitPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> 130 <td><a href="#CircuitPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
111 <td>Public method to add device specific entries to the given menu.</td> 131 <td>Public method to add device specific entries to the given menu.</td>
112 </tr> 132 </tr>
125 <tr> 145 <tr>
126 <td><a href="#CircuitPythonDevice.canStartRepl">canStartRepl</a></td> 146 <td><a href="#CircuitPythonDevice.canStartRepl">canStartRepl</a></td>
127 <td>Public method to determine, if a REPL can be started.</td> 147 <td>Public method to determine, if a REPL can be started.</td>
128 </tr> 148 </tr>
129 <tr> 149 <tr>
150 <td><a href="#CircuitPythonDevice.checkInternet">checkInternet</a></td>
151 <td>Public method to check, if the internet can be reached.</td>
152 </tr>
153 <tr>
154 <td><a href="#CircuitPythonDevice.connectWifi">connectWifi</a></td>
155 <td>Public method to connect a device to a WiFi network.</td>
156 </tr>
157 <tr>
158 <td><a href="#CircuitPythonDevice.deactivateInterface">deactivateInterface</a></td>
159 <td>Public method to deactivate a given WiFi interface of the connected device.</td>
160 </tr>
161 <tr>
130 <td><a href="#CircuitPythonDevice.deviceName">deviceName</a></td> 162 <td><a href="#CircuitPythonDevice.deviceName">deviceName</a></td>
131 <td>Public method to get the name of the device.</td> 163 <td>Public method to get the name of the device.</td>
132 </tr> 164 </tr>
133 <tr> 165 <tr>
166 <td><a href="#CircuitPythonDevice.disconnectWifi">disconnectWifi</a></td>
167 <td>Public method to disconnect a device from the WiFi network.</td>
168 </tr>
169 <tr>
134 <td><a href="#CircuitPythonDevice.forceInterrupt">forceInterrupt</a></td> 170 <td><a href="#CircuitPythonDevice.forceInterrupt">forceInterrupt</a></td>
135 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> 171 <td>Public method to determine the need for an interrupt when opening the serial connection.</td>
136 </tr> 172 </tr>
137 <tr> 173 <tr>
174 <td><a href="#CircuitPythonDevice.getConnectedClients">getConnectedClients</a></td>
175 <td>Public method to get a list of connected clients.</td>
176 </tr>
177 <tr>
138 <td><a href="#CircuitPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> 178 <td><a href="#CircuitPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td>
139 <td>Public method to get the device documentation URL.</td> 179 <td>Public method to get the device documentation URL.</td>
140 </tr> 180 </tr>
141 <tr> 181 <tr>
142 <td><a href="#CircuitPythonDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> 182 <td><a href="#CircuitPythonDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td>
143 <td>Public method to retrieve the entries for the downloads menu.</td> 183 <td>Public method to retrieve the entries for the downloads menu.</td>
144 </tr> 184 </tr>
145 <tr> 185 <tr>
186 <td><a href="#CircuitPythonDevice.getWifiData">getWifiData</a></td>
187 <td>Public method to get data related to the current WiFi status.</td>
188 </tr>
189 <tr>
146 <td><a href="#CircuitPythonDevice.getWorkspace">getWorkspace</a></td> 190 <td><a href="#CircuitPythonDevice.getWorkspace">getWorkspace</a></td>
147 <td>Public method to get the workspace directory.</td> 191 <td>Public method to get the workspace directory.</td>
148 </tr> 192 </tr>
149 <tr> 193 <tr>
150 <td><a href="#CircuitPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> 194 <td><a href="#CircuitPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td>
151 <td>Public method to check, if the device has its own flash menu entry.</td> 195 <td>Public method to check, if the device has its own flash menu entry.</td>
152 </tr> 196 </tr>
153 <tr> 197 <tr>
198 <td><a href="#CircuitPythonDevice.hasWifi">hasWifi</a></td>
199 <td>Public method to check the availability of WiFi.</td>
200 </tr>
201 <tr>
202 <td><a href="#CircuitPythonDevice.removeCredentials">removeCredentials</a></td>
203 <td>Public method to remove the saved credentials from the connected device.</td>
204 </tr>
205 <tr>
154 <td><a href="#CircuitPythonDevice.runScript">runScript</a></td> 206 <td><a href="#CircuitPythonDevice.runScript">runScript</a></td>
155 <td>Public method to run the given Python script.</td> 207 <td>Public method to run the given Python script.</td>
156 </tr> 208 </tr>
157 <tr> 209 <tr>
210 <td><a href="#CircuitPythonDevice.scanNetworks">scanNetworks</a></td>
211 <td>Public method to scan for available WiFi networks.</td>
212 </tr>
213 <tr>
158 <td><a href="#CircuitPythonDevice.setButtons">setButtons</a></td> 214 <td><a href="#CircuitPythonDevice.setButtons">setButtons</a></td>
159 <td>Public method to enable the supported action buttons.</td> 215 <td>Public method to enable the supported action buttons.</td>
160 </tr> 216 </tr>
161 <tr> 217 <tr>
162 <td><a href="#CircuitPythonDevice.setConnected">setConnected</a></td> 218 <td><a href="#CircuitPythonDevice.setConnected">setConnected</a></td>
163 <td>Public method to set the connection state.</td> 219 <td>Public method to set the connection state.</td>
164 </tr> 220 </tr>
165 <tr> 221 <tr>
222 <td><a href="#CircuitPythonDevice.startAccessPoint">startAccessPoint</a></td>
223 <td>Public method to start the access point interface.</td>
224 </tr>
225 <tr>
226 <td><a href="#CircuitPythonDevice.stopAccessPoint">stopAccessPoint</a></td>
227 <td>Public method to stop the access point interface.</td>
228 </tr>
229 <tr>
166 <td><a href="#CircuitPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> 230 <td><a href="#CircuitPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td>
167 <td>Public method to indicate file access via a local directory.</td> 231 <td>Public method to indicate file access via a local directory.</td>
232 </tr>
233 <tr>
234 <td><a href="#CircuitPythonDevice.writeCredentials">writeCredentials</a></td>
235 <td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td>
168 </tr> 236 </tr>
169 </table> 237 </table>
170 <h3>Static Methods</h3> 238 <h3>Static Methods</h3>
171 239
172 <table> 240 <table>
209 <a NAME="CircuitPythonDevice.__cpyVersionResponse" ID="CircuitPythonDevice.__cpyVersionResponse"></a> 277 <a NAME="CircuitPythonDevice.__cpyVersionResponse" ID="CircuitPythonDevice.__cpyVersionResponse"></a>
210 <h4>CircuitPythonDevice.__cpyVersionResponse</h4> 278 <h4>CircuitPythonDevice.__cpyVersionResponse</h4>
211 <b>__cpyVersionResponse</b>(<i>reply</i>) 279 <b>__cpyVersionResponse</b>(<i>reply</i>)
212 280
213 <p> 281 <p>
214 Private method handling the response of the latest version request. 282 Private slot handling the response of the latest version request.
215 </p> 283 </p>
216 <dl> 284 <dl>
217 285
218 <dt><i>reply</i> (QNetworkReply)</dt> 286 <dt><i>reply</i> (QNetworkReply)</dt>
219 <dd> 287 <dd>
225 <b>__createCPyMenu</b>(<i></i>) 293 <b>__createCPyMenu</b>(<i></i>)
226 294
227 <p> 295 <p>
228 Private method to create the CircuitPython submenu. 296 Private method to create the CircuitPython submenu.
229 </p> 297 </p>
298 <a NAME="CircuitPythonDevice.__createFlashMenus" ID="CircuitPythonDevice.__createFlashMenus"></a>
299 <h4>CircuitPythonDevice.__createFlashMenus</h4>
300 <b>__createFlashMenus</b>(<i></i>)
301
302 <p>
303 Private method to create the various menus to flash a CircuitPython firmware.
304 </p>
305 <dl>
306 <dt>Return:</dt>
307 <dd>
308 reference to the created top level flash menu
309 </dd>
310 </dl>
311 <dl>
312 <dt>Return Type:</dt>
313 <dd>
314 QMenu
315 </dd>
316 </dl>
230 <a NAME="CircuitPythonDevice.__deviceVolumeMounted" ID="CircuitPythonDevice.__deviceVolumeMounted"></a> 317 <a NAME="CircuitPythonDevice.__deviceVolumeMounted" ID="CircuitPythonDevice.__deviceVolumeMounted"></a>
231 <h4>CircuitPythonDevice.__deviceVolumeMounted</h4> 318 <h4>CircuitPythonDevice.__deviceVolumeMounted</h4>
232 <b>__deviceVolumeMounted</b>(<i></i>) 319 <b>__deviceVolumeMounted</b>(<i></i>)
233 320
234 <p> 321 <p>
244 <dt>Return Type:</dt> 331 <dt>Return Type:</dt>
245 <dd> 332 <dd>
246 bool 333 bool
247 </dd> 334 </dd>
248 </dl> 335 </dl>
336 <a NAME="CircuitPythonDevice.__esp32EraseFlash" ID="CircuitPythonDevice.__esp32EraseFlash"></a>
337 <h4>CircuitPythonDevice.__esp32EraseFlash</h4>
338 <b>__esp32EraseFlash</b>(<i></i>)
339
340 <p>
341 Private slot to erase the flash of an ESP32 device.
342 </p>
343 <a NAME="CircuitPythonDevice.__esp32FlashAddons" ID="CircuitPythonDevice.__esp32FlashAddons"></a>
344 <h4>CircuitPythonDevice.__esp32FlashAddons</h4>
345 <b>__esp32FlashAddons</b>(<i></i>)
346
347 <p>
348 Private slot to flash additional firmware to an ESP32 device.
349 </p>
350 <a NAME="CircuitPythonDevice.__esp32FlashPython" ID="CircuitPythonDevice.__esp32FlashPython"></a>
351 <h4>CircuitPythonDevice.__esp32FlashPython</h4>
352 <b>__esp32FlashPython</b>(<i></i>)
353
354 <p>
355 Private slot to flash a MicroPython or CircuitPython firmware to an ESP32
356 device.
357 </p>
249 <a NAME="CircuitPythonDevice.__findDeviceDirectories" ID="CircuitPythonDevice.__findDeviceDirectories"></a> 358 <a NAME="CircuitPythonDevice.__findDeviceDirectories" ID="CircuitPythonDevice.__findDeviceDirectories"></a>
250 <h4>CircuitPythonDevice.__findDeviceDirectories</h4> 359 <h4>CircuitPythonDevice.__findDeviceDirectories</h4>
251 <b>__findDeviceDirectories</b>(<i>directories</i>) 360 <b>__findDeviceDirectories</b>(<i>directories</i>)
252 361
253 <p> 362 <p>
280 <p> 389 <p>
281 Private method to find the workspace directory. 390 Private method to find the workspace directory.
282 </p> 391 </p>
283 <dl> 392 <dl>
284 393
285 <dt><i>silent</i> (bool)</dt> 394 <dt><i>silent</i> (bool (optional))</dt>
286 <dd> 395 <dd>
287 flag indicating silent operations 396 flag indicating silent operations (defaults to False)
288 </dd> 397 </dd>
289 </dl> 398 </dl>
290 <dl> 399 <dl>
291 <dt>Return:</dt> 400 <dt>Return:</dt>
292 <dd> 401 <dd>
319 <dd> 428 <dd>
320 flag indicating to install a library package 429 flag indicating to install a library package
321 (defaults to False) 430 (defaults to False)
322 </dd> 431 </dd>
323 </dl> 432 </dl>
433 <a NAME="CircuitPythonDevice.__resetDevice" ID="CircuitPythonDevice.__resetDevice"></a>
434 <h4>CircuitPythonDevice.__resetDevice</h4>
435 <b>__resetDevice</b>(<i></i>)
436
437 <p>
438 Private slot to reset the connected device.
439 </p>
324 <a NAME="CircuitPythonDevice.__showCircuitPythonVersions" ID="CircuitPythonDevice.__showCircuitPythonVersions"></a> 440 <a NAME="CircuitPythonDevice.__showCircuitPythonVersions" ID="CircuitPythonDevice.__showCircuitPythonVersions"></a>
325 <h4>CircuitPythonDevice.__showCircuitPythonVersions</h4> 441 <h4>CircuitPythonDevice.__showCircuitPythonVersions</h4>
326 <b>__showCircuitPythonVersions</b>(<i></i>) 442 <b>__showCircuitPythonVersions</b>(<i></i>)
327 443
328 <p> 444 <p>
332 <a NAME="CircuitPythonDevice.__showTeensyFlashInstructions" ID="CircuitPythonDevice.__showTeensyFlashInstructions"></a> 448 <a NAME="CircuitPythonDevice.__showTeensyFlashInstructions" ID="CircuitPythonDevice.__showTeensyFlashInstructions"></a>
333 <h4>CircuitPythonDevice.__showTeensyFlashInstructions</h4> 449 <h4>CircuitPythonDevice.__showTeensyFlashInstructions</h4>
334 <b>__showTeensyFlashInstructions</b>(<i></i>) 450 <b>__showTeensyFlashInstructions</b>(<i></i>)
335 451
336 <p> 452 <p>
337 Private method to show a message box because Teensy does not support 453 Private slot to show a message box because Teensy does not support
338 the UF2 bootloader yet. 454 the UF2 bootloader yet.
339 </p> 455 </p>
340 <a NAME="CircuitPythonDevice.__startTeensyLoader" ID="CircuitPythonDevice.__startTeensyLoader"></a> 456 <a NAME="CircuitPythonDevice.__startTeensyLoader" ID="CircuitPythonDevice.__startTeensyLoader"></a>
341 <h4>CircuitPythonDevice.__startTeensyLoader</h4> 457 <h4>CircuitPythonDevice.__startTeensyLoader</h4>
342 <b>__startTeensyLoader</b>(<i></i>) 458 <b>__startTeensyLoader</b>(<i></i>)
343 459
344 <p> 460 <p>
345 Private method to start the 'Teensy Loader' application. 461 Private slot to start the 'Teensy Loader' application.
346 </p> 462 </p>
347 <p> 463 <p>
348 Note: The application must be accessible via the application search path. 464 Note: The application must be accessible via the application search path.
349 </p> 465 </p>
350 <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> 466 <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a>
439 <dt>Return Type:</dt> 555 <dt>Return Type:</dt>
440 <dd> 556 <dd>
441 tuple of (bool, str) 557 tuple of (bool, str)
442 </dd> 558 </dd>
443 </dl> 559 </dl>
560 <a NAME="CircuitPythonDevice.checkInternet" ID="CircuitPythonDevice.checkInternet"></a>
561 <h4>CircuitPythonDevice.checkInternet</h4>
562 <b>checkInternet</b>(<i></i>)
563
564 <p>
565 Public method to check, if the internet can be reached.
566 </p>
567 <dl>
568 <dt>Return:</dt>
569 <dd>
570 tuple containing a flag indicating reachability and an error string
571 </dd>
572 </dl>
573 <dl>
574 <dt>Return Type:</dt>
575 <dd>
576 tuple of (bool, str)
577 </dd>
578 </dl>
579 <a NAME="CircuitPythonDevice.connectWifi" ID="CircuitPythonDevice.connectWifi"></a>
580 <h4>CircuitPythonDevice.connectWifi</h4>
581 <b>connectWifi</b>(<i>ssid, password</i>)
582
583 <p>
584 Public method to connect a device to a WiFi network.
585 </p>
586 <dl>
587
588 <dt><i>ssid</i> (str)</dt>
589 <dd>
590 name (SSID) of the WiFi network
591 </dd>
592 <dt><i>password</i> (str)</dt>
593 <dd>
594 password needed to connect
595 </dd>
596 </dl>
597 <dl>
598 <dt>Return:</dt>
599 <dd>
600 tuple containing the connection status and an error string
601 </dd>
602 </dl>
603 <dl>
604 <dt>Return Type:</dt>
605 <dd>
606 tuple of (bool, str)
607 </dd>
608 </dl>
609 <a NAME="CircuitPythonDevice.deactivateInterface" ID="CircuitPythonDevice.deactivateInterface"></a>
610 <h4>CircuitPythonDevice.deactivateInterface</h4>
611 <b>deactivateInterface</b>(<i>interface</i>)
612
613 <p>
614 Public method to deactivate a given WiFi interface of the connected device.
615 </p>
616 <p>
617 Note: With CircuitPython it is not possible to deactivate the station and
618 access point interfaces separately.
619 </p>
620 <dl>
621
622 <dt><i>interface</i> (str)</dt>
623 <dd>
624 designation of the interface to be deactivated (one of 'AP'
625 or 'STA')
626 </dd>
627 </dl>
628 <dl>
629 <dt>Return:</dt>
630 <dd>
631 tuple containg a flag indicating success and an error message
632 </dd>
633 </dl>
634 <dl>
635 <dt>Return Type:</dt>
636 <dd>
637 tuple of (bool, str)
638 </dd>
639 </dl>
640 <dl>
641
642 <dt>Raises <b>ValueError</b>:</dt>
643 <dd>
644 raised to indicate a wrong value for the interface type
645 </dd>
646 </dl>
444 <a NAME="CircuitPythonDevice.deviceName" ID="CircuitPythonDevice.deviceName"></a> 647 <a NAME="CircuitPythonDevice.deviceName" ID="CircuitPythonDevice.deviceName"></a>
445 <h4>CircuitPythonDevice.deviceName</h4> 648 <h4>CircuitPythonDevice.deviceName</h4>
446 <b>deviceName</b>(<i></i>) 649 <b>deviceName</b>(<i></i>)
447 650
448 <p> 651 <p>
458 <dt>Return Type:</dt> 661 <dt>Return Type:</dt>
459 <dd> 662 <dd>
460 str 663 str
461 </dd> 664 </dd>
462 </dl> 665 </dl>
666 <a NAME="CircuitPythonDevice.disconnectWifi" ID="CircuitPythonDevice.disconnectWifi"></a>
667 <h4>CircuitPythonDevice.disconnectWifi</h4>
668 <b>disconnectWifi</b>(<i></i>)
669
670 <p>
671 Public method to disconnect a device from the WiFi network.
672 </p>
673 <dl>
674 <dt>Return:</dt>
675 <dd>
676 tuple containing a flag indicating success and an error string
677 </dd>
678 </dl>
679 <dl>
680 <dt>Return Type:</dt>
681 <dd>
682 tuple of (bool, str)
683 </dd>
684 </dl>
463 <a NAME="CircuitPythonDevice.forceInterrupt" ID="CircuitPythonDevice.forceInterrupt"></a> 685 <a NAME="CircuitPythonDevice.forceInterrupt" ID="CircuitPythonDevice.forceInterrupt"></a>
464 <h4>CircuitPythonDevice.forceInterrupt</h4> 686 <h4>CircuitPythonDevice.forceInterrupt</h4>
465 <b>forceInterrupt</b>(<i></i>) 687 <b>forceInterrupt</b>(<i></i>)
466 688
467 <p> 689 <p>
478 <dt>Return Type:</dt> 700 <dt>Return Type:</dt>
479 <dd> 701 <dd>
480 bool 702 bool
481 </dd> 703 </dd>
482 </dl> 704 </dl>
705 <a NAME="CircuitPythonDevice.getConnectedClients" ID="CircuitPythonDevice.getConnectedClients"></a>
706 <h4>CircuitPythonDevice.getConnectedClients</h4>
707 <b>getConnectedClients</b>(<i></i>)
708
709 <p>
710 Public method to get a list of connected clients.
711 </p>
712 <dl>
713 <dt>Return:</dt>
714 <dd>
715 a tuple containing a list of tuples containing the client MAC-Address
716 and the RSSI (if supported and available) and an error message
717 </dd>
718 </dl>
719 <dl>
720 <dt>Return Type:</dt>
721 <dd>
722 tuple of ([(bytes, int)], str)
723 </dd>
724 </dl>
483 <a NAME="CircuitPythonDevice.getDocumentationUrl" ID="CircuitPythonDevice.getDocumentationUrl"></a> 725 <a NAME="CircuitPythonDevice.getDocumentationUrl" ID="CircuitPythonDevice.getDocumentationUrl"></a>
484 <h4>CircuitPythonDevice.getDocumentationUrl</h4> 726 <h4>CircuitPythonDevice.getDocumentationUrl</h4>
485 <b>getDocumentationUrl</b>(<i></i>) 727 <b>getDocumentationUrl</b>(<i></i>)
486 728
487 <p> 729 <p>
517 <dt>Return Type:</dt> 759 <dt>Return Type:</dt>
518 <dd> 760 <dd>
519 list of tuple of (str, str) 761 list of tuple of (str, str)
520 </dd> 762 </dd>
521 </dl> 763 </dl>
764 <a NAME="CircuitPythonDevice.getWifiData" ID="CircuitPythonDevice.getWifiData"></a>
765 <h4>CircuitPythonDevice.getWifiData</h4>
766 <b>getWifiData</b>(<i></i>)
767
768 <p>
769 Public method to get data related to the current WiFi status.
770 </p>
771 <dl>
772 <dt>Return:</dt>
773 <dd>
774 tuple of three dictionaries containing the WiFi status data
775 for the WiFi client, access point and overall data
776 </dd>
777 </dl>
778 <dl>
779 <dt>Return Type:</dt>
780 <dd>
781 tuple of (dict, dict, dict)
782 </dd>
783 </dl>
784 <dl>
785
786 <dt>Raises <b>OSError</b>:</dt>
787 <dd>
788 raised to indicate an issue with the device
789 </dd>
790 </dl>
522 <a NAME="CircuitPythonDevice.getWorkspace" ID="CircuitPythonDevice.getWorkspace"></a> 791 <a NAME="CircuitPythonDevice.getWorkspace" ID="CircuitPythonDevice.getWorkspace"></a>
523 <h4>CircuitPythonDevice.getWorkspace</h4> 792 <h4>CircuitPythonDevice.getWorkspace</h4>
524 <b>getWorkspace</b>(<i>silent=False</i>) 793 <b>getWorkspace</b>(<i>silent=False</i>)
525 794
526 <p> 795 <p>
562 <dt>Return Type:</dt> 831 <dt>Return Type:</dt>
563 <dd> 832 <dd>
564 bool 833 bool
565 </dd> 834 </dd>
566 </dl> 835 </dl>
836 <a NAME="CircuitPythonDevice.hasWifi" ID="CircuitPythonDevice.hasWifi"></a>
837 <h4>CircuitPythonDevice.hasWifi</h4>
838 <b>hasWifi</b>(<i></i>)
839
840 <p>
841 Public method to check the availability of WiFi.
842 </p>
843 <dl>
844 <dt>Return:</dt>
845 <dd>
846 tuple containing a flag indicating the availability of WiFi
847 and the WiFi type (picow or pimoroni)
848 </dd>
849 </dl>
850 <dl>
851 <dt>Return Type:</dt>
852 <dd>
853 tuple of (bool, str)
854 </dd>
855 </dl>
856 <dl>
857
858 <dt>Raises <b>OSError</b>:</dt>
859 <dd>
860 raised to indicate an issue with the device
861 </dd>
862 </dl>
863 <a NAME="CircuitPythonDevice.removeCredentials" ID="CircuitPythonDevice.removeCredentials"></a>
864 <h4>CircuitPythonDevice.removeCredentials</h4>
865 <b>removeCredentials</b>(<i></i>)
866
867 <p>
868 Public method to remove the saved credentials from the connected device.
869 </p>
870 <dl>
871 <dt>Return:</dt>
872 <dd>
873 tuple containing a flag indicating success and an error message
874 </dd>
875 </dl>
876 <dl>
877 <dt>Return Type:</dt>
878 <dd>
879 tuple of (bool, str)
880 </dd>
881 </dl>
567 <a NAME="CircuitPythonDevice.runScript" ID="CircuitPythonDevice.runScript"></a> 882 <a NAME="CircuitPythonDevice.runScript" ID="CircuitPythonDevice.runScript"></a>
568 <h4>CircuitPythonDevice.runScript</h4> 883 <h4>CircuitPythonDevice.runScript</h4>
569 <b>runScript</b>(<i>script</i>) 884 <b>runScript</b>(<i>script</i>)
570 885
571 <p> 886 <p>
576 <dt><i>script</i> (str)</dt> 891 <dt><i>script</i> (str)</dt>
577 <dd> 892 <dd>
578 script to be executed 893 script to be executed
579 </dd> 894 </dd>
580 </dl> 895 </dl>
896 <a NAME="CircuitPythonDevice.scanNetworks" ID="CircuitPythonDevice.scanNetworks"></a>
897 <h4>CircuitPythonDevice.scanNetworks</h4>
898 <b>scanNetworks</b>(<i></i>)
899
900 <p>
901 Public method to scan for available WiFi networks.
902 </p>
903 <dl>
904 <dt>Return:</dt>
905 <dd>
906 tuple containing the list of available networks as a tuple of 'Name',
907 'MAC-Address', 'channel', 'RSSI' and 'security' and an error string
908 </dd>
909 </dl>
910 <dl>
911 <dt>Return Type:</dt>
912 <dd>
913 tuple of (list of tuple of (str, str, int, int, str), str)
914 </dd>
915 </dl>
581 <a NAME="CircuitPythonDevice.setButtons" ID="CircuitPythonDevice.setButtons"></a> 916 <a NAME="CircuitPythonDevice.setButtons" ID="CircuitPythonDevice.setButtons"></a>
582 <h4>CircuitPythonDevice.setButtons</h4> 917 <h4>CircuitPythonDevice.setButtons</h4>
583 <b>setButtons</b>(<i></i>) 918 <b>setButtons</b>(<i></i>)
584 919
585 <p> 920 <p>
597 <dt><i>connected</i> (bool)</dt> 932 <dt><i>connected</i> (bool)</dt>
598 <dd> 933 <dd>
599 connection state 934 connection state
600 </dd> 935 </dd>
601 </dl> 936 </dl>
937 <a NAME="CircuitPythonDevice.startAccessPoint" ID="CircuitPythonDevice.startAccessPoint"></a>
938 <h4>CircuitPythonDevice.startAccessPoint</h4>
939 <b>startAccessPoint</b>(<i>ssid, security=None, password=None, ifconfig=None</i>)
940
941 <p>
942 Public method to start the access point interface.
943 </p>
944 <dl>
945
946 <dt><i>ssid</i> (str)</dt>
947 <dd>
948 SSID of the access point
949 </dd>
950 <dt><i>security</i> (int (optional))</dt>
951 <dd>
952 security method (defaults to None)
953 </dd>
954 <dt><i>password</i> (str (optional))</dt>
955 <dd>
956 password (defaults to None)
957 </dd>
958 <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt>
959 <dd>
960 IPv4 configuration for the access point if not default
961 (IPv4 address, netmask, gateway address, DNS server address)
962 </dd>
963 </dl>
964 <dl>
965 <dt>Return:</dt>
966 <dd>
967 tuple containing a flag indicating success and an error message
968 </dd>
969 </dl>
970 <dl>
971 <dt>Return Type:</dt>
972 <dd>
973 tuple of (bool, str)
974 </dd>
975 </dl>
976 <a NAME="CircuitPythonDevice.stopAccessPoint" ID="CircuitPythonDevice.stopAccessPoint"></a>
977 <h4>CircuitPythonDevice.stopAccessPoint</h4>
978 <b>stopAccessPoint</b>(<i></i>)
979
980 <p>
981 Public method to stop the access point interface.
982 </p>
983 <dl>
984 <dt>Return:</dt>
985 <dd>
986 tuple containg a flag indicating success and an error message
987 </dd>
988 </dl>
989 <dl>
990 <dt>Return Type:</dt>
991 <dd>
992 tuple of (bool, str)
993 </dd>
994 </dl>
602 <a NAME="CircuitPythonDevice.supportsLocalFileAccess" ID="CircuitPythonDevice.supportsLocalFileAccess"></a> 995 <a NAME="CircuitPythonDevice.supportsLocalFileAccess" ID="CircuitPythonDevice.supportsLocalFileAccess"></a>
603 <h4>CircuitPythonDevice.supportsLocalFileAccess</h4> 996 <h4>CircuitPythonDevice.supportsLocalFileAccess</h4>
604 <b>supportsLocalFileAccess</b>(<i></i>) 997 <b>supportsLocalFileAccess</b>(<i></i>)
605 998
606 <p> 999 <p>
614 </dl> 1007 </dl>
615 <dl> 1008 <dl>
616 <dt>Return Type:</dt> 1009 <dt>Return Type:</dt>
617 <dd> 1010 <dd>
618 bool 1011 bool
1012 </dd>
1013 </dl>
1014 <a NAME="CircuitPythonDevice.writeCredentials" ID="CircuitPythonDevice.writeCredentials"></a>
1015 <h4>CircuitPythonDevice.writeCredentials</h4>
1016 <b>writeCredentials</b>(<i>ssid, password</i>)
1017
1018 <p>
1019 Public method to write the given credentials to the connected device and modify
1020 the start script to connect automatically.
1021 </p>
1022 <dl>
1023
1024 <dt><i>ssid</i> (str)</dt>
1025 <dd>
1026 SSID of the network to connect to
1027 </dd>
1028 <dt><i>password</i> (str)</dt>
1029 <dd>
1030 password needed to authenticate
1031 </dd>
1032 </dl>
1033 <dl>
1034 <dt>Return:</dt>
1035 <dd>
1036 tuple containing a flag indicating success and an error message
1037 </dd>
1038 </dl>
1039 <dl>
1040 <dt>Return Type:</dt>
1041 <dd>
1042 tuple of (bool, str)
619 </dd> 1043 </dd>
620 </dl> 1044 </dl>
621 <div align="right"><a href="#top">Up</a></div> 1045 <div align="right"><a href="#top">Up</a></div>
622 <hr /> 1046 <hr />
623 <hr /> 1047 <hr />

Mercurial Repository: eric

eric ide

mercurial