src/eric7/Documentation/Source/eric7.MicroPython.MicrobitDevices.html

branch
eric7
changeset 9753
a774e75a45ca
parent 9749
5d409223cf3f
equal deleted inserted replaced
9752:2b9546c0cbd9 9753:a774e75a45ca
62 <tr> 62 <tr>
63 <td><a href="#MicrobitDevice.__init__">MicrobitDevice</a></td> 63 <td><a href="#MicrobitDevice.__init__">MicrobitDevice</a></td>
64 <td>Constructor</td> 64 <td>Constructor</td>
65 </tr> 65 </tr>
66 <tr> 66 <tr>
67 <td><a href="#MicrobitDevice.__createMicrobitMenu">__createMicrobitMenu</a></td>
68 <td>Private method to create the microbit submenu.</td>
69 </tr>
70 <tr>
67 <td><a href="#MicrobitDevice.__firmwareVersionResponse">__firmwareVersionResponse</a></td> 71 <td><a href="#MicrobitDevice.__firmwareVersionResponse">__firmwareVersionResponse</a></td>
68 <td>Private method handling the response of the latest version request.</td> 72 <td>Private method handling the response of the latest version request.</td>
69 </tr> 73 </tr>
70 <tr> 74 <tr>
71 <td><a href="#MicrobitDevice.__flashMicroPython">__flashMicroPython</a></td> 75 <td><a href="#MicrobitDevice.__flashMicroPython">__flashMicroPython</a></td>
72 <td>Private slot to flash MicroPython or the DAPLink firmware to the device.</td> 76 <td>Private slot to flash MicroPython or the DAPLink firmware to the device.</td>
77 </tr>
78 <tr>
79 <td><a href="#MicrobitDevice.__isCalliope">__isCalliope</a></td>
80 <td>Private method to check, if the device is a Calliope mini.</td>
81 </tr>
82 <tr>
83 <td><a href="#MicrobitDevice.__isMicroBitV1">__isMicroBitV1</a></td>
84 <td>Private method to check, if the device is a BBC micro:bit v1.</td>
85 </tr>
86 <tr>
87 <td><a href="#MicrobitDevice.__isMicroBitV2">__isMicroBitV2</a></td>
88 <td>Private method to check, if the device is a BBC micro:bit v2.</td>
73 </tr> 89 </tr>
74 <tr> 90 <tr>
75 <td><a href="#MicrobitDevice.__resetDevice">__resetDevice</a></td> 91 <td><a href="#MicrobitDevice.__resetDevice">__resetDevice</a></td>
76 <td>Private slot to reset the connected device.</td> 92 <td>Private slot to reset the connected device.</td>
77 </tr> 93 </tr>
146 <tr><td>None</td></tr> 162 <tr><td>None</td></tr>
147 </table> 163 </table>
148 164
149 <a NAME="MicrobitDevice.__init__" ID="MicrobitDevice.__init__"></a> 165 <a NAME="MicrobitDevice.__init__" ID="MicrobitDevice.__init__"></a>
150 <h4>MicrobitDevice (Constructor)</h4> 166 <h4>MicrobitDevice (Constructor)</h4>
151 <b>MicrobitDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>) 167 <b>MicrobitDevice</b>(<i>microPythonWidget, deviceType, serialNumber, parent=None</i>)
152 168
153 <p> 169 <p>
154 Constructor 170 Constructor
155 </p> 171 </p>
156 <dl> 172 <dl>
161 </dd> 177 </dd>
162 <dt><i>deviceType</i> (str)</dt> 178 <dt><i>deviceType</i> (str)</dt>
163 <dd> 179 <dd>
164 type of the device 180 type of the device
165 </dd> 181 </dd>
182 <dt><i>serialNumber</i> (str)</dt>
183 <dd>
184 serial number of the board
185 </dd>
166 <dt><i>parent</i> (QObject)</dt> 186 <dt><i>parent</i> (QObject)</dt>
167 <dd> 187 <dd>
168 reference to the parent object 188 reference to the parent object
169 </dd> 189 </dd>
170 </dl> 190 </dl>
191 <a NAME="MicrobitDevice.__createMicrobitMenu" ID="MicrobitDevice.__createMicrobitMenu"></a>
192 <h4>MicrobitDevice.__createMicrobitMenu</h4>
193 <b>__createMicrobitMenu</b>(<i></i>)
194
195 <p>
196 Private method to create the microbit submenu.
197 </p>
171 <a NAME="MicrobitDevice.__firmwareVersionResponse" ID="MicrobitDevice.__firmwareVersionResponse"></a> 198 <a NAME="MicrobitDevice.__firmwareVersionResponse" ID="MicrobitDevice.__firmwareVersionResponse"></a>
172 <h4>MicrobitDevice.__firmwareVersionResponse</h4> 199 <h4>MicrobitDevice.__firmwareVersionResponse</h4>
173 <b>__firmwareVersionResponse</b>(<i>reply, implementation</i>) 200 <b>__firmwareVersionResponse</b>(<i>reply</i>)
174 201
175 <p> 202 <p>
176 Private method handling the response of the latest version request. 203 Private method handling the response of the latest version request.
177 </p> 204 </p>
178 <dl> 205 <dl>
179 206
180 <dt><i>reply</i> (QNetworkReply)</dt> 207 <dt><i>reply</i> (QNetworkReply)</dt>
181 <dd> 208 <dd>
182 reference to the reply object 209 reference to the reply object
183 </dd>
184 <dt><i>implementation</i> (dict)</dt>
185 <dd>
186 dictionary containing the implementation data of the
187 connected device
188 </dd> 210 </dd>
189 </dl> 211 </dl>
190 <a NAME="MicrobitDevice.__flashMicroPython" ID="MicrobitDevice.__flashMicroPython"></a> 212 <a NAME="MicrobitDevice.__flashMicroPython" ID="MicrobitDevice.__flashMicroPython"></a>
191 <h4>MicrobitDevice.__flashMicroPython</h4> 213 <h4>MicrobitDevice.__flashMicroPython</h4>
192 <b>__flashMicroPython</b>(<i>firmware=False</i>) 214 <b>__flashMicroPython</b>(<i>firmware=False</i>)
198 <dl> 220 <dl>
199 221
200 <dt><i>firmware</i> (bool)</dt> 222 <dt><i>firmware</i> (bool)</dt>
201 <dd> 223 <dd>
202 flag indicating to flash the DAPLink firmware 224 flag indicating to flash the DAPLink firmware
225 </dd>
226 </dl>
227 <a NAME="MicrobitDevice.__isCalliope" ID="MicrobitDevice.__isCalliope"></a>
228 <h4>MicrobitDevice.__isCalliope</h4>
229 <b>__isCalliope</b>(<i></i>)
230
231 <p>
232 Private method to check, if the device is a Calliope mini.
233 </p>
234 <dl>
235 <dt>Return:</dt>
236 <dd>
237 flag indicating a Calliope mini
238 </dd>
239 </dl>
240 <dl>
241 <dt>Return Type:</dt>
242 <dd>
243 bool
244 </dd>
245 </dl>
246 <a NAME="MicrobitDevice.__isMicroBitV1" ID="MicrobitDevice.__isMicroBitV1"></a>
247 <h4>MicrobitDevice.__isMicroBitV1</h4>
248 <b>__isMicroBitV1</b>(<i></i>)
249
250 <p>
251 Private method to check, if the device is a BBC micro:bit v1.
252 </p>
253 <dl>
254 <dt>Return:</dt>
255 <dd>
256 falg indicating a BBC micro:bit v1
257 </dd>
258 </dl>
259 <dl>
260 <dt>Return Type:</dt>
261 <dd>
262 bool
263 </dd>
264 </dl>
265 <a NAME="MicrobitDevice.__isMicroBitV2" ID="MicrobitDevice.__isMicroBitV2"></a>
266 <h4>MicrobitDevice.__isMicroBitV2</h4>
267 <b>__isMicroBitV2</b>(<i></i>)
268
269 <p>
270 Private method to check, if the device is a BBC micro:bit v2.
271 </p>
272 <dl>
273 <dt>Return:</dt>
274 <dd>
275 falg indicating a BBC micro:bit v2
276 </dd>
277 </dl>
278 <dl>
279 <dt>Return Type:</dt>
280 <dd>
281 bool
203 </dd> 282 </dd>
204 </dl> 283 </dl>
205 <a NAME="MicrobitDevice.__resetDevice" ID="MicrobitDevice.__resetDevice"></a> 284 <a NAME="MicrobitDevice.__resetDevice" ID="MicrobitDevice.__resetDevice"></a>
206 <h4>MicrobitDevice.__resetDevice</h4> 285 <h4>MicrobitDevice.__resetDevice</h4>
207 <b>__resetDevice</b>(<i></i>) 286 <b>__resetDevice</b>(<i></i>)
477 <div align="right"><a href="#top">Up</a></div> 556 <div align="right"><a href="#top">Up</a></div>
478 <hr /> 557 <hr />
479 <hr /> 558 <hr />
480 <a NAME="createDevice" ID="createDevice"></a> 559 <a NAME="createDevice" ID="createDevice"></a>
481 <h2>createDevice</h2> 560 <h2>createDevice</h2>
482 <b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName</i>) 561 <b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName, serialNumber</i>)
483 562
484 <p> 563 <p>
485 Function to instantiate a MicroPython device object. 564 Function to instantiate a MicroPython device object.
486 </p> 565 </p>
487 <dl> 566 <dl>
503 product ID 582 product ID
504 </dd> 583 </dd>
505 <dt><i>boardName</i> (str)</dt> 584 <dt><i>boardName</i> (str)</dt>
506 <dd> 585 <dd>
507 name of the board 586 name of the board
587 </dd>
588 <dt><i>serialNumber</i> (str)</dt>
589 <dd>
590 serial number of the board
508 </dd> 591 </dd>
509 </dl> 592 </dl>
510 <dl> 593 <dl>
511 <dt>Return:</dt> 594 <dt>Return:</dt>
512 <dd> 595 <dd>

eric ide

mercurial