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

branch
eric7
changeset 9766
f0e22f3a5878
parent 9765
6378da868bb0
child 9799
a79430a8811d
child 9804
b7e200d35be9
diff -r 6378da868bb0 -r f0e22f3a5878 src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html
--- a/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Tue Feb 14 18:10:30 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MicroPython.Devices.DeviceBase.html	Wed Feb 15 15:55:37 2023 +0100
@@ -39,6 +39,41 @@
 <p>
     Base class for the more specific MicroPython devices.
 </p>
+<p>
+    It includes a list of commands for general use on the various boards.
+    If a board needs special treatment, the command should be overwritten
+    in the board specific subclass. Commands are provided to perform operations
+    on the file system of a connected MicroPython device, for getting and setting
+    the time on the board and getting board related data. Supported file system
+    commands are:
+    <ul>
+    <li>ls: directory listing</li>
+    <li>lls: directory listing with meta data</li>
+    <li>cd: change directory</li>
+    <li>pwd: get the current directory</li>
+    <li>put: copy a file to the connected device</li>
+    <li>putData: write data to a file of the connected device</li>
+    <li>get: get a file from the connected device</li>
+    <li>getData: read data of a file of the connected device</li>
+    <li>rm: remove a file from the connected device</li>
+    <li>rmrf: remove a file/directory recursively (like 'rm -rf' in bash)
+    <li>mkdir: create a new directory</li>
+    <li>rmdir: remove an empty directory</li>
+    <li>fileSystemInfo: get information about the file system
+    </ul>
+</p>
+<p>
+    Supported non file system commands are:
+    <ul>
+    <li>getBoardData: get information about the connected board</li>
+    <li>getDeviceData: get version info about MicroPython and some implementation
+        information</li>
+    <li>getModules: get a list of built-in modules</li>
+    <li>getTime: get the current time</li>
+    <li>syncTime: synchronize the time of the connected device</li>
+    <li>showTime: show the current time of the connected device</li>
+    </ul>
+</p>
 <h3>Derived from</h3>
 QObject
 <h3>Class Attributes</h3>

eric ide

mercurial