Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.MicroPython.GenericMicroPythonDevices.html

changeset 8083
a2e14cda6f3f
child 8124
98b57e2f731a
equal deleted inserted replaced
8082:2242a6a1d786 8083:a2e14cda6f3f
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.MicroPython.GenericMicroPythonDevices</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric6.MicroPython.GenericMicroPythonDevices</h1>
24
25 <p>
26 Module implementing the device interface class for generic MicroPython devices
27 (i.e. those devices not specifically supported yet).
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#GenericMicroPythonDevice">GenericMicroPythonDevice</a></td>
40 <td>Class implementing the device interface for generic MicroPython boards.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="GenericMicroPythonDevice" ID="GenericMicroPythonDevice"></a>
51 <h2>GenericMicroPythonDevice</h2>
52
53 <p>
54 Class implementing the device interface for generic MicroPython boards.
55 </p>
56 <h3>Derived from</h3>
57 MicroPythonDevice
58 <h3>Class Attributes</h3>
59
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Methods</h3>
69
70 <table>
71
72 <tr>
73 <td><a href="#GenericMicroPythonDevice.__init__">GenericMicroPythonDevice</a></td>
74 <td>Constructor</td>
75 </tr>
76 <tr>
77 <td><a href="#GenericMicroPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td>
78 <td>Private method to check, if the device volume is mounted.</td>
79 </tr>
80 <tr>
81 <td><a href="#GenericMicroPythonDevice.__findWorkspace">__findWorkspace</a></td>
82 <td>Private method to find the workspace directory.</td>
83 </tr>
84 <tr>
85 <td><a href="#GenericMicroPythonDevice.canRunScript">canRunScript</a></td>
86 <td>Public method to determine, if a script can be executed.</td>
87 </tr>
88 <tr>
89 <td><a href="#GenericMicroPythonDevice.canStartFileManager">canStartFileManager</a></td>
90 <td>Public method to determine, if a File Manager can be started.</td>
91 </tr>
92 <tr>
93 <td><a href="#GenericMicroPythonDevice.canStartPlotter">canStartPlotter</a></td>
94 <td>Public method to determine, if a Plotter can be started.</td>
95 </tr>
96 <tr>
97 <td><a href="#GenericMicroPythonDevice.canStartRepl">canStartRepl</a></td>
98 <td>Public method to determine, if a REPL can be started.</td>
99 </tr>
100 <tr>
101 <td><a href="#GenericMicroPythonDevice.deviceName">deviceName</a></td>
102 <td>Public method to get the name of the device.</td>
103 </tr>
104 <tr>
105 <td><a href="#GenericMicroPythonDevice.getWorkspace">getWorkspace</a></td>
106 <td>Public method to get the workspace directory.</td>
107 </tr>
108 <tr>
109 <td><a href="#GenericMicroPythonDevice.runScript">runScript</a></td>
110 <td>Public method to run the given Python script.</td>
111 </tr>
112 <tr>
113 <td><a href="#GenericMicroPythonDevice.setButtons">setButtons</a></td>
114 <td>Public method to enable the supported action buttons.</td>
115 </tr>
116 <tr>
117 <td><a href="#GenericMicroPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td>
118 <td>Public method to indicate file access via a local directory.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122
123 <table>
124 <tr><td>None</td></tr>
125 </table>
126
127 <a NAME="GenericMicroPythonDevice.__init__" ID="GenericMicroPythonDevice.__init__"></a>
128 <h4>GenericMicroPythonDevice (Constructor)</h4>
129 <b>GenericMicroPythonDevice</b>(<i>microPythonWidget, vid, pid, parent=None</i>)
130
131 <p>
132 Constructor
133 </p>
134 <dl>
135
136 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt>
137 <dd>
138 reference to the main MicroPython widget
139 </dd>
140 <dt><i>vid</i> (int)</dt>
141 <dd>
142 vendor ID
143 </dd>
144 <dt><i>pid</i> (int)</dt>
145 <dd>
146 product ID
147 </dd>
148 <dt><i>parent</i> (QObject)</dt>
149 <dd>
150 reference to the parent object
151 </dd>
152 </dl>
153 <a NAME="GenericMicroPythonDevice.__deviceVolumeMounted" ID="GenericMicroPythonDevice.__deviceVolumeMounted"></a>
154 <h4>GenericMicroPythonDevice.__deviceVolumeMounted</h4>
155 <b>__deviceVolumeMounted</b>(<i></i>)
156
157 <p>
158 Private method to check, if the device volume is mounted.
159 </p>
160 <dl>
161 <dt>Return:</dt>
162 <dd>
163 flag indicated a mounted device
164 </dd>
165 </dl>
166 <dl>
167 <dt>Return Type:</dt>
168 <dd>
169 bool
170 </dd>
171 </dl>
172 <a NAME="GenericMicroPythonDevice.__findWorkspace" ID="GenericMicroPythonDevice.__findWorkspace"></a>
173 <h4>GenericMicroPythonDevice.__findWorkspace</h4>
174 <b>__findWorkspace</b>(<i>silent=False</i>)
175
176 <p>
177 Private method to find the workspace directory.
178 </p>
179 <dl>
180
181 <dt><i>silent</i> (bool)</dt>
182 <dd>
183 flag indicating silent operations
184 </dd>
185 </dl>
186 <dl>
187 <dt>Return:</dt>
188 <dd>
189 workspace directory used for saving files
190 </dd>
191 </dl>
192 <dl>
193 <dt>Return Type:</dt>
194 <dd>
195 str
196 </dd>
197 </dl>
198 <a NAME="GenericMicroPythonDevice.canRunScript" ID="GenericMicroPythonDevice.canRunScript"></a>
199 <h4>GenericMicroPythonDevice.canRunScript</h4>
200 <b>canRunScript</b>(<i></i>)
201
202 <p>
203 Public method to determine, if a script can be executed.
204 </p>
205 <dl>
206 <dt>Return:</dt>
207 <dd>
208 tuple containing a flag indicating it is safe to start a
209 Plotter and a reason why it cannot.
210 </dd>
211 </dl>
212 <dl>
213 <dt>Return Type:</dt>
214 <dd>
215 tuple of (bool, str)
216 </dd>
217 </dl>
218 <a NAME="GenericMicroPythonDevice.canStartFileManager" ID="GenericMicroPythonDevice.canStartFileManager"></a>
219 <h4>GenericMicroPythonDevice.canStartFileManager</h4>
220 <b>canStartFileManager</b>(<i></i>)
221
222 <p>
223 Public method to determine, if a File Manager can be started.
224 </p>
225 <dl>
226 <dt>Return:</dt>
227 <dd>
228 tuple containing a flag indicating it is safe to start a
229 File Manager and a reason why it cannot.
230 </dd>
231 </dl>
232 <dl>
233 <dt>Return Type:</dt>
234 <dd>
235 tuple of (bool, str)
236 </dd>
237 </dl>
238 <a NAME="GenericMicroPythonDevice.canStartPlotter" ID="GenericMicroPythonDevice.canStartPlotter"></a>
239 <h4>GenericMicroPythonDevice.canStartPlotter</h4>
240 <b>canStartPlotter</b>(<i></i>)
241
242 <p>
243 Public method to determine, if a Plotter can be started.
244 </p>
245 <dl>
246 <dt>Return:</dt>
247 <dd>
248 tuple containing a flag indicating it is safe to start a
249 Plotter and a reason why it cannot.
250 </dd>
251 </dl>
252 <dl>
253 <dt>Return Type:</dt>
254 <dd>
255 tuple of (bool, str)
256 </dd>
257 </dl>
258 <a NAME="GenericMicroPythonDevice.canStartRepl" ID="GenericMicroPythonDevice.canStartRepl"></a>
259 <h4>GenericMicroPythonDevice.canStartRepl</h4>
260 <b>canStartRepl</b>(<i></i>)
261
262 <p>
263 Public method to determine, if a REPL can be started.
264 </p>
265 <dl>
266 <dt>Return:</dt>
267 <dd>
268 tuple containing a flag indicating it is safe to start a REPL
269 and a reason why it cannot.
270 </dd>
271 </dl>
272 <dl>
273 <dt>Return Type:</dt>
274 <dd>
275 tuple of (bool, str)
276 </dd>
277 </dl>
278 <a NAME="GenericMicroPythonDevice.deviceName" ID="GenericMicroPythonDevice.deviceName"></a>
279 <h4>GenericMicroPythonDevice.deviceName</h4>
280 <b>deviceName</b>(<i></i>)
281
282 <p>
283 Public method to get the name of the device.
284 </p>
285 <dl>
286 <dt>Return:</dt>
287 <dd>
288 name of the device
289 </dd>
290 </dl>
291 <dl>
292 <dt>Return Type:</dt>
293 <dd>
294 str
295 </dd>
296 </dl>
297 <a NAME="GenericMicroPythonDevice.getWorkspace" ID="GenericMicroPythonDevice.getWorkspace"></a>
298 <h4>GenericMicroPythonDevice.getWorkspace</h4>
299 <b>getWorkspace</b>(<i>silent=False</i>)
300
301 <p>
302 Public method to get the workspace directory.
303 </p>
304 <dl>
305
306 <dt><i>silent</i> (bool)</dt>
307 <dd>
308 flag indicating silent operations
309 </dd>
310 </dl>
311 <dl>
312 <dt>Return:</dt>
313 <dd>
314 workspace directory used for saving files
315 </dd>
316 </dl>
317 <dl>
318 <dt>Return Type:</dt>
319 <dd>
320 str
321 </dd>
322 </dl>
323 <a NAME="GenericMicroPythonDevice.runScript" ID="GenericMicroPythonDevice.runScript"></a>
324 <h4>GenericMicroPythonDevice.runScript</h4>
325 <b>runScript</b>(<i>script</i>)
326
327 <p>
328 Public method to run the given Python script.
329 </p>
330 <dl>
331
332 <dt><i>script</i> (str)</dt>
333 <dd>
334 script to be executed
335 </dd>
336 </dl>
337 <a NAME="GenericMicroPythonDevice.setButtons" ID="GenericMicroPythonDevice.setButtons"></a>
338 <h4>GenericMicroPythonDevice.setButtons</h4>
339 <b>setButtons</b>(<i></i>)
340
341 <p>
342 Public method to enable the supported action buttons.
343 </p>
344 <a NAME="GenericMicroPythonDevice.supportsLocalFileAccess" ID="GenericMicroPythonDevice.supportsLocalFileAccess"></a>
345 <h4>GenericMicroPythonDevice.supportsLocalFileAccess</h4>
346 <b>supportsLocalFileAccess</b>(<i></i>)
347
348 <p>
349 Public method to indicate file access via a local directory.
350 </p>
351 <dl>
352 <dt>Return:</dt>
353 <dd>
354 flag indicating file access via local directory
355 </dd>
356 </dl>
357 <dl>
358 <dt>Return Type:</dt>
359 <dd>
360 bool
361 </dd>
362 </dl>
363 <div align="right"><a href="#top">Up</a></div>
364 <hr />
365 </body></html>

Mercurial Repository: eric

eric ide

mercurial