docs: align repository names and bilingual entry points; remove obsolete reports
This commit is contained in:
@@ -1,48 +1,30 @@
|
||||
# PIGWay Raspberry Pi Console Plugin
|
||||
# PIGWay Raspberry Pi Console Adapter
|
||||
|
||||
磁盘呈现统一版本已上线，需要 Console v2.7.0：默认按设备返回顺序，同组支持上移/下移、显示名称及隐藏，所有显示偏好保存到 Console，首页与配置页共用。Agent 的名称和隐藏定义继续作为设备默认值保留。扫描仍只由配置页按钮触发。生产验证见相邻 Console 的 docs/STORAGE-PRESENTATION-v2.7.0-2026-10-15.md。
|
||||
[简体中文](README.zh-CN.md) | English
|
||||
|
||||
当前 v1.6.10 支持统一磁盘显示设置与手动扫描，需要 Console v2.7.0、Agent v3.11.1；新磁盘仅手动发现，已知磁盘容量继续刷新。见 [生产验证](STORAGE-DISCOVERY.md)。
|
||||
An independently maintained Device Console adapter for the PIGWay Raspberry Pi Agent. It installs no extra process on the Pi and retains adapter ID `pigway-agent` for existing devices.
|
||||
|
||||
独立维护的树莓派接入插件：连接现有 PIGWay Raspberry Pi Agent，不在树莓派安装新进程。设备 API、状态转换、配置字段、服务/进程监控、硬件界面及其翻译均由本仓库维护。
|
||||
## Requirements and installation
|
||||
|
||||
依赖 Python 标准库；接入 Console JSON-RPC v1 与可信前端扩展 `console-ui-v1`。插件 ID 保持 `pigway-agent`，已有设备可直接继续使用。
|
||||
The storage display and manual discovery integration requires Console v2.7.0 and Agent v3.11.1 or later. The shared UI semantics require Console v2.7.30. Runtime uses the Python standard library, JSON-RPC v1 and `console-ui-v1`.
|
||||
|
||||
打包：
|
||||
Build the ZIP below, upload it under Machine management and enable it. Register the Agent API URL and device token. Use HTTPS or a trusted tunnel across untrusted networks. For local development, set `PIGWAY_ADAPTER_PATH` to this repository's absolute `plugin` directory. Production Docker installations keep installed plugins in the persistent Console data volume.
|
||||
|
||||
## Features and boundaries
|
||||
|
||||
- Host status, hardware integration, services/processes, network metrics and Console-managed history.
|
||||
- Disk discovery runs only from Storage settings → Scan disks. Known disk capacity continues to refresh; display order, names and visibility use the shared Console settings.
|
||||
- The adapter retains existing API and service identifiers, including `pigway-pi-control`; a repository rename does not change those interfaces. Other Linux platforms are outside its support claim.
|
||||
|
||||
Install only trusted plugins: frontend code shares the page JavaScript environment, and the backend process is not a security sandbox. The ZIP contains the manifest, worker and UI, not Console internals or Git metadata.
|
||||
|
||||
See [storage behavior](STORAGE-DISCOVERY.md), [release notes](RELEASE_NOTES.md), and the [Console UI semantics](https://tea.pigway.com/way/pigway-device-console/src/branch/main/docs/UI_SEMANTICS.md). Dated deployment records describe historical validation, not a fresh online check.
|
||||
|
||||
## Build
|
||||
|
||||
Current adapter version: **1.6.10**.
|
||||
|
||||
```sh
|
||||
mkdir -p dist
|
||||
python3 package.py plugin dist/pigway-agent-1.1.0.zip
|
||||
python3 package.py plugin dist/pigway-agent-1.6.10.zip
|
||||
```
|
||||
|
||||
在控制中心的机器管理页面安装 ZIP，再启用。开发时可用 `PIGWAY_ADAPTER_PATH=/absolute/path/pigway-console-adapter-raspberry-pi/plugin` 加载源码；Docker 推荐使用持久化数据卷中的安装包。
|
||||
|
||||
包根目录只有 manifest、worker 与 ui；打包工具、文档和 Git 元数据不进入插件包。前端扩展通过 Console 的共享状态、请求、翻译与基础显示函数接入，不注入额外安装步骤。只应安装可信插件：前端模块与主页面共享 JavaScript 执行环境，加载失败、同步异常及 Promise 拒绝可降级，但不能隔离死循环或恶意代码；后端独立进程的隔离也不是安全沙箱。
|
||||
|
||||
正式仓库：https://tea.pigway.com/way/pigway-console-adapter-raspberry-pi 。首次独立版本为 v1.0.0，需要 Console v2.0.0。与 Console 的集成回归使用后者 tests 下的模拟 Agent，不操作真实设备。
|
||||
|
||||
## 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.
|
||||
|
||||
## v1.1.0 历史指标
|
||||
|
||||
将现有 Agent API 的内存/磁盘字节数、开机时长与链路速度补充到标准 metrics，Console v2.1.0 可直接统一记录历史。不需要更新或新增树莓派进程。现有设备端没有上传下载流量计数，因此本版没有实际流量曲线；链路速度仅代表协商速率。
|
||||
|
||||
v1.1.0 已与 Console v2.1.0 部署，真实树莓派在线并开始记录历史；设备端 Agent 保持原版本。[部署验收记录](https://tea.pigway.com/way/pigway-device-console/src/branch/main/docs/DEPLOYMENT-v2.1.0-2026-10-11.md)。
|
||||
|
||||
生产已升级至 v1.2.0，网络卡片与上下行历史指标见 [部署记录](DEPLOYMENT-v1.2.0-2026-10-14.md)。
|
||||
|
||||
当前网络卡片以实时上下行速率为主文字，详见 [v1.2.1 部署记录](DEPLOYMENT-v1.2.1-2026-10-14.md)。
|
||||
|
||||
网络连接文案统一为接口链路状态，见 [v1.2.2](DEPLOYMENT-v1.2.2-2026-10-14.md)。
|
||||
|
||||
生产 v1.3.0 与按设备周期采集的核验见 [部署记录](DEPLOYMENT-v1.3.0-2026-10-15.md)。
|
||||
|
||||
当前生产实时指标统一 4 秒读取，实测及版本 v1.3.2 见 [调优记录](DEPLOYMENT-v1.3.2-2026-10-15.md)。
|
||||
|
||||
当前生产 v1.3.3 的指标用词、状态与缺失百分比统一见 [部署记录](DEPLOYMENT-v1.3.3-2026-10-15.md)。
|
||||
|
||||
## Console UI 语义统一
|
||||
|
||||
本次界面需要 Console v2.7.30 的公共语义模块：在线、运行中使用绿色，健康正常使用蓝色，警告/故障/未知分别使用黄/红/灰色；状态采用14px/20px纯文字。完整规则见相邻 Console 项目的 `docs/UI_SEMANTICS.md`。
|
||||
|
||||
Reference in New Issue
Block a user