Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.MicroPython.MicrobitDevices.html
eric6/Documentation/Source/eric6.MicroPython.MicrobitDevices.html
- branch
- maintenance
- changeset 8043
- 0acf98cd089a
- parent 8039
- 13fed1ed06e8
- child 8070
- 6758ba4670e1
equal
deleted
inserted
replaced
| 7991:866adc8c315b | 8043:0acf98cd089a |
|---|---|
| 73 <td><a href="#MicrobitDevice.__init__">MicrobitDevice</a></td> | 73 <td><a href="#MicrobitDevice.__init__">MicrobitDevice</a></td> |
| 74 <td>Constructor</td> | 74 <td>Constructor</td> |
| 75 </tr> | 75 </tr> |
| 76 <tr> | 76 <tr> |
| 77 <td><a href="#MicrobitDevice.__flashMicroPython">__flashMicroPython</a></td> | 77 <td><a href="#MicrobitDevice.__flashMicroPython">__flashMicroPython</a></td> |
| 78 <td>Private slot to flash the default MicroPython firmware to the device.</td> | 78 <td>Private slot to flash MicroPython or the DAPLink firmware to the device.</td> |
| 79 </tr> | 79 </tr> |
| 80 <tr> | 80 <tr> |
| 81 <td><a href="#MicrobitDevice.__resetDevice">__resetDevice</a></td> | 81 <td><a href="#MicrobitDevice.__resetDevice">__resetDevice</a></td> |
| 82 <td>Private slot to reset the connected device.</td> | 82 <td>Private slot to reset the connected device.</td> |
| 83 </tr> | 83 </tr> |
| 110 <td>Public method to determine, if a REPL can be started.</td> | 110 <td>Public method to determine, if a REPL can be started.</td> |
| 111 </tr> | 111 </tr> |
| 112 <tr> | 112 <tr> |
| 113 <td><a href="#MicrobitDevice.deviceName">deviceName</a></td> | 113 <td><a href="#MicrobitDevice.deviceName">deviceName</a></td> |
| 114 <td>Public method to get the name of the device.</td> | 114 <td>Public method to get the name of the device.</td> |
| 115 </tr> | |
| 116 <tr> | |
| 117 <td><a href="#MicrobitDevice.downloadFirmware">downloadFirmware</a></td> | |
| 118 <td>Public method to download the device firmware.</td> | |
| 115 </tr> | 119 </tr> |
| 116 <tr> | 120 <tr> |
| 117 <td><a href="#MicrobitDevice.forceInterrupt">forceInterrupt</a></td> | 121 <td><a href="#MicrobitDevice.forceInterrupt">forceInterrupt</a></td> |
| 118 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> | 122 <td>Public method to determine the need for an interrupt when opening the serial connection.</td> |
| 119 </tr> | 123 </tr> |
| 170 reference to the parent object | 174 reference to the parent object |
| 171 </dd> | 175 </dd> |
| 172 </dl> | 176 </dl> |
| 173 <a NAME="MicrobitDevice.__flashMicroPython" ID="MicrobitDevice.__flashMicroPython"></a> | 177 <a NAME="MicrobitDevice.__flashMicroPython" ID="MicrobitDevice.__flashMicroPython"></a> |
| 174 <h4>MicrobitDevice.__flashMicroPython</h4> | 178 <h4>MicrobitDevice.__flashMicroPython</h4> |
| 175 <b>__flashMicroPython</b>(<i></i>) | 179 <b>__flashMicroPython</b>(<i>firmware=False</i>) |
| 176 | 180 |
| 177 <p> | 181 <p> |
| 178 Private slot to flash the default MicroPython firmware to the device. | 182 Private slot to flash MicroPython or the DAPLink firmware to the |
| 179 </p> | 183 device. |
| 184 </p> | |
| 185 <dl> | |
| 186 | |
| 187 <dt><i>firmware</i> (bool)</dt> | |
| 188 <dd> | |
| 189 flag indicating to flash the DAPLink firmware | |
| 190 </dd> | |
| 191 </dl> | |
| 180 <a NAME="MicrobitDevice.__resetDevice" ID="MicrobitDevice.__resetDevice"></a> | 192 <a NAME="MicrobitDevice.__resetDevice" ID="MicrobitDevice.__resetDevice"></a> |
| 181 <h4>MicrobitDevice.__resetDevice</h4> | 193 <h4>MicrobitDevice.__resetDevice</h4> |
| 182 <b>__resetDevice</b>(<i></i>) | 194 <b>__resetDevice</b>(<i></i>) |
| 183 | 195 |
| 184 <p> | 196 <p> |
| 227 | 239 |
| 228 <p> | 240 <p> |
| 229 Public method to determine, if a script can be executed. | 241 Public method to determine, if a script can be executed. |
| 230 </p> | 242 </p> |
| 231 <dl> | 243 <dl> |
| 232 <dt>Returns:</dt> | 244 <dt>Return:</dt> |
| 233 <dd> | 245 <dd> |
| 234 tuple containing a flag indicating it is safe to start a | 246 tuple containing a flag indicating it is safe to start a |
| 235 Plotter and a reason why it cannot. | 247 Plotter and a reason why it cannot. |
| 236 </dd> | 248 </dd> |
| 237 </dl> | 249 </dl> |
| 247 | 259 |
| 248 <p> | 260 <p> |
| 249 Public method to determine, if a File Manager can be started. | 261 Public method to determine, if a File Manager can be started. |
| 250 </p> | 262 </p> |
| 251 <dl> | 263 <dl> |
| 252 <dt>Returns:</dt> | 264 <dt>Return:</dt> |
| 253 <dd> | 265 <dd> |
| 254 tuple containing a flag indicating it is safe to start a | 266 tuple containing a flag indicating it is safe to start a |
| 255 File Manager and a reason why it cannot. | 267 File Manager and a reason why it cannot. |
| 256 </dd> | 268 </dd> |
| 257 </dl> | 269 </dl> |
| 267 | 279 |
| 268 <p> | 280 <p> |
| 269 Public method to determine, if a Plotter can be started. | 281 Public method to determine, if a Plotter can be started. |
| 270 </p> | 282 </p> |
| 271 <dl> | 283 <dl> |
| 272 <dt>Returns:</dt> | 284 <dt>Return:</dt> |
| 273 <dd> | 285 <dd> |
| 274 tuple containing a flag indicating it is safe to start a | 286 tuple containing a flag indicating it is safe to start a |
| 275 Plotter and a reason why it cannot. | 287 Plotter and a reason why it cannot. |
| 276 </dd> | 288 </dd> |
| 277 </dl> | 289 </dl> |
| 287 | 299 |
| 288 <p> | 300 <p> |
| 289 Public method to determine, if a REPL can be started. | 301 Public method to determine, if a REPL can be started. |
| 290 </p> | 302 </p> |
| 291 <dl> | 303 <dl> |
| 292 <dt>Returns:</dt> | 304 <dt>Return:</dt> |
| 293 <dd> | 305 <dd> |
| 294 tuple containing a flag indicating it is safe to start a REPL | 306 tuple containing a flag indicating it is safe to start a REPL |
| 295 and a reason why it cannot. | 307 and a reason why it cannot. |
| 296 </dd> | 308 </dd> |
| 297 </dl> | 309 </dl> |
| 307 | 319 |
| 308 <p> | 320 <p> |
| 309 Public method to get the name of the device. | 321 Public method to get the name of the device. |
| 310 </p> | 322 </p> |
| 311 <dl> | 323 <dl> |
| 312 <dt>Returns:</dt> | 324 <dt>Return:</dt> |
| 313 <dd> | 325 <dd> |
| 314 name of the device | 326 name of the device |
| 315 </dd> | 327 </dd> |
| 316 </dl> | 328 </dl> |
| 317 <dl> | 329 <dl> |
| 318 <dt>Return Type:</dt> | 330 <dt>Return Type:</dt> |
| 319 <dd> | 331 <dd> |
| 320 str | 332 str |
| 321 </dd> | 333 </dd> |
| 322 </dl> | 334 </dl> |
| 335 <a NAME="MicrobitDevice.downloadFirmware" ID="MicrobitDevice.downloadFirmware"></a> | |
| 336 <h4>MicrobitDevice.downloadFirmware</h4> | |
| 337 <b>downloadFirmware</b>(<i></i>) | |
| 338 | |
| 339 <p> | |
| 340 Public method to download the device firmware. | |
| 341 </p> | |
| 323 <a NAME="MicrobitDevice.forceInterrupt" ID="MicrobitDevice.forceInterrupt"></a> | 342 <a NAME="MicrobitDevice.forceInterrupt" ID="MicrobitDevice.forceInterrupt"></a> |
| 324 <h4>MicrobitDevice.forceInterrupt</h4> | 343 <h4>MicrobitDevice.forceInterrupt</h4> |
| 325 <b>forceInterrupt</b>(<i></i>) | 344 <b>forceInterrupt</b>(<i></i>) |
| 326 | 345 |
| 327 <p> | 346 <p> |
| 328 Public method to determine the need for an interrupt when opening the | 347 Public method to determine the need for an interrupt when opening the |
| 329 serial connection. | 348 serial connection. |
| 330 </p> | 349 </p> |
| 331 <dl> | 350 <dl> |
| 332 <dt>Returns:</dt> | 351 <dt>Return:</dt> |
| 333 <dd> | 352 <dd> |
| 334 flag indicating an interrupt is needed | 353 flag indicating an interrupt is needed |
| 335 </dd> | 354 </dd> |
| 336 </dl> | 355 </dl> |
| 337 <dl> | 356 <dl> |
| 346 | 365 |
| 347 <p> | 366 <p> |
| 348 Public method to get the device documentation URL. | 367 Public method to get the device documentation URL. |
| 349 </p> | 368 </p> |
| 350 <dl> | 369 <dl> |
| 351 <dt>Returns:</dt> | 370 <dt>Return:</dt> |
| 352 <dd> | 371 <dd> |
| 353 documentation URL of the device | 372 documentation URL of the device |
| 354 </dd> | 373 </dd> |
| 355 </dl> | 374 </dl> |
| 356 <dl> | 375 <dl> |
| 359 str | 378 str |
| 360 </dd> | 379 </dd> |
| 361 </dl> | 380 </dl> |
| 362 <a NAME="MicrobitDevice.getFirmwareUrl" ID="MicrobitDevice.getFirmwareUrl"></a> | 381 <a NAME="MicrobitDevice.getFirmwareUrl" ID="MicrobitDevice.getFirmwareUrl"></a> |
| 363 <h4>MicrobitDevice.getFirmwareUrl</h4> | 382 <h4>MicrobitDevice.getFirmwareUrl</h4> |
| 364 <b>getFirmwareUrl</b>(<i></i>) | 383 <b>getFirmwareUrl</b>(<i>fwtype="mpy"</i>) |
| 365 | 384 |
| 366 <p> | 385 <p> |
| 367 Public method to get the device firmware download URL. | 386 Public method to get the device firmware download URL. |
| 368 </p> | 387 </p> |
| 369 <dl> | 388 <dl> |
| 370 <dt>Returns:</dt> | 389 |
| 390 <dt><i>fwtype</i> (str (optional))</dt> | |
| 391 <dd> | |
| 392 type of firmware to download | |
| 393 (valid values are "mpy" and "dap"; defaults to "mpy") | |
| 394 </dd> | |
| 395 </dl> | |
| 396 <dl> | |
| 397 <dt>Return:</dt> | |
| 371 <dd> | 398 <dd> |
| 372 firmware download URL of the device | 399 firmware download URL of the device |
| 373 </dd> | 400 </dd> |
| 374 </dl> | 401 </dl> |
| 375 <dl> | 402 <dl> |
| 384 | 411 |
| 385 <p> | 412 <p> |
| 386 Public method to get the workspace directory. | 413 Public method to get the workspace directory. |
| 387 </p> | 414 </p> |
| 388 <dl> | 415 <dl> |
| 389 <dt>Returns:</dt> | 416 <dt>Return:</dt> |
| 390 <dd> | 417 <dd> |
| 391 workspace directory used for saving files | 418 workspace directory used for saving files |
| 392 </dd> | 419 </dd> |
| 393 </dl> | 420 </dl> |
| 394 <dl> | 421 <dl> |
| 406 </p> | 433 </p> |
| 407 <p> | 434 <p> |
| 408 The default returns True. | 435 The default returns True. |
| 409 </p> | 436 </p> |
| 410 <dl> | 437 <dl> |
| 411 <dt>Returns:</dt> | 438 <dt>Return:</dt> |
| 412 <dd> | 439 <dd> |
| 413 flag indicating support for time commands | 440 flag indicating support for time commands |
| 414 </dd> | 441 </dd> |
| 415 </dl> | 442 </dl> |
| 416 <dl> | 443 <dl> |
