Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.MicroPython.MicroPythonCommandsInterface.html

eric6/Documentation/Source/eric6.MicroPython.MicroPythonCommandsInterface.html

changeset 7273
391d6b7b1eff
parent 7145
ceb3e8b242c1
child 7846
4dfa18ef5acd
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.MicroPython.MicroPythonCommandsInterface</h1> 23 <h1>eric6.MicroPython.MicroPythonCommandsInterface</h1>
24
23 <p> 25 <p>
24 Module implementing some file system commands for MicroPython. 26 Module implementing some file system commands for MicroPython.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#MicroPythonCommandsInterface">MicroPythonCommandsInterface</a></td> 38 <td><a href="#MicroPythonCommandsInterface">MicroPythonCommandsInterface</a></td>
34 <td>Class implementing some file system commands for MicroPython.</td> 39 <td>Class implementing some file system commands for MicroPython.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="MicroPythonCommandsInterface" ID="MicroPythonCommandsInterface"></a> 49 <a NAME="MicroPythonCommandsInterface" ID="MicroPythonCommandsInterface"></a>
43 <h2>MicroPythonCommandsInterface</h2> 50 <h2>MicroPythonCommandsInterface</h2>
51
44 <p> 52 <p>
45 Class implementing some file system commands for MicroPython. 53 Class implementing some file system commands for MicroPython.
46 </p><p> 54 </p>
55 <p>
47 Commands are provided to perform operations on the file system of a 56 Commands are provided to perform operations on the file system of a
48 connected MicroPython device. Supported commands are: 57 connected MicroPython device. Supported commands are:
49 <ul> 58 <ul>
50 <li>ls: directory listing</li> 59 <li>ls: directory listing</li>
51 <li>lls: directory listing with meta data</li> 60 <li>lls: directory listing with meta data</li>
56 <li>rm: remove a file from the connected device</li> 65 <li>rm: remove a file from the connected device</li>
57 <li>rmrf: remove a file/directory recursively (like 'rm -rf' in bash) 66 <li>rmrf: remove a file/directory recursively (like 'rm -rf' in bash)
58 <li>mkdir: create a new directory</li> 67 <li>mkdir: create a new directory</li>
59 <li>rmdir: remove an empty directory</li> 68 <li>rmdir: remove an empty directory</li>
60 </ul> 69 </ul>
61 </p><p> 70 </p>
71 <p>
62 There are additional commands related to time and version. 72 There are additional commands related to time and version.
63 <ul> 73 <ul>
64 <li>version: get version info about MicroPython</li> 74 <li>version: get version info about MicroPython</li>
65 <li>getImplementation: get some implementation information</li> 75 <li>getImplementation: get some implementation information</li>
66 <li>syncTime: synchronize the time of the connected device</li> 76 <li>syncTime: synchronize the time of the connected device</li>
67 <li>showTime: show the current time of the connected device</li> 77 <li>showTime: show the current time of the connected device</li>
68 </ul> 78 </ul>
69 </p><h3>Signals</h3> 79 </p>
70 <dl> 80 <h3>Signals</h3>
81 <dl>
82
71 <dt>dataReceived(data)</dt> 83 <dt>dataReceived(data)</dt>
72 <dd> 84 <dd>
73 emitted to send data received via the serial 85 emitted to send data received via the serial
74 connection for further processing 86 connection for further processing
75 </dd><dt>executeAsyncFinished()</dt> 87 </dd>
88 <dt>executeAsyncFinished()</dt>
76 <dd> 89 <dd>
77 emitted to indicate the end of an 90 emitted to indicate the end of an
78 asynchronously executed list of commands (e.g. a script) 91 asynchronously executed list of commands (e.g. a script)
79 </dd> 92 </dd>
80 </dl> 93 </dl>
81 <h3>Derived from</h3> 94 <h3>Derived from</h3>
82 QObject 95 QObject
83 <h3>Class Attributes</h3> 96 <h3>Class Attributes</h3>
97
84 <table> 98 <table>
85 <tr><td>None</td></tr> 99 <tr><td>None</td></tr>
86 </table> 100 </table>
87 <h3>Class Methods</h3> 101 <h3>Class Methods</h3>
102
88 <table> 103 <table>
89 <tr><td>None</td></tr> 104 <tr><td>None</td></tr>
90 </table> 105 </table>
91 <h3>Methods</h3> 106 <h3>Methods</h3>
107
92 <table> 108 <table>
109
93 <tr> 110 <tr>
94 <td><a href="#MicroPythonCommandsInterface.__init__">MicroPythonCommandsInterface</a></td> 111 <td><a href="#MicroPythonCommandsInterface.__init__">MicroPythonCommandsInterface</a></td>
95 <td>Constructor</td> 112 <td>Constructor</td>
96 </tr><tr> 113 </tr>
114 <tr>
97 <td><a href="#MicroPythonCommandsInterface.__rawOff">__rawOff</a></td> 115 <td><a href="#MicroPythonCommandsInterface.__rawOff">__rawOff</a></td>
98 <td>Private method to switch 'raw' mode off.</td> 116 <td>Private method to switch 'raw' mode off.</td>
99 </tr><tr> 117 </tr>
118 <tr>
100 <td><a href="#MicroPythonCommandsInterface.__rawOn">__rawOn</a></td> 119 <td><a href="#MicroPythonCommandsInterface.__rawOn">__rawOn</a></td>
101 <td>Private method to switch the connected device to 'raw' mode.</td> 120 <td>Private method to switch the connected device to 'raw' mode.</td>
102 </tr><tr> 121 </tr>
122 <tr>
103 <td><a href="#MicroPythonCommandsInterface.__readSerial">__readSerial</a></td> 123 <td><a href="#MicroPythonCommandsInterface.__readSerial">__readSerial</a></td>
104 <td>Private slot to read all available serial data and emit it with the "dataReceived" signal for further processing.</td> 124 <td>Private slot to read all available serial data and emit it with the "dataReceived" signal for further processing.</td>
105 </tr><tr> 125 </tr>
126 <tr>
106 <td><a href="#MicroPythonCommandsInterface.__shortError">__shortError</a></td> 127 <td><a href="#MicroPythonCommandsInterface.__shortError">__shortError</a></td>
107 <td>Private method to create a shortened error message.</td> 128 <td>Private method to create a shortened error message.</td>
108 </tr><tr> 129 </tr>
130 <tr>
109 <td><a href="#MicroPythonCommandsInterface.cd">cd</a></td> 131 <td><a href="#MicroPythonCommandsInterface.cd">cd</a></td>
110 <td>Public method to change the current directory on the connected device.</td> 132 <td>Public method to change the current directory on the connected device.</td>
111 </tr><tr> 133 </tr>
134 <tr>
112 <td><a href="#MicroPythonCommandsInterface.connectToDevice">connectToDevice</a></td> 135 <td><a href="#MicroPythonCommandsInterface.connectToDevice">connectToDevice</a></td>
113 <td>Public slot to start the manager.</td> 136 <td>Public slot to start the manager.</td>
114 </tr><tr> 137 </tr>
138 <tr>
115 <td><a href="#MicroPythonCommandsInterface.disconnectFromDevice">disconnectFromDevice</a></td> 139 <td><a href="#MicroPythonCommandsInterface.disconnectFromDevice">disconnectFromDevice</a></td>
116 <td>Public slot to stop the thread.</td> 140 <td>Public slot to stop the thread.</td>
117 </tr><tr> 141 </tr>
142 <tr>
118 <td><a href="#MicroPythonCommandsInterface.execute">execute</a></td> 143 <td><a href="#MicroPythonCommandsInterface.execute">execute</a></td>
119 <td>Public method to send commands to the connected device and return the result.</td> 144 <td>Public method to send commands to the connected device and return the result.</td>
120 </tr><tr> 145 </tr>
146 <tr>
121 <td><a href="#MicroPythonCommandsInterface.executeAsync">executeAsync</a></td> 147 <td><a href="#MicroPythonCommandsInterface.executeAsync">executeAsync</a></td>
122 <td>Public method to execute a series of commands over a period of time without returning any result (asynchronous execution).</td> 148 <td>Public method to execute a series of commands over a period of time without returning any result (asynchronous execution).</td>
123 </tr><tr> 149 </tr>
150 <tr>
124 <td><a href="#MicroPythonCommandsInterface.fileSystemInfo">fileSystemInfo</a></td> 151 <td><a href="#MicroPythonCommandsInterface.fileSystemInfo">fileSystemInfo</a></td>
125 <td>Public method to obtain information about the currently mounted file systems.</td> 152 <td>Public method to obtain information about the currently mounted file systems.</td>
126 </tr><tr> 153 </tr>
154 <tr>
127 <td><a href="#MicroPythonCommandsInterface.get">get</a></td> 155 <td><a href="#MicroPythonCommandsInterface.get">get</a></td>
128 <td>Public method to copy a file from the connected device.</td> 156 <td>Public method to copy a file from the connected device.</td>
129 </tr><tr> 157 </tr>
158 <tr>
130 <td><a href="#MicroPythonCommandsInterface.getImplementation">getImplementation</a></td> 159 <td><a href="#MicroPythonCommandsInterface.getImplementation">getImplementation</a></td>
131 <td>Public method to get some implementation information of the connected device.</td> 160 <td>Public method to get some implementation information of the connected device.</td>
132 </tr><tr> 161 </tr>
162 <tr>
133 <td><a href="#MicroPythonCommandsInterface.getTime">getTime</a></td> 163 <td><a href="#MicroPythonCommandsInterface.getTime">getTime</a></td>
134 <td>Public method to get the current time of the device.</td> 164 <td>Public method to get the current time of the device.</td>
135 </tr><tr> 165 </tr>
166 <tr>
136 <td><a href="#MicroPythonCommandsInterface.handlePreferencesChanged">handlePreferencesChanged</a></td> 167 <td><a href="#MicroPythonCommandsInterface.handlePreferencesChanged">handlePreferencesChanged</a></td>
137 <td>Public slot to handle a change of the preferences.</td> 168 <td>Public slot to handle a change of the preferences.</td>
138 </tr><tr> 169 </tr>
170 <tr>
139 <td><a href="#MicroPythonCommandsInterface.isConnected">isConnected</a></td> 171 <td><a href="#MicroPythonCommandsInterface.isConnected">isConnected</a></td>
140 <td>Public method to get the connection status.</td> 172 <td>Public method to get the connection status.</td>
141 </tr><tr> 173 </tr>
174 <tr>
142 <td><a href="#MicroPythonCommandsInterface.lls">lls</a></td> 175 <td><a href="#MicroPythonCommandsInterface.lls">lls</a></td>
143 <td>Public method to get a long directory listing of the connected device including meta data.</td> 176 <td>Public method to get a long directory listing of the connected device including meta data.</td>
144 </tr><tr> 177 </tr>
178 <tr>
145 <td><a href="#MicroPythonCommandsInterface.ls">ls</a></td> 179 <td><a href="#MicroPythonCommandsInterface.ls">ls</a></td>
146 <td>Public method to get a directory listing of the connected device.</td> 180 <td>Public method to get a directory listing of the connected device.</td>
147 </tr><tr> 181 </tr>
182 <tr>
148 <td><a href="#MicroPythonCommandsInterface.mkdir">mkdir</a></td> 183 <td><a href="#MicroPythonCommandsInterface.mkdir">mkdir</a></td>
149 <td>Public method to create a new directory.</td> 184 <td>Public method to create a new directory.</td>
150 </tr><tr> 185 </tr>
186 <tr>
151 <td><a href="#MicroPythonCommandsInterface.put">put</a></td> 187 <td><a href="#MicroPythonCommandsInterface.put">put</a></td>
152 <td>Public method to copy a local file to the connected device.</td> 188 <td>Public method to copy a local file to the connected device.</td>
153 </tr><tr> 189 </tr>
190 <tr>
154 <td><a href="#MicroPythonCommandsInterface.pwd">pwd</a></td> 191 <td><a href="#MicroPythonCommandsInterface.pwd">pwd</a></td>
155 <td>Public method to get the current directory of the connected device.</td> 192 <td>Public method to get the current directory of the connected device.</td>
156 </tr><tr> 193 </tr>
194 <tr>
157 <td><a href="#MicroPythonCommandsInterface.remainingTask">remainingTask</a></td> 195 <td><a href="#MicroPythonCommandsInterface.remainingTask">remainingTask</a></td>
158 <td></td> 196 <td></td>
159 </tr><tr> 197 </tr>
198 <tr>
160 <td><a href="#MicroPythonCommandsInterface.rm">rm</a></td> 199 <td><a href="#MicroPythonCommandsInterface.rm">rm</a></td>
161 <td>Public method to remove a file from the connected device.</td> 200 <td>Public method to remove a file from the connected device.</td>
162 </tr><tr> 201 </tr>
202 <tr>
163 <td><a href="#MicroPythonCommandsInterface.rmdir">rmdir</a></td> 203 <td><a href="#MicroPythonCommandsInterface.rmdir">rmdir</a></td>
164 <td>Public method to remove a directory.</td> 204 <td>Public method to remove a directory.</td>
165 </tr><tr> 205 </tr>
206 <tr>
166 <td><a href="#MicroPythonCommandsInterface.rmrf">rmrf</a></td> 207 <td><a href="#MicroPythonCommandsInterface.rmrf">rmrf</a></td>
167 <td>Public method to remove a file or directory recursively.</td> 208 <td>Public method to remove a file or directory recursively.</td>
168 </tr><tr> 209 </tr>
210 <tr>
169 <td><a href="#MicroPythonCommandsInterface.syncTime">syncTime</a></td> 211 <td><a href="#MicroPythonCommandsInterface.syncTime">syncTime</a></td>
170 <td>Public method to set the time of the connected device to the local computer's time.</td> 212 <td>Public method to set the time of the connected device to the local computer's time.</td>
171 </tr><tr> 213 </tr>
214 <tr>
172 <td><a href="#MicroPythonCommandsInterface.version">version</a></td> 215 <td><a href="#MicroPythonCommandsInterface.version">version</a></td>
173 <td>Public method to get the MicroPython version information of the connected device.</td> 216 <td>Public method to get the MicroPython version information of the connected device.</td>
174 </tr><tr> 217 </tr>
218 <tr>
175 <td><a href="#MicroPythonCommandsInterface.write">write</a></td> 219 <td><a href="#MicroPythonCommandsInterface.write">write</a></td>
176 <td>Public method to write data to the connected device.</td> 220 <td>Public method to write data to the connected device.</td>
177 </tr> 221 </tr>
178 </table> 222 </table>
179 <h3>Static Methods</h3> 223 <h3>Static Methods</h3>
224
180 <table> 225 <table>
181 <tr><td>None</td></tr> 226 <tr><td>None</td></tr>
182 </table> 227 </table>
228
183 <a NAME="MicroPythonCommandsInterface.__init__" ID="MicroPythonCommandsInterface.__init__"></a> 229 <a NAME="MicroPythonCommandsInterface.__init__" ID="MicroPythonCommandsInterface.__init__"></a>
184 <h4>MicroPythonCommandsInterface (Constructor)</h4> 230 <h4>MicroPythonCommandsInterface (Constructor)</h4>
185 <b>MicroPythonCommandsInterface</b>(<i>parent=None</i>) 231 <b>MicroPythonCommandsInterface</b>(<i>parent=None</i>)
232
186 <p> 233 <p>
187 Constructor 234 Constructor
188 </p><dl> 235 </p>
236 <dl>
237
189 <dt><i>parent</i> (QObject)</dt> 238 <dt><i>parent</i> (QObject)</dt>
190 <dd> 239 <dd>
191 reference to the parent object 240 reference to the parent object
192 </dd> 241 </dd>
193 </dl><a NAME="MicroPythonCommandsInterface.__rawOff" ID="MicroPythonCommandsInterface.__rawOff"></a> 242 </dl>
243 <a NAME="MicroPythonCommandsInterface.__rawOff" ID="MicroPythonCommandsInterface.__rawOff"></a>
194 <h4>MicroPythonCommandsInterface.__rawOff</h4> 244 <h4>MicroPythonCommandsInterface.__rawOff</h4>
195 <b>__rawOff</b>(<i></i>) 245 <b>__rawOff</b>(<i></i>)
246
196 <p> 247 <p>
197 Private method to switch 'raw' mode off. 248 Private method to switch 'raw' mode off.
198 </p><a NAME="MicroPythonCommandsInterface.__rawOn" ID="MicroPythonCommandsInterface.__rawOn"></a> 249 </p>
250 <a NAME="MicroPythonCommandsInterface.__rawOn" ID="MicroPythonCommandsInterface.__rawOn"></a>
199 <h4>MicroPythonCommandsInterface.__rawOn</h4> 251 <h4>MicroPythonCommandsInterface.__rawOn</h4>
200 <b>__rawOn</b>(<i></i>) 252 <b>__rawOn</b>(<i></i>)
253
201 <p> 254 <p>
202 Private method to switch the connected device to 'raw' mode. 255 Private method to switch the connected device to 'raw' mode.
203 </p><p> 256 </p>
257 <p>
204 Note: switching to raw mode is done with synchronous writes. 258 Note: switching to raw mode is done with synchronous writes.
205 </p><dl> 259 </p>
260 <dl>
206 <dt>Returns:</dt> 261 <dt>Returns:</dt>
207 <dd> 262 <dd>
208 flag indicating success 263 flag indicating success
209 @rtype bool 264 @rtype bool
210 </dd> 265 </dd>
211 </dl><a NAME="MicroPythonCommandsInterface.__readSerial" ID="MicroPythonCommandsInterface.__readSerial"></a> 266 </dl>
267 <a NAME="MicroPythonCommandsInterface.__readSerial" ID="MicroPythonCommandsInterface.__readSerial"></a>
212 <h4>MicroPythonCommandsInterface.__readSerial</h4> 268 <h4>MicroPythonCommandsInterface.__readSerial</h4>
213 <b>__readSerial</b>(<i></i>) 269 <b>__readSerial</b>(<i></i>)
270
214 <p> 271 <p>
215 Private slot to read all available serial data and emit it with the 272 Private slot to read all available serial data and emit it with the
216 "dataReceived" signal for further processing. 273 "dataReceived" signal for further processing.
217 </p><a NAME="MicroPythonCommandsInterface.__shortError" ID="MicroPythonCommandsInterface.__shortError"></a> 274 </p>
275 <a NAME="MicroPythonCommandsInterface.__shortError" ID="MicroPythonCommandsInterface.__shortError"></a>
218 <h4>MicroPythonCommandsInterface.__shortError</h4> 276 <h4>MicroPythonCommandsInterface.__shortError</h4>
219 <b>__shortError</b>(<i>error</i>) 277 <b>__shortError</b>(<i>error</i>)
278
220 <p> 279 <p>
221 Private method to create a shortened error message. 280 Private method to create a shortened error message.
222 </p><dl> 281 </p>
282 <dl>
283
223 <dt><i>error</i> (bytes)</dt> 284 <dt><i>error</i> (bytes)</dt>
224 <dd> 285 <dd>
225 verbose error message 286 verbose error message
226 </dd> 287 </dd>
227 </dl><dl> 288 </dl>
289 <dl>
228 <dt>Returns:</dt> 290 <dt>Returns:</dt>
229 <dd> 291 <dd>
230 shortened error message 292 shortened error message
231 </dd> 293 </dd>
232 </dl><dl> 294 </dl>
295 <dl>
233 <dt>Return Type:</dt> 296 <dt>Return Type:</dt>
234 <dd> 297 <dd>
235 str 298 str
236 </dd> 299 </dd>
237 </dl><a NAME="MicroPythonCommandsInterface.cd" ID="MicroPythonCommandsInterface.cd"></a> 300 </dl>
301 <a NAME="MicroPythonCommandsInterface.cd" ID="MicroPythonCommandsInterface.cd"></a>
238 <h4>MicroPythonCommandsInterface.cd</h4> 302 <h4>MicroPythonCommandsInterface.cd</h4>
239 <b>cd</b>(<i>dirname</i>) 303 <b>cd</b>(<i>dirname</i>)
304
240 <p> 305 <p>
241 Public method to change the current directory on the connected device. 306 Public method to change the current directory on the connected device.
242 </p><dl> 307 </p>
308 <dl>
309
243 <dt><i>dirname</i> (str)</dt> 310 <dt><i>dirname</i> (str)</dt>
244 <dd> 311 <dd>
245 directory to change to 312 directory to change to
246 </dd> 313 </dd>
247 </dl><dl> 314 </dl>
248 <dt>Raises <b>IOError</b>:</dt> 315 <dl>
249 <dd> 316
250 raised to indicate an issue with the device 317 <dt>Raises <b>IOError</b>:</dt>
251 </dd> 318 <dd>
252 </dl><a NAME="MicroPythonCommandsInterface.connectToDevice" ID="MicroPythonCommandsInterface.connectToDevice"></a> 319 raised to indicate an issue with the device
320 </dd>
321 </dl>
322 <a NAME="MicroPythonCommandsInterface.connectToDevice" ID="MicroPythonCommandsInterface.connectToDevice"></a>
253 <h4>MicroPythonCommandsInterface.connectToDevice</h4> 323 <h4>MicroPythonCommandsInterface.connectToDevice</h4>
254 <b>connectToDevice</b>(<i>port</i>) 324 <b>connectToDevice</b>(<i>port</i>)
325
255 <p> 326 <p>
256 Public slot to start the manager. 327 Public slot to start the manager.
257 </p><dl> 328 </p>
329 <dl>
330
258 <dt><i>port</i> (str)</dt> 331 <dt><i>port</i> (str)</dt>
259 <dd> 332 <dd>
260 name of the port to be used 333 name of the port to be used
261 </dd> 334 </dd>
262 </dl><dl> 335 </dl>
336 <dl>
263 <dt>Returns:</dt> 337 <dt>Returns:</dt>
264 <dd> 338 <dd>
265 flag indicating success 339 flag indicating success
266 </dd> 340 </dd>
267 </dl><dl> 341 </dl>
342 <dl>
268 <dt>Return Type:</dt> 343 <dt>Return Type:</dt>
269 <dd> 344 <dd>
270 bool 345 bool
271 </dd> 346 </dd>
272 </dl><a NAME="MicroPythonCommandsInterface.disconnectFromDevice" ID="MicroPythonCommandsInterface.disconnectFromDevice"></a> 347 </dl>
348 <a NAME="MicroPythonCommandsInterface.disconnectFromDevice" ID="MicroPythonCommandsInterface.disconnectFromDevice"></a>
273 <h4>MicroPythonCommandsInterface.disconnectFromDevice</h4> 349 <h4>MicroPythonCommandsInterface.disconnectFromDevice</h4>
274 <b>disconnectFromDevice</b>(<i></i>) 350 <b>disconnectFromDevice</b>(<i></i>)
351
275 <p> 352 <p>
276 Public slot to stop the thread. 353 Public slot to stop the thread.
277 </p><a NAME="MicroPythonCommandsInterface.execute" ID="MicroPythonCommandsInterface.execute"></a> 354 </p>
355 <a NAME="MicroPythonCommandsInterface.execute" ID="MicroPythonCommandsInterface.execute"></a>
278 <h4>MicroPythonCommandsInterface.execute</h4> 356 <h4>MicroPythonCommandsInterface.execute</h4>
279 <b>execute</b>(<i>commands</i>) 357 <b>execute</b>(<i>commands</i>)
358
280 <p> 359 <p>
281 Public method to send commands to the connected device and return the 360 Public method to send commands to the connected device and return the
282 result. 361 result.
283 </p><p> 362 </p>
363 <p>
284 If no serial connection is available, empty results will be returned. 364 If no serial connection is available, empty results will be returned.
285 </p><dl> 365 </p>
366 <dl>
367
286 <dt><i>commands</i> (str)</dt> 368 <dt><i>commands</i> (str)</dt>
287 <dd> 369 <dd>
288 list of commands to be executed 370 list of commands to be executed
289 </dd> 371 </dd>
290 </dl><dl> 372 </dl>
373 <dl>
291 <dt>Returns:</dt> 374 <dt>Returns:</dt>
292 <dd> 375 <dd>
293 tuple containing stdout and stderr output of the device 376 tuple containing stdout and stderr output of the device
294 </dd> 377 </dd>
295 </dl><dl> 378 </dl>
379 <dl>
296 <dt>Return Type:</dt> 380 <dt>Return Type:</dt>
297 <dd> 381 <dd>
298 tuple of (bytes, bytes) 382 tuple of (bytes, bytes)
299 </dd> 383 </dd>
300 </dl><a NAME="MicroPythonCommandsInterface.executeAsync" ID="MicroPythonCommandsInterface.executeAsync"></a> 384 </dl>
385 <a NAME="MicroPythonCommandsInterface.executeAsync" ID="MicroPythonCommandsInterface.executeAsync"></a>
301 <h4>MicroPythonCommandsInterface.executeAsync</h4> 386 <h4>MicroPythonCommandsInterface.executeAsync</h4>
302 <b>executeAsync</b>(<i>commandsList</i>) 387 <b>executeAsync</b>(<i>commandsList</i>)
388
303 <p> 389 <p>
304 Public method to execute a series of commands over a period of time 390 Public method to execute a series of commands over a period of time
305 without returning any result (asynchronous execution). 391 without returning any result (asynchronous execution).
306 </p><dl> 392 </p>
393 <dl>
394
307 <dt><i>commandsList</i> (list of bytes)</dt> 395 <dt><i>commandsList</i> (list of bytes)</dt>
308 <dd> 396 <dd>
309 list of commands to be execute on the device 397 list of commands to be execute on the device
310 </dd> 398 </dd>
311 </dl><a NAME="MicroPythonCommandsInterface.fileSystemInfo" ID="MicroPythonCommandsInterface.fileSystemInfo"></a> 399 </dl>
400 <a NAME="MicroPythonCommandsInterface.fileSystemInfo" ID="MicroPythonCommandsInterface.fileSystemInfo"></a>
312 <h4>MicroPythonCommandsInterface.fileSystemInfo</h4> 401 <h4>MicroPythonCommandsInterface.fileSystemInfo</h4>
313 <b>fileSystemInfo</b>(<i></i>) 402 <b>fileSystemInfo</b>(<i></i>)
403
314 <p> 404 <p>
315 Public method to obtain information about the currently mounted file 405 Public method to obtain information about the currently mounted file
316 systems. 406 systems.
317 </p><dl> 407 </p>
408 <dl>
318 <dt>Returns:</dt> 409 <dt>Returns:</dt>
319 <dd> 410 <dd>
320 tuple of tuples containing the file system name, the total 411 tuple of tuples containing the file system name, the total
321 size, the used size and the free size 412 size, the used size and the free size
322 </dd> 413 </dd>
323 </dl><dl> 414 </dl>
415 <dl>
324 <dt>Return Type:</dt> 416 <dt>Return Type:</dt>
325 <dd> 417 <dd>
326 tuple of tuples of (str, int, int, int) 418 tuple of tuples of (str, int, int, int)
327 </dd> 419 </dd>
328 </dl><dl> 420 </dl>
329 <dt>Raises <b>IOError</b>:</dt> 421 <dl>
330 <dd> 422
331 raised to indicate an issue with the device 423 <dt>Raises <b>IOError</b>:</dt>
332 </dd> 424 <dd>
333 </dl><a NAME="MicroPythonCommandsInterface.get" ID="MicroPythonCommandsInterface.get"></a> 425 raised to indicate an issue with the device
426 </dd>
427 </dl>
428 <a NAME="MicroPythonCommandsInterface.get" ID="MicroPythonCommandsInterface.get"></a>
334 <h4>MicroPythonCommandsInterface.get</h4> 429 <h4>MicroPythonCommandsInterface.get</h4>
335 <b>get</b>(<i>deviceFileName, hostFileName=None</i>) 430 <b>get</b>(<i>deviceFileName, hostFileName=None</i>)
431
336 <p> 432 <p>
337 Public method to copy a file from the connected device. 433 Public method to copy a file from the connected device.
338 </p><dl> 434 </p>
435 <dl>
436
339 <dt><i>deviceFileName</i> (str)</dt> 437 <dt><i>deviceFileName</i> (str)</dt>
340 <dd> 438 <dd>
341 name of the file to copy 439 name of the file to copy
342 </dd><dt><i>hostFileName</i> (str)</dt> 440 </dd>
441 <dt><i>hostFileName</i> (str)</dt>
343 <dd> 442 <dd>
344 name of the file to copy to 443 name of the file to copy to
345 </dd> 444 </dd>
346 </dl><dl> 445 </dl>
446 <dl>
347 <dt>Returns:</dt> 447 <dt>Returns:</dt>
348 <dd> 448 <dd>
349 flag indicating success 449 flag indicating success
350 </dd> 450 </dd>
351 </dl><dl> 451 </dl>
452 <dl>
352 <dt>Return Type:</dt> 453 <dt>Return Type:</dt>
353 <dd> 454 <dd>
354 bool 455 bool
355 </dd> 456 </dd>
356 </dl><dl> 457 </dl>
357 <dt>Raises <b>IOError</b>:</dt> 458 <dl>
358 <dd> 459
359 raised to indicate an issue with the device 460 <dt>Raises <b>IOError</b>:</dt>
360 </dd> 461 <dd>
361 </dl><a NAME="MicroPythonCommandsInterface.getImplementation" ID="MicroPythonCommandsInterface.getImplementation"></a> 462 raised to indicate an issue with the device
463 </dd>
464 </dl>
465 <a NAME="MicroPythonCommandsInterface.getImplementation" ID="MicroPythonCommandsInterface.getImplementation"></a>
362 <h4>MicroPythonCommandsInterface.getImplementation</h4> 466 <h4>MicroPythonCommandsInterface.getImplementation</h4>
363 <b>getImplementation</b>(<i></i>) 467 <b>getImplementation</b>(<i></i>)
468
364 <p> 469 <p>
365 Public method to get some implementation information of the connected 470 Public method to get some implementation information of the connected
366 device. 471 device.
367 </p><dl> 472 </p>
473 <dl>
368 <dt>Returns:</dt> 474 <dt>Returns:</dt>
369 <dd> 475 <dd>
370 dictionary containing the implementation information 476 dictionary containing the implementation information
371 </dd> 477 </dd>
372 </dl><dl> 478 </dl>
479 <dl>
373 <dt>Return Type:</dt> 480 <dt>Return Type:</dt>
374 <dd> 481 <dd>
375 dict 482 dict
376 </dd> 483 </dd>
377 </dl><dl> 484 </dl>
378 <dt>Raises <b>IOError</b>:</dt> 485 <dl>
379 <dd> 486
380 raised to indicate an issue with the device 487 <dt>Raises <b>IOError</b>:</dt>
381 </dd> 488 <dd>
382 </dl><a NAME="MicroPythonCommandsInterface.getTime" ID="MicroPythonCommandsInterface.getTime"></a> 489 raised to indicate an issue with the device
490 </dd>
491 </dl>
492 <a NAME="MicroPythonCommandsInterface.getTime" ID="MicroPythonCommandsInterface.getTime"></a>
383 <h4>MicroPythonCommandsInterface.getTime</h4> 493 <h4>MicroPythonCommandsInterface.getTime</h4>
384 <b>getTime</b>(<i></i>) 494 <b>getTime</b>(<i></i>)
495
385 <p> 496 <p>
386 Public method to get the current time of the device. 497 Public method to get the current time of the device.
387 </p><dl> 498 </p>
499 <dl>
388 <dt>Returns:</dt> 500 <dt>Returns:</dt>
389 <dd> 501 <dd>
390 time of the device 502 time of the device
391 </dd> 503 </dd>
392 </dl><dl> 504 </dl>
505 <dl>
393 <dt>Return Type:</dt> 506 <dt>Return Type:</dt>
394 <dd> 507 <dd>
395 str 508 str
396 </dd> 509 </dd>
397 </dl><dl> 510 </dl>
398 <dt>Raises <b>IOError</b>:</dt> 511 <dl>
399 <dd> 512
400 raised to indicate an issue with the device 513 <dt>Raises <b>IOError</b>:</dt>
401 </dd> 514 <dd>
402 </dl><a NAME="MicroPythonCommandsInterface.handlePreferencesChanged" ID="MicroPythonCommandsInterface.handlePreferencesChanged"></a> 515 raised to indicate an issue with the device
516 </dd>
517 </dl>
518 <a NAME="MicroPythonCommandsInterface.handlePreferencesChanged" ID="MicroPythonCommandsInterface.handlePreferencesChanged"></a>
403 <h4>MicroPythonCommandsInterface.handlePreferencesChanged</h4> 519 <h4>MicroPythonCommandsInterface.handlePreferencesChanged</h4>
404 <b>handlePreferencesChanged</b>(<i></i>) 520 <b>handlePreferencesChanged</b>(<i></i>)
521
405 <p> 522 <p>
406 Public slot to handle a change of the preferences. 523 Public slot to handle a change of the preferences.
407 </p><a NAME="MicroPythonCommandsInterface.isConnected" ID="MicroPythonCommandsInterface.isConnected"></a> 524 </p>
525 <a NAME="MicroPythonCommandsInterface.isConnected" ID="MicroPythonCommandsInterface.isConnected"></a>
408 <h4>MicroPythonCommandsInterface.isConnected</h4> 526 <h4>MicroPythonCommandsInterface.isConnected</h4>
409 <b>isConnected</b>(<i></i>) 527 <b>isConnected</b>(<i></i>)
528
410 <p> 529 <p>
411 Public method to get the connection status. 530 Public method to get the connection status.
412 </p><dl> 531 </p>
532 <dl>
413 <dt>Returns:</dt> 533 <dt>Returns:</dt>
414 <dd> 534 <dd>
415 flag indicating the connection status 535 flag indicating the connection status
416 </dd> 536 </dd>
417 </dl><dl> 537 </dl>
538 <dl>
418 <dt>Return Type:</dt> 539 <dt>Return Type:</dt>
419 <dd> 540 <dd>
420 bool 541 bool
421 </dd> 542 </dd>
422 </dl><a NAME="MicroPythonCommandsInterface.lls" ID="MicroPythonCommandsInterface.lls"></a> 543 </dl>
544 <a NAME="MicroPythonCommandsInterface.lls" ID="MicroPythonCommandsInterface.lls"></a>
423 <h4>MicroPythonCommandsInterface.lls</h4> 545 <h4>MicroPythonCommandsInterface.lls</h4>
424 <b>lls</b>(<i>dirname="", fullstat=False, showHidden=False</i>) 546 <b>lls</b>(<i>dirname="", fullstat=False, showHidden=False</i>)
547
425 <p> 548 <p>
426 Public method to get a long directory listing of the connected device 549 Public method to get a long directory listing of the connected device
427 including meta data. 550 including meta data.
428 </p><dl> 551 </p>
552 <dl>
553
429 <dt><i>dirname</i> (str)</dt> 554 <dt><i>dirname</i> (str)</dt>
430 <dd> 555 <dd>
431 name of the directory to be listed 556 name of the directory to be listed
432 </dd><dt><i>fullstat</i> (bool)</dt> 557 </dd>
558 <dt><i>fullstat</i> (bool)</dt>
433 <dd> 559 <dd>
434 flag indicating to return the full stat() tuple 560 flag indicating to return the full stat() tuple
435 </dd><dt><i>showHidden</i> (bool)</dt> 561 </dd>
562 <dt><i>showHidden</i> (bool)</dt>
436 <dd> 563 <dd>
437 flag indicating to show hidden files as well 564 flag indicating to show hidden files as well
438 </dd> 565 </dd>
439 </dl><dl> 566 </dl>
567 <dl>
440 <dt>Returns:</dt> 568 <dt>Returns:</dt>
441 <dd> 569 <dd>
442 list containing the directory listing with tuple entries of 570 list containing the directory listing with tuple entries of
443 the name and and a tuple of mode, size and time (if fullstat is 571 the name and and a tuple of mode, size and time (if fullstat is
444 false) or the complete stat() tuple. 'None' is returned in case the 572 false) or the complete stat() tuple. 'None' is returned in case the
445 directory doesn't exist. 573 directory doesn't exist.
446 </dd> 574 </dd>
447 </dl><dl> 575 </dl>
576 <dl>
448 <dt>Return Type:</dt> 577 <dt>Return Type:</dt>
449 <dd> 578 <dd>
450 tuple of (str, tuple) 579 tuple of (str, tuple)
451 </dd> 580 </dd>
452 </dl><dl> 581 </dl>
453 <dt>Raises <b>IOError</b>:</dt> 582 <dl>
454 <dd> 583
455 raised to indicate an issue with the device 584 <dt>Raises <b>IOError</b>:</dt>
456 </dd> 585 <dd>
457 </dl><a NAME="MicroPythonCommandsInterface.ls" ID="MicroPythonCommandsInterface.ls"></a> 586 raised to indicate an issue with the device
587 </dd>
588 </dl>
589 <a NAME="MicroPythonCommandsInterface.ls" ID="MicroPythonCommandsInterface.ls"></a>
458 <h4>MicroPythonCommandsInterface.ls</h4> 590 <h4>MicroPythonCommandsInterface.ls</h4>
459 <b>ls</b>(<i>dirname=""</i>) 591 <b>ls</b>(<i>dirname=""</i>)
592
460 <p> 593 <p>
461 Public method to get a directory listing of the connected device. 594 Public method to get a directory listing of the connected device.
462 </p><dl> 595 </p>
596 <dl>
597
463 <dt><i>dirname</i> (str)</dt> 598 <dt><i>dirname</i> (str)</dt>
464 <dd> 599 <dd>
465 name of the directory to be listed 600 name of the directory to be listed
466 </dd> 601 </dd>
467 </dl><dl> 602 </dl>
603 <dl>
468 <dt>Returns:</dt> 604 <dt>Returns:</dt>
469 <dd> 605 <dd>
470 tuple containg the directory listing 606 tuple containg the directory listing
471 </dd> 607 </dd>
472 </dl><dl> 608 </dl>
609 <dl>
473 <dt>Return Type:</dt> 610 <dt>Return Type:</dt>
474 <dd> 611 <dd>
475 tuple of str 612 tuple of str
476 </dd> 613 </dd>
477 </dl><dl> 614 </dl>
478 <dt>Raises <b>IOError</b>:</dt> 615 <dl>
479 <dd> 616
480 raised to indicate an issue with the device 617 <dt>Raises <b>IOError</b>:</dt>
481 </dd> 618 <dd>
482 </dl><a NAME="MicroPythonCommandsInterface.mkdir" ID="MicroPythonCommandsInterface.mkdir"></a> 619 raised to indicate an issue with the device
620 </dd>
621 </dl>
622 <a NAME="MicroPythonCommandsInterface.mkdir" ID="MicroPythonCommandsInterface.mkdir"></a>
483 <h4>MicroPythonCommandsInterface.mkdir</h4> 623 <h4>MicroPythonCommandsInterface.mkdir</h4>
484 <b>mkdir</b>(<i>dirname</i>) 624 <b>mkdir</b>(<i>dirname</i>)
625
485 <p> 626 <p>
486 Public method to create a new directory. 627 Public method to create a new directory.
487 </p><dl> 628 </p>
629 <dl>
630
488 <dt><i>dirname</i> (str)</dt> 631 <dt><i>dirname</i> (str)</dt>
489 <dd> 632 <dd>
490 name of the directory to create 633 name of the directory to create
491 </dd> 634 </dd>
492 </dl><dl> 635 </dl>
493 <dt>Raises <b>IOError</b>:</dt> 636 <dl>
494 <dd> 637
495 raised to indicate an issue with the device 638 <dt>Raises <b>IOError</b>:</dt>
496 </dd> 639 <dd>
497 </dl><a NAME="MicroPythonCommandsInterface.put" ID="MicroPythonCommandsInterface.put"></a> 640 raised to indicate an issue with the device
641 </dd>
642 </dl>
643 <a NAME="MicroPythonCommandsInterface.put" ID="MicroPythonCommandsInterface.put"></a>
498 <h4>MicroPythonCommandsInterface.put</h4> 644 <h4>MicroPythonCommandsInterface.put</h4>
499 <b>put</b>(<i>hostFileName, deviceFileName=None</i>) 645 <b>put</b>(<i>hostFileName, deviceFileName=None</i>)
646
500 <p> 647 <p>
501 Public method to copy a local file to the connected device. 648 Public method to copy a local file to the connected device.
502 </p><dl> 649 </p>
650 <dl>
651
503 <dt><i>hostFileName</i> (str)</dt> 652 <dt><i>hostFileName</i> (str)</dt>
504 <dd> 653 <dd>
505 name of the file to be copied 654 name of the file to be copied
506 </dd><dt><i>deviceFileName</i> (str)</dt> 655 </dd>
656 <dt><i>deviceFileName</i> (str)</dt>
507 <dd> 657 <dd>
508 name of the file to copy to 658 name of the file to copy to
509 </dd> 659 </dd>
510 </dl><dl> 660 </dl>
661 <dl>
511 <dt>Returns:</dt> 662 <dt>Returns:</dt>
512 <dd> 663 <dd>
513 flag indicating success 664 flag indicating success
514 </dd> 665 </dd>
515 </dl><dl> 666 </dl>
667 <dl>
516 <dt>Return Type:</dt> 668 <dt>Return Type:</dt>
517 <dd> 669 <dd>
518 bool 670 bool
519 </dd> 671 </dd>
520 </dl><dl> 672 </dl>
521 <dt>Raises <b>IOError</b>:</dt> 673 <dl>
522 <dd> 674
523 raised to indicate an issue with the device 675 <dt>Raises <b>IOError</b>:</dt>
524 </dd> 676 <dd>
525 </dl><a NAME="MicroPythonCommandsInterface.pwd" ID="MicroPythonCommandsInterface.pwd"></a> 677 raised to indicate an issue with the device
678 </dd>
679 </dl>
680 <a NAME="MicroPythonCommandsInterface.pwd" ID="MicroPythonCommandsInterface.pwd"></a>
526 <h4>MicroPythonCommandsInterface.pwd</h4> 681 <h4>MicroPythonCommandsInterface.pwd</h4>
527 <b>pwd</b>(<i></i>) 682 <b>pwd</b>(<i></i>)
683
528 <p> 684 <p>
529 Public method to get the current directory of the connected device. 685 Public method to get the current directory of the connected device.
530 </p><dl> 686 </p>
687 <dl>
531 <dt>Returns:</dt> 688 <dt>Returns:</dt>
532 <dd> 689 <dd>
533 current directory 690 current directory
534 </dd> 691 </dd>
535 </dl><dl> 692 </dl>
693 <dl>
536 <dt>Return Type:</dt> 694 <dt>Return Type:</dt>
537 <dd> 695 <dd>
538 str 696 str
539 </dd> 697 </dd>
540 </dl><dl> 698 </dl>
541 <dt>Raises <b>IOError</b>:</dt> 699 <dl>
542 <dd> 700
543 raised to indicate an issue with the device 701 <dt>Raises <b>IOError</b>:</dt>
544 </dd> 702 <dd>
545 </dl><a NAME="MicroPythonCommandsInterface.remainingTask" ID="MicroPythonCommandsInterface.remainingTask"></a> 703 raised to indicate an issue with the device
704 </dd>
705 </dl>
706 <a NAME="MicroPythonCommandsInterface.remainingTask" ID="MicroPythonCommandsInterface.remainingTask"></a>
546 <h4>MicroPythonCommandsInterface.remainingTask</h4> 707 <h4>MicroPythonCommandsInterface.remainingTask</h4>
547 <b>remainingTask</b>(<i></i>) 708 <b>remainingTask</b>(<i></i>)
709
548 <a NAME="MicroPythonCommandsInterface.rm" ID="MicroPythonCommandsInterface.rm"></a> 710 <a NAME="MicroPythonCommandsInterface.rm" ID="MicroPythonCommandsInterface.rm"></a>
549 <h4>MicroPythonCommandsInterface.rm</h4> 711 <h4>MicroPythonCommandsInterface.rm</h4>
550 <b>rm</b>(<i>filename</i>) 712 <b>rm</b>(<i>filename</i>)
713
551 <p> 714 <p>
552 Public method to remove a file from the connected device. 715 Public method to remove a file from the connected device.
553 </p><dl> 716 </p>
717 <dl>
718
554 <dt><i>filename</i> (str)</dt> 719 <dt><i>filename</i> (str)</dt>
555 <dd> 720 <dd>
556 name of the file to be removed 721 name of the file to be removed
557 </dd> 722 </dd>
558 </dl><dl> 723 </dl>
559 <dt>Raises <b>IOError</b>:</dt> 724 <dl>
560 <dd> 725
561 raised to indicate an issue with the device 726 <dt>Raises <b>IOError</b>:</dt>
562 </dd> 727 <dd>
563 </dl><a NAME="MicroPythonCommandsInterface.rmdir" ID="MicroPythonCommandsInterface.rmdir"></a> 728 raised to indicate an issue with the device
729 </dd>
730 </dl>
731 <a NAME="MicroPythonCommandsInterface.rmdir" ID="MicroPythonCommandsInterface.rmdir"></a>
564 <h4>MicroPythonCommandsInterface.rmdir</h4> 732 <h4>MicroPythonCommandsInterface.rmdir</h4>
565 <b>rmdir</b>(<i>dirname</i>) 733 <b>rmdir</b>(<i>dirname</i>)
734
566 <p> 735 <p>
567 Public method to remove a directory. 736 Public method to remove a directory.
568 </p><dl> 737 </p>
738 <dl>
739
569 <dt><i>dirname</i> (str)</dt> 740 <dt><i>dirname</i> (str)</dt>
570 <dd> 741 <dd>
571 name of the directory to be removed 742 name of the directory to be removed
572 </dd> 743 </dd>
573 </dl><dl> 744 </dl>
574 <dt>Raises <b>IOError</b>:</dt> 745 <dl>
575 <dd> 746
576 raised to indicate an issue with the device 747 <dt>Raises <b>IOError</b>:</dt>
577 </dd> 748 <dd>
578 </dl><a NAME="MicroPythonCommandsInterface.rmrf" ID="MicroPythonCommandsInterface.rmrf"></a> 749 raised to indicate an issue with the device
750 </dd>
751 </dl>
752 <a NAME="MicroPythonCommandsInterface.rmrf" ID="MicroPythonCommandsInterface.rmrf"></a>
579 <h4>MicroPythonCommandsInterface.rmrf</h4> 753 <h4>MicroPythonCommandsInterface.rmrf</h4>
580 <b>rmrf</b>(<i>name, recursive=False, force=False</i>) 754 <b>rmrf</b>(<i>name, recursive=False, force=False</i>)
755
581 <p> 756 <p>
582 Public method to remove a file or directory recursively. 757 Public method to remove a file or directory recursively.
583 </p><dl> 758 </p>
759 <dl>
760
584 <dt><i>name</i> (str)</dt> 761 <dt><i>name</i> (str)</dt>
585 <dd> 762 <dd>
586 of the file or directory to remove 763 of the file or directory to remove
587 </dd><dt><i>recursive</i> (bool)</dt> 764 </dd>
765 <dt><i>recursive</i> (bool)</dt>
588 <dd> 766 <dd>
589 flag indicating a recursive deletion 767 flag indicating a recursive deletion
590 </dd><dt><i>force</i> (bool)</dt> 768 </dd>
769 <dt><i>force</i> (bool)</dt>
591 <dd> 770 <dd>
592 flag indicating to ignore errors 771 flag indicating to ignore errors
593 </dd> 772 </dd>
594 </dl><dl> 773 </dl>
774 <dl>
595 <dt>Returns:</dt> 775 <dt>Returns:</dt>
596 <dd> 776 <dd>
597 flag indicating success 777 flag indicating success
598 </dd> 778 </dd>
599 </dl><dl> 779 </dl>
780 <dl>
600 <dt>Return Type:</dt> 781 <dt>Return Type:</dt>
601 <dd> 782 <dd>
602 bool 783 bool
603 </dd> 784 </dd>
604 </dl><dl> 785 </dl>
605 <dt>Raises <b>IOError</b>:</dt> 786 <dl>
606 <dd> 787
607 raised to indicate an issue with the device 788 <dt>Raises <b>IOError</b>:</dt>
608 </dd> 789 <dd>
609 </dl><a NAME="MicroPythonCommandsInterface.syncTime" ID="MicroPythonCommandsInterface.syncTime"></a> 790 raised to indicate an issue with the device
791 </dd>
792 </dl>
793 <a NAME="MicroPythonCommandsInterface.syncTime" ID="MicroPythonCommandsInterface.syncTime"></a>
610 <h4>MicroPythonCommandsInterface.syncTime</h4> 794 <h4>MicroPythonCommandsInterface.syncTime</h4>
611 <b>syncTime</b>(<i></i>) 795 <b>syncTime</b>(<i></i>)
796
612 <p> 797 <p>
613 Public method to set the time of the connected device to the local 798 Public method to set the time of the connected device to the local
614 computer's time. 799 computer's time.
615 </p><dl> 800 </p>
616 <dt>Raises <b>IOError</b>:</dt> 801 <dl>
617 <dd> 802
618 raised to indicate an issue with the device 803 <dt>Raises <b>IOError</b>:</dt>
619 </dd> 804 <dd>
620 </dl><a NAME="MicroPythonCommandsInterface.version" ID="MicroPythonCommandsInterface.version"></a> 805 raised to indicate an issue with the device
806 </dd>
807 </dl>
808 <a NAME="MicroPythonCommandsInterface.version" ID="MicroPythonCommandsInterface.version"></a>
621 <h4>MicroPythonCommandsInterface.version</h4> 809 <h4>MicroPythonCommandsInterface.version</h4>
622 <b>version</b>(<i></i>) 810 <b>version</b>(<i></i>)
811
623 <p> 812 <p>
624 Public method to get the MicroPython version information of the 813 Public method to get the MicroPython version information of the
625 connected device. 814 connected device.
626 </p><dl> 815 </p>
816 <dl>
627 <dt>Returns:</dt> 817 <dt>Returns:</dt>
628 <dd> 818 <dd>
629 dictionary containing the version information 819 dictionary containing the version information
630 </dd> 820 </dd>
631 </dl><dl> 821 </dl>
822 <dl>
632 <dt>Return Type:</dt> 823 <dt>Return Type:</dt>
633 <dd> 824 <dd>
634 dict 825 dict
635 </dd> 826 </dd>
636 </dl><dl> 827 </dl>
637 <dt>Raises <b>IOError</b>:</dt> 828 <dl>
638 <dd> 829
639 raised to indicate an issue with the device 830 <dt>Raises <b>IOError</b>:</dt>
640 </dd> 831 <dd>
641 </dl><a NAME="MicroPythonCommandsInterface.write" ID="MicroPythonCommandsInterface.write"></a> 832 raised to indicate an issue with the device
833 </dd>
834 </dl>
835 <a NAME="MicroPythonCommandsInterface.write" ID="MicroPythonCommandsInterface.write"></a>
642 <h4>MicroPythonCommandsInterface.write</h4> 836 <h4>MicroPythonCommandsInterface.write</h4>
643 <b>write</b>(<i>data</i>) 837 <b>write</b>(<i>data</i>)
838
644 <p> 839 <p>
645 Public method to write data to the connected device. 840 Public method to write data to the connected device.
646 </p><dl> 841 </p>
842 <dl>
843
647 <dt><i>data</i> (bytes or bytearray)</dt> 844 <dt><i>data</i> (bytes or bytearray)</dt>
648 <dd> 845 <dd>
649 data to be written 846 data to be written
650 </dd> 847 </dd>
651 </dl> 848 </dl>

Mercurial Repository: eric

eric ide

mercurial