src/eric7/Documentation/Source/eric7.MicroPython.MicroPythonCommandsInterface.html

branch
eric7
changeset 9760
11245ac9c258
parent 9753
a774e75a45ca
equal deleted inserted replaced
9759:4543b7876047 9760:11245ac9c258
144 <tr> 144 <tr>
145 <td><a href="#MicroPythonCommandsInterface.getBoardInformation">getBoardInformation</a></td> 145 <td><a href="#MicroPythonCommandsInterface.getBoardInformation">getBoardInformation</a></td>
146 <td>Public method to get some information data of the connected board.</td> 146 <td>Public method to get some information data of the connected board.</td>
147 </tr> 147 </tr>
148 <tr> 148 <tr>
149 <td><a href="#MicroPythonCommandsInterface.getData">getData</a></td>
150 <td>Public method to read data from the connected device.</td>
151 </tr>
152 <tr>
149 <td><a href="#MicroPythonCommandsInterface.getDeviceData">getDeviceData</a></td> 153 <td><a href="#MicroPythonCommandsInterface.getDeviceData">getDeviceData</a></td>
150 <td>Public method to get some essential data for the connected board.</td> 154 <td>Public method to get some essential data for the connected board.</td>
151 </tr> 155 </tr>
152 <tr> 156 <tr>
153 <td><a href="#MicroPythonCommandsInterface.getModules">getModules</a></td> 157 <td><a href="#MicroPythonCommandsInterface.getModules">getModules</a></td>
182 <td>Public method to check the device is responding.</td> 186 <td>Public method to check the device is responding.</td>
183 </tr> 187 </tr>
184 <tr> 188 <tr>
185 <td><a href="#MicroPythonCommandsInterface.put">put</a></td> 189 <td><a href="#MicroPythonCommandsInterface.put">put</a></td>
186 <td>Public method to copy a local file to the connected device.</td> 190 <td>Public method to copy a local file to the connected device.</td>
191 </tr>
192 <tr>
193 <td><a href="#MicroPythonCommandsInterface.putData">putData</a></td>
194 <td>Public method to write the given data to the connected device.</td>
187 </tr> 195 </tr>
188 <tr> 196 <tr>
189 <td><a href="#MicroPythonCommandsInterface.pwd">pwd</a></td> 197 <td><a href="#MicroPythonCommandsInterface.pwd">pwd</a></td>
190 <td>Public method to get the current directory of the connected device.</td> 198 <td>Public method to get the current directory of the connected device.</td>
191 </tr> 199 </tr>
471 </dl> 479 </dl>
472 <dl> 480 <dl>
473 <dt>Return Type:</dt> 481 <dt>Return Type:</dt>
474 <dd> 482 <dd>
475 dict 483 dict
484 </dd>
485 </dl>
486 <dl>
487
488 <dt>Raises <b>OSError</b>:</dt>
489 <dd>
490 raised to indicate an issue with the device
491 </dd>
492 </dl>
493 <a NAME="MicroPythonCommandsInterface.getData" ID="MicroPythonCommandsInterface.getData"></a>
494 <h4>MicroPythonCommandsInterface.getData</h4>
495 <b>getData</b>(<i>deviceFileName</i>)
496
497 <p>
498 Public method to read data from the connected device.
499 </p>
500 <dl>
501
502 <dt><i>deviceFileName</i> (str)</dt>
503 <dd>
504 name of the file to read from
505 </dd>
506 </dl>
507 <dl>
508 <dt>Return:</dt>
509 <dd>
510 data read from the device
511 </dd>
512 </dl>
513 <dl>
514 <dt>Return Type:</dt>
515 <dd>
516 bytes
476 </dd> 517 </dd>
477 </dl> 518 </dl>
478 <dl> 519 <dl>
479 520
480 <dt>Raises <b>OSError</b>:</dt> 521 <dt>Raises <b>OSError</b>:</dt>
743 <dt>Raises <b>OSError</b>:</dt> 784 <dt>Raises <b>OSError</b>:</dt>
744 <dd> 785 <dd>
745 raised to indicate an issue with the device 786 raised to indicate an issue with the device
746 </dd> 787 </dd>
747 </dl> 788 </dl>
789 <a NAME="MicroPythonCommandsInterface.putData" ID="MicroPythonCommandsInterface.putData"></a>
790 <h4>MicroPythonCommandsInterface.putData</h4>
791 <b>putData</b>(<i>deviceFileName, content</i>)
792
793 <p>
794 Public method to write the given data to the connected device.
795 </p>
796 <dl>
797
798 <dt><i>deviceFileName</i> (str)</dt>
799 <dd>
800 name of the file to write to
801 </dd>
802 <dt><i>content</i> (bytes)</dt>
803 <dd>
804 data to write
805 </dd>
806 </dl>
807 <dl>
808 <dt>Return:</dt>
809 <dd>
810 flag indicating success
811 </dd>
812 </dl>
813 <dl>
814 <dt>Return Type:</dt>
815 <dd>
816 bool
817 </dd>
818 </dl>
819 <dl>
820
821 <dt>Raises <b>OSError</b>:</dt>
822 <dd>
823 raised to indicate an issue with the device
824 </dd>
825 </dl>
748 <a NAME="MicroPythonCommandsInterface.pwd" ID="MicroPythonCommandsInterface.pwd"></a> 826 <a NAME="MicroPythonCommandsInterface.pwd" ID="MicroPythonCommandsInterface.pwd"></a>
749 <h4>MicroPythonCommandsInterface.pwd</h4> 827 <h4>MicroPythonCommandsInterface.pwd</h4>
750 <b>pwd</b>(<i></i>) 828 <b>pwd</b>(<i></i>)
751 829
752 <p> 830 <p>

eric ide

mercurial