fan2go 开源项目教程

1. 项目的目录结构及介绍

fan2go 项目的目录结构如下：

fan2go/
├── cmd/
│   └── fan2go/
│       └── main.go
├── config/
│   ├── config.go
│   └── example_config.yaml
├── docs/
│   └── README.md
├── internal/
│   ├── curve/
│   ├── detect/
│   ├── fan/
│   ├── sensor/
│   └── ...
├── pkg/
│   └── ...
├── scripts/
│   └── ...
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录结构介绍：

• cmd/: 包含应用程序的入口点，即 main.go 文件。
• config/: 包含配置相关的文件，如 config.go 和示例配置文件 example_config.yaml。
• docs/: 包含项目的文档文件，如 README.md。
• internal/: 包含项目的内部包，如 curve、detect、fan 和 sensor 等。
• pkg/: 包含项目的公共包。
• scripts/: 包含项目的脚本文件。
• .gitignore: Git 忽略文件。
• go.mod 和 go.sum: Go 模块文件。
• README.md: 项目的主文档文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/fan2go/main.go。这个文件是 fan2go 应用程序的入口点，负责初始化配置、启动服务和处理命令行参数。

主要功能：

• 解析命令行参数。
• 加载配置文件。
• 初始化传感器和风扇。
• 启动守护进程，根据温度传感器控制风扇。

3. 项目的配置文件介绍

项目的配置文件示例位于 config/example_config.yaml。这个文件定义了 fan2go 的配置选项，包括传感器、风扇和曲线等。

配置文件结构：

api:
  enabled: true

sensors:
  - id: cpu_package
    type: temp
    path: /sys/class/hwmon/hwmon0/temp1_input

fans:
  - id: cpu_fan
    path: /sys/class/hwmon/hwmon0/pwm1
    sensors:
      - cpu_package

curves:
  - id: cpu_fan_curve
    fan: cpu_fan
    points:
      - temp: 40
        pwm: 50
      - temp: 60
        pwm: 100
      - temp: 80
        pwm: 200

配置文件介绍：

• api: 配置 API 是否启用。
• sensors: 定义传感器，包括 ID、类型和路径。
• fans: 定义风扇，包括 ID、路径和关联的传感器。
• curves: 定义风扇曲线，包括 ID、关联的风扇和温度-PWM 点。

通过以上配置，fan2go 可以根据温度传感器的数据自动调整风扇的转速，实现温度和噪音的平衡。