Skip to content

Commit 59eff9e

Browse files
committed
chore: update against Arduino IDE 2
Signed-off-by: Frederic Pillon <[email protected]>
1 parent eeed2fa commit 59eff9e

26 files changed

+144
-23
lines changed

Getting-Started.md

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1+
> [!WARNING]
2+
> Since core release 2.8.0, only Arduino IDE 2 is supported.
3+
> To use Legacy IDE (1.8.X), see the [[Getting Started_V1]]
4+
15
# Install Arduino.cc IDE
2-
Download and install [Arduino software (IDE)](https://www.arduino.cc/en/Main/Software) for the required OS.
3-
([Windows](https://www.arduino.cc/en/Guide/Windows), [Linux](https://www.arduino.cc/en/Guide/linux) or [Mac](https://www.arduino.cc/en/Guide/MacOSX) instructions)
6+
7+
Download and install [Arduino IDE 2](https://www.arduino.cc/en/software) for the required OS.
8+
([Windows](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/#windows), [Linux](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/#linux) or [macOS](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/#macos) instructions)
49

510
## About Boards manager concept
611
Arduino.cc IDE allows to add easily new board thanks the "**Boards Managers**".
712
More information about "**Boards Managers**" is available on Arduino.cc official website:
813

9-
[Installing additional Arduino Cores](https://www.arduino.cc/en/guide/cores)
14+
[Installing a Board Package in the IDE 2](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-board-manager)
1015

1116
The corresponding STM32 cores packages are provided thanks to:
1217

@@ -22,39 +27,39 @@ So carefully follow the following steps.
2227

2328
1- Launch Arduino.cc IDE. Click on "**File**" menu and then "**Preferences**".
2429

25-
[[img/preferences.png|alt=Preferences]]
30+
[[img/v2/preferences.png|alt=Preferences]]
2631

2732
The "**Preferences**" dialog will open, then add the following link to the "*Additional Boards Managers URLs*" field:
2833

2934
https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
3035

3136
Click "**Ok**"
3237

33-
2- Click on "**Tools**" menu and then "**Boards > Boards Manager**"
38+
2- Click on "**Tools**" menu and then "**Boards > Boards Manager**" or use the underlined icon on the left side bar:
3439

35-
[[img/menu_bm.png|alt="BoardsManager Menu"]]
40+
[[img/v2/menu_bm.png|alt="BoardsManager Menu"]]
3641

3742
The board manager will open and you will see a list of installed and available boards.
3843

3944
Select "**Contributed**" type.
4045

41-
[[img/boardsmanager.png|alt="BoardsManager dialog"]]
46+
[[img/v2/boardsmanager.png|alt="BoardsManager dialog"]]
4247

4348
Select the "**STM32 MCU based boards**" and click on install.
4449

45-
[[img/boardsmanager2.png|alt="BoardsManager dialog"]]
50+
[[img/v2/boardsmanager2.png|alt="BoardsManager dialog"]]
4651

47-
After installation is complete an "*INSTALLED*" tag appears next to the core name.
52+
After installation is complete a "*\<version> installed*" tag appears below the core name.
4853

4954
You can close the Board Manager.
5055

51-
[[img/boardslist.png|alt="Boards list"]]
56+
[[img/v2/boardslist.png|alt="Boards list"]]
5257

5358
Now you can find the STM32 boards package in the "**Board**" menu.
5459

5560
Select the desired boards series: _Nucleo-64 / Nucleo-144 / Discovery / ..._
5661

57-
[[img/SelectBoard.png|alt="Select boards"]]
62+
[[img/v2/SelectBoard.png|alt="Select boards"]]
5863

5964
Then you can find the Nucleo-64 boards available in a sub-menu of the "Tools" menu.
6065

@@ -76,38 +81,37 @@ Else configure the proxy in the Arduino.cc IDE (open the "**Preferences**" dialo
7681

7782
2. Launch the Arduino software
7883

79-
[[/img/arduino.png|alt="Arduino icon"]]
84+
[[/img/v2/arduino.png|alt="Arduino icon"]]
8085

8186
3. Select the [Nucleo L476RG] board in two steps:
8287

8388
a. From the "**Tools > Board**" menu, select the STM32 boards groups: _Nucleo-64_
8489

85-
[[/img/boardslist.png|alt="Board selection"]]
90+
[[/img/v2/boardslist.png|alt="Board selection"]]
8691

8792
b. Then from the "**Tools > Board part number**" menu, select the [Nucleo L476RG]
8893

89-
[[/img/SelectBoard.png|alt="Board selection"]]
94+
[[/img/v2/SelectBoard.png|alt="Board selection"]]
9095

9196
3. Select the serial port from the "**Tools > Port**" menu
9297

9398
* On Mac, it's something like _/dev/tty.usbmodem-1511_.
94-
* On Windows, it's often the highest-numbered COM port. In this example, it's _COM5_
99+
* On Windows, it's often the highest-numbered COM port. In this example, it's _COM40_
95100
* On Linux, it's something like _/dev/ttyACM0_.
96101

97102
(Or unplug the board, check the menu, and then plug the board and check what new port appears)
98103

99-
[[/img/SelectPort.png|alt="Port selection"]]
104+
[[/img/v2/SelectPort.png|alt="Port selection"]]
100105

101106
## Upload methods
102107
Depending of the board, several upload methods could be proposed, thanks the "**Tools > Upload Method**" menu.
103108

104109
See [[Upload methods]] for more details.
105110

106-
[[/img/UploadMethod.png|alt="Upload Method"]]
111+
[[/img/v2/UploadMethod.png|alt="Upload Method"]]
107112

108113
# Examples
109114
* [[Blink-example]]
110-
* [[Firmata-example]] (to use with [ScratchX](http://scratchx.org/) for example)
111115

112116

113117
[Nucleo L476RG]: http://www.st.com/en/evaluation-tools/nucleo-l476rg.html

Getting-Started_V1.md

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
> [!WARNING]
2+
> This page is dedicated to Legacy Arduino IDE (1.8.X).
3+
> Legacy Arduino IDE (1.8.X) can be used only with core version prio to 2.8.0.
4+
> For core version higher or equal to 2.8.0, see the [[Getting Started]]
5+
6+
# Install Arduino.cc IDE
7+
Download and install [Arduino software (IDE)](https://www.arduino.cc/en/software) for the required OS.
8+
([Windows](https://docs.arduino.cc/software/ide-v1/tutorials/Windows), [Linux](https://docs.arduino.cc/software/ide-v1/tutorials/Linux) or [Mac](https://docs.arduino.cc/software/ide-v1/tutorials/macOS/) instructions)
9+
10+
## About Boards manager concept
11+
Arduino.cc IDE allows to add easily new board thanks the "**Boards Managers**".
12+
More information about "**Boards Managers**" is available on Arduino.cc official website:
13+
14+
[Installing additional Arduino Cores](https://docs.arduino.cc/learn/starting-guide/cores)
15+
16+
The corresponding STM32 cores packages are provided thanks to:
17+
18+
https://github.com/stm32duino/BoardManagerFiles
19+
20+
Follow the below steps to get STM32 boards installed to your Arduino IDE.
21+
22+
# Add STM32 boards support to Arduino
23+
This is the needed step to get STM32 targets added to Arduino.
24+
So carefully follow the following steps.
25+
26+
## Installing STM32 Cores
27+
28+
1- Launch Arduino.cc IDE. Click on "**File**" menu and then "**Preferences**".
29+
30+
[[img/v1/preferences.png|alt=Preferences]]
31+
32+
The "**Preferences**" dialog will open, then add the following link to the "*Additional Boards Managers URLs*" field:
33+
34+
https://github.com/stm32duino/BoardManagerFiles/raw/main/package_stmicroelectronics_index.json
35+
36+
Click "**Ok**"
37+
38+
2- Click on "**Tools**" menu and then "**Boards > Boards Manager**"
39+
40+
[[img/v1/menu_bm.png|alt="BoardsManager Menu"]]
41+
42+
The board manager will open and you will see a list of installed and available boards.
43+
44+
Select "**Contributed**" type.
45+
46+
[[img/v1/boardsmanager.png|alt="BoardsManager dialog"]]
47+
48+
Select the "**STM32 MCU based boards**" and click on install.
49+
50+
[[img/v1/boardsmanager2.png|alt="BoardsManager dialog"]]
51+
52+
After installation is complete an "*INSTALLED*" tag appears next to the core name.
53+
54+
You can close the Board Manager.
55+
56+
[[img/v1/boardslist.png|alt="Boards list"]]
57+
58+
Now you can find the STM32 boards package in the "**Board**" menu.
59+
60+
Select the desired boards series: _Nucleo-64 / Nucleo-144 / Discovery / ..._
61+
62+
[[img/v1/SelectBoard.png|alt="Select boards"]]
63+
64+
Then you can find the Nucleo-64 boards available in a sub-menu of the "Tools" menu.
65+
66+
## Extra step
67+
68+
To upload through SWD (STLink), Serial or DFU, [STM32CubeProgrammer](https://www.st.com/en/development-tools/stm32cubeprog.html) needs to be installed. See [[Upload methods|Upload-methods#stm32cubeprogrammer]].
69+
70+
## Troubleshooting
71+
72+
If you have any issue to download/use a package, you could [file an issue on Github](https://github.com/stm32duino/BoardManagerFiles/issues/new).
73+
74+
### Proxy
75+
If you have any issue to download a package, ensure to not be behind a proxy.
76+
77+
Else configure the proxy in the Arduino.cc IDE (open the "**Preferences**" dialog and select "**Network**" tab).
78+
79+
# Configuring IDE
80+
1. Connect a board to the computer USB port. For this example: [Nucleo L476RG]
81+
82+
2. Launch the Arduino software
83+
84+
[[/img/v1/arduino.png|alt="Arduino icon"]]
85+
86+
3. Select the [Nucleo L476RG] board in two steps:
87+
88+
a. From the "**Tools > Board**" menu, select the STM32 boards groups: _Nucleo-64_
89+
90+
[[/img/v1/boardslist.png|alt="Board selection"]]
91+
92+
b. Then from the "**Tools > Board part number**" menu, select the [Nucleo L476RG]
93+
94+
[[/img/v1/SelectBoard.png|alt="Board selection"]]
95+
96+
3. Select the serial port from the "**Tools > Port**" menu
97+
98+
* On Mac, it's something like _/dev/tty.usbmodem-1511_.
99+
* On Windows, it's often the highest-numbered COM port. In this example, it's _COM5_
100+
* On Linux, it's something like _/dev/ttyACM0_.
101+
102+
(Or unplug the board, check the menu, and then plug the board and check what new port appears)
103+
104+
[[/img/v1/SelectPort.png|alt="Port selection"]]
105+
106+
## Upload methods
107+
Depending of the board, several upload methods could be proposed, thanks the "**Tools > Upload Method**" menu.
108+
109+
See [[Upload methods]] for more details.
110+
111+
[[/img/v1/UploadMethod.png|alt="Upload Method"]]
112+
113+
# Examples
114+
* [[Blink-example]]
115+
116+
117+
[Nucleo L476RG]: http://www.st.com/en/evaluation-tools/nucleo-l476rg.html

_Examples/Blink-example.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
## Blink example on [Nucleo L476RG](http://www.st.com/en/evaluation-tools/nucleo-l476rg.html)
2-
1. If not already done, download and install the [Arduino software (IDE)](https://www.arduino.cc/en/Main/Software) for the required OS.
3-
([Windows](https://www.arduino.cc/en/Guide/Windows), [Linux](https://www.arduino.cc/en/Guide/linux) or [Mac](https://www.arduino.cc/en/Guide/MacOSX) instructions)
2+
3+
1. If not already done, [[Getting-Started#Install-Arduino.cc-IDE]]
44

55
2. Configure the IDE to the desired board.
66

77
See [[Getting-Started#configuring-ide]]
88

99
3. Open the Blink sketch from the "**File> Examples > 01.Basics > Blink**"
1010

11-
[[/img/SelectBlinkExample.png|alt="Blink example selection"]]
12-
1311
4. Click the upload button
1412

1513
See [[Getting-Started#upload-method]] to change the upload method.
1614

17-
[[/img/Upload.png|alt="Upload"]]
15+
[[/img/v1/Upload.png|alt="Upload"]]
16+
17+
[[/img/v2/Upload.png|alt="Upload"]]
1818

1919
That's all. LED should blink on the [Nucleo L476RG](http://www.st.com/en/evaluation-tools/nucleo-l476rg.html).

img/SelectBlinkExample.png

-20.2 KB
Binary file not shown.

img/SelectSpecificExample.png

-38.3 KB
Binary file not shown.

img/Upload.png

-5.94 KB
Binary file not shown.
File renamed without changes.
File renamed without changes.

img/v1/Upload.png

9.1 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)