Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.MicroPython.MicroPythonDevices.html
eric7/Documentation/Source/eric7.MicroPython.MicroPythonDevices.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.MicroPython.MicroPythonDevices</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.MicroPython.MicroPythonDevices</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing some utility functions and the MicroPythonDevice base | |
| 27 class. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>IgnoredBoards</td></tr><tr><td>SupportedBoards</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#MicroPythonDevice">MicroPythonDevice</a></td> | |
| 40 <td>Base class for the more specific MicroPython devices.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 | |
| 47 <tr> | |
| 48 <td><a href="#getDevice">getDevice</a></td> | |
| 49 <td>Public method to instantiate a specific MicroPython device interface.</td> | |
| 50 </tr> | |
| 51 <tr> | |
| 52 <td><a href="#getDeviceIcon">getDeviceIcon</a></td> | |
| 53 <td>Function to get the icon for the given board.</td> | |
| 54 </tr> | |
| 55 <tr> | |
| 56 <td><a href="#getFoundDevices">getFoundDevices</a></td> | |
| 57 <td>Function to check the serial ports for supported MicroPython devices.</td> | |
| 58 </tr> | |
| 59 <tr> | |
| 60 <td><a href="#getSupportedDevices">getSupportedDevices</a></td> | |
| 61 <td>Function to get a list of supported MicroPython devices.</td> | |
| 62 </tr> | |
| 63 </table> | |
| 64 <hr /> | |
| 65 <hr /> | |
| 66 <a NAME="MicroPythonDevice" ID="MicroPythonDevice"></a> | |
| 67 <h2>MicroPythonDevice</h2> | |
| 68 | |
| 69 <p> | |
| 70 Base class for the more specific MicroPython devices. | |
| 71 </p> | |
| 72 <h3>Derived from</h3> | |
| 73 QObject | |
| 74 <h3>Class Attributes</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 <h3>Class Methods</h3> | |
| 80 | |
| 81 <table> | |
| 82 <tr><td>None</td></tr> | |
| 83 </table> | |
| 84 <h3>Methods</h3> | |
| 85 | |
| 86 <table> | |
| 87 | |
| 88 <tr> | |
| 89 <td><a href="#MicroPythonDevice.__init__">MicroPythonDevice</a></td> | |
| 90 <td>Constructor</td> | |
| 91 </tr> | |
| 92 <tr> | |
| 93 <td><a href="#MicroPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> | |
| 94 <td>Public method to add device specific entries to the given menu.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#MicroPythonDevice.canRunScript">canRunScript</a></td> | |
| 98 <td>Public method to determine, if a script can be executed.</td> | |
| 99 </tr> | |
| 100 <tr> | |
| 101 <td><a href="#MicroPythonDevice.canStartFileManager">canStartFileManager</a></td> | |
| 102 <td>Public method to determine, if a File Manager can be started.</td> | |
| 103 </tr> | |
| 104 <tr> | |
| 105 <td><a href="#MicroPythonDevice.canStartPlotter">canStartPlotter</a></td> | |
| 106 <td>Public method to determine, if a Plotter can be started.</td> | |
| 107 </tr> | |
| 108 <tr> | |
| 109 <td><a href="#MicroPythonDevice.canStartRepl">canStartRepl</a></td> | |
| 110 <td>Public method to determine, if a REPL can be started.</td> | |
| 111 </tr> | |
| 112 <tr> | |
| 113 <td><a href="#MicroPythonDevice.deviceName">deviceName</a></td> | |
| 114 <td>Public method to get the name of the device.</td> | |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#MicroPythonDevice.downloadFirmware">downloadFirmware</a></td> | |
| 118 <td>Public method to download the device firmware.</td> | |
| 119 </tr> | |
| 120 <tr> | |
| 121 <td><a href="#MicroPythonDevice.forceInterrupt">forceInterrupt</a></td> | |
| 122 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | |
| 123 </tr> | |
| 124 <tr> | |
| 125 <td><a href="#MicroPythonDevice.getDeviceType">getDeviceType</a></td> | |
| 126 <td>Public method to get the device type.</td> | |
| 127 </tr> | |
| 128 <tr> | |
| 129 <td><a href="#MicroPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> | |
| 130 <td>Public method to get the device documentation URL.</td> | |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#MicroPythonDevice.getDownloadMenuEntries">getDownloadMenuEntries</a></td> | |
| 134 <td>Public method to retrieve the entries for the downloads menu.</td> | |
| 135 </tr> | |
| 136 <tr> | |
| 137 <td><a href="#MicroPythonDevice.getFirmwareUrl">getFirmwareUrl</a></td> | |
| 138 <td>Public method to get the device firmware download URL.</td> | |
| 139 </tr> | |
| 140 <tr> | |
| 141 <td><a href="#MicroPythonDevice.getWorkspace">getWorkspace</a></td> | |
| 142 <td>Public method to get the workspace directory.</td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td><a href="#MicroPythonDevice.handleDataFlood">handleDataFlood</a></td> | |
| 146 <td>Public slot handling a data floof from the device.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 149 <td><a href="#MicroPythonDevice.hasDocumentationUrl">hasDocumentationUrl</a></td> | |
| 150 <td>Public method to check, if the device has a configured documentation URL.</td> | |
| 151 </tr> | |
| 152 <tr> | |
| 153 <td><a href="#MicroPythonDevice.hasFirmwareUrl">hasFirmwareUrl</a></td> | |
| 154 <td>Public method to check, if the device has a configured firmware download URL.</td> | |
| 155 </tr> | |
| 156 <tr> | |
| 157 <td><a href="#MicroPythonDevice.hasFlashMenuEntry">hasFlashMenuEntry</a></td> | |
| 158 <td>Public method to check, if the device has its own flash menu entry.</td> | |
| 159 </tr> | |
| 160 <tr> | |
| 161 <td><a href="#MicroPythonDevice.hasTimeCommands">hasTimeCommands</a></td> | |
| 162 <td>Public method to check, if the device supports time commands.</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#MicroPythonDevice.runScript">runScript</a></td> | |
| 166 <td>Public method to run the given Python script.</td> | |
| 167 </tr> | |
| 168 <tr> | |
| 169 <td><a href="#MicroPythonDevice.selectDeviceDirectory">selectDeviceDirectory</a></td> | |
| 170 <td>Public method to select the device directory from a list of detected ones.</td> | |
| 171 </tr> | |
| 172 <tr> | |
| 173 <td><a href="#MicroPythonDevice.sendCommands">sendCommands</a></td> | |
| 174 <td>Public method to send a list of commands to the device.</td> | |
| 175 </tr> | |
| 176 <tr> | |
| 177 <td><a href="#MicroPythonDevice.setButtons">setButtons</a></td> | |
| 178 <td>Public method to enable the supported action buttons.</td> | |
| 179 </tr> | |
| 180 <tr> | |
| 181 <td><a href="#MicroPythonDevice.setFileManager">setFileManager</a></td> | |
| 182 <td>Public method to set the File Manager status and dependent status.</td> | |
| 183 </tr> | |
| 184 <tr> | |
| 185 <td><a href="#MicroPythonDevice.setPlotter">setPlotter</a></td> | |
| 186 <td>Public method to set the Plotter status and dependent status.</td> | |
| 187 </tr> | |
| 188 <tr> | |
| 189 <td><a href="#MicroPythonDevice.setRepl">setRepl</a></td> | |
| 190 <td>Public method to set the REPL status and dependent status.</td> | |
| 191 </tr> | |
| 192 <tr> | |
| 193 <td><a href="#MicroPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> | |
| 194 <td>Public method to indicate file access via a local directory.</td> | |
| 195 </tr> | |
| 196 </table> | |
| 197 <h3>Static Methods</h3> | |
| 198 | |
| 199 <table> | |
| 200 <tr><td>None</td></tr> | |
| 201 </table> | |
| 202 | |
| 203 <a NAME="MicroPythonDevice.__init__" ID="MicroPythonDevice.__init__"></a> | |
| 204 <h4>MicroPythonDevice (Constructor)</h4> | |
| 205 <b>MicroPythonDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>) | |
| 206 | |
| 207 <p> | |
| 208 Constructor | |
| 209 </p> | |
| 210 <dl> | |
| 211 | |
| 212 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> | |
| 213 <dd> | |
| 214 reference to the main MicroPython widget | |
| 215 </dd> | |
| 216 <dt><i>deviceType</i> (str)</dt> | |
| 217 <dd> | |
| 218 device type assigned to this device interface | |
| 219 </dd> | |
| 220 <dt><i>parent</i> (QObject)</dt> | |
| 221 <dd> | |
| 222 reference to the parent object | |
| 223 </dd> | |
| 224 </dl> | |
| 225 <a NAME="MicroPythonDevice.addDeviceMenuEntries" ID="MicroPythonDevice.addDeviceMenuEntries"></a> | |
| 226 <h4>MicroPythonDevice.addDeviceMenuEntries</h4> | |
| 227 <b>addDeviceMenuEntries</b>(<i>menu</i>) | |
| 228 | |
| 229 <p> | |
| 230 Public method to add device specific entries to the given menu. | |
| 231 </p> | |
| 232 <dl> | |
| 233 | |
| 234 <dt><i>menu</i> (QMenu)</dt> | |
| 235 <dd> | |
| 236 reference to the context menu | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <a NAME="MicroPythonDevice.canRunScript" ID="MicroPythonDevice.canRunScript"></a> | |
| 240 <h4>MicroPythonDevice.canRunScript</h4> | |
| 241 <b>canRunScript</b>(<i></i>) | |
| 242 | |
| 243 <p> | |
| 244 Public method to determine, if a script can be executed. | |
| 245 </p> | |
| 246 <dl> | |
| 247 <dt>Return:</dt> | |
| 248 <dd> | |
| 249 tuple containing a flag indicating it is safe to start a | |
| 250 Plotter and a reason why it cannot. | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <dl> | |
| 254 <dt>Return Type:</dt> | |
| 255 <dd> | |
| 256 tuple of (bool, str) | |
| 257 </dd> | |
| 258 </dl> | |
| 259 <a NAME="MicroPythonDevice.canStartFileManager" ID="MicroPythonDevice.canStartFileManager"></a> | |
| 260 <h4>MicroPythonDevice.canStartFileManager</h4> | |
| 261 <b>canStartFileManager</b>(<i></i>) | |
| 262 | |
| 263 <p> | |
| 264 Public method to determine, if a File Manager can be started. | |
| 265 </p> | |
| 266 <dl> | |
| 267 <dt>Return:</dt> | |
| 268 <dd> | |
| 269 tuple containing a flag indicating it is safe to start a | |
| 270 File Manager and a reason why it cannot. | |
| 271 </dd> | |
| 272 </dl> | |
| 273 <dl> | |
| 274 <dt>Return Type:</dt> | |
| 275 <dd> | |
| 276 tuple of (bool, str) | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <a NAME="MicroPythonDevice.canStartPlotter" ID="MicroPythonDevice.canStartPlotter"></a> | |
| 280 <h4>MicroPythonDevice.canStartPlotter</h4> | |
| 281 <b>canStartPlotter</b>(<i></i>) | |
| 282 | |
| 283 <p> | |
| 284 Public method to determine, if a Plotter can be started. | |
| 285 </p> | |
| 286 <dl> | |
| 287 <dt>Return:</dt> | |
| 288 <dd> | |
| 289 tuple containing a flag indicating it is safe to start a | |
| 290 Plotter and a reason why it cannot. | |
| 291 </dd> | |
| 292 </dl> | |
| 293 <dl> | |
| 294 <dt>Return Type:</dt> | |
| 295 <dd> | |
| 296 tuple of (bool, str) | |
| 297 </dd> | |
| 298 </dl> | |
| 299 <a NAME="MicroPythonDevice.canStartRepl" ID="MicroPythonDevice.canStartRepl"></a> | |
| 300 <h4>MicroPythonDevice.canStartRepl</h4> | |
| 301 <b>canStartRepl</b>(<i></i>) | |
| 302 | |
| 303 <p> | |
| 304 Public method to determine, if a REPL can be started. | |
| 305 </p> | |
| 306 <dl> | |
| 307 <dt>Return:</dt> | |
| 308 <dd> | |
| 309 tuple containing a flag indicating it is safe to start a REPL | |
| 310 and a reason why it cannot. | |
| 311 </dd> | |
| 312 </dl> | |
| 313 <dl> | |
| 314 <dt>Return Type:</dt> | |
| 315 <dd> | |
| 316 tuple of (bool, str) | |
| 317 </dd> | |
| 318 </dl> | |
| 319 <a NAME="MicroPythonDevice.deviceName" ID="MicroPythonDevice.deviceName"></a> | |
| 320 <h4>MicroPythonDevice.deviceName</h4> | |
| 321 <b>deviceName</b>(<i></i>) | |
| 322 | |
| 323 <p> | |
| 324 Public method to get the name of the device. | |
| 325 </p> | |
| 326 <dl> | |
| 327 <dt>Return:</dt> | |
| 328 <dd> | |
| 329 name of the device | |
| 330 </dd> | |
| 331 </dl> | |
| 332 <dl> | |
| 333 <dt>Return Type:</dt> | |
| 334 <dd> | |
| 335 str | |
| 336 </dd> | |
| 337 </dl> | |
| 338 <a NAME="MicroPythonDevice.downloadFirmware" ID="MicroPythonDevice.downloadFirmware"></a> | |
| 339 <h4>MicroPythonDevice.downloadFirmware</h4> | |
| 340 <b>downloadFirmware</b>(<i></i>) | |
| 341 | |
| 342 <p> | |
| 343 Public method to download the device firmware. | |
| 344 </p> | |
| 345 <a NAME="MicroPythonDevice.forceInterrupt" ID="MicroPythonDevice.forceInterrupt"></a> | |
| 346 <h4>MicroPythonDevice.forceInterrupt</h4> | |
| 347 <b>forceInterrupt</b>(<i></i>) | |
| 348 | |
| 349 <p> | |
| 350 Public method to determine the need for an interrupt when opening the | |
| 351 serial connection. | |
| 352 </p> | |
| 353 <dl> | |
| 354 <dt>Return:</dt> | |
| 355 <dd> | |
| 356 flag indicating an interrupt is needed | |
| 357 </dd> | |
| 358 </dl> | |
| 359 <dl> | |
| 360 <dt>Return Type:</dt> | |
| 361 <dd> | |
| 362 bool | |
| 363 </dd> | |
| 364 </dl> | |
| 365 <a NAME="MicroPythonDevice.getDeviceType" ID="MicroPythonDevice.getDeviceType"></a> | |
| 366 <h4>MicroPythonDevice.getDeviceType</h4> | |
| 367 <b>getDeviceType</b>(<i></i>) | |
| 368 | |
| 369 <p> | |
| 370 Public method to get the device type. | |
| 371 </p> | |
| 372 <dl> | |
| 373 <dt>Return:</dt> | |
| 374 <dd> | |
| 375 type of the device | |
| 376 </dd> | |
| 377 </dl> | |
| 378 <dl> | |
| 379 <dt>Return Type:</dt> | |
| 380 <dd> | |
| 381 str | |
| 382 </dd> | |
| 383 </dl> | |
| 384 <a NAME="MicroPythonDevice.getDocumentationUrl" ID="MicroPythonDevice.getDocumentationUrl"></a> | |
| 385 <h4>MicroPythonDevice.getDocumentationUrl</h4> | |
| 386 <b>getDocumentationUrl</b>(<i></i>) | |
| 387 | |
| 388 <p> | |
| 389 Public method to get the device documentation URL. | |
| 390 </p> | |
| 391 <dl> | |
| 392 <dt>Return:</dt> | |
| 393 <dd> | |
| 394 documentation URL of the device | |
| 395 </dd> | |
| 396 </dl> | |
| 397 <dl> | |
| 398 <dt>Return Type:</dt> | |
| 399 <dd> | |
| 400 str | |
| 401 </dd> | |
| 402 </dl> | |
| 403 <a NAME="MicroPythonDevice.getDownloadMenuEntries" ID="MicroPythonDevice.getDownloadMenuEntries"></a> | |
| 404 <h4>MicroPythonDevice.getDownloadMenuEntries</h4> | |
| 405 <b>getDownloadMenuEntries</b>(<i></i>) | |
| 406 | |
| 407 <p> | |
| 408 Public method to retrieve the entries for the downloads menu. | |
| 409 </p> | |
| 410 <dl> | |
| 411 <dt>Return:</dt> | |
| 412 <dd> | |
| 413 list of tuples with menu text and URL to be opened for each | |
| 414 entry | |
| 415 </dd> | |
| 416 </dl> | |
| 417 <dl> | |
| 418 <dt>Return Type:</dt> | |
| 419 <dd> | |
| 420 list of tuple of (str, str) | |
| 421 </dd> | |
| 422 </dl> | |
| 423 <a NAME="MicroPythonDevice.getFirmwareUrl" ID="MicroPythonDevice.getFirmwareUrl"></a> | |
| 424 <h4>MicroPythonDevice.getFirmwareUrl</h4> | |
| 425 <b>getFirmwareUrl</b>(<i></i>) | |
| 426 | |
| 427 <p> | |
| 428 Public method to get the device firmware download URL. | |
| 429 </p> | |
| 430 <dl> | |
| 431 <dt>Return:</dt> | |
| 432 <dd> | |
| 433 firmware download URL of the device | |
| 434 </dd> | |
| 435 </dl> | |
| 436 <dl> | |
| 437 <dt>Return Type:</dt> | |
| 438 <dd> | |
| 439 str | |
| 440 </dd> | |
| 441 </dl> | |
| 442 <a NAME="MicroPythonDevice.getWorkspace" ID="MicroPythonDevice.getWorkspace"></a> | |
| 443 <h4>MicroPythonDevice.getWorkspace</h4> | |
| 444 <b>getWorkspace</b>(<i></i>) | |
| 445 | |
| 446 <p> | |
| 447 Public method to get the workspace directory. | |
| 448 </p> | |
| 449 <dl> | |
| 450 <dt>Return:</dt> | |
| 451 <dd> | |
| 452 workspace directory used for saving files | |
| 453 </dd> | |
| 454 </dl> | |
| 455 <dl> | |
| 456 <dt>Return Type:</dt> | |
| 457 <dd> | |
| 458 str | |
| 459 </dd> | |
| 460 </dl> | |
| 461 <a NAME="MicroPythonDevice.handleDataFlood" ID="MicroPythonDevice.handleDataFlood"></a> | |
| 462 <h4>MicroPythonDevice.handleDataFlood</h4> | |
| 463 <b>handleDataFlood</b>(<i></i>) | |
| 464 | |
| 465 <p> | |
| 466 Public slot handling a data floof from the device. | |
| 467 </p> | |
| 468 <a NAME="MicroPythonDevice.hasDocumentationUrl" ID="MicroPythonDevice.hasDocumentationUrl"></a> | |
| 469 <h4>MicroPythonDevice.hasDocumentationUrl</h4> | |
| 470 <b>hasDocumentationUrl</b>(<i></i>) | |
| 471 | |
| 472 <p> | |
| 473 Public method to check, if the device has a configured documentation | |
| 474 URL. | |
| 475 </p> | |
| 476 <dl> | |
| 477 <dt>Return:</dt> | |
| 478 <dd> | |
| 479 flag indicating a configured documentation URL | |
| 480 </dd> | |
| 481 </dl> | |
| 482 <dl> | |
| 483 <dt>Return Type:</dt> | |
| 484 <dd> | |
| 485 bool | |
| 486 </dd> | |
| 487 </dl> | |
| 488 <a NAME="MicroPythonDevice.hasFirmwareUrl" ID="MicroPythonDevice.hasFirmwareUrl"></a> | |
| 489 <h4>MicroPythonDevice.hasFirmwareUrl</h4> | |
| 490 <b>hasFirmwareUrl</b>(<i></i>) | |
| 491 | |
| 492 <p> | |
| 493 Public method to check, if the device has a configured firmware | |
| 494 download URL. | |
| 495 </p> | |
| 496 <dl> | |
| 497 <dt>Return:</dt> | |
| 498 <dd> | |
| 499 flag indicating a configured firmware download URL | |
| 500 </dd> | |
| 501 </dl> | |
| 502 <dl> | |
| 503 <dt>Return Type:</dt> | |
| 504 <dd> | |
| 505 bool | |
| 506 </dd> | |
| 507 </dl> | |
| 508 <a NAME="MicroPythonDevice.hasFlashMenuEntry" ID="MicroPythonDevice.hasFlashMenuEntry"></a> | |
| 509 <h4>MicroPythonDevice.hasFlashMenuEntry</h4> | |
| 510 <b>hasFlashMenuEntry</b>(<i></i>) | |
| 511 | |
| 512 <p> | |
| 513 Public method to check, if the device has its own flash menu entry. | |
| 514 </p> | |
| 515 <dl> | |
| 516 <dt>Return:</dt> | |
| 517 <dd> | |
| 518 flag indicating a specific flash menu entry | |
| 519 </dd> | |
| 520 </dl> | |
| 521 <dl> | |
| 522 <dt>Return Type:</dt> | |
| 523 <dd> | |
| 524 bool | |
| 525 </dd> | |
| 526 </dl> | |
| 527 <a NAME="MicroPythonDevice.hasTimeCommands" ID="MicroPythonDevice.hasTimeCommands"></a> | |
| 528 <h4>MicroPythonDevice.hasTimeCommands</h4> | |
| 529 <b>hasTimeCommands</b>(<i></i>) | |
| 530 | |
| 531 <p> | |
| 532 Public method to check, if the device supports time commands. | |
| 533 </p> | |
| 534 <p> | |
| 535 The default returns True. | |
| 536 </p> | |
| 537 <dl> | |
| 538 <dt>Return:</dt> | |
| 539 <dd> | |
| 540 flag indicating support for time commands | |
| 541 </dd> | |
| 542 </dl> | |
| 543 <dl> | |
| 544 <dt>Return Type:</dt> | |
| 545 <dd> | |
| 546 bool | |
| 547 </dd> | |
| 548 </dl> | |
| 549 <a NAME="MicroPythonDevice.runScript" ID="MicroPythonDevice.runScript"></a> | |
| 550 <h4>MicroPythonDevice.runScript</h4> | |
| 551 <b>runScript</b>(<i>script</i>) | |
| 552 | |
| 553 <p> | |
| 554 Public method to run the given Python script. | |
| 555 </p> | |
| 556 <dl> | |
| 557 | |
| 558 <dt><i>script</i> (str)</dt> | |
| 559 <dd> | |
| 560 script to be executed | |
| 561 </dd> | |
| 562 </dl> | |
| 563 <a NAME="MicroPythonDevice.selectDeviceDirectory" ID="MicroPythonDevice.selectDeviceDirectory"></a> | |
| 564 <h4>MicroPythonDevice.selectDeviceDirectory</h4> | |
| 565 <b>selectDeviceDirectory</b>(<i>deviceDirectories</i>) | |
| 566 | |
| 567 <p> | |
| 568 Public method to select the device directory from a list of detected | |
| 569 ones. | |
| 570 </p> | |
| 571 <dl> | |
| 572 | |
| 573 <dt><i>deviceDirectories</i> (list of str)</dt> | |
| 574 <dd> | |
| 575 list of directories to select from | |
| 576 </dd> | |
| 577 </dl> | |
| 578 <dl> | |
| 579 <dt>Return:</dt> | |
| 580 <dd> | |
| 581 selected directory or an empty string | |
| 582 </dd> | |
| 583 </dl> | |
| 584 <dl> | |
| 585 <dt>Return Type:</dt> | |
| 586 <dd> | |
| 587 str | |
| 588 </dd> | |
| 589 </dl> | |
| 590 <a NAME="MicroPythonDevice.sendCommands" ID="MicroPythonDevice.sendCommands"></a> | |
| 591 <h4>MicroPythonDevice.sendCommands</h4> | |
| 592 <b>sendCommands</b>(<i>commandsList</i>) | |
| 593 | |
| 594 <p> | |
| 595 Public method to send a list of commands to the device. | |
| 596 </p> | |
| 597 <dl> | |
| 598 | |
| 599 <dt><i>commandsList</i> (list of str)</dt> | |
| 600 <dd> | |
| 601 list of commands to be sent to the device | |
| 602 </dd> | |
| 603 </dl> | |
| 604 <a NAME="MicroPythonDevice.setButtons" ID="MicroPythonDevice.setButtons"></a> | |
| 605 <h4>MicroPythonDevice.setButtons</h4> | |
| 606 <b>setButtons</b>(<i></i>) | |
| 607 | |
| 608 <p> | |
| 609 Public method to enable the supported action buttons. | |
| 610 </p> | |
| 611 <a NAME="MicroPythonDevice.setFileManager" ID="MicroPythonDevice.setFileManager"></a> | |
| 612 <h4>MicroPythonDevice.setFileManager</h4> | |
| 613 <b>setFileManager</b>(<i>on</i>) | |
| 614 | |
| 615 <p> | |
| 616 Public method to set the File Manager status and dependent status. | |
| 617 </p> | |
| 618 <dl> | |
| 619 | |
| 620 <dt><i>on</i> (bool)</dt> | |
| 621 <dd> | |
| 622 flag indicating the active status | |
| 623 </dd> | |
| 624 </dl> | |
| 625 <a NAME="MicroPythonDevice.setPlotter" ID="MicroPythonDevice.setPlotter"></a> | |
| 626 <h4>MicroPythonDevice.setPlotter</h4> | |
| 627 <b>setPlotter</b>(<i>on</i>) | |
| 628 | |
| 629 <p> | |
| 630 Public method to set the Plotter status and dependent status. | |
| 631 </p> | |
| 632 <dl> | |
| 633 | |
| 634 <dt><i>on</i> (bool)</dt> | |
| 635 <dd> | |
| 636 flag indicating the active status | |
| 637 </dd> | |
| 638 </dl> | |
| 639 <a NAME="MicroPythonDevice.setRepl" ID="MicroPythonDevice.setRepl"></a> | |
| 640 <h4>MicroPythonDevice.setRepl</h4> | |
| 641 <b>setRepl</b>(<i>on</i>) | |
| 642 | |
| 643 <p> | |
| 644 Public method to set the REPL status and dependent status. | |
| 645 </p> | |
| 646 <dl> | |
| 647 | |
| 648 <dt><i>on</i> (bool)</dt> | |
| 649 <dd> | |
| 650 flag indicating the active status | |
| 651 </dd> | |
| 652 </dl> | |
| 653 <a NAME="MicroPythonDevice.supportsLocalFileAccess" ID="MicroPythonDevice.supportsLocalFileAccess"></a> | |
| 654 <h4>MicroPythonDevice.supportsLocalFileAccess</h4> | |
| 655 <b>supportsLocalFileAccess</b>(<i></i>) | |
| 656 | |
| 657 <p> | |
| 658 Public method to indicate file access via a local directory. | |
| 659 </p> | |
| 660 <dl> | |
| 661 <dt>Return:</dt> | |
| 662 <dd> | |
| 663 flag indicating file access via local directory | |
| 664 </dd> | |
| 665 </dl> | |
| 666 <dl> | |
| 667 <dt>Return Type:</dt> | |
| 668 <dd> | |
| 669 bool | |
| 670 </dd> | |
| 671 </dl> | |
| 672 <div align="right"><a href="#top">Up</a></div> | |
| 673 <hr /> | |
| 674 <hr /> | |
| 675 <a NAME="getDevice" ID="getDevice"></a> | |
| 676 <h2>getDevice</h2> | |
| 677 <b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid</i>) | |
| 678 | |
| 679 <p> | |
| 680 Public method to instantiate a specific MicroPython device interface. | |
| 681 </p> | |
| 682 <dl> | |
| 683 | |
| 684 <dt><i>deviceType</i> (str)</dt> | |
| 685 <dd> | |
| 686 type of the device interface | |
| 687 </dd> | |
| 688 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> | |
| 689 <dd> | |
| 690 reference to the main MicroPython widget | |
| 691 </dd> | |
| 692 <dt><i>vid</i> (int)</dt> | |
| 693 <dd> | |
| 694 vendor ID (only used for deviceType 'generic') | |
| 695 </dd> | |
| 696 <dt><i>pid</i> (int)</dt> | |
| 697 <dd> | |
| 698 product ID (only used for deviceType 'generic') | |
| 699 </dd> | |
| 700 </dl> | |
| 701 <dl> | |
| 702 <dt>Return:</dt> | |
| 703 <dd> | |
| 704 instantiated device interface | |
| 705 </dd> | |
| 706 </dl> | |
| 707 <dl> | |
| 708 <dt>Return Type:</dt> | |
| 709 <dd> | |
| 710 MicroPythonDevice | |
| 711 </dd> | |
| 712 </dl> | |
| 713 <div align="right"><a href="#top">Up</a></div> | |
| 714 <hr /> | |
| 715 <hr /> | |
| 716 <a NAME="getDeviceIcon" ID="getDeviceIcon"></a> | |
| 717 <h2>getDeviceIcon</h2> | |
| 718 <b>getDeviceIcon</b>(<i>boardName, iconFormat=True</i>) | |
| 719 | |
| 720 <p> | |
| 721 Function to get the icon for the given board. | |
| 722 </p> | |
| 723 <dl> | |
| 724 | |
| 725 <dt><i>boardName</i> (str)</dt> | |
| 726 <dd> | |
| 727 name of the board | |
| 728 </dd> | |
| 729 <dt><i>iconFormat</i> (bool)</dt> | |
| 730 <dd> | |
| 731 flag indicating to get an icon or a pixmap | |
| 732 </dd> | |
| 733 </dl> | |
| 734 <dl> | |
| 735 <dt>Return:</dt> | |
| 736 <dd> | |
| 737 icon for the board (iconFormat == True) or | |
| 738 a pixmap (iconFormat == False) | |
| 739 </dd> | |
| 740 </dl> | |
| 741 <dl> | |
| 742 <dt>Return Type:</dt> | |
| 743 <dd> | |
| 744 QIcon or QPixmap | |
| 745 </dd> | |
| 746 </dl> | |
| 747 <div align="right"><a href="#top">Up</a></div> | |
| 748 <hr /> | |
| 749 <hr /> | |
| 750 <a NAME="getFoundDevices" ID="getFoundDevices"></a> | |
| 751 <h2>getFoundDevices</h2> | |
| 752 <b>getFoundDevices</b>(<i></i>) | |
| 753 | |
| 754 <p> | |
| 755 Function to check the serial ports for supported MicroPython devices. | |
| 756 </p> | |
| 757 <dl> | |
| 758 <dt>Return:</dt> | |
| 759 <dd> | |
| 760 tuple containing a list of tuples with the board type, the port | |
| 761 description, a description, the serial port it is connected at, the | |
| 762 VID and PID for known device types, a list of tuples with VID, PID | |
| 763 and description for unknown devices and a list of tuples with VID, | |
| 764 PID, description and port name for ports with missing VID or PID | |
| 765 </dd> | |
| 766 </dl> | |
| 767 <dl> | |
| 768 <dt>Return Type:</dt> | |
| 769 <dd> | |
| 770 tuple of (list of tuples of (str, str, str, str, int, int), | |
| 771 list of tuples of (int, int, str), | |
| 772 list of tuples of (int, int, str, str) | |
| 773 </dd> | |
| 774 </dl> | |
| 775 <div align="right"><a href="#top">Up</a></div> | |
| 776 <hr /> | |
| 777 <hr /> | |
| 778 <a NAME="getSupportedDevices" ID="getSupportedDevices"></a> | |
| 779 <h2>getSupportedDevices</h2> | |
| 780 <b>getSupportedDevices</b>(<i></i>) | |
| 781 | |
| 782 <p> | |
| 783 Function to get a list of supported MicroPython devices. | |
| 784 </p> | |
| 785 <dl> | |
| 786 <dt>Return:</dt> | |
| 787 <dd> | |
| 788 set of tuples with the board type and description | |
| 789 </dd> | |
| 790 </dl> | |
| 791 <dl> | |
| 792 <dt>Return Type:</dt> | |
| 793 <dd> | |
| 794 set of tuples of (str, str) | |
| 795 </dd> | |
| 796 </dl> | |
| 797 <div align="right"><a href="#top">Up</a></div> | |
| 798 <hr /> | |
| 799 </body></html> |
