75 <tr> |
75 <tr> |
76 <td><a href="#PyBoardDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td> |
76 <td><a href="#PyBoardDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td> |
77 <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> |
78 </tr> |
78 </tr> |
79 <tr> |
79 <tr> |
80 <td><a href="#PyBoardDevice.__showInstallInstructions">__showInstallInstructions</a></td> |
80 <td><a href="#PyBoardDevice.__dfuUtilAvailable">__dfuUtilAvailable</a></td> |
|
81 <td>Private method to check the availability of dfu-util.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#PyBoardDevice.__flashMicroPython">__flashMicroPython</a></td> |
|
85 <td>Private slot to flash a MicroPython firmware.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#PyBoardDevice.__listDfuCapableDevices">__listDfuCapableDevices</a></td> |
|
89 <td>Private slot to list all DFU-capable devices.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#PyBoardDevice.__showDfuDisableInstructions">__showDfuDisableInstructions</a></td> |
|
93 <td>Private method to show some instructions to disable the DFU mode.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#PyBoardDevice.__showDfuEnableInstructions">__showDfuEnableInstructions</a></td> |
|
97 <td>Private method to show some instructions to enable the DFU mode.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#PyBoardDevice.__showFlashInstructions">__showFlashInstructions</a></td> |
81 <td>Private slot to open the URL containing instructions for installing MicroPython on the pyboard.</td> |
101 <td>Private slot to open the URL containing instructions for installing MicroPython on the pyboard.</td> |
82 </tr> |
102 </tr> |
83 <tr> |
103 <tr> |
84 <td><a href="#PyBoardDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
104 <td><a href="#PyBoardDevice.addDeviceMenuEntries">addDeviceMenuEntries</a></td> |
85 <td>Public method to add device specific entries to the given menu.</td> |
105 <td>Public method to add device specific entries to the given menu.</td> |
109 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
129 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
110 </tr> |
130 </tr> |
111 <tr> |
131 <tr> |
112 <td><a href="#PyBoardDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
132 <td><a href="#PyBoardDevice.getDocumentationUrl">getDocumentationUrl</a></td> |
113 <td>Public method to get the device documentation URL.</td> |
133 <td>Public method to get the device documentation URL.</td> |
|
134 </tr> |
|
135 <tr> |
|
136 <td><a href="#PyBoardDevice.getFirmwareUrl">getFirmwareUrl</a></td> |
|
137 <td>Public method to get the device firmware download URL.</td> |
114 </tr> |
138 </tr> |
115 <tr> |
139 <tr> |
116 <td><a href="#PyBoardDevice.getWorkspace">getWorkspace</a></td> |
140 <td><a href="#PyBoardDevice.getWorkspace">getWorkspace</a></td> |
117 <td>Public method to get the workspace directory.</td> |
141 <td>Public method to get the workspace directory.</td> |
118 </tr> |
142 </tr> |
170 <dt>Return Type:</dt> |
194 <dt>Return Type:</dt> |
171 <dd> |
195 <dd> |
172 bool |
196 bool |
173 </dd> |
197 </dd> |
174 </dl> |
198 </dl> |
175 <a NAME="PyBoardDevice.__showInstallInstructions" ID="PyBoardDevice.__showInstallInstructions"></a> |
199 <a NAME="PyBoardDevice.__dfuUtilAvailable" ID="PyBoardDevice.__dfuUtilAvailable"></a> |
176 <h4>PyBoardDevice.__showInstallInstructions</h4> |
200 <h4>PyBoardDevice.__dfuUtilAvailable</h4> |
177 <b>__showInstallInstructions</b>(<i></i>) |
201 <b>__dfuUtilAvailable</b>(<i></i>) |
|
202 |
|
203 <p> |
|
204 Private method to check the availability of dfu-util. |
|
205 </p> |
|
206 <dl> |
|
207 <dt>Returns:</dt> |
|
208 <dd> |
|
209 flag indicating the availability of dfu-util |
|
210 </dd> |
|
211 </dl> |
|
212 <dl> |
|
213 <dt>Return Type:</dt> |
|
214 <dd> |
|
215 bool |
|
216 </dd> |
|
217 </dl> |
|
218 <a NAME="PyBoardDevice.__flashMicroPython" ID="PyBoardDevice.__flashMicroPython"></a> |
|
219 <h4>PyBoardDevice.__flashMicroPython</h4> |
|
220 <b>__flashMicroPython</b>(<i></i>) |
|
221 |
|
222 <p> |
|
223 Private slot to flash a MicroPython firmware. |
|
224 </p> |
|
225 <a NAME="PyBoardDevice.__listDfuCapableDevices" ID="PyBoardDevice.__listDfuCapableDevices"></a> |
|
226 <h4>PyBoardDevice.__listDfuCapableDevices</h4> |
|
227 <b>__listDfuCapableDevices</b>(<i></i>) |
|
228 |
|
229 <p> |
|
230 Private slot to list all DFU-capable devices. |
|
231 </p> |
|
232 <a NAME="PyBoardDevice.__showDfuDisableInstructions" ID="PyBoardDevice.__showDfuDisableInstructions"></a> |
|
233 <h4>PyBoardDevice.__showDfuDisableInstructions</h4> |
|
234 <b>__showDfuDisableInstructions</b>(<i></i>) |
|
235 |
|
236 <p> |
|
237 Private method to show some instructions to disable the DFU mode. |
|
238 </p> |
|
239 <a NAME="PyBoardDevice.__showDfuEnableInstructions" ID="PyBoardDevice.__showDfuEnableInstructions"></a> |
|
240 <h4>PyBoardDevice.__showDfuEnableInstructions</h4> |
|
241 <b>__showDfuEnableInstructions</b>(<i>flash=True</i>) |
|
242 |
|
243 <p> |
|
244 Private method to show some instructions to enable the DFU mode. |
|
245 </p> |
|
246 <dl> |
|
247 |
|
248 <dt><i>flash</i> (bool)</dt> |
|
249 <dd> |
|
250 flag indicating to show a warning message for flashing |
|
251 </dd> |
|
252 </dl> |
|
253 <dl> |
|
254 <dt>Returns:</dt> |
|
255 <dd> |
|
256 flag indicating OK to continue or abort |
|
257 </dd> |
|
258 </dl> |
|
259 <dl> |
|
260 <dt>Return Type:</dt> |
|
261 <dd> |
|
262 bool |
|
263 </dd> |
|
264 </dl> |
|
265 <a NAME="PyBoardDevice.__showFlashInstructions" ID="PyBoardDevice.__showFlashInstructions"></a> |
|
266 <h4>PyBoardDevice.__showFlashInstructions</h4> |
|
267 <b>__showFlashInstructions</b>(<i></i>) |
178 |
268 |
179 <p> |
269 <p> |
180 Private slot to open the URL containing instructions for installing |
270 Private slot to open the URL containing instructions for installing |
181 MicroPython on the pyboard. |
271 MicroPython on the pyboard. |
182 </p> |
272 </p> |
330 <dt>Return Type:</dt> |
420 <dt>Return Type:</dt> |
331 <dd> |
421 <dd> |
332 str |
422 str |
333 </dd> |
423 </dd> |
334 </dl> |
424 </dl> |
|
425 <a NAME="PyBoardDevice.getFirmwareUrl" ID="PyBoardDevice.getFirmwareUrl"></a> |
|
426 <h4>PyBoardDevice.getFirmwareUrl</h4> |
|
427 <b>getFirmwareUrl</b>(<i></i>) |
|
428 |
|
429 <p> |
|
430 Public method to get the device firmware download URL. |
|
431 </p> |
|
432 <dl> |
|
433 <dt>Returns:</dt> |
|
434 <dd> |
|
435 firmware download URL of the device |
|
436 </dd> |
|
437 </dl> |
|
438 <dl> |
|
439 <dt>Return Type:</dt> |
|
440 <dd> |
|
441 str |
|
442 </dd> |
|
443 </dl> |
335 <a NAME="PyBoardDevice.getWorkspace" ID="PyBoardDevice.getWorkspace"></a> |
444 <a NAME="PyBoardDevice.getWorkspace" ID="PyBoardDevice.getWorkspace"></a> |
336 <h4>PyBoardDevice.getWorkspace</h4> |
445 <h4>PyBoardDevice.getWorkspace</h4> |
337 <b>getWorkspace</b>(<i>silent=False</i>) |
446 <b>getWorkspace</b>(<i>silent=False</i>) |
338 |
447 |
339 <p> |
448 <p> |