README.md
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
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
README_zh.md
1# STM32F412 Nucleo开发板的Arduino生态兼容说明
2
3## 1 RTduino - RT-Thread的Arduino生态兼容层
4
5STM32F412 Nucleo开发板已经完整适配了[RTduino软件包](https://github.com/RTduino/RTduino)，即RT-Thread的Arduino生态兼容层。用户可以按照Arduino的编程习惯来操作本BSP，并且可以使用大量Arduino社区丰富的库，是对RT-Thread生态的极大增强。更多信息，请参见[RTduino软件包说明文档](https://github.com/RTduino/RTduino)。
6
7### 1.1 如何开启针对本BSP的Arduino生态兼容层
8
9Env 工具下敲入 menuconfig 命令，或者 RT-Thread Studio IDE 下选择 RT-Thread Settings：
10
11```Kconfig
12Hardware Drivers Config --->
13 Onboard Peripheral Drivers --->
14 [*] Compatible with Arduino Ecosystem (RTduino)
15```
16
17## 2 Arduino引脚排布
18
19
20
21该BSP遵照Arduino UNO板的引脚排列方式，详见 [pins_arduino.c](pins_arduino.c) 和 [pins_arduino.h](pins_arduino.h)。
22
23| Arduino引脚编号 | STM32引脚编号 | 5V容忍 | 备注 |
24| --------------------- | --------- | ---- | --------------------------------------------- |
25| 0 (D0) | PG9 | 是 | Serial-Rx，默认被RT-Thread的UART设备框架uart3接管 |
26| 1 (D1) | PG14 | 是 | Serial-Tx，默认被RT-Thread的UART设备框架uart3接管 |
27| 2 (D2) | PF15 | 是 | |
28| 3 (D3) | PE13 | 是 | PWM1-CH3，默认被RT-Thread的PWM设备框架pwm1接管 |
29| 4 (D4) | PF14 | 是 | |
30| 5 (D5) | PE11 | 是 | PWM1-CH2，默认被RT-Thread的PWM设备框架pwm1接管 |
31| 6 (D6) | PE9 | 是 | PWM1-CH1，默认被RT-Thread的PWM设备框架pwm1接管 |
32| 7 (D7) | PF13 | 是 | |
33| 8 (D8) | PF12 | 是 | |
34| 9 (D9) | PD15 | 是 | PWM4-CH4，默认被RT-Thread的PWM设备框架pwm4接管 |
35| 10 (D10) | PD14 | 是 | PWM4-CH3，默认被RT-Thread的PWM设备框架pwm4接管 |
36| 11 (D11) | PA7 | 是 | PWM14-CH1，默认被RT-Thread的PWM设备框架pwm14接管 |
37| 12 (D12) | PA6 | 是 | |
38| 13 (D13) | PA5 | 是 | |
39| 14 (D14) | PB9 | 是 | I2C-SDA，默认被RT-Thread的I2C设备框架i2c1总线接管 |
40| 15 (D15) | PB8 | 是 | I2C-SCL，默认被RT-Thread的I2C设备框架i2c1总线接管 |
41| 16 (D16) | PC13 | 是 | 板载用户按键（左侧蓝色） |
42| 17 (D17, LED_BUILTIN) | PB0 | 是 | 板载用户LED1 |
43| 18 (D18) | PB7 | 是 | 板载用户LED2 |
44| 19 (D19) | PB14 | 是 | 板载用户LED3 |
45| A0 | PA3 | 是 | ADC1-CH3，默认被RT-Thread的ADC设备框架adc1接管 |
46| A1 | PC0 | 是 | ADC1-CH10，默认被RT-Thread的ADC设备框架adc1接管 |
47| A2 | PC3 | 是 | ADC1-CH13，默认被RT-Thread的ADC设备框架adc1接管 |
48| A3 | PC1 | 是 | ADC1-CH11，默认被RT-Thread的ADC设备框架adc1接管 |
49| A4 | PC4 | 是 | ADC1-CH14，默认被RT-Thread的ADC设备框架adc1接管 |
50| A5 | PC5 | 是 | ADC1-CH15，默认被RT-Thread的ADC设备框架adc1接管 |
51| A6 | -- | | 芯片内部参考电压 ADC1-CH17，默认被RT-Thread的ADC设备框架adc1接管 |
52| A7 | -- | | 芯片内部温度 ADC1-CH16，默认被RT-Thread的ADC设备框架adc1接管 |
53
54> 注意：
55>
56> 1. 驱动舵机和analogWrite函数要选择不同定时器发生的PWM信号引脚，由于STM32的定时器4个通道需要保持相同的频率，如果采用相同的定时器发生的PWM分别驱动舵机和analogWrite，可能会导致舵机失效。
57> 2. Nucleo板的Arduino接口中AVDD（即AREF）默认是与VDD相连的，如果需要扩展板提供外部参考电压，需要将SB57锡桥挑开。
58
59> 参考资料
60>
61> 1. [STM32 Nucleo-144板用户手册](https://www.st.com/resource/en/user_manual/um1974-stm32-nucleo144-boards-mb1137-stmicroelectronics.pdf)
62
63## 3 通信
64
65### 3.1 I2C总线
66
67I2C总线是板上丝印的 `SCL/D15` 和 `SDA/D14` 引脚，这两个引脚默认是被RT-Thread I2C设备框架接管的，直接引用`#include <Wire.h>`（Arduino官方I2C头文件）即可使用。
68
69### 3.2 SPI总线
70
71Nucleo板的SPI总线是板上丝印的 `CS/D10`、`MOSI/D11`、`MISO/D12` 以及 `SCK/D13` 引脚，这`D11`、`D12` 以及 `D13` 引脚是被RT-Thread SPI设备框架接管的，不需要直接操控这些引脚。用户需要操作 `D10` 片选引脚。直接引用`#include <SPI.h>`（Arduino官方SPI头文件）即可使用。在使用SPI功能后，`D10` 和 `D11` 的PWM功能将会不可逆失效，转为SPI功能。
72
73### 3.3 串口
74
75本BSP通过 `Serial.` 方法调用 `uart3` 串口设备。详见[例程](https://github.com/RTduino/RTduino/blob/master/examples/Basic/helloworld.cpp)。
76
77### 3.4 USB虚拟串口
78
79本BSP支持USB虚拟串口，如果需要使用，可以手动使能。详见[例程](https://github.com/RTduino/RTduino/tree/master/examples/USBSerial)。
80
81```Kconfig
82RT-Thread online packages --->
83 Arduino libraries --->
84 [*] RTduino: Arduino Ecological Compatibility Layer
85 [*] Enable USB Serial
86```
87
