|
1 | 1 | # Arduino Lab for MicroPython
|
2 | 2 |
|
3 |
| -<p align="center"> |
4 |
| - |
5 |
| -<img src="https://github.com/arduino/lab-micropython-editor/blob/development/ui/arduino/documents/Screenshot%20from%202024-04-15%2009-48-25.png?raw=true" width="50%" /> |
6 |
| - |
7 |
| -</p> |
| 3 | + |
8 | 4 |
|
9 | 5 | Arduino Lab for MicroPython is a lightweight editor for MicroPython programs, supporting connection with a board, code upload, file transfer and interactive REPL shell.
|
10 | 6 | This project is sponsored by Arduino, based on original work by [Murilo Polese](http://www.murilopolese.com). This is an experimental pre-release software, please direct any questions only to Github issues.
|
11 | 7 |
|
12 | 8 | ## Features
|
| 9 | + |
13 | 10 | - MicroPython's Read Eval Print Loop (REPL)
|
14 |
| - - Enter paste mode |
15 |
| - - Enter raw repl |
16 |
| - - Software reset |
17 |
| - - Tab to autocomplete |
| 11 | + - Enter paste mode |
| 12 | + - Enter raw repl |
| 13 | + - Software reset |
| 14 | + - Tab to autocomplete |
18 | 15 | - File system management (Disk and MicroPython File System)
|
19 |
| - - Create |
20 |
| - - Rename |
21 |
| - - Multiple file and folder selection |
22 |
| - - Remove |
23 |
| - - Upload |
24 |
| - - Download |
| 16 | + - Create |
| 17 | + - Rename |
| 18 | + - Multiple file and folder selection |
| 19 | + - Remove |
| 20 | + - Upload |
| 21 | + - Download |
25 | 22 | - Text editor
|
26 |
| - - Python syntax highlight and autocomplete |
27 |
| - - Multiple tabs |
28 |
| - - Rename tabs |
| 23 | + - Python syntax highlight and autocomplete |
| 24 | + - Multiple tabs |
| 25 | + - Rename tabs |
29 | 26 | - Code execution
|
30 |
| - - Run what's on text editor |
31 |
| - - Stop (keyboard interrupt) |
32 |
| - - Soft reset |
| 27 | + - Run what's on text editor |
| 28 | + - Stop (keyboard interrupt) |
| 29 | + - Soft reset |
33 | 30 |
|
34 | 31 | ## Technical overview
|
35 | 32 |
|
36 |
| -Arduino Lab for MicroPython is an [Electron](https://www.electronjs.org/) app that has its main purpose to communicate over serial with a microprocessor running [MicroPython](https://micropython.org/). The Electron code is at `/index.js` and inside the folder `/backend`. |
| 33 | +Arduino Lab for MicroPython is an [Electron](https://www.electronjs.org/) app whose main purpose is to communicate over serial with a microcontroller running [MicroPython](https://micropython.org/). The Electron code is at `/index.js` and inside the folder `/backend`. |
37 | 34 |
|
38 |
| -All operations over serial are abstracted and packaged on `micropython.js` which is an attempt of porting `pyboard.py`. The module has its [own repository](https://github.com/arduino/micropython.js) with documentation and examples of usage. |
| 35 | +All operations over serial are abstracted and packaged in `micropython.js` which is a JavaScript implementation of the functionalities provided by `mpremote` (namely `pyboard.py`) from the [MicroPython project](https://github.com/micropython/micropython/tree/master/tools/mpremote/mpremote). |
| 36 | +The module has its [own repository](https://github.com/arduino/micropython.js) with documentation and usage examples. |
39 | 37 |
|
40 |
| -The User Interface (UI) source code stays inside `/ui` folder and is completely independent of the Electron code. |
| 38 | +The User Interface (UI) source code stays inside `/ui` folder and is completely independent from the Electron code. |
41 | 39 |
|
42 | 40 | The communication between interface and Electron app is accomplished by using the methods and events specified by `/preload.js`.
|
43 | 41 |
|
|
0 commit comments