pigway-device-agent/README.md

# PIGWay Pi Control v3.7.0

独立的 Raspberry Pi / Linux 系统监控与多机 Web 管理。无需购买散热板，无 I2C、Pillow、smbus2 或 OLED 字体依赖。

## 功能

- CPU、温度、内存和磁盘容量/用量；主网络接口、IPv4/IPv6、Wi-Fi 信号百分比。
- systemd 服务及进程监控；暂停监控与启停服务是不同操作。
- Raspberry Pi 当前欠压、降频、频率受限、温度限制和根分区只读监控。
- 当前故障统一管理；历史电源位仅记录日志，不生成当前告警。
- 事件日志按日期、严重程度、事件类型和机器查询、排序。
- 多机状态、机器标识、配置与独立的批量配置同步。
- 中英文、跟随系统/深色/浅色主题。
- 独立硬件插件发现、手动接入、暂停联动、断开、能力配置。

## 安装

```bash
sudo ./install.sh
# 仅安装文件，不改变服务运行状态：
sudo ./install.sh --no-start
```

仅需要 Python 3。安装器不检查 I2C，不安装或启动任何散热板驱动。
配置 `/etc/pigway-pi-control.conf`；Web 默认端口 6001，可配置。

API 写入令牌在首次安装时生成，保存为 root 可读文件；安装器显示查询方法，不直接打印秘密：

```bash
sudo cat /etc/pigway-pi-control-api.token
```

服务分别是 `pigway-pi-control.service` 和 `pigway-pi-control-api.service`。
Web 重启不会自动启动已停止的监控。监控与硬件插件的运行状态彼此独立。

## 接入可选硬件

[Yahboom 散热板插件](https://tea.pigway.com/way/pigway-cooling-hat) 是独立项目、独立安装包及 systemd 服务。
先在目标机器安装并运行插件，再进入 Web → 系统配置 → 硬件插件 → 发现并接入。
发现不等于接管；只有接入后才发送当前监控状态。无需开放新的网络端口。

运行状态卡片仅为已接入插件显示摘要。插件配置根据能力生成：只有风扇就只有风扇设置，有 OLED/RGB 才有相应控件。保存插件配置不重启监控。暂停告警联动或断开接入不停止插件本地温控。

默认 Unix socket：`/run/pigway-plugins/<id>/api.sock`。协议见 [API v1](docs/HARDWARE_PLUGIN_API.md)。当前只实现 Yahboom 驱动；GPIO/PWM、其他 I2C 板和系统风扇驱动需要各自适配，不假装兼容。

## 从旧的集成版本迁移

监控安装器保留原配置及注释；`[hardware]`、`[fan]`、`[led]`、`[display]` 和 OLED timing 参数不再由监控执行或显示。
在散热板仓库中可显式迁移这些参数：

```bash
sudo ./install.sh --import-monitor-config /etc/pigway-pi-control.conf
```

不能让旧集成 Agent 和新插件同时控制硬件。迁移前停止旧 Agent，再安装独立监控和插件；新监控本身不会打开 I2C。字体原样迁入散热板仓库，不重新生成。原主板 PWR/ACT 配置继续作为监控本机设置兼容保留。

## 运维

```bash
sudo systemctl status pigway-pi-control.service pigway-pi-control-api.service
sudo journalctl -u pigway-pi-control.service -f
sudo /usr/local/sbin/pigway-pi-control --diagnose
```

`--diagnose` 使用同一套监控配置和检查函数，仅通过只读 API 发现插件，不访问硬件总线。
卸载监控不会停止或删除散热板插件；卸载插件也不会影响监控。建议先在 Web 断开关联，避免保留离线插件条目。

静态检查：Python 编译、`bash -n install.sh`、`git diff --check`、`sha256sum -c SHA256SUMS`。测试工具不随安装包发布。