[PXCT-779] MicroPython Runtime Package tutorial #2457
Conversation
- added all examples (and tested) - added API
content/micropython/00.first-steps/03.runtime-package/runtime-package.md
Outdated
Show resolved
Hide resolved
…package.md Co-authored-by: pedromsousalima <[email protected]>
|
|
||
| - `analog_read(pin)` | ||
|
|
||
| Analog read is a classic example where you read the voltage from an analog pin. |
There was a problem hiding this comment.
add: "[...] pin and print it to the console."
|
|
||
| - `digital_read(pin)` | ||
|
|
||
| Reads a digital pin and returns a HIGH (1) or LOW (0) value. |
There was a problem hiding this comment.
add: "We print this value in the console."
|
|
||
| | Function | Description | Parameters | Returns | Alias | | ||
| | ------------------- | ---------------------------------------------- | ------------------------------------------------------------- | ------------------------ | ---------------- | | ||
| | `start` | Begins main loop with hooks | `preload`, `setup`, `loop`, `cleanup` | None | None | |
There was a problem hiding this comment.
preload is added to the end because it's only needed in very specific cases.
We want to allow the user to
start(setup, loop, cleanup) as a basic, friendly flow.
| | `create_sketch` | Creates new sketch from template | `sketch_name`, `destination_path`, `overwrite`, `source_path` | Created sketch path | None | | ||
| | `copy_sketch` | Copies existing sketch to new location | `source_path`, `destination_path`, `name`, `overwrite` | Copied sketch path | None | | ||
|
|
||
| ### start(setup=None, loop=None, cleanup=None, preload=None) |
There was a problem hiding this comment.
as per the last comment :)
| Begins the main execution loop, calling user-defined hooks. | ||
|
|
||
| - **Parameters:** | ||
| - `preload`: Function run once before setup. |
There was a problem hiding this comment.
reorder placing this to the bottom of the list
|
|
||
| The [Arduino Runtime Package](https://github.com/arduino/arduino-runtime-mpy/tree/main) is a MicroPython package that allows you to write and program your board using the classic `setup()` and `loop()` constructs. | ||
|
|
||
| The package was designed to make it easier to create programs, particularly for those familiar with the Arduino C++ environment. |
There was a problem hiding this comment.
suggestion: "[...] environment, but it also adds a few interesting tricks to better help your program run and stop."
| micropython_type: test | ||
| --- | ||
|
|
||
| The [Arduino Runtime Package](https://github.com/arduino/arduino-runtime-mpy/tree/main) is a MicroPython package that allows you to write and program your board using the classic `setup()` and `loop()` constructs. |
There was a problem hiding this comment.
change: "Arduino Runtime for MicroPython is a library that [...]"
suggestion: "[...] using the familiar [...]"
suggestion: "[...] construct. It also adds a few helpers along the way."
| @@ -0,0 +1,367 @@ | |||
| --- | |||
| title: "Arduino MicroPython Runtime" | |||
| description: "Learn how to use the Arduino MicroPython runtime package, which allows you to write MicroPython code in a familiar Arduino style." | |||
There was a problem hiding this comment.
change: "Arduino Runtime for MicroPython"
suggestion: "[...] familiar Arduino style and adds a few helpers"
| def loop(): | ||
| value = digital_read(pin) | ||
| print(value) | ||
|
|
There was a problem hiding this comment.
always add a small delay not to flood the REPL and render the editor unresponsive
| - **Returns:** The interpolated value. | ||
| - **Alias:** None. | ||
|
|
||
| ### pin_mode(pin, mode) |
There was a problem hiding this comment.
I'd move pin_mode etc above map(), constrain() and such commands, which should be under a section "helpers"
What This PR Changes
Contribution Guidelines