src/eric7/Documentation/Source/eric7.MicroPython.Devices.CircuitPythonUpdater.CircuitPythonUpdaterInterface.html

branch
eric7
changeset 10479
856476537696
parent 10478
de9106c55c3d
child 11011
f1f1c8d0255d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.MicroPython.Devices.CircuitPythonUpdater.CircuitPythonUpdaterInterface</h1> 9 <h1>eric7.MicroPython.Devices.CircuitPythonUpdater.CircuitPythonUpdaterInterface</h1>
10
11 <p> 10 <p>
12 Module implementing an interface to the 'circup' package. 11 Module implementing an interface to the 'circup' package.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>circup</td></tr> 16 <tr><td>circup</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#CircuitPythonUpdaterInterface">CircuitPythonUpdaterInterface</a></td> 22 <td><a href="#CircuitPythonUpdaterInterface">CircuitPythonUpdaterInterface</a></td>
25 <td>Class implementing an interface to the 'circup' package.</td> 23 <td>Class implementing an interface to the 'circup' package.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#isCircupAvailable">isCircupAvailable</a></td> 30 <td><a href="#isCircupAvailable">isCircupAvailable</a></td>
34 <td>Function to check for the availability of 'circup'.</td> 31 <td>Function to check for the availability of 'circup'.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="CircuitPythonUpdaterInterface" ID="CircuitPythonUpdaterInterface"></a> 37 <a NAME="CircuitPythonUpdaterInterface" ID="CircuitPythonUpdaterInterface"></a>
40 <h2>CircuitPythonUpdaterInterface</h2> 38 <h2>CircuitPythonUpdaterInterface</h2>
41
42 <p> 39 <p>
43 Class implementing an interface to the 'circup' package. 40 Class implementing an interface to the 'circup' package.
44 </p> 41 </p>
42
45 <h3>Derived from</h3> 43 <h3>Derived from</h3>
46 QObject 44 QObject
47 <h3>Class Attributes</h3> 45 <h3>Class Attributes</h3>
48
49 <table> 46 <table>
50 <tr><td>None</td></tr> 47 <tr><td>None</td></tr>
51 </table> 48 </table>
49
52 <h3>Class Methods</h3> 50 <h3>Class Methods</h3>
53
54 <table> 51 <table>
55 <tr><td>None</td></tr> 52 <tr><td>None</td></tr>
56 </table> 53 </table>
54
57 <h3>Methods</h3> 55 <h3>Methods</h3>
58 56 <table>
59 <table>
60
61 <tr> 57 <tr>
62 <td><a href="#CircuitPythonUpdaterInterface.__init__">CircuitPythonUpdaterInterface</a></td> 58 <td><a href="#CircuitPythonUpdaterInterface.__init__">CircuitPythonUpdaterInterface</a></td>
63 <td>Constructor</td> 59 <td>Constructor</td>
64 </tr> 60 </tr>
65 <tr> 61 <tr>
141 <tr> 137 <tr>
142 <td><a href="#CircuitPythonUpdaterInterface.populateMenu">populateMenu</a></td> 138 <td><a href="#CircuitPythonUpdaterInterface.populateMenu">populateMenu</a></td>
143 <td>Public method to populate the 'circup' menu.</td> 139 <td>Public method to populate the 'circup' menu.</td>
144 </tr> 140 </tr>
145 </table> 141 </table>
142
146 <h3>Static Methods</h3> 143 <h3>Static Methods</h3>
147
148 <table> 144 <table>
149 <tr><td>None</td></tr> 145 <tr><td>None</td></tr>
150 </table> 146 </table>
147
151 148
152 <a NAME="CircuitPythonUpdaterInterface.__init__" ID="CircuitPythonUpdaterInterface.__init__"></a> 149 <a NAME="CircuitPythonUpdaterInterface.__init__" ID="CircuitPythonUpdaterInterface.__init__"></a>
153 <h4>CircuitPythonUpdaterInterface (Constructor)</h4> 150 <h4>CircuitPythonUpdaterInterface (Constructor)</h4>
154 <b>CircuitPythonUpdaterInterface</b>(<i>device, parent=None</i>) 151 <b>CircuitPythonUpdaterInterface</b>(<i>device, parent=None</i>)
155
156 <p> 152 <p>
157 Constructor 153 Constructor
158 </p> 154 </p>
155
159 <dl> 156 <dl>
160 157
161 <dt><i>device</i> (CircuitPythonDevice)</dt> 158 <dt><i>device</i> (CircuitPythonDevice)</dt>
162 <dd> 159 <dd>
163 reference to the CircuitPython device interface 160 reference to the CircuitPython device interface
168 </dd> 165 </dd>
169 </dl> 166 </dl>
170 <a NAME="CircuitPythonUpdaterInterface.__aboutCircup" ID="CircuitPythonUpdaterInterface.__aboutCircup"></a> 167 <a NAME="CircuitPythonUpdaterInterface.__aboutCircup" ID="CircuitPythonUpdaterInterface.__aboutCircup"></a>
171 <h4>CircuitPythonUpdaterInterface.__aboutCircup</h4> 168 <h4>CircuitPythonUpdaterInterface.__aboutCircup</h4>
172 <b>__aboutCircup</b>(<i></i>) 169 <b>__aboutCircup</b>(<i></i>)
173
174 <p> 170 <p>
175 Private slot to show some info about 'circup'. 171 Private slot to show some info about 'circup'.
176 </p> 172 </p>
173
177 <a NAME="CircuitPythonUpdaterInterface.__addBundle" ID="CircuitPythonUpdaterInterface.__addBundle"></a> 174 <a NAME="CircuitPythonUpdaterInterface.__addBundle" ID="CircuitPythonUpdaterInterface.__addBundle"></a>
178 <h4>CircuitPythonUpdaterInterface.__addBundle</h4> 175 <h4>CircuitPythonUpdaterInterface.__addBundle</h4>
179 <b>__addBundle</b>(<i></i>) 176 <b>__addBundle</b>(<i></i>)
180
181 <p> 177 <p>
182 Private slot to add a bundle to the local bundles list, by "user/repo" github 178 Private slot to add a bundle to the local bundles list, by "user/repo" github
183 string. 179 string.
184 </p> 180 </p>
181
185 <a NAME="CircuitPythonUpdaterInterface.__doUpdateModules" ID="CircuitPythonUpdaterInterface.__doUpdateModules"></a> 182 <a NAME="CircuitPythonUpdaterInterface.__doUpdateModules" ID="CircuitPythonUpdaterInterface.__doUpdateModules"></a>
186 <h4>CircuitPythonUpdaterInterface.__doUpdateModules</h4> 183 <h4>CircuitPythonUpdaterInterface.__doUpdateModules</h4>
187 <b>__doUpdateModules</b>(<i>modules</i>) 184 <b>__doUpdateModules</b>(<i>modules</i>)
188
189 <p> 185 <p>
190 Private method to perform the update of a list of modules. 186 Private method to perform the update of a list of modules.
191 </p> 187 </p>
188
192 <dl> 189 <dl>
193 190
194 <dt><i>modules</i> (circup.Module)</dt> 191 <dt><i>modules</i> (circup.Module)</dt>
195 <dd> 192 <dd>
196 list of modules to be updated 193 list of modules to be updated
197 </dd> 194 </dd>
198 </dl> 195 </dl>
199 <a NAME="CircuitPythonUpdaterInterface.__generateRequirements" ID="CircuitPythonUpdaterInterface.__generateRequirements"></a> 196 <a NAME="CircuitPythonUpdaterInterface.__generateRequirements" ID="CircuitPythonUpdaterInterface.__generateRequirements"></a>
200 <h4>CircuitPythonUpdaterInterface.__generateRequirements</h4> 197 <h4>CircuitPythonUpdaterInterface.__generateRequirements</h4>
201 <b>__generateRequirements</b>(<i></i>) 198 <b>__generateRequirements</b>(<i></i>)
202
203 <p> 199 <p>
204 Private slot to generate requirements for the connected device. 200 Private slot to generate requirements for the connected device.
205 </p> 201 </p>
202
206 <a NAME="CircuitPythonUpdaterInterface.__installFromAvailable" ID="CircuitPythonUpdaterInterface.__installFromAvailable"></a> 203 <a NAME="CircuitPythonUpdaterInterface.__installFromAvailable" ID="CircuitPythonUpdaterInterface.__installFromAvailable"></a>
207 <h4>CircuitPythonUpdaterInterface.__installFromAvailable</h4> 204 <h4>CircuitPythonUpdaterInterface.__installFromAvailable</h4>
208 <b>__installFromAvailable</b>(<i></i>) 205 <b>__installFromAvailable</b>(<i></i>)
209
210 <p> 206 <p>
211 Private slot to install modules onto the connected device. 207 Private slot to install modules onto the connected device.
212 </p> 208 </p>
209
213 <a NAME="CircuitPythonUpdaterInterface.__installFromCode" ID="CircuitPythonUpdaterInterface.__installFromCode"></a> 210 <a NAME="CircuitPythonUpdaterInterface.__installFromCode" ID="CircuitPythonUpdaterInterface.__installFromCode"></a>
214 <h4>CircuitPythonUpdaterInterface.__installFromCode</h4> 211 <h4>CircuitPythonUpdaterInterface.__installFromCode</h4>
215 <b>__installFromCode</b>(<i></i>) 212 <b>__installFromCode</b>(<i></i>)
216
217 <p> 213 <p>
218 Private slot to install modules based on the 'code.py' file of the 214 Private slot to install modules based on the 'code.py' file of the
219 connected device. 215 connected device.
220 </p> 216 </p>
217
221 <a NAME="CircuitPythonUpdaterInterface.__installModules" ID="CircuitPythonUpdaterInterface.__installModules"></a> 218 <a NAME="CircuitPythonUpdaterInterface.__installModules" ID="CircuitPythonUpdaterInterface.__installModules"></a>
222 <h4>CircuitPythonUpdaterInterface.__installModules</h4> 219 <h4>CircuitPythonUpdaterInterface.__installModules</h4>
223 <b>__installModules</b>(<i>installs</i>) 220 <b>__installModules</b>(<i>installs</i>)
224
225 <p> 221 <p>
226 Private method to install the given list of modules. 222 Private method to install the given list of modules.
227 </p> 223 </p>
224
228 <dl> 225 <dl>
229 226
230 <dt><i>installs</i> (list of str)</dt> 227 <dt><i>installs</i> (list of str)</dt>
231 <dd> 228 <dd>
232 list of module names to be installed 229 list of module names to be installed
233 </dd> 230 </dd>
234 </dl> 231 </dl>
235 <a NAME="CircuitPythonUpdaterInterface.__installRequirements" ID="CircuitPythonUpdaterInterface.__installRequirements"></a> 232 <a NAME="CircuitPythonUpdaterInterface.__installRequirements" ID="CircuitPythonUpdaterInterface.__installRequirements"></a>
236 <h4>CircuitPythonUpdaterInterface.__installRequirements</h4> 233 <h4>CircuitPythonUpdaterInterface.__installRequirements</h4>
237 <b>__installRequirements</b>(<i></i>) 234 <b>__installRequirements</b>(<i></i>)
238
239 <p> 235 <p>
240 Private slot to install modules determined by a requirements file. 236 Private slot to install modules determined by a requirements file.
241 </p> 237 </p>
238
242 <a NAME="CircuitPythonUpdaterInterface.__listOutdatedModules" ID="CircuitPythonUpdaterInterface.__listOutdatedModules"></a> 239 <a NAME="CircuitPythonUpdaterInterface.__listOutdatedModules" ID="CircuitPythonUpdaterInterface.__listOutdatedModules"></a>
243 <h4>CircuitPythonUpdaterInterface.__listOutdatedModules</h4> 240 <h4>CircuitPythonUpdaterInterface.__listOutdatedModules</h4>
244 <b>__listOutdatedModules</b>(<i></i>) 241 <b>__listOutdatedModules</b>(<i></i>)
245
246 <p> 242 <p>
247 Private slot to list the outdated modules of the connected device. 243 Private slot to list the outdated modules of the connected device.
248 </p> 244 </p>
245
249 <a NAME="CircuitPythonUpdaterInterface.__removeBundle" ID="CircuitPythonUpdaterInterface.__removeBundle"></a> 246 <a NAME="CircuitPythonUpdaterInterface.__removeBundle" ID="CircuitPythonUpdaterInterface.__removeBundle"></a>
250 <h4>CircuitPythonUpdaterInterface.__removeBundle</h4> 247 <h4>CircuitPythonUpdaterInterface.__removeBundle</h4>
251 <b>__removeBundle</b>(<i></i>) 248 <b>__removeBundle</b>(<i></i>)
252
253 <p> 249 <p>
254 Private slot to remove one or more bundles from the local bundles list. 250 Private slot to remove one or more bundles from the local bundles list.
255 </p> 251 </p>
252
256 <a NAME="CircuitPythonUpdaterInterface.__showAvailableModules" ID="CircuitPythonUpdaterInterface.__showAvailableModules"></a> 253 <a NAME="CircuitPythonUpdaterInterface.__showAvailableModules" ID="CircuitPythonUpdaterInterface.__showAvailableModules"></a>
257 <h4>CircuitPythonUpdaterInterface.__showAvailableModules</h4> 254 <h4>CircuitPythonUpdaterInterface.__showAvailableModules</h4>
258 <b>__showAvailableModules</b>(<i></i>) 255 <b>__showAvailableModules</b>(<i></i>)
259
260 <p> 256 <p>
261 Private slot to show the available modules. 257 Private slot to show the available modules.
262 </p> 258 </p>
263 <p> 259 <p>
264 These are modules which could be installed on the device. 260 These are modules which could be installed on the device.
265 </p> 261 </p>
262
266 <a NAME="CircuitPythonUpdaterInterface.__showBundles" ID="CircuitPythonUpdaterInterface.__showBundles"></a> 263 <a NAME="CircuitPythonUpdaterInterface.__showBundles" ID="CircuitPythonUpdaterInterface.__showBundles"></a>
267 <h4>CircuitPythonUpdaterInterface.__showBundles</h4> 264 <h4>CircuitPythonUpdaterInterface.__showBundles</h4>
268 <b>__showBundles</b>(<i>withModules=False</i>) 265 <b>__showBundles</b>(<i>withModules=False</i>)
269
270 <p> 266 <p>
271 Private slot to show the available bundles (default and local). 267 Private slot to show the available bundles (default and local).
272 </p> 268 </p>
269
273 <dl> 270 <dl>
274 271
275 <dt><i>withModules</i> (bool (optional))</dt> 272 <dt><i>withModules</i> (bool (optional))</dt>
276 <dd> 273 <dd>
277 flag indicating to list the modules and their version 274 flag indicating to list the modules and their version
279 </dd> 276 </dd>
280 </dl> 277 </dl>
281 <a NAME="CircuitPythonUpdaterInterface.__showBundlesModules" ID="CircuitPythonUpdaterInterface.__showBundlesModules"></a> 278 <a NAME="CircuitPythonUpdaterInterface.__showBundlesModules" ID="CircuitPythonUpdaterInterface.__showBundlesModules"></a>
282 <h4>CircuitPythonUpdaterInterface.__showBundlesModules</h4> 279 <h4>CircuitPythonUpdaterInterface.__showBundlesModules</h4>
283 <b>__showBundlesModules</b>(<i></i>) 280 <b>__showBundlesModules</b>(<i></i>)
284
285 <p> 281 <p>
286 Private slot to show the available bundles (default and local) with their 282 Private slot to show the available bundles (default and local) with their
287 modules. 283 modules.
288 </p> 284 </p>
285
289 <a NAME="CircuitPythonUpdaterInterface.__showCachePath" ID="CircuitPythonUpdaterInterface.__showCachePath"></a> 286 <a NAME="CircuitPythonUpdaterInterface.__showCachePath" ID="CircuitPythonUpdaterInterface.__showCachePath"></a>
290 <h4>CircuitPythonUpdaterInterface.__showCachePath</h4> 287 <h4>CircuitPythonUpdaterInterface.__showCachePath</h4>
291 <b>__showCachePath</b>(<i></i>) 288 <b>__showCachePath</b>(<i></i>)
292
293 <p> 289 <p>
294 Private slot to show the path used by 'circup' to store the downloaded bundles. 290 Private slot to show the path used by 'circup' to store the downloaded bundles.
295 </p> 291 </p>
292
296 <a NAME="CircuitPythonUpdaterInterface.__showInstalledModules" ID="CircuitPythonUpdaterInterface.__showInstalledModules"></a> 293 <a NAME="CircuitPythonUpdaterInterface.__showInstalledModules" ID="CircuitPythonUpdaterInterface.__showInstalledModules"></a>
297 <h4>CircuitPythonUpdaterInterface.__showInstalledModules</h4> 294 <h4>CircuitPythonUpdaterInterface.__showInstalledModules</h4>
298 <b>__showInstalledModules</b>(<i></i>) 295 <b>__showInstalledModules</b>(<i></i>)
299
300 <p> 296 <p>
301 Private slot to show the modules installed on the connected device. 297 Private slot to show the modules installed on the connected device.
302 </p> 298 </p>
299
303 <a NAME="CircuitPythonUpdaterInterface.__uninstallModules" ID="CircuitPythonUpdaterInterface.__uninstallModules"></a> 300 <a NAME="CircuitPythonUpdaterInterface.__uninstallModules" ID="CircuitPythonUpdaterInterface.__uninstallModules"></a>
304 <h4>CircuitPythonUpdaterInterface.__uninstallModules</h4> 301 <h4>CircuitPythonUpdaterInterface.__uninstallModules</h4>
305 <b>__uninstallModules</b>(<i></i>) 302 <b>__uninstallModules</b>(<i></i>)
306
307 <p> 303 <p>
308 Private slot to uninstall modules from the connected device. 304 Private slot to uninstall modules from the connected device.
309 </p> 305 </p>
306
310 <a NAME="CircuitPythonUpdaterInterface.__updateAllModules" ID="CircuitPythonUpdaterInterface.__updateAllModules"></a> 307 <a NAME="CircuitPythonUpdaterInterface.__updateAllModules" ID="CircuitPythonUpdaterInterface.__updateAllModules"></a>
311 <h4>CircuitPythonUpdaterInterface.__updateAllModules</h4> 308 <h4>CircuitPythonUpdaterInterface.__updateAllModules</h4>
312 <b>__updateAllModules</b>(<i></i>) 309 <b>__updateAllModules</b>(<i></i>)
313
314 <p> 310 <p>
315 Private slot to update all modules of the connected device. 311 Private slot to update all modules of the connected device.
316 </p> 312 </p>
313
317 <a NAME="CircuitPythonUpdaterInterface.__updateModules" ID="CircuitPythonUpdaterInterface.__updateModules"></a> 314 <a NAME="CircuitPythonUpdaterInterface.__updateModules" ID="CircuitPythonUpdaterInterface.__updateModules"></a>
318 <h4>CircuitPythonUpdaterInterface.__updateModules</h4> 315 <h4>CircuitPythonUpdaterInterface.__updateModules</h4>
319 <b>__updateModules</b>(<i></i>) 316 <b>__updateModules</b>(<i></i>)
320
321 <p> 317 <p>
322 Private slot to update the modules of the connected device. 318 Private slot to update the modules of the connected device.
323 </p> 319 </p>
320
324 <a NAME="CircuitPythonUpdaterInterface.installCircup" ID="CircuitPythonUpdaterInterface.installCircup"></a> 321 <a NAME="CircuitPythonUpdaterInterface.installCircup" ID="CircuitPythonUpdaterInterface.installCircup"></a>
325 <h4>CircuitPythonUpdaterInterface.installCircup</h4> 322 <h4>CircuitPythonUpdaterInterface.installCircup</h4>
326 <b>installCircup</b>(<i></i>) 323 <b>installCircup</b>(<i></i>)
327
328 <p> 324 <p>
329 Public slot to install the 'circup' package via pip. 325 Public slot to install the 'circup' package via pip.
330 </p> 326 </p>
327
331 <a NAME="CircuitPythonUpdaterInterface.populateMenu" ID="CircuitPythonUpdaterInterface.populateMenu"></a> 328 <a NAME="CircuitPythonUpdaterInterface.populateMenu" ID="CircuitPythonUpdaterInterface.populateMenu"></a>
332 <h4>CircuitPythonUpdaterInterface.populateMenu</h4> 329 <h4>CircuitPythonUpdaterInterface.populateMenu</h4>
333 <b>populateMenu</b>(<i>menu</i>) 330 <b>populateMenu</b>(<i>menu</i>)
334
335 <p> 331 <p>
336 Public method to populate the 'circup' menu. 332 Public method to populate the 'circup' menu.
337 </p> 333 </p>
334
338 <dl> 335 <dl>
339 336
340 <dt><i>menu</i> (QMenu)</dt> 337 <dt><i>menu</i> (QMenu)</dt>
341 <dd> 338 <dd>
342 reference to the menu to be populated 339 reference to the menu to be populated
346 <hr /> 343 <hr />
347 <hr /> 344 <hr />
348 <a NAME="isCircupAvailable" ID="isCircupAvailable"></a> 345 <a NAME="isCircupAvailable" ID="isCircupAvailable"></a>
349 <h2>isCircupAvailable</h2> 346 <h2>isCircupAvailable</h2>
350 <b>isCircupAvailable</b>(<i></i>) 347 <b>isCircupAvailable</b>(<i></i>)
351
352 <p> 348 <p>
353 Function to check for the availability of 'circup'. 349 Function to check for the availability of 'circup'.
354 </p> 350 </p>
351
355 <dl> 352 <dl>
356 <dt>Return:</dt> 353 <dt>Return:</dt>
357 <dd> 354 <dd>
358 flag indicating the availability of 'circup' 355 flag indicating the availability of 'circup'
359 </dd> 356 </dd>

eric ide

mercurial