From 18fd1febe2dcc77d2f5bfb4954a243225009e680 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B8=A1=E5=8F=A3=E6=B5=AA=E4=BA=BA?= Date: Sun, 27 Sep 2026 21:05:44 +0800 Subject: [PATCH] docs: simplify standalone plugin setup --- README.md | 8 ++++---- SHA256SUMS | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bea1bab..5b12db8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # PIGWay Cooling HAT -独立运行的本机硬件插件。当前驱动：Yahboom RGB Cooling HAT（MCU 0x0D、OLED 0x3C、128×32）。不需要安装 PIGWay Pi Control；也不会自动启动它。 +独立运行的本机硬件插件。当前驱动：Yahboom RGB Cooling HAT（MCU 0x0D、OLED 0x3C、128×32）。提供本机状态采集、OLED 展示、风扇温控和 RGB 灯效。无需安装监控主程序即可使用。 ## 安装与独立运行 @@ -8,8 +8,6 @@ sudo ./install.sh # 只安装，不启动/启用新服务： sudo ./install.sh --no-start -# 显式迁移旧集成版的硬件设置： -sudo ./install.sh --import-monitor-config /etc/pigway-pi-control.conf ``` 启用 I2C 后安装；需要 python3-smbus2、python3-pil。安装器检查文件及总线占用，不停止其他进程。配置：`/etc/pigway-cooling-hat.conf`。 @@ -26,6 +24,8 @@ curl --unix-socket /run/pigway-plugins/yahboom-cooling-hat/api.sock http://local ## 接入监控 +可选接入 [PIGWay Pi Control 监控平台](https://tea.pigway.com/way/pigway-pi-control)，接收服务、进程和系统健康告警。双方独立安装、独立运行；不接入也可正常使用本地功能。 + 监控 Web → 系统配置 → 硬件插件中发现并手动接入。协议是本机 Unix socket 上的 HTTP API，默认不开放 TCP 端口。目录 0750、socket 0660，只有 root 和被明确加入 `pigway-hardware` 组的账户能访问。不要随意授予组成员资格。 监控发送完整、带版本和有效期的状态；不发送动画帧或 MCU 指令。插件自己仲裁 OLED 页和 RGB 效果。告警页有页码并轮播主页，相同 RGB 效果不因切页重启。只有一个有效监控来源可以持有显示状态，重复/乱序版本会拒绝。状态超过 10 秒未更新（由客户端声明，允许3–30秒），旧告警失效，OLED 回到本机主页、RGB 回到正常灯效，风扇继续本地温控。主动断开行为相同。监控快照中的 system/network 字段保留 API v1 兼容，但不会覆盖插件的本地数据。采样失败显示 --，不伪装为零。 @@ -38,7 +38,7 @@ curl --unix-socket /run/pigway-plugins/yahboom-cooling-hat/api.sock http://local 自定义颜色常亮和闪烁仍保留。闪烁是实验性兼容路径：全选→R→全选→G→全选→B，每条间隔5ms；亮灭均完整写三个通道，灭灯写 RGB=0；实际每段至少 `custom_min_hold_ms`（最低1500ms），从指令完成后计时，不追赶延迟边沿。既往实机曾出现异色/漏执行，未证明存在完全稳定的自定义协议，不宣称这些限制能修好 MCU。 -OLED 与 RGB 各自一个线程，风扇有独立温控线程；访问同一总线时串行，完整 RGB 写入不能被风扇插入。风扇仅写0x08，不补写RGB。OLED字体逐字节从原项目迁入，未重新生成或替换。 +OLED 与 RGB 各自一个线程，风扇有独立温控线程；访问同一总线时串行，完整 RGB 写入不能被风扇插入。风扇仅写0x08，不补写RGB。OLED 字体随插件提供。 ## 卸载 diff --git a/SHA256SUMS b/SHA256SUMS index 23ebe01..5bcaa7e 100644 --- a/SHA256SUMS +++ b/SHA256SUMS @@ -1,4 +1,4 @@ -5666fc2dc544eaa2fb9e11452740d05d621a7982a6f7d258b563e38fdf04a19a README.md +74aaf7f7d07d49c7103dfb1dd3ca624c0d4efe5838c76073402541f81d37b42b README.md 30646b607d69dcbddbd5b41119a22f63ffb8de22929d1d0f9ff3715326a5bca6 install.sh cd6bb5137dd5922e48866f6daf4b949a16f8fad321e77addd5b4f75181bc4248 uninstall.sh 1c7836f80b0845fbc5c4b8570b12d736e2a3c442b1ceb5d35d48cdd518e4ad50 app/drivers/yahboom.py