Skip to content

Commit b6942bd

Browse files
committed
Update reference.md
1 parent d6cfe16 commit b6942bd

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

content/micropython/01.basics/08.reference/reference.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
---
22
title: MicroPython Reference
3-
description: A reference of the MicroPython API
3+
description: A single document reference of the MicroPython API
44
authors: Karl Söderby
55
micropython_type: basics
66
---
77

8-
***Note that this article is a work in progress and is subject to major changes.***
9-
10-
This reference acts as a "translation" between what is known as the "Arduino API", which is documented in the [Arduino Language Reference](), and the MicroPython API.
11-
12-
Please note that implementations may vary from board to board, such as how you configure pins, and how to use PWM.
8+
This reference serves as a "translation" between what is known as the **Arduino API**, which is documented in the [Arduino Language Reference](https://www.arduino.cc/reference/en/), and the **MicroPython API**.
139

1410
The main goal with this reference is to provide an understanding of how to e.g. use common Arduino concepts such as `digitalWrite()` in a MicroPython script.
1511

1612
For example:
1713
- `digitalWrite(pin, HIGH)` (Arduino/C++)
1814
- `pin.value(1)` (MicroPython)
1915

16+
The entries are named exactly the same as in the language reference, with the MicroPython syntax, description and code example provided for each entry.
17+
18+
***Note that several entries in the original [Language Reference](https://www.arduino.cc/reference/en/) are directly taken from the C++ reference. In the same fashion, many functions located in this reference are taken from the Python reference, and are not MicroPython specific.***
19+
2020
## Index
2121

22+
The entire reference is located inside this document, and the index below helps navigate to the right section.
23+
2224
- [Index](#index)
2325
- [Digital I/O](#digital-io)
2426
- [pinMode()](#pinmode)

0 commit comments

Comments
 (0)