Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonDevices.html
src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonDevices.html
- branch
- eric7
- changeset 9753
- a774e75a45ca
- parent 9747
- b7976868d5b0
equal
deleted
inserted
replaced
| 9752:2b9546c0cbd9 | 9753:a774e75a45ca |
|---|---|
| 94 <tr> | 94 <tr> |
| 95 <td><a href="#MicroPythonDevice.canStartRepl">canStartRepl</a></td> | 95 <td><a href="#MicroPythonDevice.canStartRepl">canStartRepl</a></td> |
| 96 <td>Public method to determine, if a REPL can be started.</td> | 96 <td>Public method to determine, if a REPL can be started.</td> |
| 97 </tr> | 97 </tr> |
| 98 <tr> | 98 <tr> |
| 99 <td><a href="#MicroPythonDevice.checkDeviceData">checkDeviceData</a></td> | |
| 100 <td>Public method to check the validity of the device data determined during connecting the device.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 99 <td><a href="#MicroPythonDevice.deviceName">deviceName</a></td> | 103 <td><a href="#MicroPythonDevice.deviceName">deviceName</a></td> |
| 100 <td>Public method to get the name of the device.</td> | 104 <td>Public method to get the name of the device.</td> |
| 101 </tr> | 105 </tr> |
| 102 <tr> | 106 <tr> |
| 103 <td><a href="#MicroPythonDevice.downloadFirmware">downloadFirmware</a></td> | 107 <td><a href="#MicroPythonDevice.downloadFirmware">downloadFirmware</a></td> |
| 106 <tr> | 110 <tr> |
| 107 <td><a href="#MicroPythonDevice.forceInterrupt">forceInterrupt</a></td> | 111 <td><a href="#MicroPythonDevice.forceInterrupt">forceInterrupt</a></td> |
| 108 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | 112 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
| 109 </tr> | 113 </tr> |
| 110 <tr> | 114 <tr> |
| 115 <td><a href="#MicroPythonDevice.getDeviceData">getDeviceData</a></td> | |
| 116 <td>Public method to get a copy of the determined device data.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 111 <td><a href="#MicroPythonDevice.getDeviceType">getDeviceType</a></td> | 119 <td><a href="#MicroPythonDevice.getDeviceType">getDeviceType</a></td> |
| 112 <td>Public method to get the device type.</td> | 120 <td>Public method to get the device type.</td> |
| 113 </tr> | 121 </tr> |
| 114 <tr> | 122 <tr> |
| 115 <td><a href="#MicroPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> | 123 <td><a href="#MicroPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
| 160 <td>Public method to send a list of commands to the device.</td> | 168 <td>Public method to send a list of commands to the device.</td> |
| 161 </tr> | 169 </tr> |
| 162 <tr> | 170 <tr> |
| 163 <td><a href="#MicroPythonDevice.setButtons">setButtons</a></td> | 171 <td><a href="#MicroPythonDevice.setButtons">setButtons</a></td> |
| 164 <td>Public method to enable the supported action buttons.</td> | 172 <td>Public method to enable the supported action buttons.</td> |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#MicroPythonDevice.setConnected">setConnected</a></td> | |
| 176 <td>Public method to set the connection state.</td> | |
| 165 </tr> | 177 </tr> |
| 166 <tr> | 178 <tr> |
| 167 <td><a href="#MicroPythonDevice.setFileManager">setFileManager</a></td> | 179 <td><a href="#MicroPythonDevice.setFileManager">setFileManager</a></td> |
| 168 <td>Public method to set the File Manager status and dependent status.</td> | 180 <td>Public method to set the File Manager status and dependent status.</td> |
| 169 </tr> | 181 </tr> |
| 300 <dt>Return Type:</dt> | 312 <dt>Return Type:</dt> |
| 301 <dd> | 313 <dd> |
| 302 tuple of (bool, str) | 314 tuple of (bool, str) |
| 303 </dd> | 315 </dd> |
| 304 </dl> | 316 </dl> |
| 317 <a NAME="MicroPythonDevice.checkDeviceData" ID="MicroPythonDevice.checkDeviceData"></a> | |
| 318 <h4>MicroPythonDevice.checkDeviceData</h4> | |
| 319 <b>checkDeviceData</b>(<i></i>) | |
| 320 | |
| 321 <p> | |
| 322 Public method to check the validity of the device data determined during | |
| 323 connecting the device. | |
| 324 </p> | |
| 325 <dl> | |
| 326 <dt>Return:</dt> | |
| 327 <dd> | |
| 328 flag indicating valid device data | |
| 329 </dd> | |
| 330 </dl> | |
| 331 <dl> | |
| 332 <dt>Return Type:</dt> | |
| 333 <dd> | |
| 334 bool | |
| 335 </dd> | |
| 336 </dl> | |
| 305 <a NAME="MicroPythonDevice.deviceName" ID="MicroPythonDevice.deviceName"></a> | 337 <a NAME="MicroPythonDevice.deviceName" ID="MicroPythonDevice.deviceName"></a> |
| 306 <h4>MicroPythonDevice.deviceName</h4> | 338 <h4>MicroPythonDevice.deviceName</h4> |
| 307 <b>deviceName</b>(<i></i>) | 339 <b>deviceName</b>(<i></i>) |
| 308 | 340 |
| 309 <p> | 341 <p> |
| 346 <dt>Return Type:</dt> | 378 <dt>Return Type:</dt> |
| 347 <dd> | 379 <dd> |
| 348 bool | 380 bool |
| 349 </dd> | 381 </dd> |
| 350 </dl> | 382 </dl> |
| 383 <a NAME="MicroPythonDevice.getDeviceData" ID="MicroPythonDevice.getDeviceData"></a> | |
| 384 <h4>MicroPythonDevice.getDeviceData</h4> | |
| 385 <b>getDeviceData</b>(<i></i>) | |
| 386 | |
| 387 <p> | |
| 388 Public method to get a copy of the determined device data. | |
| 389 </p> | |
| 390 <dl> | |
| 391 <dt>Return:</dt> | |
| 392 <dd> | |
| 393 dictionary containing the essential device data | |
| 394 </dd> | |
| 395 </dl> | |
| 396 <dl> | |
| 397 <dt>Return Type:</dt> | |
| 398 <dd> | |
| 399 dict | |
| 400 </dd> | |
| 401 </dl> | |
| 351 <a NAME="MicroPythonDevice.getDeviceType" ID="MicroPythonDevice.getDeviceType"></a> | 402 <a NAME="MicroPythonDevice.getDeviceType" ID="MicroPythonDevice.getDeviceType"></a> |
| 352 <h4>MicroPythonDevice.getDeviceType</h4> | 403 <h4>MicroPythonDevice.getDeviceType</h4> |
| 353 <b>getDeviceType</b>(<i></i>) | 404 <b>getDeviceType</b>(<i></i>) |
| 354 | 405 |
| 355 <p> | 406 <p> |
| 592 <b>setButtons</b>(<i></i>) | 643 <b>setButtons</b>(<i></i>) |
| 593 | 644 |
| 594 <p> | 645 <p> |
| 595 Public method to enable the supported action buttons. | 646 Public method to enable the supported action buttons. |
| 596 </p> | 647 </p> |
| 648 <a NAME="MicroPythonDevice.setConnected" ID="MicroPythonDevice.setConnected"></a> | |
| 649 <h4>MicroPythonDevice.setConnected</h4> | |
| 650 <b>setConnected</b>(<i>connected</i>) | |
| 651 | |
| 652 <p> | |
| 653 Public method to set the connection state. | |
| 654 </p> | |
| 655 <p> | |
| 656 Note: This method can be overwritten to perform actions upon connect | |
| 657 or disconnect of the device. | |
| 658 </p> | |
| 659 <dl> | |
| 660 | |
| 661 <dt><i>connected</i> (bool)</dt> | |
| 662 <dd> | |
| 663 connection state | |
| 664 </dd> | |
| 665 </dl> | |
| 597 <a NAME="MicroPythonDevice.setFileManager" ID="MicroPythonDevice.setFileManager"></a> | 666 <a NAME="MicroPythonDevice.setFileManager" ID="MicroPythonDevice.setFileManager"></a> |
| 598 <h4>MicroPythonDevice.setFileManager</h4> | 667 <h4>MicroPythonDevice.setFileManager</h4> |
| 599 <b>setFileManager</b>(<i>on</i>) | 668 <b>setFileManager</b>(<i>on</i>) |
| 600 | 669 |
| 601 <p> | 670 <p> |
| 658 <div align="right"><a href="#top">Up</a></div> | 727 <div align="right"><a href="#top">Up</a></div> |
| 659 <hr /> | 728 <hr /> |
| 660 <hr /> | 729 <hr /> |
| 661 <a NAME="getDevice" ID="getDevice"></a> | 730 <a NAME="getDevice" ID="getDevice"></a> |
| 662 <h2>getDevice</h2> | 731 <h2>getDevice</h2> |
| 663 <b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName=""</i>) | 732 <b>getDevice</b>(<i>deviceType, microPythonWidget, vid, pid, boardName="", serialNumber=""</i>) |
| 664 | 733 |
| 665 <p> | 734 <p> |
| 666 Public method to instantiate a specific MicroPython device interface. | 735 Public method to instantiate a specific MicroPython device interface. |
| 667 </p> | 736 </p> |
| 668 <dl> | 737 <dl> |
| 684 product ID (only used for deviceType 'generic') | 753 product ID (only used for deviceType 'generic') |
| 685 </dd> | 754 </dd> |
| 686 <dt><i>boardName</i> (str (optional))</dt> | 755 <dt><i>boardName</i> (str (optional))</dt> |
| 687 <dd> | 756 <dd> |
| 688 name of the board (defaults to "") | 757 name of the board (defaults to "") |
| 758 </dd> | |
| 759 <dt><i>serialNumber</i> (str (optional))</dt> | |
| 760 <dd> | |
| 761 serial number of the board (defaults to "") | |
| 689 </dd> | 762 </dd> |
| 690 </dl> | 763 </dl> |
| 691 <dl> | 764 <dl> |
| 692 <dt>Return:</dt> | 765 <dt>Return:</dt> |
| 693 <dd> | 766 <dd> |
