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

Sat, 25 Feb 2023 19:18:07 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 25 Feb 2023 19:18:07 +0100
branch
mpy_network
changeset 9799
a79430a8811d
parent 9765
6378da868bb0
child 9840
d41ee69fa69b
permissions
-rw-r--r--

MicroPython
- added support for 'paste' mode to circumvent the reset of CircuitPython when executing some commands through the device interface

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

eric ide

mercurial