Skip to content

Commit 3092a92

Browse files
committed
docs: 插入 DAC 文档并更新文档导航顺序
1 parent 584c77b commit 3092a92

File tree

30 files changed

+159
-40
lines changed

30 files changed

+159
-40
lines changed

docs/basic_coding/driver/adc.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,3 @@ public:
2222
2323
- `Read()` 是纯虚函数,子类需实现具体的采样逻辑;
2424
- 返回值通常为 0 ~ 3.3V 或芯片支持的其他范围;
25-
- 接口简单明了,适合平台移植与模拟信号读取抽象。
26-
27-
## 特性总结
28-
29-
- 提供统一的模拟电压读取接口;
30-
- 避免平台差异,便于上层逻辑复用;
31-
- 适用于温度、电压、光照等传感器输入;
32-
- 所有平台需实现 `Read()` 方法完成采样。

docs/basic_coding/driver/dac.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
id: dac
3+
title: 数模转换
4+
sidebar_position: 7
5+
---
6+
7+
# DAC(数模转换)
8+
9+
`LibXR::DAC` 提供平台无关的数字转模拟(DAC)接口,用于输出指定的模拟电压。
10+
11+
## 接口定义
12+
13+
```cpp
14+
class DAC {
15+
public:
16+
DAC() = default;
17+
18+
// 输出 DAC 电压,单位为伏特(float 类型)
19+
// Outputs the DAC voltage in volts (float type)
20+
virtual ErrorCode Write(float voltage) = 0;
21+
};
22+
```
23+
24+
- `Write(voltage)` 是纯虚函数,子类需实现具体的输出逻辑;
25+
- 参数 `voltage` 为需要输出的模拟电压值(单位:V);
26+
- 返回 `ErrorCode`,用于表示输出过程中的错误或成功状态;
27+
28+
## 典型用法
29+
30+
```cpp
31+
// 示例:输出 1.23V 到 DAC
32+
dac->Write(1.23f);
33+
```

docs/basic_coding/driver/flash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: flash
33
title: 闪存接口
4-
sidebar_position: 8
4+
sidebar_position: 9
55
---
66

77
# Flash(闪存接口)

docs/basic_coding/driver/power.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: power
33
title: 电源管理
4-
sidebar_position: 9
4+
sidebar_position: 10
55
---
66

77
# Power(电源管理)

docs/basic_coding/driver/pwm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: pwm
33
title: PWM
4-
sidebar_position: 7
4+
sidebar_position: 8
55
---
66

77
# PWM(脉宽调制)

docs/basic_coding/driver/timebase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: timebase
33
title: 时间基准
4-
sidebar_position: 10
4+
sidebar_position: 11
55
---
66

77
# Timebase(时间基准)

docs/basic_coding/driver/watchdog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: watchdog
33
title: 看门狗
4-
sidebar_position: 11
4+
sidebar_position: 12
55
---
66

77
# Watchdog(看门狗)

docs/code_gen/stm32/cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: stm32-code-gen-cache
33
title: 高速缓存
4-
sidebar_position: 12
4+
sidebar_position: 13
55
---
66

77
# 高速缓存 (Cache)

docs/code_gen/stm32/can.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: stm32-code-gen-can
33
title: CAN与CAN FD
4-
sidebar_position: 9
4+
sidebar_position: 10
55
---
66

77
# CAN 与 CAN FD

docs/code_gen/stm32/dac.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
id: stm32-code-gen-dac
3+
title: DAC
4+
sidebar_position: 6
5+
---
6+
7+
# DAC
8+
9+
无需开启DMA,只做普通DAC输出。
10+
11+
## 示例
12+
13+
代码生成工具会读取每个DAC外设开启的通道,生成如下代码:
14+
15+
```cpp
16+
STM32DAC dac1_out1(&hdac1, DAC_CHANNEL_1, 0.0, 3.3);
17+
```
18+
19+
## 配置文件
20+
21+
在上一步代码生成后,会在`User/libxr_config.yaml`文件中出现ADC配置文件,格式如下:
22+
23+
```yaml
24+
DAC:
25+
dac1:
26+
init_voltage: 0.0
27+
vref: 3.3
28+
```
29+
30+
其中`init_voltage`为初始输出电压,`vref`为参考电压。
31+
32+
可直接修改该文件。如需应用更新配置,请执行以下任一命令以重新生成代码:
33+
`xr_cubemx_cfg -d .`
34+
35+
`xr_gen_code_stm32 -i ./.config.yaml -o ./User/app_main.cpp`

0 commit comments

Comments
 (0)