src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html

branch
eric7
changeset 11186
c2d18aefef6b
parent 11167
a3f5af773bc7
child 11190
f5ffdf0164ab
equal deleted inserted replaced
11185:a6f70425f5be 11186:c2d18aefef6b
145 <tr> 145 <tr>
146 <td><a href="#BaseDevice.__getDeviceData">__getDeviceData</a></td> 146 <td><a href="#BaseDevice.__getDeviceData">__getDeviceData</a></td>
147 <td>Private method to get some essential data for the connected board.</td> 147 <td>Private method to get some essential data for the connected board.</td>
148 </tr> 148 </tr>
149 <tr> 149 <tr>
150 <td><a href="#BaseDevice._boardInformationCommands">_boardInformationCommands</a></td>
151 <td>Protected method defining the list of commands to be execute on the board for determining information about the board.</td>
152 </tr>
153 <tr>
150 <td><a href="#BaseDevice._getSetTimeCode">_getSetTimeCode</a></td> 154 <td><a href="#BaseDevice._getSetTimeCode">_getSetTimeCode</a></td>
151 <td>Protected method to get the device code to set the time.</td> 155 <td>Protected method to get the device code to set the time.</td>
152 </tr> 156 </tr>
153 <tr> 157 <tr>
154 <td><a href="#BaseDevice._shortError">_shortError</a></td> 158 <td><a href="#BaseDevice._shortError">_shortError</a></td>
389 <tr> 393 <tr>
390 <td><a href="#BaseDevice.isLanConnected">isLanConnected</a></td> 394 <td><a href="#BaseDevice.isLanConnected">isLanConnected</a></td>
391 <td>Public method to check the LAN connection status.</td> 395 <td>Public method to check the LAN connection status.</td>
392 </tr> 396 </tr>
393 <tr> 397 <tr>
398 <td><a href="#BaseDevice.isMicrobit">isMicrobit</a></td>
399 <td>Public method to check, if the device is a BBC micro:bit or Calliope mini.</td>
400 </tr>
401 <tr>
394 <td><a href="#BaseDevice.isNetworkConnected">isNetworkConnected</a></td> 402 <td><a href="#BaseDevice.isNetworkConnected">isNetworkConnected</a></td>
395 <td>Public method to check, if the network interface (WiFi or Ethernet) is connected.</td> 403 <td>Public method to check, if the network interface (WiFi or Ethernet) is connected.</td>
396 </tr> 404 </tr>
397 <tr> 405 <tr>
398 <td><a href="#BaseDevice.isWifiApConnected">isWifiApConnected</a></td> 406 <td><a href="#BaseDevice.isWifiApConnected">isWifiApConnected</a></td>
513 <tr> 521 <tr>
514 <td><a href="#BaseDevice.supportsDeviceScan">supportsDeviceScan</a></td> 522 <td><a href="#BaseDevice.supportsDeviceScan">supportsDeviceScan</a></td>
515 <td>Public method to indicate, that the Bluetooth implementation supports scanning for devices.</td> 523 <td>Public method to indicate, that the Bluetooth implementation supports scanning for devices.</td>
516 </tr> 524 </tr>
517 <tr> 525 <tr>
526 <td><a href="#BaseDevice.supportsDirectories">supportsDirectories</a></td>
527 <td>Public method to check, if the device supports directory operations.</td>
528 </tr>
529 <tr>
518 <td><a href="#BaseDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> 530 <td><a href="#BaseDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td>
519 <td>Public method to indicate file access via a local directory.</td> 531 <td>Public method to indicate file access via a local directory.</td>
532 </tr>
533 <tr>
534 <td><a href="#BaseDevice.supportsRenameFiles">supportsRenameFiles</a></td>
535 <td>Public method to check, if the device supports renaming of files.</td>
520 </tr> 536 </tr>
521 <tr> 537 <tr>
522 <td><a href="#BaseDevice.syncTime">syncTime</a></td> 538 <td><a href="#BaseDevice.syncTime">syncTime</a></td>
523 <td>Public method to set the time of the connected device to the local computer's time.</td> 539 <td>Public method to set the time of the connected device to the local computer's time.</td>
524 </tr> 540 </tr>
588 <dt>Raises <b>OSError</b>:</dt> 604 <dt>Raises <b>OSError</b>:</dt>
589 <dd> 605 <dd>
590 raised to indicate an issue with the device 606 raised to indicate an issue with the device
591 </dd> 607 </dd>
592 </dl> 608 </dl>
609 <a NAME="BaseDevice._boardInformationCommands" ID="BaseDevice._boardInformationCommands"></a>
610 <h4>BaseDevice._boardInformationCommands</h4>
611 <b>_boardInformationCommands</b>(<i></i>)
612 <p>
613 Protected method defining the list of commands to be execute on the board
614 for determining information about the board.
615 </p>
616
617 <dl>
618 <dt>Return:</dt>
619 <dd>
620 list of command strings to be executed
621 </dd>
622 </dl>
623 <dl>
624 <dt>Return Type:</dt>
625 <dd>
626 list of str
627 </dd>
628 </dl>
593 <a NAME="BaseDevice._getSetTimeCode" ID="BaseDevice._getSetTimeCode"></a> 629 <a NAME="BaseDevice._getSetTimeCode" ID="BaseDevice._getSetTimeCode"></a>
594 <h4>BaseDevice._getSetTimeCode</h4> 630 <h4>BaseDevice._getSetTimeCode</h4>
595 <b>_getSetTimeCode</b>(<i></i>) 631 <b>_getSetTimeCode</b>(<i></i>)
596 <p> 632 <p>
597 Protected method to get the device code to set the time. 633 Protected method to get the device code to set the time.
1907 1943
1908 <dl> 1944 <dl>
1909 <dt>Return:</dt> 1945 <dt>Return:</dt>
1910 <dd> 1946 <dd>
1911 flag indicating that the device is connected to the LAN 1947 flag indicating that the device is connected to the LAN
1948 </dd>
1949 </dl>
1950 <dl>
1951 <dt>Return Type:</dt>
1952 <dd>
1953 bool
1954 </dd>
1955 </dl>
1956 <a NAME="BaseDevice.isMicrobit" ID="BaseDevice.isMicrobit"></a>
1957 <h4>BaseDevice.isMicrobit</h4>
1958 <b>isMicrobit</b>(<i></i>)
1959 <p>
1960 Public method to check, if the device is a BBC micro:bit or Calliope mini.
1961 </p>
1962
1963 <dl>
1964 <dt>Return:</dt>
1965 <dd>
1966 flag indicating a micro:bit device
1912 </dd> 1967 </dd>
1913 </dl> 1968 </dl>
1914 <dl> 1969 <dl>
1915 <dt>Return Type:</dt> 1970 <dt>Return Type:</dt>
1916 <dd> 1971 <dd>
2657 <dt>Return Type:</dt> 2712 <dt>Return Type:</dt>
2658 <dd> 2713 <dd>
2659 bool 2714 bool
2660 </dd> 2715 </dd>
2661 </dl> 2716 </dl>
2717 <a NAME="BaseDevice.supportsDirectories" ID="BaseDevice.supportsDirectories"></a>
2718 <h4>BaseDevice.supportsDirectories</h4>
2719 <b>supportsDirectories</b>(<i></i>)
2720 <p>
2721 Public method to check, if the device supports directory operations.
2722 </p>
2723
2724 <dl>
2725 <dt>Return:</dt>
2726 <dd>
2727 flag indicating directory operations are supported
2728 </dd>
2729 </dl>
2730 <dl>
2731 <dt>Return Type:</dt>
2732 <dd>
2733 bool
2734 </dd>
2735 </dl>
2662 <a NAME="BaseDevice.supportsLocalFileAccess" ID="BaseDevice.supportsLocalFileAccess"></a> 2736 <a NAME="BaseDevice.supportsLocalFileAccess" ID="BaseDevice.supportsLocalFileAccess"></a>
2663 <h4>BaseDevice.supportsLocalFileAccess</h4> 2737 <h4>BaseDevice.supportsLocalFileAccess</h4>
2664 <b>supportsLocalFileAccess</b>(<i></i>) 2738 <b>supportsLocalFileAccess</b>(<i></i>)
2665 <p> 2739 <p>
2666 Public method to indicate file access via a local directory. 2740 Public method to indicate file access via a local directory.
2676 <dt>Return Type:</dt> 2750 <dt>Return Type:</dt>
2677 <dd> 2751 <dd>
2678 bool 2752 bool
2679 </dd> 2753 </dd>
2680 </dl> 2754 </dl>
2755 <a NAME="BaseDevice.supportsRenameFiles" ID="BaseDevice.supportsRenameFiles"></a>
2756 <h4>BaseDevice.supportsRenameFiles</h4>
2757 <b>supportsRenameFiles</b>(<i></i>)
2758 <p>
2759 Public method to check, if the device supports renaming of files.
2760 </p>
2761
2762 <dl>
2763 <dt>Return:</dt>
2764 <dd>
2765 flag indicating renaming of files are supported
2766 </dd>
2767 </dl>
2768 <dl>
2769 <dt>Return Type:</dt>
2770 <dd>
2771 bool
2772 </dd>
2773 </dl>
2681 <a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a> 2774 <a NAME="BaseDevice.syncTime" ID="BaseDevice.syncTime"></a>
2682 <h4>BaseDevice.syncTime</h4> 2775 <h4>BaseDevice.syncTime</h4>
2683 <b>syncTime</b>(<i>_deviceType, hasCPy=False</i>) 2776 <b>syncTime</b>(<i>_deviceType, hasCPy=False</i>)
2684 <p> 2777 <p>
2685 Public method to set the time of the connected device to the local 2778 Public method to set the time of the connected device to the local

eric ide

mercurial