Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html
- branch
- eric7
- changeset 9765
- 6378da868bb0
- parent 9756
- 9854647c8c5c
- child 9766
- f0e22f3a5878
equal
deleted
inserted
replaced
| 9764:57496966803c | 9765:6378da868bb0 |
|---|---|
| 58 <tr> | 58 <tr> |
| 59 <td><a href="#BaseDevice.__init__">BaseDevice</a></td> | 59 <td><a href="#BaseDevice.__init__">BaseDevice</a></td> |
| 60 <td>Constructor</td> | 60 <td>Constructor</td> |
| 61 </tr> | 61 </tr> |
| 62 <tr> | 62 <tr> |
| 63 <td><a href="#BaseDevice.__getDeviceData">__getDeviceData</a></td> | |
| 64 <td>Private method to get some essential data for the connected board.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#BaseDevice._getSetTimeCode">_getSetTimeCode</a></td> | |
| 68 <td>Protected method to get the device code to set the time.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#BaseDevice._shortError">_shortError</a></td> | |
| 72 <td>Protected method to create a shortened error message.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 63 <td><a href="#BaseDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> | 75 <td><a href="#BaseDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
| 64 <td>Public method to add device specific entries to the given menu.</td> | 76 <td>Public method to add device specific entries to the given menu.</td> |
| 65 </tr> | 77 </tr> |
| 66 <tr> | 78 <tr> |
| 67 <td><a href="#BaseDevice.canRunScript">canRunScript</a></td> | 79 <td><a href="#BaseDevice.canRunScript">canRunScript</a></td> |
| 78 <tr> | 90 <tr> |
| 79 <td><a href="#BaseDevice.canStartRepl">canStartRepl</a></td> | 91 <td><a href="#BaseDevice.canStartRepl">canStartRepl</a></td> |
| 80 <td>Public method to determine, if a REPL can be started.</td> | 92 <td>Public method to determine, if a REPL can be started.</td> |
| 81 </tr> | 93 </tr> |
| 82 <tr> | 94 <tr> |
| 95 <td><a href="#BaseDevice.cd">cd</a></td> | |
| 96 <td>Public method to change the current directory on the connected device.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 83 <td><a href="#BaseDevice.checkDeviceData">checkDeviceData</a></td> | 99 <td><a href="#BaseDevice.checkDeviceData">checkDeviceData</a></td> |
| 84 <td>Public method to check the validity of the device data determined during connecting the device.</td> | 100 <td>Public method to check the validity of the device data determined during connecting the device.</td> |
| 85 </tr> | 101 </tr> |
| 86 <tr> | 102 <tr> |
| 87 <td><a href="#BaseDevice.deviceName">deviceName</a></td> | 103 <td><a href="#BaseDevice.deviceName">deviceName</a></td> |
| 90 <tr> | 106 <tr> |
| 91 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td> | 107 <td><a href="#BaseDevice.downloadFirmware">downloadFirmware</a></td> |
| 92 <td>Public method to download the device firmware.</td> | 108 <td>Public method to download the device firmware.</td> |
| 93 </tr> | 109 </tr> |
| 94 <tr> | 110 <tr> |
| 111 <td><a href="#BaseDevice.fileSystemInfo">fileSystemInfo</a></td> | |
| 112 <td>Public method to obtain information about the currently mounted file systems.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 95 <td><a href="#BaseDevice.forceInterrupt">forceInterrupt</a></td> | 115 <td><a href="#BaseDevice.forceInterrupt">forceInterrupt</a></td> |
| 96 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | 116 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
| 97 </tr> | 117 </tr> |
| 98 <tr> | 118 <tr> |
| 119 <td><a href="#BaseDevice.get">get</a></td> | |
| 120 <td>Public method to copy a file from the connected device.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#BaseDevice.getBoardInformation">getBoardInformation</a></td> | |
| 124 <td>Public method to get some information data of the connected board.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#BaseDevice.getData">getData</a></td> | |
| 128 <td>Public method to read data from the connected device.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 99 <td><a href="#BaseDevice.getDeviceData">getDeviceData</a></td> | 131 <td><a href="#BaseDevice.getDeviceData">getDeviceData</a></td> |
| 100 <td>Public method to get a copy of the determined device data.</td> | 132 <td>Public method to get a copy of the determined device data.</td> |
| 101 </tr> | 133 </tr> |
| 102 <tr> | 134 <tr> |
| 103 <td><a href="#BaseDevice.getDeviceType">getDeviceType</a></td> | 135 <td><a href="#BaseDevice.getDeviceType">getDeviceType</a></td> |
| 114 <tr> | 146 <tr> |
| 115 <td><a href="#BaseDevice.getFirmwareUrl">getFirmwareUrl</a></td> | 147 <td><a href="#BaseDevice.getFirmwareUrl">getFirmwareUrl</a></td> |
| 116 <td>Public method to get the device firmware download URL.</td> | 148 <td>Public method to get the device firmware download URL.</td> |
| 117 </tr> | 149 </tr> |
| 118 <tr> | 150 <tr> |
| 151 <td><a href="#BaseDevice.getModules">getModules</a></td> | |
| 152 <td>Public method to show a list of modules built into the firmware.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#BaseDevice.getTime">getTime</a></td> | |
| 156 <td>Public method to get the current time of the device.</td> | |
| 157 </tr> | |
| 158 <tr> | |
| 119 <td><a href="#BaseDevice.getWorkspace">getWorkspace</a></td> | 159 <td><a href="#BaseDevice.getWorkspace">getWorkspace</a></td> |
| 120 <td>Public method to get the workspace directory.</td> | 160 <td>Public method to get the workspace directory.</td> |
| 121 </tr> | 161 </tr> |
| 122 <tr> | 162 <tr> |
| 123 <td><a href="#BaseDevice.handleDataFlood">handleDataFlood</a></td> | 163 <td><a href="#BaseDevice.handleDataFlood">handleDataFlood</a></td> |
| 124 <td>Public slot handling a data floof from the device.</td> | 164 <td>Public slot handling a data floof from the device.</td> |
| 125 </tr> | 165 </tr> |
| 126 <tr> | 166 <tr> |
| 167 <td><a href="#BaseDevice.hasCircuitPython">hasCircuitPython</a></td> | |
| 168 <td>Public method to check, if the connected device is flashed with CircuitPython.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 127 <td><a href="#BaseDevice.hasDocumentationUrl">hasDocumentationUrl</a></td> | 171 <td><a href="#BaseDevice.hasDocumentationUrl">hasDocumentationUrl</a></td> |
| 128 <td>Public method to check, if the device has a configured documentation URL.</td> | 172 <td>Public method to check, if the device has a configured documentation URL.</td> |
| 129 </tr> | 173 </tr> |
| 130 <tr> | 174 <tr> |
| 131 <td><a href="#BaseDevice.hasFirmwareUrl">hasFirmwareUrl</a></td> | 175 <td><a href="#BaseDevice.hasFirmwareUrl">hasFirmwareUrl</a></td> |
| 138 <tr> | 182 <tr> |
| 139 <td><a href="#BaseDevice.hasTimeCommands">hasTimeCommands</a></td> | 183 <td><a href="#BaseDevice.hasTimeCommands">hasTimeCommands</a></td> |
| 140 <td>Public method to check, if the device supports time commands.</td> | 184 <td>Public method to check, if the device supports time commands.</td> |
| 141 </tr> | 185 </tr> |
| 142 <tr> | 186 <tr> |
| 187 <td><a href="#BaseDevice.lls">lls</a></td> | |
| 188 <td>Public method to get a long directory listing of the connected device including meta data.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 191 <td><a href="#BaseDevice.ls">ls</a></td> | |
| 192 <td>Public method to get a directory listing of the connected device.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 195 <td><a href="#BaseDevice.mkdir">mkdir</a></td> | |
| 196 <td>Public method to create a new directory.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 199 <td><a href="#BaseDevice.put">put</a></td> | |
| 200 <td>Public method to copy a local file to the connected device.</td> | |
| 201 </tr> | |
| 202 <tr> | |
| 203 <td><a href="#BaseDevice.putData">putData</a></td> | |
| 204 <td>Public method to write the given data to the connected device.</td> | |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#BaseDevice.pwd">pwd</a></td> | |
| 208 <td>Public method to get the current directory of the connected device.</td> | |
| 209 </tr> | |
| 210 <tr> | |
| 211 <td><a href="#BaseDevice.rm">rm</a></td> | |
| 212 <td>Public method to remove a file from the connected device.</td> | |
| 213 </tr> | |
| 214 <tr> | |
| 215 <td><a href="#BaseDevice.rmdir">rmdir</a></td> | |
| 216 <td>Public method to remove a directory.</td> | |
| 217 </tr> | |
| 218 <tr> | |
| 219 <td><a href="#BaseDevice.rmrf">rmrf</a></td> | |
| 220 <td>Public method to remove a file or directory recursively.</td> | |
| 221 </tr> | |
| 222 <tr> | |
| 143 <td><a href="#BaseDevice.runScript">runScript</a></td> | 223 <td><a href="#BaseDevice.runScript">runScript</a></td> |
| 144 <td>Public method to run the given Python script.</td> | 224 <td>Public method to run the given Python script.</td> |
| 145 </tr> | 225 </tr> |
| 146 <tr> | 226 <tr> |
| 147 <td><a href="#BaseDevice.selectDeviceDirectory">selectDeviceDirectory</a></td> | 227 <td><a href="#BaseDevice.selectDeviceDirectory">selectDeviceDirectory</a></td> |
| 172 <td>Public method to set the REPL status and dependent status.</td> | 252 <td>Public method to set the REPL status and dependent status.</td> |
| 173 </tr> | 253 </tr> |
| 174 <tr> | 254 <tr> |
| 175 <td><a href="#BaseDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> | 255 <td><a href="#BaseDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> |
| 176 <td>Public method to indicate file access via a local directory.</td> | 256 <td>Public method to indicate file access via a local directory.</td> |
| 257 </tr> | |
| 258 <tr> | |
| 259 <td><a href="#BaseDevice.syncTime">syncTime</a></td> | |
| 260 <td>Public method to set the time of the connected device to the local computer's time.</td> | |
| 177 </tr> | 261 </tr> |
| 178 </table> | 262 </table> |
| 179 <h3>Static Methods</h3> | 263 <h3>Static Methods</h3> |
| 180 | 264 |
| 181 <table> | 265 <table> |
| 202 <dt><i>parent</i> (QObject)</dt> | 286 <dt><i>parent</i> (QObject)</dt> |
| 203 <dd> | 287 <dd> |
| 204 reference to the parent object | 288 reference to the parent object |
| 205 </dd> | 289 </dd> |
| 206 </dl> | 290 </dl> |
| 291 <a NAME="BaseDevice.__getDeviceData" ID="BaseDevice.__getDeviceData"></a> | |
| 292 <h4>BaseDevice.__getDeviceData</h4> | |
| 293 <b>__getDeviceData</b>(<i></i>) | |
| 294 | |
| 295 <p> | |
| 296 Private method to get some essential data for the connected board. | |
| 297 </p> | |
| 298 <dl> | |
| 299 <dt>Return:</dt> | |
| 300 <dd> | |
| 301 dictionary containing the determined data | |
| 302 </dd> | |
| 303 </dl> | |
| 304 <dl> | |
| 305 <dt>Return Type:</dt> | |
| 306 <dd> | |
| 307 dict | |
| 308 </dd> | |
| 309 </dl> | |
| 310 <dl> | |
| 311 | |
| 312 <dt>Raises <b>OSError</b>:</dt> | |
| 313 <dd> | |
| 314 raised to indicate an issue with the device | |
| 315 </dd> | |
| 316 </dl> | |
| 317 <a NAME="BaseDevice._getSetTimeCode" ID="BaseDevice._getSetTimeCode"></a> | |
| 318 <h4>BaseDevice._getSetTimeCode</h4> | |
| 319 <b>_getSetTimeCode</b>(<i></i>) | |
| 320 | |
| 321 <p> | |
| 322 Protected method to get the device code to set the time. | |
| 323 </p> | |
| 324 <p> | |
| 325 Note: This method must be implemented in the various device specific | |
| 326 subclasses. | |
| 327 </p> | |
| 328 <dl> | |
| 329 <dt>Return:</dt> | |
| 330 <dd> | |
| 331 code to be executed on the connected device to set the time | |
| 332 </dd> | |
| 333 </dl> | |
| 334 <dl> | |
| 335 <dt>Return Type:</dt> | |
| 336 <dd> | |
| 337 str | |
| 338 </dd> | |
| 339 </dl> | |
| 340 <a NAME="BaseDevice._shortError" ID="BaseDevice._shortError"></a> | |
| 341 <h4>BaseDevice._shortError</h4> | |
| 342 <b>_shortError</b>(<i>error</i>) | |
| 343 | |
| 344 <p> | |
| 345 Protected method to create a shortened error message. | |
| 346 </p> | |
| 347 <dl> | |
| 348 | |
| 349 <dt><i>error</i> (bytes)</dt> | |
| 350 <dd> | |
| 351 verbose error message | |
| 352 </dd> | |
| 353 </dl> | |
| 354 <dl> | |
| 355 <dt>Return:</dt> | |
| 356 <dd> | |
| 357 shortened error message | |
| 358 </dd> | |
| 359 </dl> | |
| 360 <dl> | |
| 361 <dt>Return Type:</dt> | |
| 362 <dd> | |
| 363 str | |
| 364 </dd> | |
| 365 </dl> | |
| 207 <a NAME="BaseDevice.addDeviceMenuEntries" ID="BaseDevice.addDeviceMenuEntries"></a> | 366 <a NAME="BaseDevice.addDeviceMenuEntries" ID="BaseDevice.addDeviceMenuEntries"></a> |
| 208 <h4>BaseDevice.addDeviceMenuEntries</h4> | 367 <h4>BaseDevice.addDeviceMenuEntries</h4> |
| 209 <b>addDeviceMenuEntries</b>(<i>menu</i>) | 368 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
| 210 | 369 |
| 211 <p> | 370 <p> |
| 296 <dt>Return Type:</dt> | 455 <dt>Return Type:</dt> |
| 297 <dd> | 456 <dd> |
| 298 tuple of (bool, str) | 457 tuple of (bool, str) |
| 299 </dd> | 458 </dd> |
| 300 </dl> | 459 </dl> |
| 460 <a NAME="BaseDevice.cd" ID="BaseDevice.cd"></a> | |
| 461 <h4>BaseDevice.cd</h4> | |
| 462 <b>cd</b>(<i>dirname</i>) | |
| 463 | |
| 464 <p> | |
| 465 Public method to change the current directory on the connected device. | |
| 466 </p> | |
| 467 <dl> | |
| 468 | |
| 469 <dt><i>dirname</i> (str)</dt> | |
| 470 <dd> | |
| 471 directory to change to | |
| 472 </dd> | |
| 473 </dl> | |
| 474 <dl> | |
| 475 | |
| 476 <dt>Raises <b>OSError</b>:</dt> | |
| 477 <dd> | |
| 478 raised to indicate an issue with the device | |
| 479 </dd> | |
| 480 </dl> | |
| 301 <a NAME="BaseDevice.checkDeviceData" ID="BaseDevice.checkDeviceData"></a> | 481 <a NAME="BaseDevice.checkDeviceData" ID="BaseDevice.checkDeviceData"></a> |
| 302 <h4>BaseDevice.checkDeviceData</h4> | 482 <h4>BaseDevice.checkDeviceData</h4> |
| 303 <b>checkDeviceData</b>(<i></i>) | 483 <b>checkDeviceData</b>(<i></i>) |
| 304 | 484 |
| 305 <p> | 485 <p> |
| 342 <b>downloadFirmware</b>(<i></i>) | 522 <b>downloadFirmware</b>(<i></i>) |
| 343 | 523 |
| 344 <p> | 524 <p> |
| 345 Public method to download the device firmware. | 525 Public method to download the device firmware. |
| 346 </p> | 526 </p> |
| 527 <a NAME="BaseDevice.fileSystemInfo" ID="BaseDevice.fileSystemInfo"></a> | |
| 528 <h4>BaseDevice.fileSystemInfo</h4> | |
| 529 <b>fileSystemInfo</b>(<i></i>) | |
| 530 | |
| 531 <p> | |
| 532 Public method to obtain information about the currently mounted file | |
| 533 systems. | |
| 534 </p> | |
| 535 <dl> | |
| 536 <dt>Return:</dt> | |
| 537 <dd> | |
| 538 tuple of tuples containing the file system name, the total | |
| 539 size, the used size and the free size | |
| 540 </dd> | |
| 541 </dl> | |
| 542 <dl> | |
| 543 <dt>Return Type:</dt> | |
| 544 <dd> | |
| 545 tuple of tuples of (str, int, int, int) | |
| 546 </dd> | |
| 547 </dl> | |
| 548 <dl> | |
| 549 | |
| 550 <dt>Raises <b>OSError</b>:</dt> | |
| 551 <dd> | |
| 552 raised to indicate an issue with the device | |
| 553 </dd> | |
| 554 </dl> | |
| 347 <a NAME="BaseDevice.forceInterrupt" ID="BaseDevice.forceInterrupt"></a> | 555 <a NAME="BaseDevice.forceInterrupt" ID="BaseDevice.forceInterrupt"></a> |
| 348 <h4>BaseDevice.forceInterrupt</h4> | 556 <h4>BaseDevice.forceInterrupt</h4> |
| 349 <b>forceInterrupt</b>(<i></i>) | 557 <b>forceInterrupt</b>(<i></i>) |
| 350 | 558 |
| 351 <p> | 559 <p> |
| 362 <dt>Return Type:</dt> | 570 <dt>Return Type:</dt> |
| 363 <dd> | 571 <dd> |
| 364 bool | 572 bool |
| 365 </dd> | 573 </dd> |
| 366 </dl> | 574 </dl> |
| 575 <a NAME="BaseDevice.get" ID="BaseDevice.get"></a> | |
| 576 <h4>BaseDevice.get</h4> | |
| 577 <b>get</b>(<i>deviceFileName, hostFileName=None</i>) | |
| 578 | |
| 579 <p> | |
| 580 Public method to copy a file from the connected device. | |
| 581 </p> | |
| 582 <dl> | |
| 583 | |
| 584 <dt><i>deviceFileName</i> (str)</dt> | |
| 585 <dd> | |
| 586 name of the file to copy | |
| 587 </dd> | |
| 588 <dt><i>hostFileName</i> (str)</dt> | |
| 589 <dd> | |
| 590 name of the file to copy to | |
| 591 </dd> | |
| 592 </dl> | |
| 593 <dl> | |
| 594 <dt>Return:</dt> | |
| 595 <dd> | |
| 596 flag indicating success | |
| 597 </dd> | |
| 598 </dl> | |
| 599 <dl> | |
| 600 <dt>Return Type:</dt> | |
| 601 <dd> | |
| 602 bool | |
| 603 </dd> | |
| 604 </dl> | |
| 605 <dl> | |
| 606 | |
| 607 <dt>Raises <b>OSError</b>:</dt> | |
| 608 <dd> | |
| 609 raised to indicate an issue with the device | |
| 610 </dd> | |
| 611 </dl> | |
| 612 <a NAME="BaseDevice.getBoardInformation" ID="BaseDevice.getBoardInformation"></a> | |
| 613 <h4>BaseDevice.getBoardInformation</h4> | |
| 614 <b>getBoardInformation</b>(<i></i>) | |
| 615 | |
| 616 <p> | |
| 617 Public method to get some information data of the connected board. | |
| 618 </p> | |
| 619 <dl> | |
| 620 <dt>Return:</dt> | |
| 621 <dd> | |
| 622 dictionary containing the determined data | |
| 623 </dd> | |
| 624 </dl> | |
| 625 <dl> | |
| 626 <dt>Return Type:</dt> | |
| 627 <dd> | |
| 628 dict | |
| 629 </dd> | |
| 630 </dl> | |
| 631 <dl> | |
| 632 | |
| 633 <dt>Raises <b>OSError</b>:</dt> | |
| 634 <dd> | |
| 635 raised to indicate an issue with the device | |
| 636 </dd> | |
| 637 </dl> | |
| 638 <a NAME="BaseDevice.getData" ID="BaseDevice.getData"></a> | |
| 639 <h4>BaseDevice.getData</h4> | |
| 640 <b>getData</b>(<i>deviceFileName</i>) | |
| 641 | |
| 642 <p> | |
| 643 Public method to read data from the connected device. | |
| 644 </p> | |
| 645 <dl> | |
| 646 | |
| 647 <dt><i>deviceFileName</i> (str)</dt> | |
| 648 <dd> | |
| 649 name of the file to read from | |
| 650 </dd> | |
| 651 </dl> | |
| 652 <dl> | |
| 653 <dt>Return:</dt> | |
| 654 <dd> | |
| 655 data read from the device | |
| 656 </dd> | |
| 657 </dl> | |
| 658 <dl> | |
| 659 <dt>Return Type:</dt> | |
| 660 <dd> | |
| 661 bytes | |
| 662 </dd> | |
| 663 </dl> | |
| 664 <dl> | |
| 665 | |
| 666 <dt>Raises <b>OSError</b>:</dt> | |
| 667 <dd> | |
| 668 raised to indicate an issue with the device | |
| 669 </dd> | |
| 670 </dl> | |
| 367 <a NAME="BaseDevice.getDeviceData" ID="BaseDevice.getDeviceData"></a> | 671 <a NAME="BaseDevice.getDeviceData" ID="BaseDevice.getDeviceData"></a> |
| 368 <h4>BaseDevice.getDeviceData</h4> | 672 <h4>BaseDevice.getDeviceData</h4> |
| 369 <b>getDeviceData</b>(<i></i>) | 673 <b>getDeviceData</b>(<i></i>) |
| 370 | 674 |
| 371 <p> | 675 <p> |
| 458 <dt>Return Type:</dt> | 762 <dt>Return Type:</dt> |
| 459 <dd> | 763 <dd> |
| 460 str | 764 str |
| 461 </dd> | 765 </dd> |
| 462 </dl> | 766 </dl> |
| 767 <a NAME="BaseDevice.getModules" ID="BaseDevice.getModules"></a> | |
| 768 <h4>BaseDevice.getModules</h4> | |
| 769 <b>getModules</b>(<i></i>) | |
| 770 | |
| 771 <p> | |
| 772 Public method to show a list of modules built into the firmware. | |
| 773 </p> | |
| 774 <dl> | |
| 775 <dt>Return:</dt> | |
| 776 <dd> | |
| 777 list of builtin modules | |
| 778 </dd> | |
| 779 </dl> | |
| 780 <dl> | |
| 781 <dt>Return Type:</dt> | |
| 782 <dd> | |
| 783 list of str | |
| 784 </dd> | |
| 785 </dl> | |
| 786 <dl> | |
| 787 | |
| 788 <dt>Raises <b>OSError</b>:</dt> | |
| 789 <dd> | |
| 790 raised to indicate an issue with the device | |
| 791 </dd> | |
| 792 </dl> | |
| 793 <a NAME="BaseDevice.getTime" ID="BaseDevice.getTime"></a> | |
| 794 <h4>BaseDevice.getTime</h4> | |
| 795 <b>getTime</b>(<i></i>) | |
| 796 | |
| 797 <p> | |
| 798 Public method to get the current time of the device. | |
| 799 </p> | |
| 800 <dl> | |
| 801 <dt>Return:</dt> | |
| 802 <dd> | |
| 803 time of the device | |
| 804 </dd> | |
| 805 </dl> | |
| 806 <dl> | |
| 807 <dt>Return Type:</dt> | |
| 808 <dd> | |
| 809 str | |
| 810 </dd> | |
| 811 </dl> | |
| 812 <dl> | |
| 813 | |
| 814 <dt>Raises <b>OSError</b>:</dt> | |
| 815 <dd> | |
| 816 raised to indicate an issue with the device | |
| 817 </dd> | |
| 818 </dl> | |
| 463 <a NAME="BaseDevice.getWorkspace" ID="BaseDevice.getWorkspace"></a> | 819 <a NAME="BaseDevice.getWorkspace" ID="BaseDevice.getWorkspace"></a> |
| 464 <h4>BaseDevice.getWorkspace</h4> | 820 <h4>BaseDevice.getWorkspace</h4> |
| 465 <b>getWorkspace</b>(<i></i>) | 821 <b>getWorkspace</b>(<i></i>) |
| 466 | 822 |
| 467 <p> | 823 <p> |
| 484 <b>handleDataFlood</b>(<i></i>) | 840 <b>handleDataFlood</b>(<i></i>) |
| 485 | 841 |
| 486 <p> | 842 <p> |
| 487 Public slot handling a data floof from the device. | 843 Public slot handling a data floof from the device. |
| 488 </p> | 844 </p> |
| 845 <a NAME="BaseDevice.hasCircuitPython" ID="BaseDevice.hasCircuitPython"></a> | |
| 846 <h4>BaseDevice.hasCircuitPython</h4> | |
| 847 <b>hasCircuitPython</b>(<i></i>) | |
| 848 | |
| 849 <p> | |
| 850 Public method to check, if the connected device is flashed with CircuitPython. | |
| 851 </p> | |
| 852 <dl> | |
| 853 <dt>Return:</dt> | |
| 854 <dd> | |
| 855 flag indicating CircuitPython | |
| 856 </dd> | |
| 857 </dl> | |
| 858 <dl> | |
| 859 <dt>Return Type:</dt> | |
| 860 <dd> | |
| 861 bool | |
| 862 </dd> | |
| 863 </dl> | |
| 489 <a NAME="BaseDevice.hasDocumentationUrl" ID="BaseDevice.hasDocumentationUrl"></a> | 864 <a NAME="BaseDevice.hasDocumentationUrl" ID="BaseDevice.hasDocumentationUrl"></a> |
| 490 <h4>BaseDevice.hasDocumentationUrl</h4> | 865 <h4>BaseDevice.hasDocumentationUrl</h4> |
| 491 <b>hasDocumentationUrl</b>(<i></i>) | 866 <b>hasDocumentationUrl</b>(<i></i>) |
| 492 | 867 |
| 493 <p> | 868 <p> |
| 565 <dt>Return Type:</dt> | 940 <dt>Return Type:</dt> |
| 566 <dd> | 941 <dd> |
| 567 bool | 942 bool |
| 568 </dd> | 943 </dd> |
| 569 </dl> | 944 </dl> |
| 945 <a NAME="BaseDevice.lls" ID="BaseDevice.lls"></a> | |
| 946 <h4>BaseDevice.lls</h4> | |
| 947 <b>lls</b>(<i>dirname="", fullstat=False, showHidden=False</i>) | |
| 948 | |
| 949 <p> | |
| 950 Public method to get a long directory listing of the connected device | |
| 951 including meta data. | |
| 952 </p> | |
| 953 <dl> | |
| 954 | |
| 955 <dt><i>dirname</i> (str)</dt> | |
| 956 <dd> | |
| 957 name of the directory to be listed | |
| 958 </dd> | |
| 959 <dt><i>fullstat</i> (bool)</dt> | |
| 960 <dd> | |
| 961 flag indicating to return the full stat() tuple | |
| 962 </dd> | |
| 963 <dt><i>showHidden</i> (bool)</dt> | |
| 964 <dd> | |
| 965 flag indicating to show hidden files as well | |
| 966 </dd> | |
| 967 </dl> | |
| 968 <dl> | |
| 969 <dt>Return:</dt> | |
| 970 <dd> | |
| 971 list containing the directory listing with tuple entries of | |
| 972 the name and and a tuple of mode, size and time (if fullstat is | |
| 973 false) or the complete stat() tuple. 'None' is returned in case the | |
| 974 directory doesn't exist. | |
| 975 </dd> | |
| 976 </dl> | |
| 977 <dl> | |
| 978 <dt>Return Type:</dt> | |
| 979 <dd> | |
| 980 tuple of (str, tuple) | |
| 981 </dd> | |
| 982 </dl> | |
| 983 <dl> | |
| 984 | |
| 985 <dt>Raises <b>OSError</b>:</dt> | |
| 986 <dd> | |
| 987 raised to indicate an issue with the device | |
| 988 </dd> | |
| 989 </dl> | |
| 990 <a NAME="BaseDevice.ls" ID="BaseDevice.ls"></a> | |
| 991 <h4>BaseDevice.ls</h4> | |
| 992 <b>ls</b>(<i>dirname=""</i>) | |
| 993 | |
| 994 <p> | |
| 995 Public method to get a directory listing of the connected device. | |
| 996 </p> | |
| 997 <dl> | |
| 998 | |
| 999 <dt><i>dirname</i> (str)</dt> | |
| 1000 <dd> | |
| 1001 name of the directory to be listed | |
| 1002 </dd> | |
| 1003 </dl> | |
| 1004 <dl> | |
| 1005 <dt>Return:</dt> | |
| 1006 <dd> | |
| 1007 tuple containg the directory listing | |
| 1008 </dd> | |
| 1009 </dl> | |
| 1010 <dl> | |
| 1011 <dt>Return Type:</dt> | |
| 1012 <dd> | |
| 1013 tuple of str | |
| 1014 </dd> | |
| 1015 </dl> | |
| 1016 <dl> | |
| 1017 | |
| 1018 <dt>Raises <b>OSError</b>:</dt> | |
| 1019 <dd> | |
| 1020 raised to indicate an issue with the device | |
| 1021 </dd> | |
| 1022 </dl> | |
| 1023 <a NAME="BaseDevice.mkdir" ID="BaseDevice.mkdir"></a> | |
| 1024 <h4>BaseDevice.mkdir</h4> | |
| 1025 <b>mkdir</b>(<i>dirname</i>) | |
| 1026 | |
| 1027 <p> | |
| 1028 Public method to create a new directory. | |
| 1029 </p> | |
| 1030 <dl> | |
| 1031 | |
| 1032 <dt><i>dirname</i> (str)</dt> | |
| 1033 <dd> | |
| 1034 name of the directory to create | |
| 1035 </dd> | |
| 1036 </dl> | |
| 1037 <dl> | |
| 1038 | |
| 1039 <dt>Raises <b>OSError</b>:</dt> | |
| 1040 <dd> | |
| 1041 raised to indicate an issue with the device | |
| 1042 </dd> | |
| 1043 </dl> | |
| 1044 <a NAME="BaseDevice.put" ID="BaseDevice.put"></a> | |
| 1045 <h4>BaseDevice.put</h4> | |
| 1046 <b>put</b>(<i>hostFileName, deviceFileName=None</i>) | |
| 1047 | |
| 1048 <p> | |
| 1049 Public method to copy a local file to the connected device. | |
| 1050 </p> | |
| 1051 <dl> | |
| 1052 | |
| 1053 <dt><i>hostFileName</i> (str)</dt> | |
| 1054 <dd> | |
| 1055 name of the file to be copied | |
| 1056 </dd> | |
| 1057 <dt><i>deviceFileName</i> (str)</dt> | |
| 1058 <dd> | |
| 1059 name of the file to copy to | |
| 1060 </dd> | |
| 1061 </dl> | |
| 1062 <dl> | |
| 1063 <dt>Return:</dt> | |
| 1064 <dd> | |
| 1065 flag indicating success | |
| 1066 </dd> | |
| 1067 </dl> | |
| 1068 <dl> | |
| 1069 <dt>Return Type:</dt> | |
| 1070 <dd> | |
| 1071 bool | |
| 1072 </dd> | |
| 1073 </dl> | |
| 1074 <dl> | |
| 1075 | |
| 1076 <dt>Raises <b>OSError</b>:</dt> | |
| 1077 <dd> | |
| 1078 raised to indicate an issue with the device | |
| 1079 </dd> | |
| 1080 </dl> | |
| 1081 <a NAME="BaseDevice.putData" ID="BaseDevice.putData"></a> | |
| 1082 <h4>BaseDevice.putData</h4> | |
| 1083 <b>putData</b>(<i>deviceFileName, content</i>) | |
| 1084 | |
| 1085 <p> | |
| 1086 Public method to write the given data to the connected device. | |
| 1087 </p> | |
| 1088 <dl> | |
| 1089 | |
| 1090 <dt><i>deviceFileName</i> (str)</dt> | |
| 1091 <dd> | |
| 1092 name of the file to write to | |
| 1093 </dd> | |
| 1094 <dt><i>content</i> (bytes)</dt> | |
| 1095 <dd> | |
| 1096 data to write | |
| 1097 </dd> | |
| 1098 </dl> | |
| 1099 <dl> | |
| 1100 <dt>Return:</dt> | |
| 1101 <dd> | |
| 1102 flag indicating success | |
| 1103 </dd> | |
| 1104 </dl> | |
| 1105 <dl> | |
| 1106 <dt>Return Type:</dt> | |
| 1107 <dd> | |
| 1108 bool | |
| 1109 </dd> | |
| 1110 </dl> | |
| 1111 <dl> | |
| 1112 | |
| 1113 <dt>Raises <b>OSError</b>:</dt> | |
| 1114 <dd> | |
| 1115 raised to indicate an issue with the device | |
| 1116 </dd> | |
| 1117 </dl> | |
| 1118 <a NAME="BaseDevice.pwd" ID="BaseDevice.pwd"></a> | |
| 1119 <h4>BaseDevice.pwd</h4> | |
| 1120 <b>pwd</b>(<i></i>) | |
| 1121 | |
| 1122 <p> | |
| 1123 Public method to get the current directory of the connected device. | |
| 1124 </p> | |
| 1125 <dl> | |
| 1126 <dt>Return:</dt> | |
| 1127 <dd> | |
| 1128 current directory | |
| 1129 </dd> | |
| 1130 </dl> | |
| 1131 <dl> | |
| 1132 <dt>Return Type:</dt> | |
| 1133 <dd> | |
| 1134 str | |
| 1135 </dd> | |
| 1136 </dl> | |
| 1137 <dl> | |
| 1138 | |
| 1139 <dt>Raises <b>OSError</b>:</dt> | |
| 1140 <dd> | |
| 1141 raised to indicate an issue with the device | |
| 1142 </dd> | |
| 1143 </dl> | |
| 1144 <a NAME="BaseDevice.rm" ID="BaseDevice.rm"></a> | |
| 1145 <h4>BaseDevice.rm</h4> | |
| 1146 <b>rm</b>(<i>filename</i>) | |
| 1147 | |
| 1148 <p> | |
| 1149 Public method to remove a file from the connected device. | |
| 1150 </p> | |
| 1151 <dl> | |
| 1152 | |
| 1153 <dt><i>filename</i> (str)</dt> | |
| 1154 <dd> | |
| 1155 name of the file to be removed | |
| 1156 </dd> | |
| 1157 </dl> | |
| 1158 <dl> | |
| 1159 | |
| 1160 <dt>Raises <b>OSError</b>:</dt> | |
| 1161 <dd> | |
| 1162 raised to indicate an issue with the device | |
| 1163 </dd> | |
| 1164 </dl> | |
| 1165 <a NAME="BaseDevice.rmdir" ID="BaseDevice.rmdir"></a> | |
| 1166 <h4>BaseDevice.rmdir</h4> | |
| 1167 <b>rmdir</b>(<i>dirname</i>) | |
| 1168 | |
| 1169 <p> | |
| 1170 Public method to remove a directory. | |
| 1171 </p> | |
| 1172 <dl> | |
| 1173 | |
| 1174 <dt><i>dirname</i> (str)</dt> | |
| 1175 <dd> | |
| 1176 name of the directory to be removed | |
| 1177 </dd> | |
| 1178 </dl> | |
| 1179 <dl> | |
| 1180 | |
| 1181 <dt>Raises <b>OSError</b>:</dt> | |
| 1182 <dd> | |
| 1183 raised to indicate an issue with the device | |
| 1184 </dd> | |
| 1185 </dl> | |
| 1186 <a NAME="BaseDevice.rmrf" ID="BaseDevice.rmrf"></a> | |
| 1187 <h4>BaseDevice.rmrf</h4> | |
| 1188 <b>rmrf</b>(<i>name, recursive=False, force=False</i>) | |
| 1189 | |
| 1190 <p> | |
| 1191 Public method to remove a file or directory recursively. | |
| 1192 </p> | |
| 1193 <dl> | |
| 1194 | |
| 1195 <dt><i>name</i> (str)</dt> | |
| 1196 <dd> | |
| 1197 of the file or directory to remove | |
| 1198 </dd> | |
| 1199 <dt><i>recursive</i> (bool)</dt> | |
| 1200 <dd> | |
| 1201 flag indicating a recursive deletion | |
| 1202 </dd> | |
| 1203 <dt><i>force</i> (bool)</dt> | |
| 1204 <dd> | |
| 1205 flag indicating to ignore errors | |
| 1206 </dd> | |
| 1207 </dl> | |
| 1208 <dl> | |
| 1209 <dt>Return:</dt> | |
| 1210 <dd> | |
| 1211 flag indicating success | |
| 1212 </dd> | |
| 1213 </dl> | |
| 1214 <dl> | |
| 1215 <dt>Return Type:</dt> | |
| 1216 <dd> | |
| 1217 bool | |
| 1218 </dd> | |
| 1219 </dl> | |
| 1220 <dl> | |
| 1221 | |
| 1222 <dt>Raises <b>OSError</b>:</dt> | |
| 1223 <dd> | |
| 1224 raised to indicate an issue with the device | |
| 1225 </dd> | |
| 1226 </dl> | |
| 570 <a NAME="BaseDevice.runScript" ID="BaseDevice.runScript"></a> | 1227 <a NAME="BaseDevice.runScript" ID="BaseDevice.runScript"></a> |
| 571 <h4>BaseDevice.runScript</h4> | 1228 <h4>BaseDevice.runScript</h4> |
| 572 <b>runScript</b>(<i>script</i>) | 1229 <b>runScript</b>(<i>script</i>) |
| 573 | 1230 |
| 574 <p> | 1231 <p> |
| 706 <dt>Return Type:</dt> | 1363 <dt>Return Type:</dt> |
| 707 <dd> | 1364 <dd> |
| 708 bool | 1365 bool |
| 709 </dd> | 1366 </dd> |
| 710 </dl> | 1367 </dl> |
| 1368 <a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a> | |
| 1369 <h4>BaseDevice.syncTime</h4> | |
| 1370 <b>syncTime</b>(<i>deviceType, hasCPy=False</i>) | |
| 1371 | |
| 1372 <p> | |
| 1373 Public method to set the time of the connected device to the local | |
| 1374 computer's time. | |
| 1375 </p> | |
| 1376 <dl> | |
| 1377 | |
| 1378 <dt><i>deviceType</i> (str)</dt> | |
| 1379 <dd> | |
| 1380 type of board to sync time to | |
| 1381 </dd> | |
| 1382 <dt><i>hasCPy</i> (bool)</dt> | |
| 1383 <dd> | |
| 1384 flag indicating that the device has CircuitPython loadede | |
| 1385 (defaults to False) | |
| 1386 </dd> | |
| 1387 </dl> | |
| 1388 <dl> | |
| 1389 | |
| 1390 <dt>Raises <b>OSError</b>:</dt> | |
| 1391 <dd> | |
| 1392 raised to indicate an issue with the device | |
| 1393 </dd> | |
| 1394 </dl> | |
| 711 <div align="right"><a href="#top">Up</a></div> | 1395 <div align="right"><a href="#top">Up</a></div> |
| 712 <hr /> | 1396 <hr /> |
| 713 </body></html> | 1397 </body></html> |
