Fri, 03 Mar 2023 11:34:59 +0100
Updated source documentation.
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric7.MicroPython.Devices.RP2040Devices</title> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
5 | <link rel="stylesheet" href="styles.css"> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | </head> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | <body> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | <a NAME="top" ID="top"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | <h1>eric7.MicroPython.Devices.RP2040Devices</h1> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | Module implementing the device interface class for RP2040 based boards |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | (e.g. Raspberry Pi Pico). |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | <h3>Global Attributes</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | <table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
18 | <tr><td>None</td></tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | </table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | <h3>Classes</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | <table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
23 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <td><a href="#RP2040Device">RP2040Device</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <td>Class implementing the device for RP2040 based boards.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
28 | </table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <h3>Functions</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
32 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
33 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
34 | <td><a href="#createDevice">createDevice</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
35 | <td>Function to instantiate a MicroPython device object.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | </table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | <hr /> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | <hr /> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
40 | <a NAME="RP2040Device" ID="RP2040Device"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <h2>RP2040Device</h2> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
43 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
44 | Class implementing the device for RP2040 based boards. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
45 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
46 | <h3>Derived from</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
47 | BaseDevice |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
48 | <h3>Class Attributes</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
49 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
50 | <table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
51 | <tr><td>None</td></tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
52 | </table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
53 | <h3>Class Methods</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
54 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
55 | <table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
56 | <tr><td>None</td></tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
57 | </table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
58 | <h3>Methods</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
59 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
60 | <table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
61 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
62 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
63 | <td><a href="#RP2040Device.__init__">RP2040Device</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
64 | <td>Constructor</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <td><a href="#RP2040Device.__activateBootloader">__activateBootloader</a></td> |
9840
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
68 | <td>Private slot to switch the board into 'bootloader' mode.</td> |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
71 | <td><a href="#RP2040Device.__createRP2040Menu">__createRP2040Menu</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | <td>Private method to create the RO2040 submenu.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
74 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
75 | <td><a href="#RP2040Device.__firmwareVersionResponse">__firmwareVersionResponse</a></td> |
9840
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
76 | <td>Private slot handling the response of the latest version request.</td> |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
77 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
78 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
79 | <td><a href="#RP2040Device.__flashPython">__flashPython</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
80 | <td>Private slot to flash a MicroPython firmware to the device.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
81 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
82 | <tr> |
9840
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
83 | <td><a href="#RP2040Device.__resetDevice">__resetDevice</a></td> |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
84 | <td>Private slot to reset the connected device.</td> |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
85 | </tr> |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
86 | <tr> |
9799 | 87 | <td><a href="#RP2040Device.__setCountry">__setCountry</a></td> |
88 | <td>Private slot to configure the country of the connected RP2040 device.</td> | |
89 | </tr> | |
90 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
91 | <td><a href="#RP2040Device.__showFirmwareVersions">__showFirmwareVersions</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
92 | <td>Private slot to show the firmware version of the connected device and the available firmware version.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
93 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
94 | <tr> |
9765
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
95 | <td><a href="#RP2040Device._getSetTimeCode">_getSetTimeCode</a></td> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
96 | <td>Protected method to get the device code to set the time.</td> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
97 | </tr> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
98 | <tr> |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
99 | <td><a href="#RP2040Device.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
100 | <td>Public method to add device specific entries to the given menu.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
101 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
102 | <tr> |
9799 | 103 | <td><a href="#RP2040Device.addDeviceWifiEntries">addDeviceWifiEntries</a></td> |
104 | <td>Public method to add device specific entries to the given menu.</td> | |
105 | </tr> | |
106 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
107 | <td><a href="#RP2040Device.canRunScript">canRunScript</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
108 | <td>Public method to determine, if a script can be executed.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
109 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
110 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
111 | <td><a href="#RP2040Device.canStartFileManager">canStartFileManager</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
112 | <td>Public method to determine, if a File Manager can be started.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
113 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
114 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
115 | <td><a href="#RP2040Device.canStartPlotter">canStartPlotter</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
116 | <td>Public method to determine, if a Plotter can be started.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
117 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
118 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
119 | <td><a href="#RP2040Device.canStartRepl">canStartRepl</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
120 | <td>Public method to determine, if a REPL can be started.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
121 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
122 | <tr> |
9799 | 123 | <td><a href="#RP2040Device.checkInternet">checkInternet</a></td> |
124 | <td>Public method to check, if the internet can be reached.</td> | |
125 | </tr> | |
126 | <tr> | |
127 | <td><a href="#RP2040Device.connectWifi">connectWifi</a></td> | |
128 | <td>Public method to connect a device to a WiFi network.</td> | |
129 | </tr> | |
130 | <tr> | |
131 | <td><a href="#RP2040Device.deactivateInterface">deactivateInterface</a></td> | |
132 | <td>Public method to deactivate a given WiFi interface of the connected device.</td> | |
133 | </tr> | |
134 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
135 | <td><a href="#RP2040Device.deviceName">deviceName</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
136 | <td>Public method to get the name of the device.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
137 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
138 | <tr> |
9799 | 139 | <td><a href="#RP2040Device.disconnectWifi">disconnectWifi</a></td> |
140 | <td>Public method to disconnect a device from the WiFi network.</td> | |
141 | </tr> | |
142 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
143 | <td><a href="#RP2040Device.forceInterrupt">forceInterrupt</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
144 | <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
145 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
146 | <tr> |
9799 | 147 | <td><a href="#RP2040Device.getConnectedClients">getConnectedClients</a></td> |
148 | <td>Public method to get a list of connected clients.</td> | |
149 | </tr> | |
150 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
151 | <td><a href="#RP2040Device.getDocumentationUrl">getDocumentationUrl</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
152 | <td>Public method to get the device documentation URL.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
153 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
154 | <tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
155 | <td><a href="#RP2040Device.getDownloadMenuEntries">getDownloadMenuEntries</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
156 | <td>Public method to retrieve the entries for the downloads menu.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
157 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
158 | <tr> |
9799 | 159 | <td><a href="#RP2040Device.getWifiData">getWifiData</a></td> |
160 | <td>Public method to get data related to the current WiFi status.</td> | |
161 | </tr> | |
162 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
163 | <td><a href="#RP2040Device.hasFlashMenuEntry">hasFlashMenuEntry</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
164 | <td>Public method to check, if the device has its own flash menu entry.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
165 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
166 | <tr> |
9799 | 167 | <td><a href="#RP2040Device.hasWifi">hasWifi</a></td> |
168 | <td>Public method to check the availability of WiFi.</td> | |
169 | </tr> | |
170 | <tr> | |
171 | <td><a href="#RP2040Device.removeCredentials">removeCredentials</a></td> | |
172 | <td>Public method to remove the saved credentials from the connected device.</td> | |
173 | </tr> | |
174 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
175 | <td><a href="#RP2040Device.runScript">runScript</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
176 | <td>Public method to run the given Python script.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
177 | </tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
178 | <tr> |
9799 | 179 | <td><a href="#RP2040Device.scanNetworks">scanNetworks</a></td> |
180 | <td>Public method to scan for available WiFi networks.</td> | |
181 | </tr> | |
182 | <tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
183 | <td><a href="#RP2040Device.setButtons">setButtons</a></td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
184 | <td>Public method to enable the supported action buttons.</td> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
185 | </tr> |
9799 | 186 | <tr> |
187 | <td><a href="#RP2040Device.startAccessPoint">startAccessPoint</a></td> | |
188 | <td>Public method to start the access point interface.</td> | |
189 | </tr> | |
190 | <tr> | |
191 | <td><a href="#RP2040Device.stopAccessPoint">stopAccessPoint</a></td> | |
192 | <td>Public method to stop the access point interface.</td> | |
193 | </tr> | |
194 | <tr> | |
195 | <td><a href="#RP2040Device.writeCredentials">writeCredentials</a></td> | |
196 | <td>Public method to write the given credentials to the connected device and modify the start script to connect automatically.</td> | |
197 | </tr> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
198 | </table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
199 | <h3>Static Methods</h3> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
200 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
201 | <table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
202 | <tr><td>None</td></tr> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
203 | </table> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
204 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
205 | <a NAME="RP2040Device.__init__" ID="RP2040Device.__init__"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
206 | <h4>RP2040Device (Constructor)</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
207 | <b>RP2040Device</b>(<i>microPythonWidget, deviceType, parent=None</i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
208 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
209 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
210 | Constructor |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
211 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
212 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
213 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
214 | <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
215 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
216 | reference to the main MicroPython widget |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
217 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
218 | <dt><i>deviceType</i> (str)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
219 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
220 | device type assigned to this device interface |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
221 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
222 | <dt><i>parent</i> (QObject)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
223 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
224 | reference to the parent object |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
225 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
226 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
227 | <a NAME="RP2040Device.__activateBootloader" ID="RP2040Device.__activateBootloader"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
228 | <h4>RP2040Device.__activateBootloader</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
229 | <b>__activateBootloader</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
230 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
231 | <p> |
9840
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
232 | Private slot to switch the board into 'bootloader' mode. |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
233 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
234 | <a NAME="RP2040Device.__createRP2040Menu" ID="RP2040Device.__createRP2040Menu"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
235 | <h4>RP2040Device.__createRP2040Menu</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
236 | <b>__createRP2040Menu</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
237 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
238 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
239 | Private method to create the RO2040 submenu. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
240 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
241 | <a NAME="RP2040Device.__firmwareVersionResponse" ID="RP2040Device.__firmwareVersionResponse"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
242 | <h4>RP2040Device.__firmwareVersionResponse</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
243 | <b>__firmwareVersionResponse</b>(<i>reply</i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
244 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
245 | <p> |
9840
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
246 | Private slot handling the response of the latest version request. |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
247 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
248 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
249 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
250 | <dt><i>reply</i> (QNetworkReply)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
251 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
252 | reference to the reply object |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
253 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
254 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
255 | <a NAME="RP2040Device.__flashPython" ID="RP2040Device.__flashPython"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
256 | <h4>RP2040Device.__flashPython</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
257 | <b>__flashPython</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
258 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
259 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
260 | Private slot to flash a MicroPython firmware to the device. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
261 | </p> |
9840
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
262 | <a NAME="RP2040Device.__resetDevice" ID="RP2040Device.__resetDevice"></a> |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
263 | <h4>RP2040Device.__resetDevice</h4> |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
264 | <b>__resetDevice</b>(<i></i>) |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
265 | |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
266 | <p> |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
267 | Private slot to reset the connected device. |
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
268 | </p> |
9799 | 269 | <a NAME="RP2040Device.__setCountry" ID="RP2040Device.__setCountry"></a> |
270 | <h4>RP2040Device.__setCountry</h4> | |
271 | <b>__setCountry</b>(<i></i>) | |
272 | ||
273 | <p> | |
274 | Private slot to configure the country of the connected RP2040 device. | |
275 | </p> | |
276 | <p> | |
277 | The country is the two letter country code. | |
278 | </p> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
279 | <a NAME="RP2040Device.__showFirmwareVersions" ID="RP2040Device.__showFirmwareVersions"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
280 | <h4>RP2040Device.__showFirmwareVersions</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
281 | <b>__showFirmwareVersions</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
282 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
283 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
284 | Private slot to show the firmware version of the connected device and the |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
285 | available firmware version. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
286 | </p> |
9765
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
287 | <a NAME="RP2040Device._getSetTimeCode" ID="RP2040Device._getSetTimeCode"></a> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
288 | <h4>RP2040Device._getSetTimeCode</h4> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
289 | <b>_getSetTimeCode</b>(<i></i>) |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
290 | |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
291 | <p> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
292 | Protected method to get the device code to set the time. |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
293 | </p> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
294 | <p> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
295 | Note: This method must be implemented in the various device specific |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
296 | subclasses. |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
297 | </p> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
298 | <dl> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
299 | <dt>Return:</dt> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
300 | <dd> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
301 | code to be executed on the connected device to set the time |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
302 | </dd> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
303 | </dl> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
304 | <dl> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
305 | <dt>Return Type:</dt> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
306 | <dd> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
307 | str |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
308 | </dd> |
6378da868bb0
Reorganized the MicroPython code even more.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9756
diff
changeset
|
309 | </dl> |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
310 | <a NAME="RP2040Device.addDeviceMenuEntries" ID="RP2040Device.addDeviceMenuEntries"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
311 | <h4>RP2040Device.addDeviceMenuEntries</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
312 | <b>addDeviceMenuEntries</b>(<i>menu</i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
313 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
314 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
315 | Public method to add device specific entries to the given menu. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
316 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
317 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
318 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
319 | <dt><i>menu</i> (QMenu)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
320 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
321 | reference to the context menu |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
322 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
323 | </dl> |
9799 | 324 | <a NAME="RP2040Device.addDeviceWifiEntries" ID="RP2040Device.addDeviceWifiEntries"></a> |
325 | <h4>RP2040Device.addDeviceWifiEntries</h4> | |
326 | <b>addDeviceWifiEntries</b>(<i>menu</i>) | |
327 | ||
328 | <p> | |
329 | Public method to add device specific entries to the given menu. | |
330 | </p> | |
331 | <dl> | |
332 | ||
333 | <dt><i>menu</i> (QMenu)</dt> | |
334 | <dd> | |
335 | reference to the context menu | |
336 | </dd> | |
337 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
338 | <a NAME="RP2040Device.canRunScript" ID="RP2040Device.canRunScript"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
339 | <h4>RP2040Device.canRunScript</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
340 | <b>canRunScript</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
341 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
342 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
343 | Public method to determine, if a script can be executed. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
344 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
345 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
346 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
347 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
348 | tuple containing a flag indicating it is safe to start a |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
349 | Plotter and a reason why it cannot. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
350 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
351 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
352 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
353 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
354 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
355 | tuple of (bool, str) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
356 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
357 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
358 | <a NAME="RP2040Device.canStartFileManager" ID="RP2040Device.canStartFileManager"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
359 | <h4>RP2040Device.canStartFileManager</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
360 | <b>canStartFileManager</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
361 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
362 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
363 | Public method to determine, if a File Manager can be started. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
364 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
365 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
366 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
367 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
368 | tuple containing a flag indicating it is safe to start a |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
369 | File Manager and a reason why it cannot. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
370 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
371 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
372 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
373 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
374 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
375 | tuple of (bool, str) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
376 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
377 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
378 | <a NAME="RP2040Device.canStartPlotter" ID="RP2040Device.canStartPlotter"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
379 | <h4>RP2040Device.canStartPlotter</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
380 | <b>canStartPlotter</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
381 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
382 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
383 | Public method to determine, if a Plotter can be started. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
384 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
385 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
386 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
387 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
388 | tuple containing a flag indicating it is safe to start a |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
389 | Plotter and a reason why it cannot. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
390 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
391 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
392 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
393 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
394 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
395 | tuple of (bool, str) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
396 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
397 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
398 | <a NAME="RP2040Device.canStartRepl" ID="RP2040Device.canStartRepl"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
399 | <h4>RP2040Device.canStartRepl</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
400 | <b>canStartRepl</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
401 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
402 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
403 | Public method to determine, if a REPL can be started. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
404 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
405 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
406 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
407 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
408 | tuple containing a flag indicating it is safe to start a REPL |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
409 | and a reason why it cannot. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
410 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
411 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
412 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
413 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
414 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
415 | tuple of (bool, str) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
416 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
417 | </dl> |
9799 | 418 | <a NAME="RP2040Device.checkInternet" ID="RP2040Device.checkInternet"></a> |
419 | <h4>RP2040Device.checkInternet</h4> | |
420 | <b>checkInternet</b>(<i></i>) | |
421 | ||
422 | <p> | |
423 | Public method to check, if the internet can be reached. | |
424 | </p> | |
425 | <dl> | |
426 | <dt>Return:</dt> | |
427 | <dd> | |
428 | tuple containing a flag indicating reachability and an error string | |
429 | </dd> | |
430 | </dl> | |
431 | <dl> | |
432 | <dt>Return Type:</dt> | |
433 | <dd> | |
434 | tuple of (bool, str) | |
435 | </dd> | |
436 | </dl> | |
437 | <a NAME="RP2040Device.connectWifi" ID="RP2040Device.connectWifi"></a> | |
438 | <h4>RP2040Device.connectWifi</h4> | |
439 | <b>connectWifi</b>(<i>ssid, password</i>) | |
440 | ||
441 | <p> | |
442 | Public method to connect a device to a WiFi network. | |
443 | </p> | |
444 | <dl> | |
445 | ||
446 | <dt><i>ssid</i> (str)</dt> | |
447 | <dd> | |
448 | name (SSID) of the WiFi network | |
449 | </dd> | |
450 | <dt><i>password</i> (str)</dt> | |
451 | <dd> | |
452 | password needed to connect | |
453 | </dd> | |
454 | </dl> | |
455 | <dl> | |
456 | <dt>Return:</dt> | |
457 | <dd> | |
458 | tuple containing the connection status and an error string | |
459 | </dd> | |
460 | </dl> | |
461 | <dl> | |
462 | <dt>Return Type:</dt> | |
463 | <dd> | |
464 | tuple of (bool, str) | |
465 | </dd> | |
466 | </dl> | |
467 | <a NAME="RP2040Device.deactivateInterface" ID="RP2040Device.deactivateInterface"></a> | |
468 | <h4>RP2040Device.deactivateInterface</h4> | |
469 | <b>deactivateInterface</b>(<i>interface</i>) | |
470 | ||
471 | <p> | |
472 | Public method to deactivate a given WiFi interface of the connected device. | |
473 | </p> | |
474 | <dl> | |
475 | ||
476 | <dt><i>interface</i> (str)</dt> | |
477 | <dd> | |
478 | designation of the interface to be deactivated (one of 'AP' | |
479 | or 'STA') | |
480 | </dd> | |
481 | </dl> | |
482 | <dl> | |
483 | <dt>Return:</dt> | |
484 | <dd> | |
485 | tuple containg a flag indicating success and an error message | |
486 | </dd> | |
487 | </dl> | |
488 | <dl> | |
489 | <dt>Return Type:</dt> | |
490 | <dd> | |
491 | tuple of (bool, str) | |
492 | </dd> | |
493 | </dl> | |
494 | <dl> | |
495 | ||
496 | <dt>Raises <b>ValueError</b>:</dt> | |
497 | <dd> | |
498 | raised to indicate a wrong value for the interface type | |
499 | </dd> | |
500 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
501 | <a NAME="RP2040Device.deviceName" ID="RP2040Device.deviceName"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
502 | <h4>RP2040Device.deviceName</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
503 | <b>deviceName</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
504 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
505 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
506 | Public method to get the name of the device. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
507 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
508 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
509 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
510 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
511 | name of the device |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
512 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
513 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
514 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
515 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
516 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
517 | str |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
518 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
519 | </dl> |
9799 | 520 | <a NAME="RP2040Device.disconnectWifi" ID="RP2040Device.disconnectWifi"></a> |
521 | <h4>RP2040Device.disconnectWifi</h4> | |
522 | <b>disconnectWifi</b>(<i></i>) | |
523 | ||
524 | <p> | |
525 | Public method to disconnect a device from the WiFi network. | |
526 | </p> | |
527 | <dl> | |
528 | <dt>Return:</dt> | |
529 | <dd> | |
530 | tuple containing a flag indicating success and an error string | |
531 | </dd> | |
532 | </dl> | |
533 | <dl> | |
534 | <dt>Return Type:</dt> | |
535 | <dd> | |
536 | tuple of (bool, str) | |
537 | </dd> | |
538 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
539 | <a NAME="RP2040Device.forceInterrupt" ID="RP2040Device.forceInterrupt"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
540 | <h4>RP2040Device.forceInterrupt</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
541 | <b>forceInterrupt</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
542 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
543 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
544 | Public method to determine the need for an interrupt when opening the |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
545 | serial connection. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
546 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
547 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
548 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
549 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
550 | flag indicating an interrupt is needed |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
551 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
552 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
553 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
554 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
555 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
556 | bool |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
557 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
558 | </dl> |
9799 | 559 | <a NAME="RP2040Device.getConnectedClients" ID="RP2040Device.getConnectedClients"></a> |
560 | <h4>RP2040Device.getConnectedClients</h4> | |
561 | <b>getConnectedClients</b>(<i></i>) | |
562 | ||
563 | <p> | |
564 | Public method to get a list of connected clients. | |
565 | </p> | |
566 | <dl> | |
567 | <dt>Return:</dt> | |
568 | <dd> | |
569 | a tuple containing a list of tuples containing the client MAC-Address | |
570 | and the RSSI (if supported and available) and an error message | |
571 | </dd> | |
572 | </dl> | |
573 | <dl> | |
574 | <dt>Return Type:</dt> | |
575 | <dd> | |
576 | tuple of ([(bytes, int)], str) | |
577 | </dd> | |
578 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
579 | <a NAME="RP2040Device.getDocumentationUrl" ID="RP2040Device.getDocumentationUrl"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
580 | <h4>RP2040Device.getDocumentationUrl</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
581 | <b>getDocumentationUrl</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
582 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
583 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
584 | Public method to get the device documentation URL. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
585 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
586 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
587 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
588 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
589 | documentation URL of the device |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
590 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
591 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
592 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
593 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
594 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
595 | str |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
596 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
597 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
598 | <a NAME="RP2040Device.getDownloadMenuEntries" ID="RP2040Device.getDownloadMenuEntries"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
599 | <h4>RP2040Device.getDownloadMenuEntries</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
600 | <b>getDownloadMenuEntries</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
601 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
602 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
603 | Public method to retrieve the entries for the downloads menu. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
604 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
605 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
606 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
607 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
608 | list of tuples with menu text and URL to be opened for each |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
609 | entry |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
610 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
611 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
612 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
613 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
614 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
615 | list of tuple of (str, str) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
616 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
617 | </dl> |
9799 | 618 | <a NAME="RP2040Device.getWifiData" ID="RP2040Device.getWifiData"></a> |
619 | <h4>RP2040Device.getWifiData</h4> | |
620 | <b>getWifiData</b>(<i></i>) | |
621 | ||
622 | <p> | |
623 | Public method to get data related to the current WiFi status. | |
624 | </p> | |
625 | <dl> | |
626 | <dt>Return:</dt> | |
627 | <dd> | |
628 | tuple of three dictionaries containing the WiFi status data | |
629 | for the WiFi client, access point and overall data | |
630 | </dd> | |
631 | </dl> | |
632 | <dl> | |
633 | <dt>Return Type:</dt> | |
634 | <dd> | |
635 | tuple of (dict, dict, dict) | |
636 | </dd> | |
637 | </dl> | |
638 | <dl> | |
639 | ||
640 | <dt>Raises <b>OSError</b>:</dt> | |
641 | <dd> | |
642 | raised to indicate an issue with the device | |
643 | </dd> | |
644 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
645 | <a NAME="RP2040Device.hasFlashMenuEntry" ID="RP2040Device.hasFlashMenuEntry"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
646 | <h4>RP2040Device.hasFlashMenuEntry</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
647 | <b>hasFlashMenuEntry</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
648 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
649 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
650 | Public method to check, if the device has its own flash menu entry. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
651 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
652 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
653 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
654 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
655 | flag indicating a specific flash menu entry |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
656 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
657 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
658 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
659 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
660 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
661 | bool |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
662 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
663 | </dl> |
9799 | 664 | <a NAME="RP2040Device.hasWifi" ID="RP2040Device.hasWifi"></a> |
665 | <h4>RP2040Device.hasWifi</h4> | |
666 | <b>hasWifi</b>(<i></i>) | |
667 | ||
668 | <p> | |
669 | Public method to check the availability of WiFi. | |
670 | </p> | |
671 | <dl> | |
672 | <dt>Return:</dt> | |
673 | <dd> | |
674 | tuple containing a flag indicating the availability of WiFi | |
9840
d41ee69fa69b
Updated source documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9799
diff
changeset
|
675 | and the WiFi type (picow or picowireless) |
9799 | 676 | </dd> |
677 | </dl> | |
678 | <dl> | |
679 | <dt>Return Type:</dt> | |
680 | <dd> | |
681 | tuple of (bool, str) | |
682 | </dd> | |
683 | </dl> | |
684 | <dl> | |
685 | ||
686 | <dt>Raises <b>OSError</b>:</dt> | |
687 | <dd> | |
688 | raised to indicate an issue with the device | |
689 | </dd> | |
690 | </dl> | |
691 | <a NAME="RP2040Device.removeCredentials" ID="RP2040Device.removeCredentials"></a> | |
692 | <h4>RP2040Device.removeCredentials</h4> | |
693 | <b>removeCredentials</b>(<i></i>) | |
694 | ||
695 | <p> | |
696 | Public method to remove the saved credentials from the connected device. | |
697 | </p> | |
698 | <dl> | |
699 | <dt>Return:</dt> | |
700 | <dd> | |
701 | tuple containing a flag indicating success and an error message | |
702 | </dd> | |
703 | </dl> | |
704 | <dl> | |
705 | <dt>Return Type:</dt> | |
706 | <dd> | |
707 | tuple of (bool, str) | |
708 | </dd> | |
709 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
710 | <a NAME="RP2040Device.runScript" ID="RP2040Device.runScript"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
711 | <h4>RP2040Device.runScript</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
712 | <b>runScript</b>(<i>script</i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
713 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
714 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
715 | Public method to run the given Python script. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
716 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
717 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
718 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
719 | <dt><i>script</i> (str)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
720 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
721 | script to be executed |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
722 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
723 | </dl> |
9799 | 724 | <a NAME="RP2040Device.scanNetworks" ID="RP2040Device.scanNetworks"></a> |
725 | <h4>RP2040Device.scanNetworks</h4> | |
726 | <b>scanNetworks</b>(<i></i>) | |
727 | ||
728 | <p> | |
729 | Public method to scan for available WiFi networks. | |
730 | </p> | |
731 | <dl> | |
732 | <dt>Return:</dt> | |
733 | <dd> | |
734 | tuple containing the list of available networks as a tuple of 'Name', | |
735 | 'MAC-Address', 'channel', 'RSSI' and 'security' and an error string | |
736 | </dd> | |
737 | </dl> | |
738 | <dl> | |
739 | <dt>Return Type:</dt> | |
740 | <dd> | |
741 | tuple of (list of tuple of (str, str, int, int, str), str) | |
742 | </dd> | |
743 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
744 | <a NAME="RP2040Device.setButtons" ID="RP2040Device.setButtons"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
745 | <h4>RP2040Device.setButtons</h4> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
746 | <b>setButtons</b>(<i></i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
747 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
748 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
749 | Public method to enable the supported action buttons. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
750 | </p> |
9799 | 751 | <a NAME="RP2040Device.startAccessPoint" ID="RP2040Device.startAccessPoint"></a> |
752 | <h4>RP2040Device.startAccessPoint</h4> | |
753 | <b>startAccessPoint</b>(<i>ssid, security=None, password=None, ifconfig=None</i>) | |
754 | ||
755 | <p> | |
756 | Public method to start the access point interface. | |
757 | </p> | |
758 | <dl> | |
759 | ||
760 | <dt><i>ssid</i> (str)</dt> | |
761 | <dd> | |
762 | SSID of the access point | |
763 | </dd> | |
764 | <dt><i>security</i> (int (optional))</dt> | |
765 | <dd> | |
766 | security method (defaults to None) | |
767 | </dd> | |
768 | <dt><i>password</i> (str (optional))</dt> | |
769 | <dd> | |
770 | password (defaults to None) | |
771 | </dd> | |
772 | <dt><i>ifconfig</i> (tuple of (str, str, str, str))</dt> | |
773 | <dd> | |
774 | IPv4 configuration for the access point if not default | |
775 | (IPv4 address, netmask, gateway address, DNS server address) | |
776 | </dd> | |
777 | </dl> | |
778 | <dl> | |
779 | <dt>Return:</dt> | |
780 | <dd> | |
781 | tuple containing a flag indicating success and an error message | |
782 | </dd> | |
783 | </dl> | |
784 | <dl> | |
785 | <dt>Return Type:</dt> | |
786 | <dd> | |
787 | tuple of (bool, str) | |
788 | </dd> | |
789 | </dl> | |
790 | <a NAME="RP2040Device.stopAccessPoint" ID="RP2040Device.stopAccessPoint"></a> | |
791 | <h4>RP2040Device.stopAccessPoint</h4> | |
792 | <b>stopAccessPoint</b>(<i></i>) | |
793 | ||
794 | <p> | |
795 | Public method to stop the access point interface. | |
796 | </p> | |
797 | <dl> | |
798 | <dt>Return:</dt> | |
799 | <dd> | |
800 | tuple containg a flag indicating success and an error message | |
801 | </dd> | |
802 | </dl> | |
803 | <dl> | |
804 | <dt>Return Type:</dt> | |
805 | <dd> | |
806 | tuple of (bool, str) | |
807 | </dd> | |
808 | </dl> | |
809 | <a NAME="RP2040Device.writeCredentials" ID="RP2040Device.writeCredentials"></a> | |
810 | <h4>RP2040Device.writeCredentials</h4> | |
811 | <b>writeCredentials</b>(<i>ssid, password</i>) | |
812 | ||
813 | <p> | |
814 | Public method to write the given credentials to the connected device and modify | |
815 | the start script to connect automatically. | |
816 | </p> | |
817 | <dl> | |
818 | ||
819 | <dt><i>ssid</i> (str)</dt> | |
820 | <dd> | |
821 | SSID of the network to connect to | |
822 | </dd> | |
823 | <dt><i>password</i> (str)</dt> | |
824 | <dd> | |
825 | password needed to authenticate | |
826 | </dd> | |
827 | </dl> | |
828 | <dl> | |
829 | <dt>Return:</dt> | |
830 | <dd> | |
831 | tuple containing a flag indicating success and an error message | |
832 | </dd> | |
833 | </dl> | |
834 | <dl> | |
835 | <dt>Return Type:</dt> | |
836 | <dd> | |
837 | tuple of (bool, str) | |
838 | </dd> | |
839 | </dl> | |
9756
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
840 | <div align="right"><a href="#top">Up</a></div> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
841 | <hr /> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
842 | <hr /> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
843 | <a NAME="createDevice" ID="createDevice"></a> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
844 | <h2>createDevice</h2> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
845 | <b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName, serialNumber</i>) |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
846 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
847 | <p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
848 | Function to instantiate a MicroPython device object. |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
849 | </p> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
850 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
851 | |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
852 | <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
853 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
854 | reference to the main MicroPython widget |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
855 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
856 | <dt><i>deviceType</i> (str)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
857 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
858 | device type assigned to this device interface |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
859 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
860 | <dt><i>vid</i> (int)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
861 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
862 | vendor ID |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
863 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
864 | <dt><i>pid</i> (int)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
865 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
866 | product ID |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
867 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
868 | <dt><i>boardName</i> (str)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
869 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
870 | name of the board |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
871 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
872 | <dt><i>serialNumber</i> (str)</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
873 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
874 | serial number of the board |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
875 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
876 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
877 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
878 | <dt>Return:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
879 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
880 | reference to the instantiated device object |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
881 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
882 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
883 | <dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
884 | <dt>Return Type:</dt> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
885 | <dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
886 | RP2040Device |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
887 | </dd> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
888 | </dl> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
889 | <div align="right"><a href="#top">Up</a></div> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
890 | <hr /> |
9854647c8c5c
Reorganized the MicroPython package.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
891 | </body></html> |