From e55ad3217ff462c3b66b78f806f63f0d2f40d2d0 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, 11 Oct 2026 16:29:26 +0800 Subject: [PATCH] docs: clarify Raspberry Pi project names and integration scope --- README.md | 8 ++++++-- README.zh-CN.md | 8 ++++++-- SHA256SUMS | 12 ++++++------ docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md | 6 +++--- docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md | 6 +++--- systemd/pigway-pi-control-api.service | 2 +- systemd/pigway-pi-control.service | 2 +- 7 files changed, 26 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 4eda795..06d63f0 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -# PIGWay Device Agent v3.7.1 +# PIGWay Raspberry Pi Agent v3.7.1 [简体中文](README.zh-CN.md) | English -PIGWay Device Agent is a lightweight local monitoring service for Raspberry Pi and Linux. It monitors CPU, memory, temperature, disk, networking, services, processes, system health alerts, and journal events. Ethernet monitoring reads the negotiated link speed and can alert when it remains below the configured minimum. It has no embedded Web UI and does not require a hardware plugin or Device Console. +PIGWay Raspberry Pi Agent is a lightweight local monitoring service for Raspberry Pi. It monitors CPU, memory, temperature, disk, networking, services, processes, system health alerts, and journal events. Ethernet monitoring reads the negotiated link speed and can alert when it remains below the configured minimum. It has no embedded Web UI and does not require a hardware plugin or Device Console. ### Installation @@ -51,3 +51,7 @@ sudo journalctl -u pigway-pi-control.service -f ``` Logs follow the system journal retention policy; no additional database is created. Uninstalling one project never uninstalls either of the others. See [Plugin API v1](docs/HARDWARE_PLUGIN_API.md). + +## Naming and compatibility + +This project targets Raspberry Pi. Other Linux platforms are not covered by its support claim and may have separately maintained adapters. Repository naming does not change the existing `pigway-agent` adapter ID or `pigway-pi-control` service, configuration and API identifiers. diff --git a/README.zh-CN.md b/README.zh-CN.md index ecdb101..efea024 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,9 +1,9 @@ -# PIGWay Device Agent v3.7.1 +# PIGWay Raspberry Pi Agent v3.7.1 简体中文 | [English](README.md) -极轻的 Raspberry Pi / Linux 本地监控服务：CPU、内存、温度、磁盘、网络、服务/进程、系统健康告警与 journal 日志。有线网络会读取真实协商速率，并可在持续低于配置阈值时告警。无 Web 界面；无需硬件插件，也无需管理中心。 +极轻的树莓派本地监控服务：CPU、内存、温度、磁盘、网络、服务/进程、系统健康告警与 journal 日志。有线网络会读取真实协商速率，并可在持续低于配置阈值时告警。无 Web 界面；无需硬件插件，也无需管理中心。 ## 安装 @@ -53,3 +53,7 @@ sudo journalctl -u pigway-pi-control.service -f ``` 日志依照系统 journal 的保留策略，不额外建库。卸载任何一个项目不会卸载另外两个项目。插件协议见 [API v1](docs/HARDWARE_PLUGIN_API.md)。 + +## 名称与兼容性 + +本项目支持范围明确为树莓派；其他 Linux 平台以后独立维护项目。仓库改名不改变现有 `pigway-pi-control` 服务名、配置路径和 API。远程 API 仍可选择启用，默认关闭。 diff --git a/SHA256SUMS b/SHA256SUMS index 7ad229b..6433d75 100644 --- a/SHA256SUMS +++ b/SHA256SUMS @@ -1,14 +1,14 @@ ecf1884bb89b86ed4573d4d922a971abde43772bf7b2ffa6a999a12fbfb72caf .gitignore -04c279ff4068517fb6772f5c2fe39d9aca12b7ec9154fc2e74e89e9d2a85a457 README.md -673d815a06e8f7b15df3f6d3b76dad3d38a3a3eb29c81480ec106debf0e85ea0 README.zh-CN.md +d0e219b4b02b073f83e17ba3bb6e8c96dd4152ecdf11d946d53319613097e294 README.md +64a9708701f8c8d872a587e8a2845afff463797b06a2791319daadd705933d31 README.zh-CN.md 852889cbbf57d5e857794432426e3343b5d08b1395b3098a6e19fd648b4f4267 app/pigway_pi_control.py 757eb6a83ca07740a2389af9b51c6fd5d940b4eb86abbc603f231409416d45db app/pigway_pi_control_api.py 3a8a368bbf299eb2d6cccc968a4aacf070058bddebdc5176083a97ac579d720d app/plugin_api.py d5a783b64a10fa43191a813ef73ef8f762e359b0bd42ec155724fa46216298b0 config/pigway-pi-control.conf e3bf3e7070ea62c0526791bed922688c3fb49fee36ca9c375d080119968feb72 docs/HARDWARE_PLUGIN_API.md -2030b90b8c01d02c414a1fb44c96c84527b6cafcc8a6ead5634c5e9dcd5dad4b docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md -75984d9dea668c04d35f79d7c454d93b835825ef2eff607b760294237016aa8f docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md +b54ec1f3e9fb15473910686c54142a85d387e44ea5df427a4cf1b06052e789b3 docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md +9222a2b6a38f6b6d7d88b30c05413c68c05f69ee499c8479eca05ee7c62e87c3 docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md d2706de954d0c3f1b4311c1bac52ef09b912919b96126fa6000a88786e969438 install.sh -5e16c1d5d592fa3e129cde0077da6b089784c82f452205a349d4824f48eb3a66 systemd/pigway-pi-control-api.service -272545c6f821a850caa545361f4f93e3218436c7fbc1b3dd01b83ac442e7793e systemd/pigway-pi-control.service +8a593c290da5bd0d037aee86c35264512afd574a2a0f60f2c29e9db63e0109bd systemd/pigway-pi-control-api.service +1cb55de6b104a233066495e9786319305fa4f1b6f25483c108ab4f5ac9aa5700 systemd/pigway-pi-control.service 9f59e7313ee58e687ae6dd29d175c67082674254ac5c5f54168b2735b64c20a4 uninstall.sh diff --git a/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md b/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md index f522db2..66a71d0 100644 --- a/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md +++ b/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.md @@ -4,7 +4,7 @@ English | [简体中文](RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md) ## Compatibility -PIGWay Device Agent v3.7.1 supports Raspberry Pi OS Lite 64-bit based on Debian 13 Trixie and Python 3.13. The Agent reads Linux `/proc`, `/sys`, systemd, network state, and journal data. It has no GPIO, I2C, Pillow, or third-party Python dependency and does not need a virtual environment. +PIGWay Raspberry Pi Agent v3.7.1 supports Raspberry Pi OS Lite 64-bit based on Debian 13 Trixie and Python 3.13. The Agent reads Linux `/proc`, `/sys`, systemd, network state, and journal data. It has no GPIO, I2C, Pillow, or third-party Python dependency and does not need a virtual environment. The Yahboom RGB Cooling HAT is an independent plugin. It uses Debian packages `python3-smbus2` and `python3-pil`, avoiding pip changes to the PEP 668 managed system Python. Its verified interface remains unchanged: @@ -37,8 +37,8 @@ sudo reboot Install the Agent first. Its API is opt-in: ```bash -git clone https://tea.pigway.com/way/pigway-device-agent.git -cd pigway-device-agent +git clone https://tea.pigway.com/way/pigway-raspberry-pi-agent.git +cd pigway-raspberry-pi-agent sudo ./install.sh --disable-api ``` diff --git a/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md b/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md index 49e91b7..a48e888 100644 --- a/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md +++ b/docs/RASPBERRY_PI_OS_TRIXIE_FRESH_INSTALL.zh-CN.md @@ -4,7 +4,7 @@ ## 兼容性结论 -PIGWay Device Agent v3.7.1 兼容 Raspberry Pi OS Lite 64-bit、Debian 13 Trixie 与 Python 3.13。Agent 只读取 Linux 的 `/proc`、`/sys`、systemd、网络状态和 journal，不依赖 GPIO、I²C、Pillow 或第三方 Python 包，也不需要 venv。 +PIGWay Raspberry Pi Agent v3.7.1 兼容 Raspberry Pi OS Lite 64-bit、Debian 13 Trixie 与 Python 3.13。Agent 只读取 Linux 的 `/proc`、`/sys`、systemd、网络状态和 journal，不依赖 GPIO、I²C、Pillow 或第三方 Python 包，也不需要 venv。 Yahboom RGB Cooling HAT 已拆分为独立插件。插件使用 Debian 系统包 `python3-smbus2` 与 `python3-pil`，不会通过 pip 修改受 PEP 668 管理的系统 Python。硬件接口保持原实现： @@ -39,8 +39,8 @@ sudo reboot 先安装通用监控 Agent： ```bash -git clone https://tea.pigway.com/way/pigway-device-agent.git -cd pigway-device-agent +git clone https://tea.pigway.com/way/pigway-raspberry-pi-agent.git +cd pigway-raspberry-pi-agent sudo ./install.sh --disable-api ``` diff --git a/systemd/pigway-pi-control-api.service b/systemd/pigway-pi-control-api.service index ef06fd5..b9bff80 100644 --- a/systemd/pigway-pi-control-api.service +++ b/systemd/pigway-pi-control-api.service @@ -1,5 +1,5 @@ [Unit] -Description=PIGWay Device Agent optional local API +Description=PIGWay Raspberry Pi Agent optional local API After=network.target pigway-pi-control.service Wants=network.target diff --git a/systemd/pigway-pi-control.service b/systemd/pigway-pi-control.service index 13e89f2..8d6a2b7 100644 --- a/systemd/pigway-pi-control.service +++ b/systemd/pigway-pi-control.service @@ -1,5 +1,5 @@ [Unit] -Description=PIGWay system monitor +Description=PIGWay Raspberry Pi Agent system monitor After=local-fs.target systemd-modules-load.service network-online.target ssh.service Wants=network-online.target