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

changeset 7989
a21d673a8f99
parent 7796
657532a9a0a4
child 8039
13fed1ed06e8
equal deleted inserted replaced
7988:c4c17121eff8 7989:a21d673a8f99
218 218
219 <p> 219 <p>
220 Public method to determine, if a script can be executed. 220 Public method to determine, if a script can be executed.
221 </p> 221 </p>
222 <dl> 222 <dl>
223 <dt>Returns:</dt> 223 <dt>Return:</dt>
224 <dd> 224 <dd>
225 tuple containing a flag indicating it is safe to start a 225 tuple containing a flag indicating it is safe to start a
226 Plotter and a reason why it cannot. 226 Plotter and a reason why it cannot.
227 </dd> 227 </dd>
228 </dl> 228 </dl>
238 238
239 <p> 239 <p>
240 Public method to determine, if a File Manager can be started. 240 Public method to determine, if a File Manager can be started.
241 </p> 241 </p>
242 <dl> 242 <dl>
243 <dt>Returns:</dt> 243 <dt>Return:</dt>
244 <dd> 244 <dd>
245 tuple containing a flag indicating it is safe to start a 245 tuple containing a flag indicating it is safe to start a
246 File Manager and a reason why it cannot. 246 File Manager and a reason why it cannot.
247 </dd> 247 </dd>
248 </dl> 248 </dl>
258 258
259 <p> 259 <p>
260 Public method to determine, if a Plotter can be started. 260 Public method to determine, if a Plotter can be started.
261 </p> 261 </p>
262 <dl> 262 <dl>
263 <dt>Returns:</dt> 263 <dt>Return:</dt>
264 <dd> 264 <dd>
265 tuple containing a flag indicating it is safe to start a 265 tuple containing a flag indicating it is safe to start a
266 Plotter and a reason why it cannot. 266 Plotter and a reason why it cannot.
267 </dd> 267 </dd>
268 </dl> 268 </dl>
278 278
279 <p> 279 <p>
280 Public method to determine, if a REPL can be started. 280 Public method to determine, if a REPL can be started.
281 </p> 281 </p>
282 <dl> 282 <dl>
283 <dt>Returns:</dt> 283 <dt>Return:</dt>
284 <dd> 284 <dd>
285 tuple containing a flag indicating it is safe to start a REPL 285 tuple containing a flag indicating it is safe to start a REPL
286 and a reason why it cannot. 286 and a reason why it cannot.
287 </dd> 287 </dd>
288 </dl> 288 </dl>
298 298
299 <p> 299 <p>
300 Public method to get the name of the device. 300 Public method to get the name of the device.
301 </p> 301 </p>
302 <dl> 302 <dl>
303 <dt>Returns:</dt> 303 <dt>Return:</dt>
304 <dd> 304 <dd>
305 name of the device 305 name of the device
306 </dd> 306 </dd>
307 </dl> 307 </dl>
308 <dl> 308 <dl>
318 <p> 318 <p>
319 Public method to determine the need for an interrupt when opening the 319 Public method to determine the need for an interrupt when opening the
320 serial connection. 320 serial connection.
321 </p> 321 </p>
322 <dl> 322 <dl>
323 <dt>Returns:</dt> 323 <dt>Return:</dt>
324 <dd> 324 <dd>
325 flag indicating an interrupt is needed 325 flag indicating an interrupt is needed
326 </dd> 326 </dd>
327 </dl> 327 </dl>
328 <dl> 328 <dl>
337 337
338 <p> 338 <p>
339 Public method to get the device documentation URL. 339 Public method to get the device documentation URL.
340 </p> 340 </p>
341 <dl> 341 <dl>
342 <dt>Returns:</dt> 342 <dt>Return:</dt>
343 <dd> 343 <dd>
344 documentation URL of the device 344 documentation URL of the device
345 </dd> 345 </dd>
346 </dl> 346 </dl>
347 <dl> 347 <dl>
356 356
357 <p> 357 <p>
358 Public method to get the device firmware download URL. 358 Public method to get the device firmware download URL.
359 </p> 359 </p>
360 <dl> 360 <dl>
361 <dt>Returns:</dt> 361 <dt>Return:</dt>
362 <dd> 362 <dd>
363 firmware download URL of the device 363 firmware download URL of the device
364 </dd> 364 </dd>
365 </dl> 365 </dl>
366 <dl> 366 <dl>
375 375
376 <p> 376 <p>
377 Public method to get the workspace directory. 377 Public method to get the workspace directory.
378 </p> 378 </p>
379 <dl> 379 <dl>
380 <dt>Returns:</dt> 380 <dt>Return:</dt>
381 <dd> 381 <dd>
382 workspace directory used for saving files 382 workspace directory used for saving files
383 </dd> 383 </dd>
384 </dl> 384 </dl>
385 <dl> 385 <dl>
402 <p> 402 <p>
403 Public method to check, if the device has a configured documentation 403 Public method to check, if the device has a configured documentation
404 URL. 404 URL.
405 </p> 405 </p>
406 <dl> 406 <dl>
407 <dt>Returns:</dt> 407 <dt>Return:</dt>
408 <dd> 408 <dd>
409 flag indicating a configured documentation URL 409 flag indicating a configured documentation URL
410 </dd> 410 </dd>
411 </dl> 411 </dl>
412 <dl> 412 <dl>
422 <p> 422 <p>
423 Public method to check, if the device has a configured firmware 423 Public method to check, if the device has a configured firmware
424 download URL. 424 download URL.
425 </p> 425 </p>
426 <dl> 426 <dl>
427 <dt>Returns:</dt> 427 <dt>Return:</dt>
428 <dd> 428 <dd>
429 flag indicating a configured firmware download URL 429 flag indicating a configured firmware download URL
430 </dd> 430 </dd>
431 </dl> 431 </dl>
432 <dl> 432 <dl>
444 </p> 444 </p>
445 <p> 445 <p>
446 The default returns True. 446 The default returns True.
447 </p> 447 </p>
448 <dl> 448 <dl>
449 <dt>Returns:</dt> 449 <dt>Return:</dt>
450 <dd> 450 <dd>
451 flag indicating support for time commands 451 flag indicating support for time commands
452 </dd> 452 </dd>
453 </dl> 453 </dl>
454 <dl> 454 <dl>
540 540
541 <p> 541 <p>
542 Public method to indicate file access via a local directory. 542 Public method to indicate file access via a local directory.
543 </p> 543 </p>
544 <dl> 544 <dl>
545 <dt>Returns:</dt> 545 <dt>Return:</dt>
546 <dd> 546 <dd>
547 flag indicating file access via local directory 547 flag indicating file access via local directory
548 </dd> 548 </dd>
549 </dl> 549 </dl>
550 <dl> 550 <dl>
573 <dd> 573 <dd>
574 reference to the main MicroPython widget 574 reference to the main MicroPython widget
575 </dd> 575 </dd>
576 </dl> 576 </dl>
577 <dl> 577 <dl>
578 <dt>Returns:</dt> 578 <dt>Return:</dt>
579 <dd> 579 <dd>
580 instantiated device interface 580 instantiated device interface
581 </dd> 581 </dd>
582 </dl> 582 </dl>
583 <dl> 583 <dl>
606 <dd> 606 <dd>
607 flag indicating to get an icon or a pixmap 607 flag indicating to get an icon or a pixmap
608 </dd> 608 </dd>
609 </dl> 609 </dl>
610 <dl> 610 <dl>
611 <dt>Returns:</dt> 611 <dt>Return:</dt>
612 <dd> 612 <dd>
613 icon for the board (iconFormat == True) or 613 icon for the board (iconFormat == True) or
614 a pixmap (iconFormat == False) 614 a pixmap (iconFormat == False)
615 </dd> 615 </dd>
616 </dl> 616 </dl>
629 629
630 <p> 630 <p>
631 Function to check the serial ports for supported MicroPython devices. 631 Function to check the serial ports for supported MicroPython devices.
632 </p> 632 </p>
633 <dl> 633 <dl>
634 <dt>Returns:</dt> 634 <dt>Return:</dt>
635 <dd> 635 <dd>
636 tuple containing a list of tuples with the board type, a 636 tuple containing a list of tuples with the board type, a
637 description and the serial port it is connected at for known device 637 description and the serial port it is connected at for known device
638 types and a list of tuples with VID, PID and description for unknown 638 types and a list of tuples with VID, PID and description for unknown
639 devices 639 devices
655 655
656 <p> 656 <p>
657 Function to get a list of supported MicroPython devices. 657 Function to get a list of supported MicroPython devices.
658 </p> 658 </p>
659 <dl> 659 <dl>
660 <dt>Returns:</dt> 660 <dt>Return:</dt>
661 <dd> 661 <dd>
662 set of tuples with the board type and description 662 set of tuples with the board type and description
663 </dd> 663 </dd>
664 </dl> 664 </dl>
665 <dl> 665 <dl>

eric ide

mercurial