Skip to content

Commit 81b305d

Browse files
deadprogramdeadprogram
committed
microcontrollers: update for new boards, but does not have the generated machine docs included yet
Signed-off-by: deadprogram <[email protected]>
1 parent 5d32d36 commit 81b305d

File tree

8 files changed

+316
-21
lines changed

8 files changed

+316
-21
lines changed

‎content/microcontrollers/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 3
88

99
TinyGo lets you run Go directly on microcontrollers.
1010

11-
TinyGo has support for 44 different boards and devices such as the Arduino Nano33 IoT, Adafruit Circuit Playground Express, BBC micro:bit and more. Click on a board name found in the left menu to see the what features are supported for the given hardware.
11+
TinyGo has support for 46 different boards and devices such as the Arduino Nano33 IoT, Adafruit Circuit Playground Express, BBC micro:bit and more. Click on a board name found in the left menu to see the what features are supported for the given hardware.
1212

1313
We also give you the ability to add new boards. If your target isn't listed here, please raise an issue in the [issue tracker](https://github.com/tinygo-org/tinygo/issues).
1414

‎content/microcontrollers/esp32-coreboard-v2.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: "ESP32 - Core board"
3+
weight: 3
4+
---
5+
6+
The esp32-coreboard-v2 is a development board based on the [Espressif ESP32](https://www.espressif.com/en/products/socs/esp32) a powerful chip that is used on many different board mostly because of the built-in radio that can be used for WiFi or Bluetooth wireless connections.
7+
8+
## Interfaces
9+
10+
| Interface | Hardware Supported | TinyGo Support |
11+
| --------- | ------------- | ----- |
12+
| GPIO | YES | YES |
13+
| UART | YES | YES |
14+
| SPI | YES | YES |
15+
| I2C | YES | Not Yet |
16+
| ADC | YES | Not Yet |
17+
| PWM | YES | Not Yet |
18+
| WiFi | YES | Not Yet |
19+
| Bluetooth | YES | Not Yet |
20+
21+
## Machine Package Docs
22+
23+
[Documentation for the machine package for the ESP32 Core board v2](../machine/esp32-coreboard-v2)
24+
25+
## Flashing
26+
27+
### CLI Flashing on Linux
28+
29+
You need to install the Espressif toolchain for Linux to use TinyGo with the ESP32:
30+
31+
https://docs.espressif.com/projects/esp-idf/en/release-v3.0/get-started/linux-setup.html#standard-setup-of-toolchain-for-linux
32+
33+
In addition, you must install the `esptool` flashing tool:
34+
35+
https://github.com/espressif/esptool#easy-installation
36+
37+
Now you should be able to flash your board as follows:
38+
39+
- Plug your ESP32 board into your computer's USB port.
40+
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP32 with the blinky1 example:
41+
42+
```
43+
tinygo flash -target=esp32-coreboard-v2 -port=/dev/ttyUSB0 examples/blinky1
44+
```
45+
46+
- The ESP32 board should restart and then begin running your program.
47+
48+
### CLI Flashing on macOS
49+
50+
You need to install the Espressif toolchain for macOS to use TinyGo with the ESP32:
51+
52+
https://docs.espressif.com/projects/esp-idf/en/release-v3.0/get-started/macos-setup.html
53+
54+
In addition, you must install the `esptool` flashing tool:
55+
56+
https://github.com/espressif/esptool#easy-installation
57+
58+
Now you should be able to flash your board as follows:
59+
60+
- Plug your ESP32 board into your computer's USB port.
61+
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP32 with the blinky1 example:
62+
63+
```
64+
tinygo flash -target=esp32-coreboard-v2 examples/blinky1
65+
```
66+
67+
- The ESP32 board should restart and then begin running your program.
68+
69+
### CLI Flashing on Windows
70+
71+
You need to install the Espressif toolchain for Windows to use TinyGo with the ESP32:
72+
73+
https://docs.espressif.com/projects/esp-idf/en/release-v3.0/get-started/windows-setup.html
74+
75+
In addition, you must install the `esptool` flashing tool:
76+
77+
https://github.com/espressif/esptool#easy-installation
78+
79+
Now you should be able to flash your board as follows:
80+
81+
- Plug your ESP32 board into your computer's USB port.
82+
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP32 with the blinky1 example:
83+
84+
```
85+
tinygo flash -target=esp32-coreboard-v2 examples/blinky1
86+
```
87+
88+
- The ESP32 board should restart and then begin running your program.
89+
90+
### Troubleshooting
91+
92+
Goes here
93+
94+
## Notes
95+
96+
Goes here

‎content/microcontrollers/esp32.md renamed to ‎content/microcontrollers/esp32-mini32.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: "ESP32"
2+
title: "ESP32 - mini32"
33
weight: 3
44
---
55

6-
The [Espressif ESP32](https://www.espressif.com/en/products/socs/esp32) is a powerful chip that is used on many different development boards. It includes a built-in radio that can be used for WiFi or Bluetooth wireless connections.
6+
The mini32 is a small development board based on the popular [Espressif ESP32](https://www.espressif.com/en/products/socs/esp32). The ESP32 includes a built-in radio that can be used for WiFi or Bluetooth wireless connections.
77

88
## Interfaces
99

@@ -20,7 +20,7 @@ The [Espressif ESP32](https://www.espressif.com/en/products/socs/esp32) is a pow
2020

2121
## Machine Package Docs
2222

23-
[Documentation for the machine package for the ESP32](../machine/esp32)
23+
[Documentation for the machine package for the ESP32-mini32](../machine/esp32-mini32)
2424

2525
## Flashing
2626

@@ -40,7 +40,7 @@ Now you should be able to flash your board as follows:
4040
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP32 with the blinky1 example:
4141

4242
```
43-
tinygo flash -target=esp32-wroom-32 -port=/dev/ttyUSB0 examples/blinky1
43+
tinygo flash -target=esp32-mini32 -port=/dev/ttyUSB0 examples/blinky1
4444
```
4545
4646
- The ESP32 board should restart and then begin running your program.
@@ -61,7 +61,7 @@ Now you should be able to flash your board as follows:
6161
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP32 with the blinky1 example:
6262
6363
```
64-
tinygo flash -target=esp32-wroom-32 examples/blinky1
64+
tinygo flash -target=esp32-mini32 examples/blinky1
6565
```
6666
6767
- The ESP32 board should restart and then begin running your program.
@@ -82,7 +82,7 @@ Now you should be able to flash your board as follows:
8282
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP32 with the blinky1 example:
8383
8484
```
85-
tinygo flash -target=esp32-wroom-32 examples/blinky1
85+
tinygo flash -target=esp32-mini32 examples/blinky1
8686
```
8787
8888
- The ESP32 board should restart and then begin running your program.

‎content/microcontrollers/esp8266-d1mini.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
title: "ESP8266 - d1mini"
3+
weight: 3
4+
---
5+
6+
The [Espressif ESP8266](https://www.espressif.com/en/products/socs/esp8266) d1mini is a very small yet powerful SoC that is usually used for WiFi applications thanks to its built-in radio.
7+
8+
## Interfaces
9+
10+
| Interface | Hardware Supported | TinyGo Support |
11+
| --------- | ------------- | ----- |
12+
| GPIO | YES | YES |
13+
| UART | YES | YES |
14+
| SPI | YES | Not Yet |
15+
| I2C | YES | Not Yet |
16+
| ADC | YES | Not Yet |
17+
| PWM | YES | Not Yet |
18+
| WiFi | YES | Not Yet |
19+
20+
## Machine Package Docs
21+
22+
[Documentation for the machine package for the ESP8266 d1mini](../machine/d1mini)
23+
24+
## Flashing
25+
26+
### CLI Flashing on Linux
27+
28+
You need to install the same toolchain for the ESP8266 as is used for the ESP32 to use the ESP8266 with TinyGo:
29+
30+
https://docs.espressif.com/projects/esp-idf/en/release-v3.0/get-started/linux-setup.html#standard-setup-of-toolchain-for-linux
31+
32+
In addition, you must install the `esptool` flashing tool:
33+
34+
https://github.com/espressif/esptool#easy-installation
35+
36+
Now you should be able to flash your board as follows:
37+
38+
- Plug your ESP8266 board into your computer's USB port.
39+
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP8266 with the blinky1 example:
40+
41+
```
42+
tinygo flash -target=d1mini -port=/dev/ttyUSB examples/blinky1
43+
```
44+
45+
- The ESP8266 board should restart and then begin running your program.
46+
47+
### CLI Flashing on macOS
48+
49+
You need to install the same toolchain for the ESP8266 as is used for the ESP32 to use the ESP8266 with TinyGo:
50+
51+
https://docs.espressif.com/projects/esp-idf/en/release-v3.0/get-started/macos-setup.html
52+
53+
In addition, you must install the `esptool` flashing tool:
54+
55+
https://github.com/espressif/esptool#easy-installation
56+
57+
Now you should be able to flash your board as follows:
58+
59+
- Plug your ESP8266 board into your computer's USB port.
60+
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP8266 with the blinky1 example:
61+
62+
```
63+
tinygo flash -target=d1mini examples/blinky1
64+
```
65+
66+
- The ESP826 board should restart and then begin running your program.
67+
68+
### CLI Flashing on Windows
69+
70+
You need to install the same toolchain for the ESP8266 as is used for the ESP32 to use the ESP8266 with TinyGo:
71+
72+
https://docs.espressif.com/projects/esp-idf/en/release-v3.0/get-started/windows-setup.html
73+
74+
In addition, you must install the `esptool` flashing tool:
75+
76+
https://github.com/espressif/esptool#easy-installation
77+
78+
Now you should be able to flash your board as follows:
79+
80+
- Plug your ESP826 board into your computer's USB port.
81+
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP826 with the blinky1 example:
82+
83+
```
84+
tinygo flash -target=d1mini examples/blinky1
85+
```
86+
87+
- The ESP826 board should restart and then begin running your program.
88+
89+
### Troubleshooting
90+
91+
Goes here
92+
93+
## Notes
94+
95+
Goes here

‎content/microcontrollers/esp8266.md renamed to ‎content/microcontrollers/esp8266-nodemcu.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
title: "ESP8266"
2+
title: "ESP8266 - NodeMCU"
33
weight: 3
44
---
55

6-
The [Espressif ESP8266](https://www.espressif.com/en/products/socs/esp8266) is small yet powerful SoC that is usually used for WiFi applications thanks to its built-in radio.
6+
The [Espressif ESP8266](https://www.espressif.com/en/products/socs/esp8266) NodeMCU is a small yet powerful SoC that is usually used for WiFi applications thanks to its built-in radio.
77

88
## Interfaces
99

@@ -19,7 +19,7 @@ The [Espressif ESP8266](https://www.espressif.com/en/products/socs/esp8266) is s
1919

2020
## Machine Package Docs
2121

22-
[Documentation for the machine package for the ESP8266](../machine/esp8266)
22+
[Documentation for the machine package for the ESP8266 NodeMCU](../machine/nodemcu)
2323

2424
## Flashing
2525

@@ -39,7 +39,7 @@ Now you should be able to flash your board as follows:
3939
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP8266 with the blinky1 example:
4040

4141
```
42-
tinygo flash -target=esp8266 -port=/dev/ttyUSB examples/blinky1
42+
tinygo flash -target=nodemcu -port=/dev/ttyUSB examples/blinky1
4343
```
4444
4545
- The ESP8266 board should restart and then begin running your program.
@@ -60,7 +60,7 @@ Now you should be able to flash your board as follows:
6060
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP8266 with the blinky1 example:
6161
6262
```
63-
tinygo flash -target=esp8266 examples/blinky1
63+
tinygo flash -target=nodemcu examples/blinky1
6464
```
6565
6666
- The ESP826 board should restart and then begin running your program.
@@ -81,7 +81,7 @@ Now you should be able to flash your board as follows:
8181
- Build and flash your TinyGo code using the `tinygo flash` command. This command flashes the ESP826 with the blinky1 example:
8282
8383
```
84-
tinygo flash -target=esp8266 examples/blinky1
84+
tinygo flash -target=nodemcu examples/blinky1
8585
```
8686
8787
- The ESP826 board should restart and then begin running your program.

‎content/microcontrollers/qtpy.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: "Adafruit QtPy"
3+
weight: 3
4+
---
5+
6+
The [Adafruit QtPy](https://www.adafruit.com/product/4600) is a tiny ARM development board based on the Atmel [ATSAMD21E18](https://www.microchip.com/wwwproducts/en/ATSAMD21E18) family of SoC.
7+
8+
## Interfaces
9+
10+
| Interface | Hardware Supported | TinyGo Support |
11+
| --------- | ------------- | ----- |
12+
| GPIO | YES | YES |
13+
| UART | YES | YES |
14+
| SPI | YES | YES |
15+
| I2C | YES | YES |
16+
| ADC | YES | YES |
17+
| PWM | YES | YES |
18+
19+
## Machine Package Docs
20+
21+
[Documentation for the machine package for the Adafruit QtPy](../machine/qtpy)
22+
23+
## Flashing
24+
25+
### UF2
26+
27+
The QtPy comes with the [UF2 bootloader](https://github.com/Microsoft/uf2) already installed.
28+
29+
### CLI Flashing
30+
31+
- Plug your QtPy into your computer's USB port.
32+
- Flash your TinyGo program to the board using this command:
33+
34+
```shell
35+
tinygo flash -target=qtpy [PATH TO YOUR PROGRAM]
36+
```
37+
38+
- The QtPy board should restart and then begin running your program.
39+
40+
### Troubleshooting
41+
42+
If you have troubles getting your QtPy board to receive code, try this:
43+
44+
- Press the "RESET" button on the board two times to get the QtPy board ready to receive code.
45+
- The QtPy board will appear to your computer like a USB drive.
46+
- Now try running the `tinygo flash` command as above:
47+
48+
```shell
49+
tinygo flash -target=qtpy [PATH TO YOUR PROGRAM]
50+
```
51+
52+
Once you have updated your QtPy board the first time, after that you should be able to flash it entirely from the command line.
53+
54+
## Notes
55+
56+
You can use the USB port to the QtPy as a serial port. `UART0` refers to this connection.

0 commit comments

Comments
 (0)