Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MicroPython.Devices.PyBoardDevices.html
src/eric7/Documentation/Source/eric7.MicroPython.Devices.PyBoardDevices.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 9927
- fa258d559f01
- child 10684
- 58c7f23ae1cb
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.PyBoardDevices</h1> | 9 <h1>eric7.MicroPython.Devices.PyBoardDevices</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the device interface class for PyBoard boards. | 11 Module implementing the device interface class for PyBoard boards. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#PyBoardDevice">PyBoardDevice</a></td> | 22 <td><a href="#PyBoardDevice">PyBoardDevice</a></td> |
| 25 <td>Class implementing the device for PyBoard boards.</td> | 23 <td>Class implementing the device for PyBoard boards.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 | |
| 32 <tr> | 29 <tr> |
| 33 <td><a href="#createDevice">createDevice</a></td> | 30 <td><a href="#createDevice">createDevice</a></td> |
| 34 <td>Function to instantiate a MicroPython device object.</td> | 31 <td>Function to instantiate a MicroPython device object.</td> |
| 35 </tr> | 32 </tr> |
| 36 </table> | 33 </table> |
| 34 | |
| 37 <hr /> | 35 <hr /> |
| 38 <hr /> | 36 <hr /> |
| 39 <a NAME="PyBoardDevice" ID="PyBoardDevice"></a> | 37 <a NAME="PyBoardDevice" ID="PyBoardDevice"></a> |
| 40 <h2>PyBoardDevice</h2> | 38 <h2>PyBoardDevice</h2> |
| 41 | |
| 42 <p> | 39 <p> |
| 43 Class implementing the device for PyBoard boards. | 40 Class implementing the device for PyBoard boards. |
| 44 </p> | 41 </p> |
| 42 | |
| 45 <h3>Derived from</h3> | 43 <h3>Derived from</h3> |
| 46 BaseDevice | 44 BaseDevice |
| 47 <h3>Class Attributes</h3> | 45 <h3>Class Attributes</h3> |
| 48 | |
| 49 <table> | 46 <table> |
| 50 <tr><td>DeviceVolumeName</td></tr><tr><td>FlashInstructionsURL</td></tr> | 47 <tr><td>DeviceVolumeName</td></tr> |
| 48 <tr><td>FlashInstructionsURL</td></tr> | |
| 51 </table> | 49 </table> |
| 50 | |
| 52 <h3>Class Methods</h3> | 51 <h3>Class Methods</h3> |
| 53 | |
| 54 <table> | 52 <table> |
| 55 <tr><td>None</td></tr> | 53 <tr><td>None</td></tr> |
| 56 </table> | 54 </table> |
| 55 | |
| 57 <h3>Methods</h3> | 56 <h3>Methods</h3> |
| 58 | |
| 59 <table> | 57 <table> |
| 60 | |
| 61 <tr> | 58 <tr> |
| 62 <td><a href="#PyBoardDevice.__init__">PyBoardDevice</a></td> | 59 <td><a href="#PyBoardDevice.__init__">PyBoardDevice</a></td> |
| 63 <td>Constructor</td> | 60 <td>Constructor</td> |
| 64 </tr> | 61 </tr> |
| 65 <tr> | 62 <tr> |
| 173 <tr> | 170 <tr> |
| 174 <td><a href="#PyBoardDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> | 171 <td><a href="#PyBoardDevice.supportsLocalFileAccess">supportsLocalFileAccess</a></td> |
| 175 <td>Public method to indicate file access via a local directory.</td> | 172 <td>Public method to indicate file access via a local directory.</td> |
| 176 </tr> | 173 </tr> |
| 177 </table> | 174 </table> |
| 175 | |
| 178 <h3>Static Methods</h3> | 176 <h3>Static Methods</h3> |
| 179 | |
| 180 <table> | 177 <table> |
| 181 <tr><td>None</td></tr> | 178 <tr><td>None</td></tr> |
| 182 </table> | 179 </table> |
| 183 | 180 |
| 181 | |
| 184 <a NAME="PyBoardDevice.__init__" ID="PyBoardDevice.__init__"></a> | 182 <a NAME="PyBoardDevice.__init__" ID="PyBoardDevice.__init__"></a> |
| 185 <h4>PyBoardDevice (Constructor)</h4> | 183 <h4>PyBoardDevice (Constructor)</h4> |
| 186 <b>PyBoardDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>) | 184 <b>PyBoardDevice</b>(<i>microPythonWidget, deviceType, parent=None</i>) |
| 187 | |
| 188 <p> | 185 <p> |
| 189 Constructor | 186 Constructor |
| 190 </p> | 187 </p> |
| 188 | |
| 191 <dl> | 189 <dl> |
| 192 | 190 |
| 193 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> | 191 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> |
| 194 <dd> | 192 <dd> |
| 195 reference to the main MicroPython widget | 193 reference to the main MicroPython widget |
| 204 </dd> | 202 </dd> |
| 205 </dl> | 203 </dl> |
| 206 <a NAME="PyBoardDevice.__activateBootloader" ID="PyBoardDevice.__activateBootloader"></a> | 204 <a NAME="PyBoardDevice.__activateBootloader" ID="PyBoardDevice.__activateBootloader"></a> |
| 207 <h4>PyBoardDevice.__activateBootloader</h4> | 205 <h4>PyBoardDevice.__activateBootloader</h4> |
| 208 <b>__activateBootloader</b>(<i></i>) | 206 <b>__activateBootloader</b>(<i></i>) |
| 209 | |
| 210 <p> | 207 <p> |
| 211 Private slot to activate the bootloader and disconnect. | 208 Private slot to activate the bootloader and disconnect. |
| 212 </p> | 209 </p> |
| 210 | |
| 213 <a NAME="PyBoardDevice.__createPyboardMenu" ID="PyBoardDevice.__createPyboardMenu"></a> | 211 <a NAME="PyBoardDevice.__createPyboardMenu" ID="PyBoardDevice.__createPyboardMenu"></a> |
| 214 <h4>PyBoardDevice.__createPyboardMenu</h4> | 212 <h4>PyBoardDevice.__createPyboardMenu</h4> |
| 215 <b>__createPyboardMenu</b>(<i></i>) | 213 <b>__createPyboardMenu</b>(<i></i>) |
| 216 | |
| 217 <p> | 214 <p> |
| 218 Private method to create the pyboard submenu. | 215 Private method to create the pyboard submenu. |
| 219 </p> | 216 </p> |
| 217 | |
| 220 <a NAME="PyBoardDevice.__deviceVolumeMounted" ID="PyBoardDevice.__deviceVolumeMounted"></a> | 218 <a NAME="PyBoardDevice.__deviceVolumeMounted" ID="PyBoardDevice.__deviceVolumeMounted"></a> |
| 221 <h4>PyBoardDevice.__deviceVolumeMounted</h4> | 219 <h4>PyBoardDevice.__deviceVolumeMounted</h4> |
| 222 <b>__deviceVolumeMounted</b>(<i></i>) | 220 <b>__deviceVolumeMounted</b>(<i></i>) |
| 223 | |
| 224 <p> | 221 <p> |
| 225 Private method to check, if the device volume is mounted. | 222 Private method to check, if the device volume is mounted. |
| 226 </p> | 223 </p> |
| 224 | |
| 227 <dl> | 225 <dl> |
| 228 <dt>Return:</dt> | 226 <dt>Return:</dt> |
| 229 <dd> | 227 <dd> |
| 230 flag indicated a mounted device | 228 flag indicated a mounted device |
| 231 </dd> | 229 </dd> |
| 237 </dd> | 235 </dd> |
| 238 </dl> | 236 </dl> |
| 239 <a NAME="PyBoardDevice.__dfuUtilAvailable" ID="PyBoardDevice.__dfuUtilAvailable"></a> | 237 <a NAME="PyBoardDevice.__dfuUtilAvailable" ID="PyBoardDevice.__dfuUtilAvailable"></a> |
| 240 <h4>PyBoardDevice.__dfuUtilAvailable</h4> | 238 <h4>PyBoardDevice.__dfuUtilAvailable</h4> |
| 241 <b>__dfuUtilAvailable</b>(<i></i>) | 239 <b>__dfuUtilAvailable</b>(<i></i>) |
| 242 | |
| 243 <p> | 240 <p> |
| 244 Private method to check the availability of dfu-util. | 241 Private method to check the availability of dfu-util. |
| 245 </p> | 242 </p> |
| 243 | |
| 246 <dl> | 244 <dl> |
| 247 <dt>Return:</dt> | 245 <dt>Return:</dt> |
| 248 <dd> | 246 <dd> |
| 249 flag indicating the availability of dfu-util | 247 flag indicating the availability of dfu-util |
| 250 </dd> | 248 </dd> |
| 256 </dd> | 254 </dd> |
| 257 </dl> | 255 </dl> |
| 258 <a NAME="PyBoardDevice.__findWorkspace" ID="PyBoardDevice.__findWorkspace"></a> | 256 <a NAME="PyBoardDevice.__findWorkspace" ID="PyBoardDevice.__findWorkspace"></a> |
| 259 <h4>PyBoardDevice.__findWorkspace</h4> | 257 <h4>PyBoardDevice.__findWorkspace</h4> |
| 260 <b>__findWorkspace</b>(<i>silent=False</i>) | 258 <b>__findWorkspace</b>(<i>silent=False</i>) |
| 261 | |
| 262 <p> | 259 <p> |
| 263 Private method to find the workspace directory. | 260 Private method to find the workspace directory. |
| 264 </p> | 261 </p> |
| 262 | |
| 265 <dl> | 263 <dl> |
| 266 | 264 |
| 267 <dt><i>silent</i> (bool)</dt> | 265 <dt><i>silent</i> (bool)</dt> |
| 268 <dd> | 266 <dd> |
| 269 flag indicating silent operations | 267 flag indicating silent operations |
| 282 </dd> | 280 </dd> |
| 283 </dl> | 281 </dl> |
| 284 <a NAME="PyBoardDevice.__firmwareVersionResponse" ID="PyBoardDevice.__firmwareVersionResponse"></a> | 282 <a NAME="PyBoardDevice.__firmwareVersionResponse" ID="PyBoardDevice.__firmwareVersionResponse"></a> |
| 285 <h4>PyBoardDevice.__firmwareVersionResponse</h4> | 283 <h4>PyBoardDevice.__firmwareVersionResponse</h4> |
| 286 <b>__firmwareVersionResponse</b>(<i>reply</i>) | 284 <b>__firmwareVersionResponse</b>(<i>reply</i>) |
| 287 | |
| 288 <p> | 285 <p> |
| 289 Private slot handling the response of the latest version request. | 286 Private slot handling the response of the latest version request. |
| 290 </p> | 287 </p> |
| 288 | |
| 291 <dl> | 289 <dl> |
| 292 | 290 |
| 293 <dt><i>reply</i> (QNetworkReply)</dt> | 291 <dt><i>reply</i> (QNetworkReply)</dt> |
| 294 <dd> | 292 <dd> |
| 295 reference to the reply object | 293 reference to the reply object |
| 296 </dd> | 294 </dd> |
| 297 </dl> | 295 </dl> |
| 298 <a NAME="PyBoardDevice.__flashMicroPython" ID="PyBoardDevice.__flashMicroPython"></a> | 296 <a NAME="PyBoardDevice.__flashMicroPython" ID="PyBoardDevice.__flashMicroPython"></a> |
| 299 <h4>PyBoardDevice.__flashMicroPython</h4> | 297 <h4>PyBoardDevice.__flashMicroPython</h4> |
| 300 <b>__flashMicroPython</b>(<i></i>) | 298 <b>__flashMicroPython</b>(<i></i>) |
| 301 | |
| 302 <p> | 299 <p> |
| 303 Private slot to flash a MicroPython firmware. | 300 Private slot to flash a MicroPython firmware. |
| 304 </p> | 301 </p> |
| 302 | |
| 305 <a NAME="PyBoardDevice.__listDfuCapableDevices" ID="PyBoardDevice.__listDfuCapableDevices"></a> | 303 <a NAME="PyBoardDevice.__listDfuCapableDevices" ID="PyBoardDevice.__listDfuCapableDevices"></a> |
| 306 <h4>PyBoardDevice.__listDfuCapableDevices</h4> | 304 <h4>PyBoardDevice.__listDfuCapableDevices</h4> |
| 307 <b>__listDfuCapableDevices</b>(<i></i>) | 305 <b>__listDfuCapableDevices</b>(<i></i>) |
| 308 | |
| 309 <p> | 306 <p> |
| 310 Private slot to list all DFU-capable devices. | 307 Private slot to list all DFU-capable devices. |
| 311 </p> | 308 </p> |
| 309 | |
| 312 <a NAME="PyBoardDevice.__resetDevice" ID="PyBoardDevice.__resetDevice"></a> | 310 <a NAME="PyBoardDevice.__resetDevice" ID="PyBoardDevice.__resetDevice"></a> |
| 313 <h4>PyBoardDevice.__resetDevice</h4> | 311 <h4>PyBoardDevice.__resetDevice</h4> |
| 314 <b>__resetDevice</b>(<i></i>) | 312 <b>__resetDevice</b>(<i></i>) |
| 315 | |
| 316 <p> | 313 <p> |
| 317 Private slot to reset the connected device. | 314 Private slot to reset the connected device. |
| 318 </p> | 315 </p> |
| 316 | |
| 319 <a NAME="PyBoardDevice.__showDfuDisableInstructions" ID="PyBoardDevice.__showDfuDisableInstructions"></a> | 317 <a NAME="PyBoardDevice.__showDfuDisableInstructions" ID="PyBoardDevice.__showDfuDisableInstructions"></a> |
| 320 <h4>PyBoardDevice.__showDfuDisableInstructions</h4> | 318 <h4>PyBoardDevice.__showDfuDisableInstructions</h4> |
| 321 <b>__showDfuDisableInstructions</b>(<i></i>) | 319 <b>__showDfuDisableInstructions</b>(<i></i>) |
| 322 | |
| 323 <p> | 320 <p> |
| 324 Private method to show some instructions to disable the DFU mode. | 321 Private method to show some instructions to disable the DFU mode. |
| 325 </p> | 322 </p> |
| 323 | |
| 326 <a NAME="PyBoardDevice.__showDfuEnableInstructions" ID="PyBoardDevice.__showDfuEnableInstructions"></a> | 324 <a NAME="PyBoardDevice.__showDfuEnableInstructions" ID="PyBoardDevice.__showDfuEnableInstructions"></a> |
| 327 <h4>PyBoardDevice.__showDfuEnableInstructions</h4> | 325 <h4>PyBoardDevice.__showDfuEnableInstructions</h4> |
| 328 <b>__showDfuEnableInstructions</b>(<i>flash=True</i>) | 326 <b>__showDfuEnableInstructions</b>(<i>flash=True</i>) |
| 329 | |
| 330 <p> | 327 <p> |
| 331 Private method to show some instructions to enable the DFU mode. | 328 Private method to show some instructions to enable the DFU mode. |
| 332 </p> | 329 </p> |
| 330 | |
| 333 <dl> | 331 <dl> |
| 334 | 332 |
| 335 <dt><i>flash</i> (bool)</dt> | 333 <dt><i>flash</i> (bool)</dt> |
| 336 <dd> | 334 <dd> |
| 337 flag indicating to show a warning message for flashing | 335 flag indicating to show a warning message for flashing |
| 350 </dd> | 348 </dd> |
| 351 </dl> | 349 </dl> |
| 352 <a NAME="PyBoardDevice.__showFirmwareVersions" ID="PyBoardDevice.__showFirmwareVersions"></a> | 350 <a NAME="PyBoardDevice.__showFirmwareVersions" ID="PyBoardDevice.__showFirmwareVersions"></a> |
| 353 <h4>PyBoardDevice.__showFirmwareVersions</h4> | 351 <h4>PyBoardDevice.__showFirmwareVersions</h4> |
| 354 <b>__showFirmwareVersions</b>(<i></i>) | 352 <b>__showFirmwareVersions</b>(<i></i>) |
| 355 | |
| 356 <p> | 353 <p> |
| 357 Private slot to show the firmware version of the connected device and the | 354 Private slot to show the firmware version of the connected device and the |
| 358 available firmware version. | 355 available firmware version. |
| 359 </p> | 356 </p> |
| 357 | |
| 360 <a NAME="PyBoardDevice.__showFlashInstructions" ID="PyBoardDevice.__showFlashInstructions"></a> | 358 <a NAME="PyBoardDevice.__showFlashInstructions" ID="PyBoardDevice.__showFlashInstructions"></a> |
| 361 <h4>PyBoardDevice.__showFlashInstructions</h4> | 359 <h4>PyBoardDevice.__showFlashInstructions</h4> |
| 362 <b>__showFlashInstructions</b>(<i></i>) | 360 <b>__showFlashInstructions</b>(<i></i>) |
| 363 | |
| 364 <p> | 361 <p> |
| 365 Private slot to open the URL containing instructions for installing | 362 Private slot to open the URL containing instructions for installing |
| 366 MicroPython on the pyboard. | 363 MicroPython on the pyboard. |
| 367 </p> | 364 </p> |
| 365 | |
| 368 <a NAME="PyBoardDevice._getSetTimeCode" ID="PyBoardDevice._getSetTimeCode"></a> | 366 <a NAME="PyBoardDevice._getSetTimeCode" ID="PyBoardDevice._getSetTimeCode"></a> |
| 369 <h4>PyBoardDevice._getSetTimeCode</h4> | 367 <h4>PyBoardDevice._getSetTimeCode</h4> |
| 370 <b>_getSetTimeCode</b>(<i></i>) | 368 <b>_getSetTimeCode</b>(<i></i>) |
| 371 | |
| 372 <p> | 369 <p> |
| 373 Protected method to get the device code to set the time. | 370 Protected method to get the device code to set the time. |
| 374 </p> | 371 </p> |
| 375 <p> | 372 <p> |
| 376 Note: This method must be implemented in the various device specific | 373 Note: This method must be implemented in the various device specific |
| 377 subclasses. | 374 subclasses. |
| 378 </p> | 375 </p> |
| 376 | |
| 379 <dl> | 377 <dl> |
| 380 <dt>Return:</dt> | 378 <dt>Return:</dt> |
| 381 <dd> | 379 <dd> |
| 382 code to be executed on the connected device to set the time | 380 code to be executed on the connected device to set the time |
| 383 </dd> | 381 </dd> |
| 389 </dd> | 387 </dd> |
| 390 </dl> | 388 </dl> |
| 391 <a NAME="PyBoardDevice.addDeviceMenuEntries" ID="PyBoardDevice.addDeviceMenuEntries"></a> | 389 <a NAME="PyBoardDevice.addDeviceMenuEntries" ID="PyBoardDevice.addDeviceMenuEntries"></a> |
| 392 <h4>PyBoardDevice.addDeviceMenuEntries</h4> | 390 <h4>PyBoardDevice.addDeviceMenuEntries</h4> |
| 393 <b>addDeviceMenuEntries</b>(<i>menu</i>) | 391 <b>addDeviceMenuEntries</b>(<i>menu</i>) |
| 394 | |
| 395 <p> | 392 <p> |
| 396 Public method to add device specific entries to the given menu. | 393 Public method to add device specific entries to the given menu. |
| 397 </p> | 394 </p> |
| 395 | |
| 398 <dl> | 396 <dl> |
| 399 | 397 |
| 400 <dt><i>menu</i> (QMenu)</dt> | 398 <dt><i>menu</i> (QMenu)</dt> |
| 401 <dd> | 399 <dd> |
| 402 reference to the context menu | 400 reference to the context menu |
| 403 </dd> | 401 </dd> |
| 404 </dl> | 402 </dl> |
| 405 <a NAME="PyBoardDevice.canRunScript" ID="PyBoardDevice.canRunScript"></a> | 403 <a NAME="PyBoardDevice.canRunScript" ID="PyBoardDevice.canRunScript"></a> |
| 406 <h4>PyBoardDevice.canRunScript</h4> | 404 <h4>PyBoardDevice.canRunScript</h4> |
| 407 <b>canRunScript</b>(<i></i>) | 405 <b>canRunScript</b>(<i></i>) |
| 408 | |
| 409 <p> | 406 <p> |
| 410 Public method to determine, if a script can be executed. | 407 Public method to determine, if a script can be executed. |
| 411 </p> | 408 </p> |
| 409 | |
| 412 <dl> | 410 <dl> |
| 413 <dt>Return:</dt> | 411 <dt>Return:</dt> |
| 414 <dd> | 412 <dd> |
| 415 tuple containing a flag indicating it is safe to start a | 413 tuple containing a flag indicating it is safe to start a |
| 416 Plotter and a reason why it cannot. | 414 Plotter and a reason why it cannot. |
| 423 </dd> | 421 </dd> |
| 424 </dl> | 422 </dl> |
| 425 <a NAME="PyBoardDevice.canStartFileManager" ID="PyBoardDevice.canStartFileManager"></a> | 423 <a NAME="PyBoardDevice.canStartFileManager" ID="PyBoardDevice.canStartFileManager"></a> |
| 426 <h4>PyBoardDevice.canStartFileManager</h4> | 424 <h4>PyBoardDevice.canStartFileManager</h4> |
| 427 <b>canStartFileManager</b>(<i></i>) | 425 <b>canStartFileManager</b>(<i></i>) |
| 428 | |
| 429 <p> | 426 <p> |
| 430 Public method to determine, if a File Manager can be started. | 427 Public method to determine, if a File Manager can be started. |
| 431 </p> | 428 </p> |
| 429 | |
| 432 <dl> | 430 <dl> |
| 433 <dt>Return:</dt> | 431 <dt>Return:</dt> |
| 434 <dd> | 432 <dd> |
| 435 tuple containing a flag indicating it is safe to start a | 433 tuple containing a flag indicating it is safe to start a |
| 436 File Manager and a reason why it cannot. | 434 File Manager and a reason why it cannot. |
| 443 </dd> | 441 </dd> |
| 444 </dl> | 442 </dl> |
| 445 <a NAME="PyBoardDevice.canStartPlotter" ID="PyBoardDevice.canStartPlotter"></a> | 443 <a NAME="PyBoardDevice.canStartPlotter" ID="PyBoardDevice.canStartPlotter"></a> |
| 446 <h4>PyBoardDevice.canStartPlotter</h4> | 444 <h4>PyBoardDevice.canStartPlotter</h4> |
| 447 <b>canStartPlotter</b>(<i></i>) | 445 <b>canStartPlotter</b>(<i></i>) |
| 448 | |
| 449 <p> | 446 <p> |
| 450 Public method to determine, if a Plotter can be started. | 447 Public method to determine, if a Plotter can be started. |
| 451 </p> | 448 </p> |
| 449 | |
| 452 <dl> | 450 <dl> |
| 453 <dt>Return:</dt> | 451 <dt>Return:</dt> |
| 454 <dd> | 452 <dd> |
| 455 tuple containing a flag indicating it is safe to start a | 453 tuple containing a flag indicating it is safe to start a |
| 456 Plotter and a reason why it cannot. | 454 Plotter and a reason why it cannot. |
| 463 </dd> | 461 </dd> |
| 464 </dl> | 462 </dl> |
| 465 <a NAME="PyBoardDevice.canStartRepl" ID="PyBoardDevice.canStartRepl"></a> | 463 <a NAME="PyBoardDevice.canStartRepl" ID="PyBoardDevice.canStartRepl"></a> |
| 466 <h4>PyBoardDevice.canStartRepl</h4> | 464 <h4>PyBoardDevice.canStartRepl</h4> |
| 467 <b>canStartRepl</b>(<i></i>) | 465 <b>canStartRepl</b>(<i></i>) |
| 468 | |
| 469 <p> | 466 <p> |
| 470 Public method to determine, if a REPL can be started. | 467 Public method to determine, if a REPL can be started. |
| 471 </p> | 468 </p> |
| 469 | |
| 472 <dl> | 470 <dl> |
| 473 <dt>Return:</dt> | 471 <dt>Return:</dt> |
| 474 <dd> | 472 <dd> |
| 475 tuple containing a flag indicating it is safe to start a REPL | 473 tuple containing a flag indicating it is safe to start a REPL |
| 476 and a reason why it cannot. | 474 and a reason why it cannot. |
| 483 </dd> | 481 </dd> |
| 484 </dl> | 482 </dl> |
| 485 <a NAME="PyBoardDevice.deviceName" ID="PyBoardDevice.deviceName"></a> | 483 <a NAME="PyBoardDevice.deviceName" ID="PyBoardDevice.deviceName"></a> |
| 486 <h4>PyBoardDevice.deviceName</h4> | 484 <h4>PyBoardDevice.deviceName</h4> |
| 487 <b>deviceName</b>(<i></i>) | 485 <b>deviceName</b>(<i></i>) |
| 488 | |
| 489 <p> | 486 <p> |
| 490 Public method to get the name of the device. | 487 Public method to get the name of the device. |
| 491 </p> | 488 </p> |
| 489 | |
| 492 <dl> | 490 <dl> |
| 493 <dt>Return:</dt> | 491 <dt>Return:</dt> |
| 494 <dd> | 492 <dd> |
| 495 name of the device | 493 name of the device |
| 496 </dd> | 494 </dd> |
| 502 </dd> | 500 </dd> |
| 503 </dl> | 501 </dl> |
| 504 <a NAME="PyBoardDevice.forceInterrupt" ID="PyBoardDevice.forceInterrupt"></a> | 502 <a NAME="PyBoardDevice.forceInterrupt" ID="PyBoardDevice.forceInterrupt"></a> |
| 505 <h4>PyBoardDevice.forceInterrupt</h4> | 503 <h4>PyBoardDevice.forceInterrupt</h4> |
| 506 <b>forceInterrupt</b>(<i></i>) | 504 <b>forceInterrupt</b>(<i></i>) |
| 507 | |
| 508 <p> | 505 <p> |
| 509 Public method to determine the need for an interrupt when opening the | 506 Public method to determine the need for an interrupt when opening the |
| 510 serial connection. | 507 serial connection. |
| 511 </p> | 508 </p> |
| 509 | |
| 512 <dl> | 510 <dl> |
| 513 <dt>Return:</dt> | 511 <dt>Return:</dt> |
| 514 <dd> | 512 <dd> |
| 515 flag indicating an interrupt is needed | 513 flag indicating an interrupt is needed |
| 516 </dd> | 514 </dd> |
| 522 </dd> | 520 </dd> |
| 523 </dl> | 521 </dl> |
| 524 <a NAME="PyBoardDevice.getDocumentationUrl" ID="PyBoardDevice.getDocumentationUrl"></a> | 522 <a NAME="PyBoardDevice.getDocumentationUrl" ID="PyBoardDevice.getDocumentationUrl"></a> |
| 525 <h4>PyBoardDevice.getDocumentationUrl</h4> | 523 <h4>PyBoardDevice.getDocumentationUrl</h4> |
| 526 <b>getDocumentationUrl</b>(<i></i>) | 524 <b>getDocumentationUrl</b>(<i></i>) |
| 527 | |
| 528 <p> | 525 <p> |
| 529 Public method to get the device documentation URL. | 526 Public method to get the device documentation URL. |
| 530 </p> | 527 </p> |
| 528 | |
| 531 <dl> | 529 <dl> |
| 532 <dt>Return:</dt> | 530 <dt>Return:</dt> |
| 533 <dd> | 531 <dd> |
| 534 documentation URL of the device | 532 documentation URL of the device |
| 535 </dd> | 533 </dd> |
| 541 </dd> | 539 </dd> |
| 542 </dl> | 540 </dl> |
| 543 <a NAME="PyBoardDevice.getFirmwareUrl" ID="PyBoardDevice.getFirmwareUrl"></a> | 541 <a NAME="PyBoardDevice.getFirmwareUrl" ID="PyBoardDevice.getFirmwareUrl"></a> |
| 544 <h4>PyBoardDevice.getFirmwareUrl</h4> | 542 <h4>PyBoardDevice.getFirmwareUrl</h4> |
| 545 <b>getFirmwareUrl</b>(<i></i>) | 543 <b>getFirmwareUrl</b>(<i></i>) |
| 546 | |
| 547 <p> | 544 <p> |
| 548 Public method to get the device firmware download URL. | 545 Public method to get the device firmware download URL. |
| 549 </p> | 546 </p> |
| 547 | |
| 550 <dl> | 548 <dl> |
| 551 <dt>Return:</dt> | 549 <dt>Return:</dt> |
| 552 <dd> | 550 <dd> |
| 553 firmware download URL of the device | 551 firmware download URL of the device |
| 554 </dd> | 552 </dd> |
| 560 </dd> | 558 </dd> |
| 561 </dl> | 559 </dl> |
| 562 <a NAME="PyBoardDevice.getWorkspace" ID="PyBoardDevice.getWorkspace"></a> | 560 <a NAME="PyBoardDevice.getWorkspace" ID="PyBoardDevice.getWorkspace"></a> |
| 563 <h4>PyBoardDevice.getWorkspace</h4> | 561 <h4>PyBoardDevice.getWorkspace</h4> |
| 564 <b>getWorkspace</b>(<i>silent=False</i>) | 562 <b>getWorkspace</b>(<i>silent=False</i>) |
| 565 | |
| 566 <p> | 563 <p> |
| 567 Public method to get the workspace directory. | 564 Public method to get the workspace directory. |
| 568 </p> | 565 </p> |
| 566 | |
| 569 <dl> | 567 <dl> |
| 570 | 568 |
| 571 <dt><i>silent</i> (bool)</dt> | 569 <dt><i>silent</i> (bool)</dt> |
| 572 <dd> | 570 <dd> |
| 573 flag indicating silent operations | 571 flag indicating silent operations |
| 586 </dd> | 584 </dd> |
| 587 </dl> | 585 </dl> |
| 588 <a NAME="PyBoardDevice.hasFlashMenuEntry" ID="PyBoardDevice.hasFlashMenuEntry"></a> | 586 <a NAME="PyBoardDevice.hasFlashMenuEntry" ID="PyBoardDevice.hasFlashMenuEntry"></a> |
| 589 <h4>PyBoardDevice.hasFlashMenuEntry</h4> | 587 <h4>PyBoardDevice.hasFlashMenuEntry</h4> |
| 590 <b>hasFlashMenuEntry</b>(<i></i>) | 588 <b>hasFlashMenuEntry</b>(<i></i>) |
| 591 | |
| 592 <p> | 589 <p> |
| 593 Public method to check, if the device has its own flash menu entry. | 590 Public method to check, if the device has its own flash menu entry. |
| 594 </p> | 591 </p> |
| 592 | |
| 595 <dl> | 593 <dl> |
| 596 <dt>Return:</dt> | 594 <dt>Return:</dt> |
| 597 <dd> | 595 <dd> |
| 598 flag indicating a specific flash menu entry | 596 flag indicating a specific flash menu entry |
| 599 </dd> | 597 </dd> |
| 605 </dd> | 603 </dd> |
| 606 </dl> | 604 </dl> |
| 607 <a NAME="PyBoardDevice.runScript" ID="PyBoardDevice.runScript"></a> | 605 <a NAME="PyBoardDevice.runScript" ID="PyBoardDevice.runScript"></a> |
| 608 <h4>PyBoardDevice.runScript</h4> | 606 <h4>PyBoardDevice.runScript</h4> |
| 609 <b>runScript</b>(<i>script</i>) | 607 <b>runScript</b>(<i>script</i>) |
| 610 | |
| 611 <p> | 608 <p> |
| 612 Public method to run the given Python script. | 609 Public method to run the given Python script. |
| 613 </p> | 610 </p> |
| 611 | |
| 614 <dl> | 612 <dl> |
| 615 | 613 |
| 616 <dt><i>script</i> (str)</dt> | 614 <dt><i>script</i> (str)</dt> |
| 617 <dd> | 615 <dd> |
| 618 script to be executed | 616 script to be executed |
| 619 </dd> | 617 </dd> |
| 620 </dl> | 618 </dl> |
| 621 <a NAME="PyBoardDevice.setButtons" ID="PyBoardDevice.setButtons"></a> | 619 <a NAME="PyBoardDevice.setButtons" ID="PyBoardDevice.setButtons"></a> |
| 622 <h4>PyBoardDevice.setButtons</h4> | 620 <h4>PyBoardDevice.setButtons</h4> |
| 623 <b>setButtons</b>(<i></i>) | 621 <b>setButtons</b>(<i></i>) |
| 624 | |
| 625 <p> | 622 <p> |
| 626 Public method to enable the supported action buttons. | 623 Public method to enable the supported action buttons. |
| 627 </p> | 624 </p> |
| 625 | |
| 628 <a NAME="PyBoardDevice.supportsLocalFileAccess" ID="PyBoardDevice.supportsLocalFileAccess"></a> | 626 <a NAME="PyBoardDevice.supportsLocalFileAccess" ID="PyBoardDevice.supportsLocalFileAccess"></a> |
| 629 <h4>PyBoardDevice.supportsLocalFileAccess</h4> | 627 <h4>PyBoardDevice.supportsLocalFileAccess</h4> |
| 630 <b>supportsLocalFileAccess</b>(<i></i>) | 628 <b>supportsLocalFileAccess</b>(<i></i>) |
| 631 | |
| 632 <p> | 629 <p> |
| 633 Public method to indicate file access via a local directory. | 630 Public method to indicate file access via a local directory. |
| 634 </p> | 631 </p> |
| 632 | |
| 635 <dl> | 633 <dl> |
| 636 <dt>Return:</dt> | 634 <dt>Return:</dt> |
| 637 <dd> | 635 <dd> |
| 638 flag indicating file access via local directory | 636 flag indicating file access via local directory |
| 639 </dd> | 637 </dd> |
| 648 <hr /> | 646 <hr /> |
| 649 <hr /> | 647 <hr /> |
| 650 <a NAME="createDevice" ID="createDevice"></a> | 648 <a NAME="createDevice" ID="createDevice"></a> |
| 651 <h2>createDevice</h2> | 649 <h2>createDevice</h2> |
| 652 <b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName, serialNumber</i>) | 650 <b>createDevice</b>(<i>microPythonWidget, deviceType, vid, pid, boardName, serialNumber</i>) |
| 653 | |
| 654 <p> | 651 <p> |
| 655 Function to instantiate a MicroPython device object. | 652 Function to instantiate a MicroPython device object. |
| 656 </p> | 653 </p> |
| 654 | |
| 657 <dl> | 655 <dl> |
| 658 | 656 |
| 659 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> | 657 <dt><i>microPythonWidget</i> (MicroPythonWidget)</dt> |
| 660 <dd> | 658 <dd> |
| 661 reference to the main MicroPython widget | 659 reference to the main MicroPython widget |
