1# The Arduino Compatible for STM32F412 Nucleo Board
2
3**English** | [中文](README_zh.md)
4
5## 1 RTduino - Arduino Ecosystem Compatibility Layer for RT-Thread
6
7STM32F412 Nucleo board has support [RTduino](https://github.com/RTduino/RTduino). Users can use Arduino APIs, third party libraries and programming method to program on the board.
8
9### 1.1 How to Enable RTduino
10
11Please go to the [RTduino repository](https://github.com/RTduino/RTduino) to see the details.
12
13```Kconfig
14Hardware Drivers Config --->
15    Onboard Peripheral Drivers --->
16        [*] Compatible with Arduino Ecosystem (RTduino)
17```
18
19## 2 Arduino Pinout
20
21![nucleo-f412-pinout](nucleo-f412-pinout.png)
22
23This board complies with Arduino UNO pins layout. For more details, please take a look at: [pins_arduino.c](pins_arduino.c) and [pins_arduino.h](pins_arduino.h).
24
25| Arduino Pin           | STM32 Pin | 5V Tolerate | Note                                                                                          |
26| --------------------- | --------- | ----------- | --------------------------------------------------------------------------------------------- |
27| 0 (D0)                | PG9       | Yes         | Serial-Rx. Token over by RT-Thread UART device by default                                     |
28| 1 (D1)                | PG14      | Yes         | Serial-Tx. Token over by RT-Thread UART device by default                                     |
29| 2 (D2)                | PF15      | Yes         |                                                                                               |
30| 3 (D3)                | PE13      | Yes         | PWM1-CH3. Token over by RT-Thread PWM device by default                                       |
31| 4 (D4)                | PF14      | Yes         |                                                                                               |
32| 5 (D5)                | PE11      | Yes         | PWM1-CH2. Token over by RT-Thread PWM device by default                                       |
33| 6 (D6)                | PE9       | Yes         | PWM1-CH1. Token over by RT-Thread PWM device by default                                       |
34| 7 (D7)                | PF13      | Yes         |                                                                                               |
35| 8 (D8)                | PF12      | Yes         |                                                                                               |
36| 9 (D9)                | PD15      | Yes         | PWM4-CH4. Token over by RT-Thread PWM device by default                                       |
37| 10 (D10)              | PD14      | Yes         | PWM4-CH3. Token over by RT-Thread PWM device by default                                       |
38| 11 (D11)              | PA7       | Yes         | PWM14-CH1. Token over by RT-Thread PWM device by default                                      |
39| 12 (D12)              | PA6       | Yes         |                                                                                               |
40| 13 (D13)              | PA5       | Yes         |                                                                                               |
41| 14 (D14)              | PB9       | Yes         | I2C-SDA. Token over by RT-Thread I2C device by default                                        |
42| 15 (D15)              | PB8       | Yes         | I2C-SCL. Token over by RT-Thread I2C device by default                                        |
43| 16 (D16)              | PC13      | Yes         | USER Button                                                                                   |
44| 17 (D17, LED_BUILTIN) | PB0       | Yes         | USER LED1                                                                                     |
45| 18 (D18)              | PB7       | Yes         | USER LED2                                                                                     |
46| 19 (D19)              | PB14      | Yes         | USER LED3                                                                                     |
47| A0                    | PA3       | Yes         | ADC1-CH3. Token over by RT-Thread ADC device by default                                       |
48| A1                    | PC0       | Yes         | ADC1-CH10. Token over by RT-Thread ADC device by default                                      |
49| A2                    | PC3       | Yes         | ADC1-CH13. Token over by RT-Thread ADC device by default                                      |
50| A3                    | PC1       | Yes         | ADC1-CH11. Token over by RT-Thread ADC device by default                                      |
51| A4                    | PC4       | Yes         | ADC1-CH14. Token over by RT-Thread ADC device by default                                      |
52| A5                    | PC5       | Yes         | ADC1-CH15. Token over by RT-Thread ADC device by default                                      |
53| A6                    | --        |             | On-chip internal voltage sensor. ADC1-CH17. Token over by RT-Thread ADC device by default     |
54| A7                    | --        |             | On-chip internal temperature sensor. ADC1-CH16. Token over by RT-Thread ADC device by default |
55
56> Notice:
57>
58> 1. Don't use a same hardware timer to drive PWM (analogRead) and servos at same time, because hardware timers can only generate a same frequency for 4 PWM channels. Otherwise, it could cause a failure when drive servos.
59
60> References
61>
62> 1. [STM32 Nucleo-144 user manual](https://www.st.com/resource/en/user_manual/um1974-stm32-nucleo144-boards-mb1137-stmicroelectronics.pdf)
63
64## 3 Communication
65
66### 3.1 I2C Bus
67
68I2C bus is `SCL/D15` and `SDA/D14` pins. Users can directly include the `#include <Wire.h>`, which is the Arduino official I2C header file, to use the I2C bus.
69
70### 3.2 SPI Bus
71
72The SPI bus of the Nucleo board is the `CS/D10`, `MOSI/D11`, `MISO/D12` and `SCK/D13` pins printed on the board. These `D11`, `D12` and `D13` pins It is taken over by the RT-Thread SPI device framework and there is no need to directly control these pins. User needs to operate `D10` chip select pin. Directly quote `#include <SPI.h>` (Arduino official SPI header file) to use. After using the SPI function, the PWM function of `D10` and `D11` will be irreversibly disabled and converted to the SPI function.
73
74### 3.3 Serial
75
76This board supports to use `Serial.` method to operate `uart3` device. See [example](https://github.com/RTduino/RTduino/blob/master/examples/Basic/helloworld.cpp).
77