Add FanControl.ChromeboxEC plugin, project background, ectool docs
- Add FanControl.ChromeboxEC plugin for Fan Control - Add project background/缘由 in README (EN/zh) - Add docs/ectool-commands-zh.md - Update sln, appsettings, gitignore Made-with: Cursor
This commit is contained in:
157
FanControl.ChromeboxEC/README.md
Normal file
157
FanControl.ChromeboxEC/README.md
Normal file
@@ -0,0 +1,157 @@
|
||||
# FanControl.ChromeboxEC
|
||||
|
||||
Plugin for [Fan Control](https://github.com/Rem0o/FanControl.Releases) that controls Chromebox fan via ectool. Reads EC temperature, sets fan duty. For Chromebox with coreboot.
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Fan Control](https://github.com/Rem0o/FanControl.Releases) (Rémi Mercier)
|
||||
- [Coolstar CROS-EC driver](https://github.com/coolstar/crwindows) / crosec with `ectool.exe`
|
||||
- Run Fan Control **as Administrator**
|
||||
|
||||
No separate .NET installation needed — the plugin runs inside Fan Control’s process.
|
||||
|
||||
## Build
|
||||
|
||||
1. Copy `FanControl.Plugins.dll` from your Fan Control installation to `lib/`:
|
||||
- Typical path: `C:\Program Files (x86)\FanControl\FanControl.Plugins.dll`
|
||||
2. Build from `FanControl.ChromeboxEC` directory:
|
||||
```powershell
|
||||
cd FanControl.ChromeboxEC
|
||||
dotnet build -c Release
|
||||
```
|
||||
|
||||
## Install
|
||||
|
||||
1. Copy `FanControl.ChromeboxEC.dll` to Fan Control’s `Plugins` folder (same folder as `FanControl.exe`)
|
||||
2. Optional: Copy `FanControl.ChromeboxEC.json.example` to `FanControl.ChromeboxEC.json` and edit
|
||||
3. Start Fan Control as Administrator
|
||||
|
||||
## Configuration
|
||||
|
||||
Create `FanControl.ChromeboxEC.json` in the Plugins folder to override defaults. See [ectool commands reference](../docs/ectool-commands-zh.md).
|
||||
|
||||
| Field | Default | Description |
|
||||
|-------|---------|-------------|
|
||||
| `EctoolPath` | `C:\Program Files\crosec\ectool.exe` | Path to ectool |
|
||||
| `TempArgs` | `["temps", "0"]` | Read temp: `ectool temps <sensorid>`. Use `ectool tempsinfo` for your board |
|
||||
| `FanRpmArgs` | `["pwmgetfanrpm", "0"]` | Read RPM: `ectool pwmgetfanrpm [index\|all]` |
|
||||
| `AutoFanCtrlArgs` | `["autofanctrl"]` | Restore auto fan when control disabled |
|
||||
|
||||
## Plugin sensors
|
||||
|
||||
| Sensor | ectool command | Description |
|
||||
|--------|----------------|-------------|
|
||||
| Chromebox EC Temperature | `temps <sensorid>` | EC temp for fan curves |
|
||||
| Chromebox EC Fan RPM | `pwmgetfanrpm` | Fan speed |
|
||||
| Chromebox EC Fan | `fanduty` / `autofanctrl` | Fan control, restores auto on disable |
|
||||
|
||||
## Recommended config
|
||||
|
||||
**CPU core temp + board temp (EC Temp) dual curves, take max to set fan.**
|
||||
|
||||
1. Create curve **CPU Package**: temp source = CPU Package, output 0–100% duty
|
||||
2. Create curve **Board Temp**: temp source = Chromebox EC Temperature, output 0–100% duty
|
||||
3. Create **Mix** curve: function = Max, inputs = both curves above
|
||||
4. Set **Chromebox EC Fan** control to use **Mix** curve
|
||||
|
||||
The fan will respond to whichever sensor is hotter.
|
||||
|
||||
## Troubleshooting: fan sensor not found
|
||||
|
||||
If "Chromebox EC Fan" control cannot pair with a speed sensor:
|
||||
|
||||
1. **Run Fan Control as Administrator** (ectool requires it)
|
||||
2. **Test ectool manually**: open CMD as admin, run
|
||||
```cmd
|
||||
"C:\Program Files\crosec\ectool.exe" pwmgetfanrpm 0
|
||||
```
|
||||
If it fails, try `pwmgetfanrpm` (no args) or `pwmgetfanrpm all`
|
||||
3. **Create config file**: in Fan Control’s `Plugins` folder, create `FanControl.ChromeboxEC.json` and adjust `FanRpmArgs`, e.g.:
|
||||
```json
|
||||
{
|
||||
"FanRpmArgs": ["pwmgetfanrpm"],
|
||||
"EctoolPath": "C:\\Program Files\\crosec\\ectool.exe"
|
||||
}
|
||||
```
|
||||
or `["pwmgetfanrpm", "all"]`
|
||||
4. **Check ectool path**: if crosec is elsewhere, set correct `EctoolPath` in config
|
||||
|
||||
---
|
||||
|
||||
# 中文 / Chinese
|
||||
|
||||
[Fan Control](https://github.com/Rem0o/FanControl.Releases) 插件，通过 ectool 读取 Chromebox EC 温度并控制风扇。适用于刷了 coreboot 的 Chromebox。
|
||||
|
||||
## 依赖
|
||||
|
||||
- [Fan Control](https://github.com/Rem0o/FanControl.Releases)（Rémi Mercier）
|
||||
- [Coolstar CROS-EC 驱动](https://github.com/coolstar/crwindows) / crosec，内含 `ectool.exe`
|
||||
- **以管理员身份运行** Fan Control
|
||||
|
||||
无需单独安装 .NET，插件在 Fan Control 进程内运行。
|
||||
|
||||
## 编译
|
||||
|
||||
1. 将 Fan Control 安装目录下的 `FanControl.Plugins.dll` 复制到 `lib/`：
|
||||
- 常见路径：`C:\Program Files (x86)\FanControl\FanControl.Plugins.dll`
|
||||
2. 在 `FanControl.ChromeboxEC` 目录下编译：
|
||||
```powershell
|
||||
cd FanControl.ChromeboxEC
|
||||
dotnet build -c Release
|
||||
```
|
||||
|
||||
## 安装
|
||||
|
||||
1. 将 `FanControl.ChromeboxEC.dll` 复制到 Fan Control 的 `Plugins` 文件夹（与 `FanControl.exe` 同目录）
|
||||
2. 可选：将 `FanControl.ChromeboxEC.json.example` 复制为 `FanControl.ChromeboxEC.json` 并修改配置
|
||||
3. 以管理员身份启动 Fan Control
|
||||
|
||||
## 配置
|
||||
|
||||
在 Plugins 文件夹中创建 `FanControl.ChromeboxEC.json` 可覆盖默认值。ectool 命令说明见 [ectool 命令参考](../docs/ectool-commands-zh.md)。
|
||||
|
||||
| 字段 | 默认 | 说明 |
|
||||
|------|------|------|
|
||||
| `EctoolPath` | `C:\Program Files\crosec\ectool.exe` | ectool 路径 |
|
||||
| `TempArgs` | `["temps", "0"]` | 读取温度：`ectool temps <sensorid>`。用 `ectool tempsinfo` 查看本机传感器 ID |
|
||||
| `FanRpmArgs` | `["pwmgetfanrpm", "0"]` | 读取转速：`ectool pwmgetfanrpm [index\|all]` |
|
||||
| `AutoFanCtrlArgs` | `["autofanctrl"]` | 禁用控制时恢复自动风扇 |
|
||||
|
||||
## 插件功能
|
||||
|
||||
| 传感器 | ectool 命令 | 说明 |
|
||||
|--------|-------------|------|
|
||||
| Chromebox EC Temperature | `temps <sensorid>` | EC 温度，可用于风扇曲线 |
|
||||
| Chromebox EC Fan RPM | `pwmgetfanrpm` | 风扇转速 |
|
||||
| Chromebox EC Fan | `fanduty` / `autofanctrl` | 风扇控制，禁用时恢复 EC 自动控速 |
|
||||
|
||||
## 推荐配置
|
||||
|
||||
**CPU 核心温度 + 板载温度（EC Temp）双曲线，取最大值设置风扇。**
|
||||
|
||||
1. 新建曲线 **CPU Package**：温度源选「CPU Package」，按温度输出 0–100% 占空比
|
||||
2. 新建曲线 **Board Temp**：温度源选「Chromebox EC Temperature」，按温度输出 0–100% 占空比
|
||||
3. 新建 **Mix** 曲线：函数选「最大」，输入上述两条曲线
|
||||
4. 将 **Chromebox EC Fan** 控制的曲线设为 **Mix**
|
||||
|
||||
这样风扇会以 CPU 和板载温度中较高者为依据控速。
|
||||
|
||||
## 故障排除：找不到风扇传感器
|
||||
|
||||
若「Chromebox EC Fan」控制无法配对到转速传感器（配对时找不到风扇）：
|
||||
|
||||
1. **确认以管理员身份运行 Fan Control**（ectool 需要）
|
||||
2. **手动测试 ectool**：以管理员打开 CMD，执行
|
||||
```cmd
|
||||
"C:\Program Files\crosec\ectool.exe" pwmgetfanrpm 0
|
||||
```
|
||||
若报错或输出异常，尝试 `pwmgetfanrpm`（无参数）或 `pwmgetfanrpm all`
|
||||
3. **创建配置文件**：在 Fan Control 的 `Plugins` 目录新建 `FanControl.ChromeboxEC.json`，按本机 ectool 输出调整 `FanRpmArgs`，例如：
|
||||
```json
|
||||
{
|
||||
"FanRpmArgs": ["pwmgetfanrpm"],
|
||||
"EctoolPath": "C:\\Program Files\\crosec\\ectool.exe"
|
||||
}
|
||||
```
|
||||
或 `["pwmgetfanrpm", "all"]`
|
||||
4. **确认 ectool 路径**：若 crosec 安装在其他位置，在配置中设置正确的 `EctoolPath`
|
||||
Reference in New Issue
Block a user