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

branch
eric7
changeset 9738
4ae976ee5339
parent 9503
ae9232bf4854
child 9740
90072e10ae9b
equal deleted inserted replaced
9737:5e05b2089daf 9738:4ae976ee5339
65 <tr> 65 <tr>
66 <td><a href="#CircuitPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td> 66 <td><a href="#CircuitPythonDevice.__deviceVolumeMounted">__deviceVolumeMounted</a></td>
67 <td>Private method to check, if the device volume is mounted.</td> 67 <td>Private method to check, if the device volume is mounted.</td>
68 </tr> 68 </tr>
69 <tr> 69 <tr>
70 <td><a href="#CircuitPythonDevice.__findDeviceDirectories">__findDeviceDirectories</a></td>
71 <td>Private method to find the device directories associated with the current board name.</td>
72 </tr>
73 <tr>
70 <td><a href="#CircuitPythonDevice.__findWorkspace">__findWorkspace</a></td> 74 <td><a href="#CircuitPythonDevice.__findWorkspace">__findWorkspace</a></td>
71 <td>Private method to find the workspace directory.</td> 75 <td>Private method to find the workspace directory.</td>
72 </tr> 76 </tr>
73 <tr> 77 <tr>
74 <td><a href="#CircuitPythonDevice.__flashCircuitPython">__flashCircuitPython</a></td> 78 <td><a href="#CircuitPythonDevice.__flashCircuitPython">__flashCircuitPython</a></td>
145 <tr><td>None</td></tr> 149 <tr><td>None</td></tr>
146 </table> 150 </table>
147 151
148 <a NAME="CircuitPythonDevice.__init__" ID="CircuitPythonDevice.__init__"></a> 152 <a NAME="CircuitPythonDevice.__init__" ID="CircuitPythonDevice.__init__"></a>
149 <h4>CircuitPythonDevice (Constructor)</h4> 153 <h4>CircuitPythonDevice (Constructor)</h4>
150 <b>CircuitPythonDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>) 154 <b>CircuitPythonDevice</b>(<i>microPythonWidget, deviceType, boardName, parent=None</i>)
151 155
152 <p> 156 <p>
153 Constructor 157 Constructor
154 </p> 158 </p>
155 <dl> 159 <dl>
159 reference to the main MicroPython widget 163 reference to the main MicroPython widget
160 </dd> 164 </dd>
161 <dt><i>deviceType</i> (str)</dt> 165 <dt><i>deviceType</i> (str)</dt>
162 <dd> 166 <dd>
163 device type assigned to this device interface 167 device type assigned to this device interface
168 </dd>
169 <dt><i>boardName</i> (str)</dt>
170 <dd>
171 name of the board
164 </dd> 172 </dd>
165 <dt><i>parent</i> (QObject)</dt> 173 <dt><i>parent</i> (QObject)</dt>
166 <dd> 174 <dd>
167 reference to the parent object 175 reference to the parent object
168 </dd> 176 </dd>
184 <dt>Return Type:</dt> 192 <dt>Return Type:</dt>
185 <dd> 193 <dd>
186 bool 194 bool
187 </dd> 195 </dd>
188 </dl> 196 </dl>
197 <a NAME="CircuitPythonDevice.__findDeviceDirectories" ID="CircuitPythonDevice.__findDeviceDirectories"></a>
198 <h4>CircuitPythonDevice.__findDeviceDirectories</h4>
199 <b>__findDeviceDirectories</b>(<i>directories</i>)
200
201 <p>
202 Private method to find the device directories associated with the
203 current board name.
204 </p>
205 <dl>
206
207 <dt><i>directories</i> (list of str)</dt>
208 <dd>
209 list of directories to be checked
210 </dd>
211 </dl>
212 <dl>
213 <dt>Return:</dt>
214 <dd>
215 list of associated directories
216 </dd>
217 </dl>
218 <dl>
219 <dt>Return Type:</dt>
220 <dd>
221 list of str
222 </dd>
223 </dl>
189 <a NAME="CircuitPythonDevice.__findWorkspace" ID="CircuitPythonDevice.__findWorkspace"></a> 224 <a NAME="CircuitPythonDevice.__findWorkspace" ID="CircuitPythonDevice.__findWorkspace"></a>
190 <h4>CircuitPythonDevice.__findWorkspace</h4> 225 <h4>CircuitPythonDevice.__findWorkspace</h4>
191 <b>__findWorkspace</b>(<i>silent=False</i>) 226 <b>__findWorkspace</b>(<i>silent=False</i>)
192 227
193 <p> 228 <p>
227 Private method to show a message box because Teens does not support 262 Private method to show a message box because Teens does not support
228 the UF2 bootloader yet. 263 the UF2 bootloader yet.
229 </p> 264 </p>
230 <a NAME="CircuitPythonDevice.__installLibraryFiles" ID="CircuitPythonDevice.__installLibraryFiles"></a> 265 <a NAME="CircuitPythonDevice.__installLibraryFiles" ID="CircuitPythonDevice.__installLibraryFiles"></a>
231 <h4>CircuitPythonDevice.__installLibraryFiles</h4> 266 <h4>CircuitPythonDevice.__installLibraryFiles</h4>
232 <b>__installLibraryFiles</b>(<i></i>) 267 <b>__installLibraryFiles</b>(<i>packageMode=False</i>)
233 268
234 <p> 269 <p>
235 Private slot to install Python files into the onboard library. 270 Private slot to install Python files into the onboard library.
236 </p> 271 </p>
272 <dl>
273
274 <dt><i>packageMode</i> (bool (optional))</dt>
275 <dd>
276 flag indicating to install a library package
277 (defaults to False)
278 </dd>
279 </dl>
237 <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a> 280 <a NAME="CircuitPythonDevice.addDeviceMenuEntries" ID="CircuitPythonDevice.addDeviceMenuEntries"></a>
238 <h4>CircuitPythonDevice.addDeviceMenuEntries</h4> 281 <h4>CircuitPythonDevice.addDeviceMenuEntries</h4>
239 <b>addDeviceMenuEntries</b>(<i>menu</i>) 282 <b>addDeviceMenuEntries</b>(<i>menu</i>)
240 283
241 <p> 284 <p>
494 <div align="right"><a href="#top">Up</a></div> 537 <div align="right"><a href="#top">Up</a></div>
495 <hr /> 538 <hr />
496 <hr /> 539 <hr />
497 <a NAME="createDevice" ID="createDevice"></a> 540 <a NAME="createDevice" ID="createDevice"></a>
498 <h2>createDevice</h2> 541 <h2>createDevice</h2>
499 <b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid</i>) 542 <b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName</i>)
500 543
501 <p> 544 <p>
502 Function to instantiate a MicroPython device object. 545 Function to instantiate a MicroPython device object.
503 </p> 546 </p>
504 <dl> 547 <dl>
516 vendor ID 559 vendor ID
517 </dd> 560 </dd>
518 <dt><i>pid</i> (int)</dt> 561 <dt><i>pid</i> (int)</dt>
519 <dd> 562 <dd>
520 product ID 563 product ID
564 </dd>
565 <dt><i>boardName</i> (str)</dt>
566 <dd>
567 name of the board
521 </dd> 568 </dd>
522 </dl> 569 </dl>
523 <dl> 570 <dl>
524 <dt>Return:</dt> 571 <dt>Return:</dt>
525 <dd> 572 <dd>

eric ide

mercurial