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.CircuitPythonDevices</h1> |
23 <h1>eric6.MicroPython.CircuitPythonDevices</h1> |
|
24 |
23 <p> |
25 <p> |
24 Module implementing the device interface class for CircuitPython boards. |
26 Module implementing the device interface class for CircuitPython boards. |
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> |
31 <table> |
34 |
|
35 <table> |
|
36 |
32 <tr> |
37 <tr> |
33 <td><a href="#CircuitPythonDevice">CircuitPythonDevice</a></td> |
38 <td><a href="#CircuitPythonDevice">CircuitPythonDevice</a></td> |
34 <td>Class implementing the device for CircuitPython boards.</td> |
39 <td>Class implementing the device for CircuitPython boards.</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="CircuitPythonDevice" ID="CircuitPythonDevice"></a> |
49 <a NAME="CircuitPythonDevice" ID="CircuitPythonDevice"></a> |
43 <h2>CircuitPythonDevice</h2> |
50 <h2>CircuitPythonDevice</h2> |
|
51 |
44 <p> |
52 <p> |
45 Class implementing the device for CircuitPython boards. |
53 Class implementing the device for CircuitPython boards. |
46 </p> |
54 </p> |
47 <h3>Derived from</h3> |
55 <h3>Derived from</h3> |
48 MicroPythonDevice |
56 MicroPythonDevice |
49 <h3>Class Attributes</h3> |
57 <h3>Class Attributes</h3> |
|
58 |
50 <table> |
59 <table> |
51 <tr><td>DeviceVolumeName</td></tr> |
60 <tr><td>DeviceVolumeName</td></tr> |
52 </table> |
61 </table> |
53 <h3>Class Methods</h3> |
62 <h3>Class Methods</h3> |
|
63 |
54 <table> |
64 <table> |
55 <tr><td>None</td></tr> |
65 <tr><td>None</td></tr> |
56 </table> |
66 </table> |
57 <h3>Methods</h3> |
67 <h3>Methods</h3> |
58 <table> |
68 |
|
69 <table> |
|
70 |
59 <tr> |
71 <tr> |
60 <td><a href="#CircuitPythonDevice.__init__">CircuitPythonDevice</a></td> |
72 <td><a href="#CircuitPythonDevice.__init__">CircuitPythonDevice</a></td> |
61 <td>Constructor</td> |
73 <td>Constructor</td> |
62 </tr><tr> |
74 </tr> |
|
75 <tr> |
63 <td><a href="#CircuitPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td> |
76 <td><a href="#CircuitPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td> |
64 <td>Private method to check, if the device volume is mounted.</td> |
77 <td>Private method to check, if the device volume is mounted.</td> |
65 </tr><tr> |
78 </tr> |
|
79 <tr> |
66 <td><a href="#CircuitPythonDevice.__flashCircuitPython">__flashCircuitPython</a></td> |
80 <td><a href="#CircuitPythonDevice.__flashCircuitPython">__flashCircuitPython</a></td> |
67 <td>Private slot to flash a CircuitPython firmware to the device.</td> |
81 <td>Private slot to flash a CircuitPython firmware to the device.</td> |
68 </tr><tr> |
82 </tr> |
|
83 <tr> |
69 <td><a href="#CircuitPythonDevice.__installLibraryFiles">__installLibraryFiles</a></td> |
84 <td><a href="#CircuitPythonDevice.__installLibraryFiles">__installLibraryFiles</a></td> |
70 <td>Private slot to install Python files into the onboard library.</td> |
85 <td>Private slot to install Python files into the onboard library.</td> |
71 </tr><tr> |
86 </tr> |
|
87 <tr> |
72 <td><a href="#CircuitPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
88 <td><a href="#CircuitPythonDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
73 <td>Public method to add device specific entries to the given menu.</td> |
89 <td>Public method to add device specific entries to the given menu.</td> |
74 </tr><tr> |
90 </tr> |
|
91 <tr> |
75 <td><a href="#CircuitPythonDevice.canRunScript">canRunScript</a></td> |
92 <td><a href="#CircuitPythonDevice.canRunScript">canRunScript</a></td> |
76 <td>Public method to determine, if a script can be executed.</td> |
93 <td>Public method to determine, if a script can be executed.</td> |
77 </tr><tr> |
94 </tr> |
|
95 <tr> |
78 <td><a href="#CircuitPythonDevice.canStartFileManager">canStartFileManager</a></td> |
96 <td><a href="#CircuitPythonDevice.canStartFileManager">canStartFileManager</a></td> |
79 <td>Public method to determine, if a File Manager can be started.</td> |
97 <td>Public method to determine, if a File Manager can be started.</td> |
80 </tr><tr> |
98 </tr> |
|
99 <tr> |
81 <td><a href="#CircuitPythonDevice.canStartPlotter">canStartPlotter</a></td> |
100 <td><a href="#CircuitPythonDevice.canStartPlotter">canStartPlotter</a></td> |
82 <td>Public method to determine, if a Plotter can be started.</td> |
101 <td>Public method to determine, if a Plotter can be started.</td> |
83 </tr><tr> |
102 </tr> |
|
103 <tr> |
84 <td><a href="#CircuitPythonDevice.canStartRepl">canStartRepl</a></td> |
104 <td><a href="#CircuitPythonDevice.canStartRepl">canStartRepl</a></td> |
85 <td>Public method to determine, if a REPL can be started.</td> |
105 <td>Public method to determine, if a REPL can be started.</td> |
86 </tr><tr> |
106 </tr> |
|
107 <tr> |
87 <td><a href="#CircuitPythonDevice.deviceName">deviceName</a></td> |
108 <td><a href="#CircuitPythonDevice.deviceName">deviceName</a></td> |
88 <td>Public method to get the name of the device.</td> |
109 <td>Public method to get the name of the device.</td> |
89 </tr><tr> |
110 </tr> |
|
111 <tr> |
90 <td><a href="#CircuitPythonDevice.forceInterrupt">forceInterrupt</a></td> |
112 <td><a href="#CircuitPythonDevice.forceInterrupt">forceInterrupt</a></td> |
91 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
113 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
92 </tr><tr> |
114 </tr> |
|
115 <tr> |
93 <td><a href="#CircuitPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
116 <td><a href="#CircuitPythonDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
94 <td>Public method to get the device documentation URL.</td> |
117 <td>Public method to get the device documentation URL.</td> |
95 </tr><tr> |
118 </tr> |
|
119 <tr> |
96 <td><a href="#CircuitPythonDevice.getWorkspace">getWorkspace</a></td> |
120 <td><a href="#CircuitPythonDevice.getWorkspace">getWorkspace</a></td> |
97 <td>Public method to get the workspace directory.</td> |
121 <td>Public method to get the workspace directory.</td> |
98 </tr><tr> |
122 </tr> |
|
123 <tr> |
99 <td><a href="#CircuitPythonDevice.runScript">runScript</a></td> |
124 <td><a href="#CircuitPythonDevice.runScript">runScript</a></td> |
100 <td>Public method to run the given Python script.</td> |
125 <td>Public method to run the given Python script.</td> |
101 </tr><tr> |
126 </tr> |
|
127 <tr> |
102 <td><a href="#CircuitPythonDevice.setButtons">setButtons</a></td> |
128 <td><a href="#CircuitPythonDevice.setButtons">setButtons</a></td> |
103 <td>Public method to enable the supported action buttons.</td> |
129 <td>Public method to enable the supported action buttons.</td> |
104 </tr><tr> |
130 </tr> |
|
131 <tr> |
105 <td><a href="#CircuitPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> |
132 <td><a href="#CircuitPythonDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> |
106 <td>Public method to indicate file access via a local directory.</td> |
133 <td>Public method to indicate file access via a local directory.</td> |
107 </tr> |
134 </tr> |
108 </table> |
135 </table> |
109 <h3>Static Methods</h3> |
136 <h3>Static Methods</h3> |
|
137 |
110 <table> |
138 <table> |
111 <tr><td>None</td></tr> |
139 <tr><td>None</td></tr> |
112 </table> |
140 </table> |
|
141 |
113 <a NAME="CircuitPythonDevice.__init__" ID="CircuitPythonDevice.__init__"></a> |
142 <a NAME="CircuitPythonDevice.__init__" ID="CircuitPythonDevice.__init__"></a> |
114 <h4>CircuitPythonDevice (Constructor)</h4> |
143 <h4>CircuitPythonDevice (Constructor)</h4> |
115 <b>CircuitPythonDevice</b>(<i>microPythonWidget, parent=None</i>) |
144 <b>CircuitPythonDevice</b>(<i>microPythonWidget, parent=None</i>) |
|
145 |
116 <p> |
146 <p> |
117 Constructor |
147 Constructor |
118 </p><dl> |
148 </p> |
|
149 <dl> |
|
150 |
119 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> |
151 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> |
120 <dd> |
152 <dd> |
121 reference to the main MicroPython widget |
153 reference to the main MicroPython widget |
122 </dd><dt><i>parent</i> (QObject)</dt> |
154 </dd> |
|
155 <dt><i>parent</i> (QObject)</dt> |
123 <dd> |
156 <dd> |
124 reference to the parent object |
157 reference to the parent object |
125 </dd> |
158 </dd> |
126 </dl><a NAME="CircuitPythonDevice.__deviceVolumeMounted" ID="CircuitPythonDevice.__deviceVolumeMounted"></a> |
159 </dl> |
|
160 <a NAME="CircuitPythonDevice.__deviceVolumeMounted" ID="CircuitPythonDevice.__deviceVolumeMounted"></a> |
127 <h4>CircuitPythonDevice.__deviceVolumeMounted</h4> |
161 <h4>CircuitPythonDevice.__deviceVolumeMounted</h4> |
128 <b>__deviceVolumeMounted</b>(<i></i>) |
162 <b>__deviceVolumeMounted</b>(<i></i>) |
|
163 |
129 <p> |
164 <p> |
130 Private method to check, if the device volume is mounted. |
165 Private method to check, if the device volume is mounted. |
131 </p><dl> |
166 </p> |
|
167 <dl> |
132 <dt>Returns:</dt> |
168 <dt>Returns:</dt> |
133 <dd> |
169 <dd> |
134 flag indicated a mounted device |
170 flag indicated a mounted device |
135 </dd> |
171 </dd> |
136 </dl><dl> |
172 </dl> |
|
173 <dl> |
137 <dt>Return Type:</dt> |
174 <dt>Return Type:</dt> |
138 <dd> |
175 <dd> |
139 bool |
176 bool |
140 </dd> |
177 </dd> |
141 </dl><a NAME="CircuitPythonDevice.__flashCircuitPython" ID="CircuitPythonDevice.__flashCircuitPython"></a> |
178 </dl> |
|
179 <a NAME="CircuitPythonDevice.__flashCircuitPython" ID="CircuitPythonDevice.__flashCircuitPython"></a> |
142 <h4>CircuitPythonDevice.__flashCircuitPython</h4> |
180 <h4>CircuitPythonDevice.__flashCircuitPython</h4> |
143 <b>__flashCircuitPython</b>(<i></i>) |
181 <b>__flashCircuitPython</b>(<i></i>) |
|
182 |
144 <p> |
183 <p> |
145 Private slot to flash a CircuitPython firmware to the device. |
184 Private slot to flash a CircuitPython firmware to the device. |
146 </p><a NAME="CircuitPythonDevice.__installLibraryFiles" ID="CircuitPythonDevice.__installLibraryFiles"></a> |
185 </p> |
|
186 <a NAME="CircuitPythonDevice.__installLibraryFiles" ID="CircuitPythonDevice.__installLibraryFiles"></a> |
147 <h4>CircuitPythonDevice.__installLibraryFiles</h4> |
187 <h4>CircuitPythonDevice.__installLibraryFiles</h4> |
148 <b>__installLibraryFiles</b>(<i></i>) |
188 <b>__installLibraryFiles</b>(<i></i>) |
|
189 |
149 <p> |
190 <p> |
150 Private slot to install Python files into the onboard library. |
191 Private slot to install Python files into the onboard library. |
151 </p><a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> |
192 </p> |
|
193 <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> |
152 <h4>CircuitPythonDevice.addDeviceMenuEntries</h4> |
194 <h4>CircuitPythonDevice.addDeviceMenuEntries</h4> |
153 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
195 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
|
196 |
154 <p> |
197 <p> |
155 Public method to add device specific entries to the given menu. |
198 Public method to add device specific entries to the given menu. |
156 </p><dl> |
199 </p> |
|
200 <dl> |
|
201 |
157 <dt><i>menu</i> (QMenu)</dt> |
202 <dt><i>menu</i> (QMenu)</dt> |
158 <dd> |
203 <dd> |
159 reference to the context menu |
204 reference to the context menu |
160 </dd> |
205 </dd> |
161 </dl><a NAME="CircuitPythonDevice.canRunScript" ID="CircuitPythonDevice.canRunScript"></a> |
206 </dl> |
|
207 <a NAME="CircuitPythonDevice.canRunScript" ID="CircuitPythonDevice.canRunScript"></a> |
162 <h4>CircuitPythonDevice.canRunScript</h4> |
208 <h4>CircuitPythonDevice.canRunScript</h4> |
163 <b>canRunScript</b>(<i></i>) |
209 <b>canRunScript</b>(<i></i>) |
|
210 |
164 <p> |
211 <p> |
165 Public method to determine, if a script can be executed. |
212 Public method to determine, if a script can be executed. |
166 </p><dl> |
213 </p> |
|
214 <dl> |
167 <dt>Returns:</dt> |
215 <dt>Returns:</dt> |
168 <dd> |
216 <dd> |
169 tuple containing a flag indicating it is safe to start a |
217 tuple containing a flag indicating it is safe to start a |
170 Plotter and a reason why it cannot. |
218 Plotter and a reason why it cannot. |
171 </dd> |
219 </dd> |
172 </dl><dl> |
220 </dl> |
|
221 <dl> |
173 <dt>Return Type:</dt> |
222 <dt>Return Type:</dt> |
174 <dd> |
223 <dd> |
175 tuple of (bool, str) |
224 tuple of (bool, str) |
176 </dd> |
225 </dd> |
177 </dl><a NAME="CircuitPythonDevice.canStartFileManager" ID="CircuitPythonDevice.canStartFileManager"></a> |
226 </dl> |
|
227 <a NAME="CircuitPythonDevice.canStartFileManager" ID="CircuitPythonDevice.canStartFileManager"></a> |
178 <h4>CircuitPythonDevice.canStartFileManager</h4> |
228 <h4>CircuitPythonDevice.canStartFileManager</h4> |
179 <b>canStartFileManager</b>(<i></i>) |
229 <b>canStartFileManager</b>(<i></i>) |
|
230 |
180 <p> |
231 <p> |
181 Public method to determine, if a File Manager can be started. |
232 Public method to determine, if a File Manager can be started. |
182 </p><dl> |
233 </p> |
|
234 <dl> |
183 <dt>Returns:</dt> |
235 <dt>Returns:</dt> |
184 <dd> |
236 <dd> |
185 tuple containing a flag indicating it is safe to start a |
237 tuple containing a flag indicating it is safe to start a |
186 File Manager and a reason why it cannot. |
238 File Manager and a reason why it cannot. |
187 </dd> |
239 </dd> |
188 </dl><dl> |
240 </dl> |
|
241 <dl> |
189 <dt>Return Type:</dt> |
242 <dt>Return Type:</dt> |
190 <dd> |
243 <dd> |
191 tuple of (bool, str) |
244 tuple of (bool, str) |
192 </dd> |
245 </dd> |
193 </dl><a NAME="CircuitPythonDevice.canStartPlotter" ID="CircuitPythonDevice.canStartPlotter"></a> |
246 </dl> |
|
247 <a NAME="CircuitPythonDevice.canStartPlotter" ID="CircuitPythonDevice.canStartPlotter"></a> |
194 <h4>CircuitPythonDevice.canStartPlotter</h4> |
248 <h4>CircuitPythonDevice.canStartPlotter</h4> |
195 <b>canStartPlotter</b>(<i></i>) |
249 <b>canStartPlotter</b>(<i></i>) |
|
250 |
196 <p> |
251 <p> |
197 Public method to determine, if a Plotter can be started. |
252 Public method to determine, if a Plotter can be started. |
198 </p><dl> |
253 </p> |
|
254 <dl> |
199 <dt>Returns:</dt> |
255 <dt>Returns:</dt> |
200 <dd> |
256 <dd> |
201 tuple containing a flag indicating it is safe to start a |
257 tuple containing a flag indicating it is safe to start a |
202 Plotter and a reason why it cannot. |
258 Plotter and a reason why it cannot. |
203 </dd> |
259 </dd> |
204 </dl><dl> |
260 </dl> |
|
261 <dl> |
205 <dt>Return Type:</dt> |
262 <dt>Return Type:</dt> |
206 <dd> |
263 <dd> |
207 tuple of (bool, str) |
264 tuple of (bool, str) |
208 </dd> |
265 </dd> |
209 </dl><a NAME="CircuitPythonDevice.canStartRepl" ID="CircuitPythonDevice.canStartRepl"></a> |
266 </dl> |
|
267 <a NAME="CircuitPythonDevice.canStartRepl" ID="CircuitPythonDevice.canStartRepl"></a> |
210 <h4>CircuitPythonDevice.canStartRepl</h4> |
268 <h4>CircuitPythonDevice.canStartRepl</h4> |
211 <b>canStartRepl</b>(<i></i>) |
269 <b>canStartRepl</b>(<i></i>) |
|
270 |
212 <p> |
271 <p> |
213 Public method to determine, if a REPL can be started. |
272 Public method to determine, if a REPL can be started. |
214 </p><dl> |
273 </p> |
|
274 <dl> |
215 <dt>Returns:</dt> |
275 <dt>Returns:</dt> |
216 <dd> |
276 <dd> |
217 tuple containing a flag indicating it is safe to start a REPL |
277 tuple containing a flag indicating it is safe to start a REPL |
218 and a reason why it cannot. |
278 and a reason why it cannot. |
219 </dd> |
279 </dd> |
220 </dl><dl> |
280 </dl> |
|
281 <dl> |
221 <dt>Return Type:</dt> |
282 <dt>Return Type:</dt> |
222 <dd> |
283 <dd> |
223 tuple of (bool, str) |
284 tuple of (bool, str) |
224 </dd> |
285 </dd> |
225 </dl><a NAME="CircuitPythonDevice.deviceName" ID="CircuitPythonDevice.deviceName"></a> |
286 </dl> |
|
287 <a NAME="CircuitPythonDevice.deviceName" ID="CircuitPythonDevice.deviceName"></a> |
226 <h4>CircuitPythonDevice.deviceName</h4> |
288 <h4>CircuitPythonDevice.deviceName</h4> |
227 <b>deviceName</b>(<i></i>) |
289 <b>deviceName</b>(<i></i>) |
|
290 |
228 <p> |
291 <p> |
229 Public method to get the name of the device. |
292 Public method to get the name of the device. |
230 </p><dl> |
293 </p> |
|
294 <dl> |
231 <dt>Returns:</dt> |
295 <dt>Returns:</dt> |
232 <dd> |
296 <dd> |
233 name of the device |
297 name of the device |
234 </dd> |
298 </dd> |
235 </dl><dl> |
299 </dl> |
|
300 <dl> |
236 <dt>Return Type:</dt> |
301 <dt>Return Type:</dt> |
237 <dd> |
302 <dd> |
238 str |
303 str |
239 </dd> |
304 </dd> |
240 </dl><a NAME="CircuitPythonDevice.forceInterrupt" ID="CircuitPythonDevice.forceInterrupt"></a> |
305 </dl> |
|
306 <a NAME="CircuitPythonDevice.forceInterrupt" ID="CircuitPythonDevice.forceInterrupt"></a> |
241 <h4>CircuitPythonDevice.forceInterrupt</h4> |
307 <h4>CircuitPythonDevice.forceInterrupt</h4> |
242 <b>forceInterrupt</b>(<i></i>) |
308 <b>forceInterrupt</b>(<i></i>) |
|
309 |
243 <p> |
310 <p> |
244 Public method to determine the need for an interrupt when opening the |
311 Public method to determine the need for an interrupt when opening the |
245 serial connection. |
312 serial connection. |
246 </p><dl> |
313 </p> |
|
314 <dl> |
247 <dt>Returns:</dt> |
315 <dt>Returns:</dt> |
248 <dd> |
316 <dd> |
249 flag indicating an interrupt is needed |
317 flag indicating an interrupt is needed |
250 </dd> |
318 </dd> |
251 </dl><dl> |
319 </dl> |
|
320 <dl> |
252 <dt>Return Type:</dt> |
321 <dt>Return Type:</dt> |
253 <dd> |
322 <dd> |
254 bool |
323 bool |
255 </dd> |
324 </dd> |
256 </dl><a NAME="CircuitPythonDevice.getDocumentationUrl" ID="CircuitPythonDevice.getDocumentationUrl"></a> |
325 </dl> |
|
326 <a NAME="CircuitPythonDevice.getDocumentationUrl" ID="CircuitPythonDevice.getDocumentationUrl"></a> |
257 <h4>CircuitPythonDevice.getDocumentationUrl</h4> |
327 <h4>CircuitPythonDevice.getDocumentationUrl</h4> |
258 <b>getDocumentationUrl</b>(<i></i>) |
328 <b>getDocumentationUrl</b>(<i></i>) |
|
329 |
259 <p> |
330 <p> |
260 Public method to get the device documentation URL. |
331 Public method to get the device documentation URL. |
261 </p><dl> |
332 </p> |
|
333 <dl> |
262 <dt>Returns:</dt> |
334 <dt>Returns:</dt> |
263 <dd> |
335 <dd> |
264 documentation URL of the device |
336 documentation URL of the device |
265 </dd> |
337 </dd> |
266 </dl><dl> |
338 </dl> |
|
339 <dl> |
267 <dt>Return Type:</dt> |
340 <dt>Return Type:</dt> |
268 <dd> |
341 <dd> |
269 str |
342 str |
270 </dd> |
343 </dd> |
271 </dl><a NAME="CircuitPythonDevice.getWorkspace" ID="CircuitPythonDevice.getWorkspace"></a> |
344 </dl> |
|
345 <a NAME="CircuitPythonDevice.getWorkspace" ID="CircuitPythonDevice.getWorkspace"></a> |
272 <h4>CircuitPythonDevice.getWorkspace</h4> |
346 <h4>CircuitPythonDevice.getWorkspace</h4> |
273 <b>getWorkspace</b>(<i>silent=False</i>) |
347 <b>getWorkspace</b>(<i>silent=False</i>) |
|
348 |
274 <p> |
349 <p> |
275 Public method to get the workspace directory. |
350 Public method to get the workspace directory. |
276 </p><dl> |
351 </p> |
|
352 <dl> |
|
353 |
277 <dt><i>silent</i> (bool)</dt> |
354 <dt><i>silent</i> (bool)</dt> |
278 <dd> |
355 <dd> |
279 flag indicating silent operations |
356 flag indicating silent operations |
280 </dd> |
357 </dd> |
281 </dl><dl> |
358 </dl> |
|
359 <dl> |
282 <dt>Returns:</dt> |
360 <dt>Returns:</dt> |
283 <dd> |
361 <dd> |
284 workspace directory used for saving files |
362 workspace directory used for saving files |
285 </dd> |
363 </dd> |
286 </dl><dl> |
364 </dl> |
|
365 <dl> |
287 <dt>Return Type:</dt> |
366 <dt>Return Type:</dt> |
288 <dd> |
367 <dd> |
289 str |
368 str |
290 </dd> |
369 </dd> |
291 </dl><a NAME="CircuitPythonDevice.runScript" ID="CircuitPythonDevice.runScript"></a> |
370 </dl> |
|
371 <a NAME="CircuitPythonDevice.runScript" ID="CircuitPythonDevice.runScript"></a> |
292 <h4>CircuitPythonDevice.runScript</h4> |
372 <h4>CircuitPythonDevice.runScript</h4> |
293 <b>runScript</b>(<i>script</i>) |
373 <b>runScript</b>(<i>script</i>) |
|
374 |
294 <p> |
375 <p> |
295 Public method to run the given Python script. |
376 Public method to run the given Python script. |
296 </p><dl> |
377 </p> |
|
378 <dl> |
|
379 |
297 <dt><i>script</i> (str)</dt> |
380 <dt><i>script</i> (str)</dt> |
298 <dd> |
381 <dd> |
299 script to be executed |
382 script to be executed |
300 </dd> |
383 </dd> |
301 </dl><a NAME="CircuitPythonDevice.setButtons" ID="CircuitPythonDevice.setButtons"></a> |
384 </dl> |
|
385 <a NAME="CircuitPythonDevice.setButtons" ID="CircuitPythonDevice.setButtons"></a> |
302 <h4>CircuitPythonDevice.setButtons</h4> |
386 <h4>CircuitPythonDevice.setButtons</h4> |
303 <b>setButtons</b>(<i></i>) |
387 <b>setButtons</b>(<i></i>) |
|
388 |
304 <p> |
389 <p> |
305 Public method to enable the supported action buttons. |
390 Public method to enable the supported action buttons. |
306 </p><a NAME="CircuitPythonDevice.supportsLocalFileAccess" ID="CircuitPythonDevice.supportsLocalFileAccess"></a> |
391 </p> |
|
392 <a NAME="CircuitPythonDevice.supportsLocalFileAccess" ID="CircuitPythonDevice.supportsLocalFileAccess"></a> |
307 <h4>CircuitPythonDevice.supportsLocalFileAccess</h4> |
393 <h4>CircuitPythonDevice.supportsLocalFileAccess</h4> |
308 <b>supportsLocalFileAccess</b>(<i></i>) |
394 <b>supportsLocalFileAccess</b>(<i></i>) |
|
395 |
309 <p> |
396 <p> |
310 Public method to indicate file access via a local directory. |
397 Public method to indicate file access via a local directory. |
311 </p><dl> |
398 </p> |
|
399 <dl> |
312 <dt>Returns:</dt> |
400 <dt>Returns:</dt> |
313 <dd> |
401 <dd> |
314 flag indicating file access via local directory |
402 flag indicating file access via local directory |
315 </dd> |
403 </dd> |
316 </dl><dl> |
404 </dl> |
|
405 <dl> |
317 <dt>Return Type:</dt> |
406 <dt>Return Type:</dt> |
318 <dd> |
407 <dd> |
319 bool |
408 bool |
320 </dd> |
409 </dd> |
321 </dl> |
410 </dl> |