README.md
1# STM32L476 Nucleo 开发板的Arduino生态兼容说明
2
3## 1 RTduino - RT-Thread的Arduino生态兼容层
4
5STM32L476 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更多引脚布局相关信息参见 [pins_arduino.c](pins_arduino.c) 和 [pins_arduino.h](pins_arduino.h)。
20
21
22
23| Arduino引脚编号 | STM32引脚编号 | 5V容忍 | 备注 |
24| ------------------- | --------- | ---- | ------------------------------------------------------------------------- |
25| 0 (D0) | PA3 | 否 | Serial-RX，默认被RT-Thread的UART设备框架uart2接管 |
26| 1 (D1) | PA2 | 是 | Serial-TX，默认被RT-Thread的UART设备框架uart2接管 |
27| 2 (D2) | PA10 | 是 | |
28| 3 (D3) | PB3 | 是 | PWM2-CH2，默认被RT-Thread的PWM设备框架pwm2接管 |
29| 4 (D4) | PB5 | 是 | |
30| 5 (D5) | PB4 | 是 | PWM3-CH1，默认被RT-Thread的PWM设备框架pwm3接管 |
31| 6 (D6) | PB10 | 是 | PWM2-CH3，默认被RT-Thread的PWM设备框架pwm2接管 |
32| 7 (D7) | PA8 | 是 | |
33| 8 (D8) | PA9 | 是 | |
34| 9 (D9) | PC7 | 是 | PWM3-CH2，默认被RT-Thread的PWM设备框架pwm3接管 |
35| 10 (D10) | PB6 | 是 | PWM4-CH1，默认被RT-Thread的PWM设备框架pwm4接管 |
36| 11 (D11) | PA7 | 是 | PWM17-CH1，默认被RT-Thread的PWM设备框架pwm17接管 |
37| 12 (D12) | PA6 | 是 | |
38| 13 (D13) | PA5 | 否 | |
39| 14 (D14) | PB9 | 是 | I2C1-SDA，默认被RT-Thread的I2C设备框架i2c1接管 |
40| 15 (D15) | PB8 | 是 | I2C1-SCL，默认被RT-Thread的I2C设备框架i2c1接管 |
41| 16 (D16) | PA5 | 否 | |
42| 17 (A0) | PA0 | 是 | ADC1-CH5，默认被RT-Thread的ADC设备框架adc1接管 |
43| 18 (A1) | PA1 | 是 | ADC1-CH6，默认被RT-Thread的ADC设备框架adc1接管 |
44| 19 (A2) | PA4 | 否 | ADC1-CH9，默认被RT-Thread的ADC设备框架adc1接管 |
45| 20 (A3) | PB0 | 否 | ADC1-CH15，默认被RT-Thread的ADC设备框架adc1接管 |
46| 21 (A4) | PC1 | 是 | ADC1-CH2，默认被RT-Thread的ADC设备框架adc1接管 |
47| 22 (A5) | PC0 | 是 | ADC1-CH1，默认被RT-Thread的ADC设备框架adc1接管 |
48| 23 (A6) | -- | | 芯片内部参考电压 ADC，默认被RT-Thread的ADC设备框架adc1接管 |
49| 24 (A7) | -- | | 芯片内部温度 ADC，默认被RT-Thread的ADC设备框架adc1接管 |
50
51> 注意：
52>
53> 1. 驱动舵机和analogWrite函数要选择不同定时器发生的PWM信号引脚，由于STM32的定时器4个通道需要保持相同的频率，如果采用相同的定时器发生的PWM分别驱动舵机和analogWrite，可能会导致舵机失效。
54> 2. USART2是Nucleo板的默认串口，理论应对接到了Arduino引脚编号的D0和D1，但是其实际用于串口通信，因此不允许当做普通IO来使用和操作。如果需要将D0、D1与STM32 USART2的引脚相连，需要手动焊接锡桥SB62、SB63。
55> 3. Nucleo板的Arduino接口中AVDD（即AREF）默认是与VDD相连的，如果需要扩展板提供外部参考电压，需要将SB57锡桥挑开。
56
57> 参考资料
58>
59> 1. [STM32 Nucleo-64板用户手册](https://www.st.com/resource/en/user_manual/um1724-stm32-nucleo64-boards-mb1136-stmicroelectronics.pdf)
60
61## 3 通信
62
63### 3.1 I2C总线
64
65Nucleo板的I2C总线是板上丝印的 `SCL/D15` 和 `SDA/D14` 引脚，这两个引脚是被RT-Thread I2C设备框架接管的，不需要直接操控这两个引脚，直接引用`#include <Wire.h>`（Arduino官方I2C头文件）即可使用。
66
67### 3.2 SPI总线
68
69Nucleo板的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功能。
70
71### 3.3 串口
72
73本BSP通过 `Serial.` 方法调用 `uart2` 串口设备。详见[例程](https://github.com/RTduino/RTduino/blob/master/examples/Basic/helloworld.cpp)。
74
