Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.MicroPython.MicroPythonDevices.html

eric6/Documentation/Source/eric6.MicroPython.MicroPythonDevices.html

changeset 7273
391d6b7b1eff
parent 7161
728018c32b09
child 7336
0095e231ddaf
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.MicroPython.MicroPythonDevices</h1> 23 <h1>eric6.MicroPython.MicroPythonDevices</h1>
24
23 <p> 25 <p>
24 Module implementing some utility functions and the MicroPythonDevice base 26 Module implementing some utility functions and the MicroPythonDevice base
25 class. 27 class.
26 </p> 28 </p>
27 <h3>Global Attributes</h3> 29 <h3>Global Attributes</h3>
30
28 <table> 31 <table>
29 <tr><td>SupportedBoards</td></tr> 32 <tr><td>SupportedBoards</td></tr>
30 </table> 33 </table>
31 <h3>Classes</h3> 34 <h3>Classes</h3>
35
32 <table> 36 <table>
37
33 <tr> 38 <tr>
34 <td><a href="#MicroPythonDevice">MicroPythonDevice</a></td> 39 <td><a href="#MicroPythonDevice">MicroPythonDevice</a></td>
35 <td>Base class for the more specific MicroPython devices.</td> 40 <td>Base class for the more specific MicroPython devices.</td>
36 </tr> 41 </tr>
37 </table> 42 </table>
38 <h3>Functions</h3> 43 <h3>Functions</h3>
44
39 <table> 45 <table>
46
40 <tr> 47 <tr>
41 <td><a href="#getDevice">getDevice</a></td> 48 <td><a href="#getDevice">getDevice</a></td>
42 <td>Public method to instantiate a specific MicroPython device interface.</td> 49 <td>Public method to instantiate a specific MicroPython device interface.</td>
43 </tr><tr> 50 </tr>
51 <tr>
44 <td><a href="#getDeviceIcon">getDeviceIcon</a></td> 52 <td><a href="#getDeviceIcon">getDeviceIcon</a></td>
45 <td>Function to get the icon for the given board.</td> 53 <td>Function to get the icon for the given board.</td>
46 </tr><tr> 54 </tr>
55 <tr>
47 <td><a href="#getFoundDevices">getFoundDevices</a></td> 56 <td><a href="#getFoundDevices">getFoundDevices</a></td>
48 <td>Function to check the serial ports for supported MicroPython devices.</td> 57 <td>Function to check the serial ports for supported MicroPython devices.</td>
49 </tr><tr> 58 </tr>
59 <tr>
50 <td><a href="#getSupportedDevices">getSupportedDevices</a></td> 60 <td><a href="#getSupportedDevices">getSupportedDevices</a></td>
51 <td>Function to get a list of supported MicroPython devices.</td> 61 <td>Function to get a list of supported MicroPython devices.</td>
52 </tr> 62 </tr>
53 </table> 63 </table>
54 <hr /><hr /> 64 <hr />
65 <hr />
55 <a NAME="MicroPythonDevice" ID="MicroPythonDevice"></a> 66 <a NAME="MicroPythonDevice" ID="MicroPythonDevice"></a>
56 <h2>MicroPythonDevice</h2> 67 <h2>MicroPythonDevice</h2>
68
57 <p> 69 <p>
58 Base class for the more specific MicroPython devices. 70 Base class for the more specific MicroPython devices.
59 </p> 71 </p>
60 <h3>Derived from</h3> 72 <h3>Derived from</h3>
61 QObject 73 QObject
62 <h3>Class Attributes</h3> 74 <h3>Class Attributes</h3>
75
63 <table> 76 <table>
64 <tr><td>None</td></tr> 77 <tr><td>None</td></tr>
65 </table> 78 </table>
66 <h3>Class Methods</h3> 79 <h3>Class Methods</h3>
80
67 <table> 81 <table>
68 <tr><td>None</td></tr> 82 <tr><td>None</td></tr>
69 </table> 83 </table>
70 <h3>Methods</h3> 84 <h3>Methods</h3>
85
71 <table> 86 <table>
87
72 <tr> 88 <tr>
73 <td><a href="#MicroPythonDevice.__init__">MicroPythonDevice</a></td> 89 <td><a href="#MicroPythonDevice.__init__">MicroPythonDevice</a></td>
74 <td>Constructor</td> 90 <td>Constructor</td>
75 </tr><tr> 91 </tr>
92 <tr>
76 <td><a href="#MicroPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> 93 <td><a href="#MicroPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td>
77 <td>Public method to add device specific entries to the given menu.</td> 94 <td>Public method to add device specific entries to the given menu.</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#MicroPythonDevice.canRunScript">canRunScript</a></td> 97 <td><a href="#MicroPythonDevice.canRunScript">canRunScript</a></td>
80 <td>Public method to determine, if a script can be executed.</td> 98 <td>Public method to determine, if a script can be executed.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#MicroPythonDevice.canStartFileManager">canStartFileManager</a></td> 101 <td><a href="#MicroPythonDevice.canStartFileManager">canStartFileManager</a></td>
83 <td>Public method to determine, if a File Manager can be started.</td> 102 <td>Public method to determine, if a File Manager can be started.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#MicroPythonDevice.canStartPlotter">canStartPlotter</a></td> 105 <td><a href="#MicroPythonDevice.canStartPlotter">canStartPlotter</a></td>
86 <td>Public method to determine, if a Plotter can be started.</td> 106 <td>Public method to determine, if a Plotter can be started.</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#MicroPythonDevice.canStartRepl">canStartRepl</a></td> 109 <td><a href="#MicroPythonDevice.canStartRepl">canStartRepl</a></td>
89 <td>Public method to determine, if a REPL can be started.</td> 110 <td>Public method to determine, if a REPL can be started.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#MicroPythonDevice.deviceName">deviceName</a></td> 113 <td><a href="#MicroPythonDevice.deviceName">deviceName</a></td>
92 <td>Public method to get the name of the device.</td> 114 <td>Public method to get the name of the device.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#MicroPythonDevice.forceInterrupt">forceInterrupt</a></td> 117 <td><a href="#MicroPythonDevice.forceInterrupt">forceInterrupt</a></td>
95 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> 118 <td>Public method to determine the need for an interrupt when opening the serial connection.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#MicroPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> 121 <td><a href="#MicroPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td>
98 <td>Public method to get the device documentation URL.</td> 122 <td>Public method to get the device documentation URL.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#MicroPythonDevice.getWorkspace">getWorkspace</a></td> 125 <td><a href="#MicroPythonDevice.getWorkspace">getWorkspace</a></td>
101 <td>Public method to get the workspace directory.</td> 126 <td>Public method to get the workspace directory.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#MicroPythonDevice.handleDataFlood">handleDataFlood</a></td> 129 <td><a href="#MicroPythonDevice.handleDataFlood">handleDataFlood</a></td>
104 <td>Public slot handling a data floof from the device.</td> 130 <td>Public slot handling a data floof from the device.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#MicroPythonDevice.hasDocumentationUrl">hasDocumentationUrl</a></td> 133 <td><a href="#MicroPythonDevice.hasDocumentationUrl">hasDocumentationUrl</a></td>
107 <td>Public method to check, if the device has a configured documentation URL.</td> 134 <td>Public method to check, if the device has a configured documentation URL.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#MicroPythonDevice.hasTimeCommands">hasTimeCommands</a></td> 137 <td><a href="#MicroPythonDevice.hasTimeCommands">hasTimeCommands</a></td>
110 <td>Public method to check, if the device supports time commands.</td> 138 <td>Public method to check, if the device supports time commands.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#MicroPythonDevice.runScript">runScript</a></td> 141 <td><a href="#MicroPythonDevice.runScript">runScript</a></td>
113 <td>Public method to run the given Python script.</td> 142 <td>Public method to run the given Python script.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#MicroPythonDevice.sendCommands">sendCommands</a></td> 145 <td><a href="#MicroPythonDevice.sendCommands">sendCommands</a></td>
116 <td>Public method to send a list of commands to the device.</td> 146 <td>Public method to send a list of commands to the device.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#MicroPythonDevice.setButtons">setButtons</a></td> 149 <td><a href="#MicroPythonDevice.setButtons">setButtons</a></td>
119 <td>Public method to enable the supported action buttons.</td> 150 <td>Public method to enable the supported action buttons.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#MicroPythonDevice.setFileManager">setFileManager</a></td> 153 <td><a href="#MicroPythonDevice.setFileManager">setFileManager</a></td>
122 <td>Public method to set the File Manager status and dependent status.</td> 154 <td>Public method to set the File Manager status and dependent status.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#MicroPythonDevice.setPlotter">setPlotter</a></td> 157 <td><a href="#MicroPythonDevice.setPlotter">setPlotter</a></td>
125 <td>Public method to set the Plotter status and dependent status.</td> 158 <td>Public method to set the Plotter status and dependent status.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#MicroPythonDevice.setRepl">setRepl</a></td> 161 <td><a href="#MicroPythonDevice.setRepl">setRepl</a></td>
128 <td>Public method to set the REPL status and dependent status.</td> 162 <td>Public method to set the REPL status and dependent status.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#MicroPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> 165 <td><a href="#MicroPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td>
131 <td>Public method to indicate file access via a local directory.</td> 166 <td>Public method to indicate file access via a local directory.</td>
132 </tr> 167 </tr>
133 </table> 168 </table>
134 <h3>Static Methods</h3> 169 <h3>Static Methods</h3>
170
135 <table> 171 <table>
136 <tr><td>None</td></tr> 172 <tr><td>None</td></tr>
137 </table> 173 </table>
174
138 <a NAME="MicroPythonDevice.__init__" ID="MicroPythonDevice.__init__"></a> 175 <a NAME="MicroPythonDevice.__init__" ID="MicroPythonDevice.__init__"></a>
139 <h4>MicroPythonDevice (Constructor)</h4> 176 <h4>MicroPythonDevice (Constructor)</h4>
140 <b>MicroPythonDevice</b>(<i>microPythonWidget, parent=None</i>) 177 <b>MicroPythonDevice</b>(<i>microPythonWidget, parent=None</i>)
178
141 <p> 179 <p>
142 Constructor 180 Constructor
143 </p><dl> 181 </p>
182 <dl>
183
144 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> 184 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
145 <dd> 185 <dd>
146 reference to the main MicroPython widget 186 reference to the main MicroPython widget
147 </dd><dt><i>parent</i> (QObject)</dt> 187 </dd>
188 <dt><i>parent</i> (QObject)</dt>
148 <dd> 189 <dd>
149 reference to the parent object 190 reference to the parent object
150 </dd> 191 </dd>
151 </dl><a NAME="MicroPythonDevice.addDeviceMenuEntries" ID="MicroPythonDevice.addDeviceMenuEntries"></a> 192 </dl>
193 <a NAME="MicroPythonDevice.addDeviceMenuEntries" ID="MicroPythonDevice.addDeviceMenuEntries"></a>
152 <h4>MicroPythonDevice.addDeviceMenuEntries</h4> 194 <h4>MicroPythonDevice.addDeviceMenuEntries</h4>
153 <b>addDeviceMenuEntries</b>(<i>menu</i>) 195 <b>addDeviceMenuEntries</b>(<i>menu</i>)
196
154 <p> 197 <p>
155 Public method to add device specific entries to the given menu. 198 Public method to add device specific entries to the given menu.
156 </p><dl> 199 </p>
200 <dl>
201
157 <dt><i>menu</i> (QMenu)</dt> 202 <dt><i>menu</i> (QMenu)</dt>
158 <dd> 203 <dd>
159 reference to the context menu 204 reference to the context menu
160 </dd> 205 </dd>
161 </dl><a NAME="MicroPythonDevice.canRunScript" ID="MicroPythonDevice.canRunScript"></a> 206 </dl>
207 <a NAME="MicroPythonDevice.canRunScript" ID="MicroPythonDevice.canRunScript"></a>
162 <h4>MicroPythonDevice.canRunScript</h4> 208 <h4>MicroPythonDevice.canRunScript</h4>
163 <b>canRunScript</b>(<i></i>) 209 <b>canRunScript</b>(<i></i>)
210
164 <p> 211 <p>
165 Public method to determine, if a script can be executed. 212 Public method to determine, if a script can be executed.
166 </p><dl> 213 </p>
214 <dl>
167 <dt>Returns:</dt> 215 <dt>Returns:</dt>
168 <dd> 216 <dd>
169 tuple containing a flag indicating it is safe to start a 217 tuple containing a flag indicating it is safe to start a
170 Plotter and a reason why it cannot. 218 Plotter and a reason why it cannot.
171 </dd> 219 </dd>
172 </dl><dl> 220 </dl>
221 <dl>
173 <dt>Return Type:</dt> 222 <dt>Return Type:</dt>
174 <dd> 223 <dd>
175 tuple of (bool, str) 224 tuple of (bool, str)
176 </dd> 225 </dd>
177 </dl><a NAME="MicroPythonDevice.canStartFileManager" ID="MicroPythonDevice.canStartFileManager"></a> 226 </dl>
227 <a NAME="MicroPythonDevice.canStartFileManager" ID="MicroPythonDevice.canStartFileManager"></a>
178 <h4>MicroPythonDevice.canStartFileManager</h4> 228 <h4>MicroPythonDevice.canStartFileManager</h4>
179 <b>canStartFileManager</b>(<i></i>) 229 <b>canStartFileManager</b>(<i></i>)
230
180 <p> 231 <p>
181 Public method to determine, if a File Manager can be started. 232 Public method to determine, if a File Manager can be started.
182 </p><dl> 233 </p>
234 <dl>
183 <dt>Returns:</dt> 235 <dt>Returns:</dt>
184 <dd> 236 <dd>
185 tuple containing a flag indicating it is safe to start a 237 tuple containing a flag indicating it is safe to start a
186 File Manager and a reason why it cannot. 238 File Manager and a reason why it cannot.
187 </dd> 239 </dd>
188 </dl><dl> 240 </dl>
241 <dl>
189 <dt>Return Type:</dt> 242 <dt>Return Type:</dt>
190 <dd> 243 <dd>
191 tuple of (bool, str) 244 tuple of (bool, str)
192 </dd> 245 </dd>
193 </dl><a NAME="MicroPythonDevice.canStartPlotter" ID="MicroPythonDevice.canStartPlotter"></a> 246 </dl>
247 <a NAME="MicroPythonDevice.canStartPlotter" ID="MicroPythonDevice.canStartPlotter"></a>
194 <h4>MicroPythonDevice.canStartPlotter</h4> 248 <h4>MicroPythonDevice.canStartPlotter</h4>
195 <b>canStartPlotter</b>(<i></i>) 249 <b>canStartPlotter</b>(<i></i>)
250
196 <p> 251 <p>
197 Public method to determine, if a Plotter can be started. 252 Public method to determine, if a Plotter can be started.
198 </p><dl> 253 </p>
254 <dl>
199 <dt>Returns:</dt> 255 <dt>Returns:</dt>
200 <dd> 256 <dd>
201 tuple containing a flag indicating it is safe to start a 257 tuple containing a flag indicating it is safe to start a
202 Plotter and a reason why it cannot. 258 Plotter and a reason why it cannot.
203 </dd> 259 </dd>
204 </dl><dl> 260 </dl>
261 <dl>
205 <dt>Return Type:</dt> 262 <dt>Return Type:</dt>
206 <dd> 263 <dd>
207 tuple of (bool, str) 264 tuple of (bool, str)
208 </dd> 265 </dd>
209 </dl><a NAME="MicroPythonDevice.canStartRepl" ID="MicroPythonDevice.canStartRepl"></a> 266 </dl>
267 <a NAME="MicroPythonDevice.canStartRepl" ID="MicroPythonDevice.canStartRepl"></a>
210 <h4>MicroPythonDevice.canStartRepl</h4> 268 <h4>MicroPythonDevice.canStartRepl</h4>
211 <b>canStartRepl</b>(<i></i>) 269 <b>canStartRepl</b>(<i></i>)
270
212 <p> 271 <p>
213 Public method to determine, if a REPL can be started. 272 Public method to determine, if a REPL can be started.
214 </p><dl> 273 </p>
274 <dl>
215 <dt>Returns:</dt> 275 <dt>Returns:</dt>
216 <dd> 276 <dd>
217 tuple containing a flag indicating it is safe to start a REPL 277 tuple containing a flag indicating it is safe to start a REPL
218 and a reason why it cannot. 278 and a reason why it cannot.
219 </dd> 279 </dd>
220 </dl><dl> 280 </dl>
281 <dl>
221 <dt>Return Type:</dt> 282 <dt>Return Type:</dt>
222 <dd> 283 <dd>
223 tuple of (bool, str) 284 tuple of (bool, str)
224 </dd> 285 </dd>
225 </dl><a NAME="MicroPythonDevice.deviceName" ID="MicroPythonDevice.deviceName"></a> 286 </dl>
287 <a NAME="MicroPythonDevice.deviceName" ID="MicroPythonDevice.deviceName"></a>
226 <h4>MicroPythonDevice.deviceName</h4> 288 <h4>MicroPythonDevice.deviceName</h4>
227 <b>deviceName</b>(<i></i>) 289 <b>deviceName</b>(<i></i>)
290
228 <p> 291 <p>
229 Public method to get the name of the device. 292 Public method to get the name of the device.
230 </p><dl> 293 </p>
294 <dl>
231 <dt>Returns:</dt> 295 <dt>Returns:</dt>
232 <dd> 296 <dd>
233 name of the device 297 name of the device
234 </dd> 298 </dd>
235 </dl><dl> 299 </dl>
300 <dl>
236 <dt>Return Type:</dt> 301 <dt>Return Type:</dt>
237 <dd> 302 <dd>
238 str 303 str
239 </dd> 304 </dd>
240 </dl><a NAME="MicroPythonDevice.forceInterrupt" ID="MicroPythonDevice.forceInterrupt"></a> 305 </dl>
306 <a NAME="MicroPythonDevice.forceInterrupt" ID="MicroPythonDevice.forceInterrupt"></a>
241 <h4>MicroPythonDevice.forceInterrupt</h4> 307 <h4>MicroPythonDevice.forceInterrupt</h4>
242 <b>forceInterrupt</b>(<i></i>) 308 <b>forceInterrupt</b>(<i></i>)
309
243 <p> 310 <p>
244 Public method to determine the need for an interrupt when opening the 311 Public method to determine the need for an interrupt when opening the
245 serial connection. 312 serial connection.
246 </p><dl> 313 </p>
314 <dl>
247 <dt>Returns:</dt> 315 <dt>Returns:</dt>
248 <dd> 316 <dd>
249 flag indicating an interrupt is needed 317 flag indicating an interrupt is needed
250 </dd> 318 </dd>
251 </dl><dl> 319 </dl>
320 <dl>
252 <dt>Return Type:</dt> 321 <dt>Return Type:</dt>
253 <dd> 322 <dd>
254 bool 323 bool
255 </dd> 324 </dd>
256 </dl><a NAME="MicroPythonDevice.getDocumentationUrl" ID="MicroPythonDevice.getDocumentationUrl"></a> 325 </dl>
326 <a NAME="MicroPythonDevice.getDocumentationUrl" ID="MicroPythonDevice.getDocumentationUrl"></a>
257 <h4>MicroPythonDevice.getDocumentationUrl</h4> 327 <h4>MicroPythonDevice.getDocumentationUrl</h4>
258 <b>getDocumentationUrl</b>(<i></i>) 328 <b>getDocumentationUrl</b>(<i></i>)
329
259 <p> 330 <p>
260 Public method to get the device documentation URL. 331 Public method to get the device documentation URL.
261 </p><dl> 332 </p>
333 <dl>
262 <dt>Returns:</dt> 334 <dt>Returns:</dt>
263 <dd> 335 <dd>
264 documentation URL of the device 336 documentation URL of the device
265 </dd> 337 </dd>
266 </dl><dl> 338 </dl>
339 <dl>
267 <dt>Return Type:</dt> 340 <dt>Return Type:</dt>
268 <dd> 341 <dd>
269 str 342 str
270 </dd> 343 </dd>
271 </dl><a NAME="MicroPythonDevice.getWorkspace" ID="MicroPythonDevice.getWorkspace"></a> 344 </dl>
345 <a NAME="MicroPythonDevice.getWorkspace" ID="MicroPythonDevice.getWorkspace"></a>
272 <h4>MicroPythonDevice.getWorkspace</h4> 346 <h4>MicroPythonDevice.getWorkspace</h4>
273 <b>getWorkspace</b>(<i></i>) 347 <b>getWorkspace</b>(<i></i>)
348
274 <p> 349 <p>
275 Public method to get the workspace directory. 350 Public method to get the workspace directory.
276 </p><dl> 351 </p>
352 <dl>
277 <dt>Returns:</dt> 353 <dt>Returns:</dt>
278 <dd> 354 <dd>
279 workspace directory used for saving files 355 workspace directory used for saving files
280 </dd> 356 </dd>
281 </dl><dl> 357 </dl>
358 <dl>
282 <dt>Return Type:</dt> 359 <dt>Return Type:</dt>
283 <dd> 360 <dd>
284 str 361 str
285 </dd> 362 </dd>
286 </dl><a NAME="MicroPythonDevice.handleDataFlood" ID="MicroPythonDevice.handleDataFlood"></a> 363 </dl>
364 <a NAME="MicroPythonDevice.handleDataFlood" ID="MicroPythonDevice.handleDataFlood"></a>
287 <h4>MicroPythonDevice.handleDataFlood</h4> 365 <h4>MicroPythonDevice.handleDataFlood</h4>
288 <b>handleDataFlood</b>(<i></i>) 366 <b>handleDataFlood</b>(<i></i>)
367
289 <p> 368 <p>
290 Public slot handling a data floof from the device. 369 Public slot handling a data floof from the device.
291 </p><a NAME="MicroPythonDevice.hasDocumentationUrl" ID="MicroPythonDevice.hasDocumentationUrl"></a> 370 </p>
371 <a NAME="MicroPythonDevice.hasDocumentationUrl" ID="MicroPythonDevice.hasDocumentationUrl"></a>
292 <h4>MicroPythonDevice.hasDocumentationUrl</h4> 372 <h4>MicroPythonDevice.hasDocumentationUrl</h4>
293 <b>hasDocumentationUrl</b>(<i></i>) 373 <b>hasDocumentationUrl</b>(<i></i>)
374
294 <p> 375 <p>
295 Public method to check, if the device has a configured documentation 376 Public method to check, if the device has a configured documentation
296 URL. 377 URL.
297 </p><dl> 378 </p>
379 <dl>
298 <dt>Returns:</dt> 380 <dt>Returns:</dt>
299 <dd> 381 <dd>
300 flag indicating a configured documentation URL 382 flag indicating a configured documentation URL
301 </dd> 383 </dd>
302 </dl><dl> 384 </dl>
385 <dl>
303 <dt>Return Type:</dt> 386 <dt>Return Type:</dt>
304 <dd> 387 <dd>
305 bool 388 bool
306 </dd> 389 </dd>
307 </dl><a NAME="MicroPythonDevice.hasTimeCommands" ID="MicroPythonDevice.hasTimeCommands"></a> 390 </dl>
391 <a NAME="MicroPythonDevice.hasTimeCommands" ID="MicroPythonDevice.hasTimeCommands"></a>
308 <h4>MicroPythonDevice.hasTimeCommands</h4> 392 <h4>MicroPythonDevice.hasTimeCommands</h4>
309 <b>hasTimeCommands</b>(<i></i>) 393 <b>hasTimeCommands</b>(<i></i>)
394
310 <p> 395 <p>
311 Public method to check, if the device supports time commands. 396 Public method to check, if the device supports time commands.
312 </p><p> 397 </p>
398 <p>
313 The default returns True. 399 The default returns True.
314 </p><dl> 400 </p>
401 <dl>
315 <dt>Returns:</dt> 402 <dt>Returns:</dt>
316 <dd> 403 <dd>
317 flag indicating support for time commands 404 flag indicating support for time commands
318 </dd> 405 </dd>
319 </dl><dl> 406 </dl>
407 <dl>
320 <dt>Return Type:</dt> 408 <dt>Return Type:</dt>
321 <dd> 409 <dd>
322 bool 410 bool
323 </dd> 411 </dd>
324 </dl><a NAME="MicroPythonDevice.runScript" ID="MicroPythonDevice.runScript"></a> 412 </dl>
413 <a NAME="MicroPythonDevice.runScript" ID="MicroPythonDevice.runScript"></a>
325 <h4>MicroPythonDevice.runScript</h4> 414 <h4>MicroPythonDevice.runScript</h4>
326 <b>runScript</b>(<i>script</i>) 415 <b>runScript</b>(<i>script</i>)
416
327 <p> 417 <p>
328 Public method to run the given Python script. 418 Public method to run the given Python script.
329 </p><dl> 419 </p>
420 <dl>
421
330 <dt><i>script</i> (str)</dt> 422 <dt><i>script</i> (str)</dt>
331 <dd> 423 <dd>
332 script to be executed 424 script to be executed
333 </dd> 425 </dd>
334 </dl><a NAME="MicroPythonDevice.sendCommands" ID="MicroPythonDevice.sendCommands"></a> 426 </dl>
427 <a NAME="MicroPythonDevice.sendCommands" ID="MicroPythonDevice.sendCommands"></a>
335 <h4>MicroPythonDevice.sendCommands</h4> 428 <h4>MicroPythonDevice.sendCommands</h4>
336 <b>sendCommands</b>(<i>commandsList</i>) 429 <b>sendCommands</b>(<i>commandsList</i>)
430
337 <p> 431 <p>
338 Public method to send a list of commands to the device. 432 Public method to send a list of commands to the device.
339 </p><dl> 433 </p>
434 <dl>
435
340 <dt><i>commandsList</i> (list of str)</dt> 436 <dt><i>commandsList</i> (list of str)</dt>
341 <dd> 437 <dd>
342 list of commands to be sent to the device 438 list of commands to be sent to the device
343 </dd> 439 </dd>
344 </dl><a NAME="MicroPythonDevice.setButtons" ID="MicroPythonDevice.setButtons"></a> 440 </dl>
441 <a NAME="MicroPythonDevice.setButtons" ID="MicroPythonDevice.setButtons"></a>
345 <h4>MicroPythonDevice.setButtons</h4> 442 <h4>MicroPythonDevice.setButtons</h4>
346 <b>setButtons</b>(<i></i>) 443 <b>setButtons</b>(<i></i>)
444
347 <p> 445 <p>
348 Public method to enable the supported action buttons. 446 Public method to enable the supported action buttons.
349 </p><a NAME="MicroPythonDevice.setFileManager" ID="MicroPythonDevice.setFileManager"></a> 447 </p>
448 <a NAME="MicroPythonDevice.setFileManager" ID="MicroPythonDevice.setFileManager"></a>
350 <h4>MicroPythonDevice.setFileManager</h4> 449 <h4>MicroPythonDevice.setFileManager</h4>
351 <b>setFileManager</b>(<i>on</i>) 450 <b>setFileManager</b>(<i>on</i>)
451
352 <p> 452 <p>
353 Public method to set the File Manager status and dependent status. 453 Public method to set the File Manager status and dependent status.
354 </p><dl> 454 </p>
455 <dl>
456
355 <dt><i>on</i> (bool)</dt> 457 <dt><i>on</i> (bool)</dt>
356 <dd> 458 <dd>
357 flag indicating the active status 459 flag indicating the active status
358 </dd> 460 </dd>
359 </dl><a NAME="MicroPythonDevice.setPlotter" ID="MicroPythonDevice.setPlotter"></a> 461 </dl>
462 <a NAME="MicroPythonDevice.setPlotter" ID="MicroPythonDevice.setPlotter"></a>
360 <h4>MicroPythonDevice.setPlotter</h4> 463 <h4>MicroPythonDevice.setPlotter</h4>
361 <b>setPlotter</b>(<i>on</i>) 464 <b>setPlotter</b>(<i>on</i>)
465
362 <p> 466 <p>
363 Public method to set the Plotter status and dependent status. 467 Public method to set the Plotter status and dependent status.
364 </p><dl> 468 </p>
469 <dl>
470
365 <dt><i>on</i> (bool)</dt> 471 <dt><i>on</i> (bool)</dt>
366 <dd> 472 <dd>
367 flag indicating the active status 473 flag indicating the active status
368 </dd> 474 </dd>
369 </dl><a NAME="MicroPythonDevice.setRepl" ID="MicroPythonDevice.setRepl"></a> 475 </dl>
476 <a NAME="MicroPythonDevice.setRepl" ID="MicroPythonDevice.setRepl"></a>
370 <h4>MicroPythonDevice.setRepl</h4> 477 <h4>MicroPythonDevice.setRepl</h4>
371 <b>setRepl</b>(<i>on</i>) 478 <b>setRepl</b>(<i>on</i>)
479
372 <p> 480 <p>
373 Public method to set the REPL status and dependent status. 481 Public method to set the REPL status and dependent status.
374 </p><dl> 482 </p>
483 <dl>
484
375 <dt><i>on</i> (bool)</dt> 485 <dt><i>on</i> (bool)</dt>
376 <dd> 486 <dd>
377 flag indicating the active status 487 flag indicating the active status
378 </dd> 488 </dd>
379 </dl><a NAME="MicroPythonDevice.supportsLocalFileAccess" ID="MicroPythonDevice.supportsLocalFileAccess"></a> 489 </dl>
490 <a NAME="MicroPythonDevice.supportsLocalFileAccess" ID="MicroPythonDevice.supportsLocalFileAccess"></a>
380 <h4>MicroPythonDevice.supportsLocalFileAccess</h4> 491 <h4>MicroPythonDevice.supportsLocalFileAccess</h4>
381 <b>supportsLocalFileAccess</b>(<i></i>) 492 <b>supportsLocalFileAccess</b>(<i></i>)
493
382 <p> 494 <p>
383 Public method to indicate file access via a local directory. 495 Public method to indicate file access via a local directory.
384 </p><dl> 496 </p>
497 <dl>
385 <dt>Returns:</dt> 498 <dt>Returns:</dt>
386 <dd> 499 <dd>
387 flag indicating file access via local directory 500 flag indicating file access via local directory
388 </dd> 501 </dd>
389 </dl><dl> 502 </dl>
503 <dl>
390 <dt>Return Type:</dt> 504 <dt>Return Type:</dt>
391 <dd> 505 <dd>
392 bool 506 bool
393 </dd> 507 </dd>
394 </dl> 508 </dl>
395 <div align="right"><a href="#top">Up</a></div> 509 <div align="right"><a href="#top">Up</a></div>
396 <hr /><hr /> 510 <hr />
511 <hr />
397 <a NAME="getDevice" ID="getDevice"></a> 512 <a NAME="getDevice" ID="getDevice"></a>
398 <h2>getDevice</h2> 513 <h2>getDevice</h2>
399 <b>getDevice</b>(<i>deviceType, microPythonWidget</i>) 514 <b>getDevice</b>(<i>deviceType, microPythonWidget</i>)
515
400 <p> 516 <p>
401 Public method to instantiate a specific MicroPython device interface. 517 Public method to instantiate a specific MicroPython device interface.
402 </p><dl> 518 </p>
519 <dl>
520
403 <dt><i>deviceType</i> (str)</dt> 521 <dt><i>deviceType</i> (str)</dt>
404 <dd> 522 <dd>
405 type of the device interface 523 type of the device interface
406 </dd><dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> 524 </dd>
525 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
407 <dd> 526 <dd>
408 reference to the main MicroPython widget 527 reference to the main MicroPython widget
409 </dd> 528 </dd>
410 </dl><dl> 529 </dl>
530 <dl>
411 <dt>Returns:</dt> 531 <dt>Returns:</dt>
412 <dd> 532 <dd>
413 instantiated device interface 533 instantiated device interface
414 </dd> 534 </dd>
415 </dl><dl> 535 </dl>
536 <dl>
416 <dt>Return Type:</dt> 537 <dt>Return Type:</dt>
417 <dd> 538 <dd>
418 MicroPythonDevice 539 MicroPythonDevice
419 </dd> 540 </dd>
420 </dl> 541 </dl>
421 <div align="right"><a href="#top">Up</a></div> 542 <div align="right"><a href="#top">Up</a></div>
422 <hr /><hr /> 543 <hr />
544 <hr />
423 <a NAME="getDeviceIcon" ID="getDeviceIcon"></a> 545 <a NAME="getDeviceIcon" ID="getDeviceIcon"></a>
424 <h2>getDeviceIcon</h2> 546 <h2>getDeviceIcon</h2>
425 <b>getDeviceIcon</b>(<i>boardName, iconFormat=True</i>) 547 <b>getDeviceIcon</b>(<i>boardName, iconFormat=True</i>)
548
426 <p> 549 <p>
427 Function to get the icon for the given board. 550 Function to get the icon for the given board.
428 </p><dl> 551 </p>
552 <dl>
553
429 <dt><i>boardName</i> (str)</dt> 554 <dt><i>boardName</i> (str)</dt>
430 <dd> 555 <dd>
431 name of the board 556 name of the board
432 </dd><dt><i>iconFormat</i> (bool)</dt> 557 </dd>
558 <dt><i>iconFormat</i> (bool)</dt>
433 <dd> 559 <dd>
434 flag indicating to get an icon or a pixmap 560 flag indicating to get an icon or a pixmap
435 </dd> 561 </dd>
436 </dl><dl> 562 </dl>
563 <dl>
437 <dt>Returns:</dt> 564 <dt>Returns:</dt>
438 <dd> 565 <dd>
439 icon for the board (iconFormat == True) or 566 icon for the board (iconFormat == True) or
440 a pixmap (iconFormat == False) 567 a pixmap (iconFormat == False)
441 </dd> 568 </dd>
442 </dl><dl> 569 </dl>
570 <dl>
443 <dt>Return Type:</dt> 571 <dt>Return Type:</dt>
444 <dd> 572 <dd>
445 QIcon or QPixmap 573 QIcon or QPixmap
446 </dd> 574 </dd>
447 </dl> 575 </dl>
448 <div align="right"><a href="#top">Up</a></div> 576 <div align="right"><a href="#top">Up</a></div>
449 <hr /><hr /> 577 <hr />
578 <hr />
450 <a NAME="getFoundDevices" ID="getFoundDevices"></a> 579 <a NAME="getFoundDevices" ID="getFoundDevices"></a>
451 <h2>getFoundDevices</h2> 580 <h2>getFoundDevices</h2>
452 <b>getFoundDevices</b>(<i></i>) 581 <b>getFoundDevices</b>(<i></i>)
582
453 <p> 583 <p>
454 Function to check the serial ports for supported MicroPython devices. 584 Function to check the serial ports for supported MicroPython devices.
455 </p><dl> 585 </p>
586 <dl>
456 <dt>Returns:</dt> 587 <dt>Returns:</dt>
457 <dd> 588 <dd>
458 set of tuples with the board type, a description and the serial 589 set of tuples with the board type, a description and the serial
459 port it is connected at 590 port it is connected at
460 </dd> 591 </dd>
461 </dl><dl> 592 </dl>
593 <dl>
462 <dt>Return Type:</dt> 594 <dt>Return Type:</dt>
463 <dd> 595 <dd>
464 set of tuples of (str, str, str) 596 set of tuples of (str, str, str)
465 </dd> 597 </dd>
466 </dl> 598 </dl>
467 <div align="right"><a href="#top">Up</a></div> 599 <div align="right"><a href="#top">Up</a></div>
468 <hr /><hr /> 600 <hr />
601 <hr />
469 <a NAME="getSupportedDevices" ID="getSupportedDevices"></a> 602 <a NAME="getSupportedDevices" ID="getSupportedDevices"></a>
470 <h2>getSupportedDevices</h2> 603 <h2>getSupportedDevices</h2>
471 <b>getSupportedDevices</b>(<i></i>) 604 <b>getSupportedDevices</b>(<i></i>)
605
472 <p> 606 <p>
473 Function to get a list of supported MicroPython devices. 607 Function to get a list of supported MicroPython devices.
474 </p><dl> 608 </p>
609 <dl>
475 <dt>Returns:</dt> 610 <dt>Returns:</dt>
476 <dd> 611 <dd>
477 set of tuples with the board type and description 612 set of tuples with the board type and description
478 </dd> 613 </dd>
479 </dl><dl> 614 </dl>
615 <dl>
480 <dt>Return Type:</dt> 616 <dt>Return Type:</dt>
481 <dd> 617 <dd>
482 set of tuples of (str, str) 618 set of tuples of (str, str)
483 </dd> 619 </dd>
484 </dl> 620 </dl>

Mercurial Repository: eric

eric ide

mercurial