From 31401afbbd00479d8edae12a3c92c67e92db9108 Mon Sep 17 00:00:00 2001 From: Vertax42 <1007644658@qq.com> Date: Sun, 18 Oct 2026 14:11:24 +0800 Subject: [PATCH 1/4] =?UTF-8?q?docs:=20=E4=B8=AD=E6=96=87=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E7=BB=9F=E4=B8=80=E5=91=BD=E5=90=8D=E4=B8=BA=20-zh.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README_CN.md -> README-zh.md,docs/USAGE_CN.md -> docs/USAGE-zh.md,仓库内链接 同步更新(README.md、docs/USAGE.md、两份中文文档互链、wrist_camera.py 的提示)。 CHANGELOG 历史条目保留当时的文件名。外部仓库(文档站、lerobot、三个工具)未引用旧名。 Co-Authored-By: Claude Opus 5.5 (1M context) --- CHANGELOG.md | 6 ++++++ README_CN.md => README-zh.md | 2 +- README.md | 4 ++-- docs/{USAGE_CN.md => USAGE-zh.md} | 10 +++++----- docs/USAGE.md | 2 +- python/examples/wrist_camera.py | 2 +- 6 files changed, 16 insertions(+), 10 deletions(-) rename README_CN.md => README-zh.md (99%) rename docs/{USAGE_CN.md => USAGE-zh.md} (99%) diff --git a/CHANGELOG.md b/CHANGELOG.md index eae2949..14bcf7d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- **Chinese documents are named `-zh.md`.** `README_CN.md` is now + `README-zh.md` and `docs/USAGE_CN.md` is `docs/USAGE-zh.md`; links inside the + repository are updated. English files stay authoritative. + ## [0.4.3] - 2026-10-10 ### Fixed diff --git a/README_CN.md b/README-zh.md similarity index 99% rename from README_CN.md rename to README-zh.md index 584d97c..0e01e75 100644 --- a/README_CN.md +++ b/README-zh.md @@ -344,7 +344,7 @@ python python/examples/follower_status.py left ## 文档 -- [docs/USAGE_CN.md](docs/USAGE_CN.md)([English](docs/USAGE.md))—— 夹爪、腕部相机、视触觉传感器的完整上手流程 +- [docs/USAGE-zh.md](docs/USAGE-zh.md)([English](docs/USAGE.md))—— 夹爪、腕部相机、视触觉传感器的完整上手流程 - [docs/INSTALL.md](docs/INSTALL.md) —— 构建选项、纯 C++ 构建、环境陷阱 - [docs/CALIBRATION.md](docs/CALIBRATION.md) —— 编码器零点、行程、鱼眼内参 - [docs/EXAMPLES.md](docs/EXAMPLES.md) —— 每个示例脚本与控制器参数 diff --git a/README.md b/README.md index b3ebade..8b777be 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # taccap-gripper -[中文](README_CN.md) +[中文](README-zh.md) C++17 / Python SDK for the **TacCap-Gripper**, XenseRobotics' multimodal tactile data-collection gripper. One namespace: `xense::taccap::` in C++, @@ -378,7 +378,7 @@ Logs: every process writes a DEBUG log to `~/.taccaplogs/session_*.log` ## Documentation -- [docs/USAGE.md](docs/USAGE.md) ([中文](docs/USAGE_CN.md)) — end-to-end bring-up of gripper, wrist camera and tactile sensor +- [docs/USAGE.md](docs/USAGE.md) ([中文](docs/USAGE-zh.md)) — end-to-end bring-up of gripper, wrist camera and tactile sensor - [docs/INSTALL.md](docs/INSTALL.md) — build options, C++-only builds, environment traps - [docs/CALIBRATION.md](docs/CALIBRATION.md) — encoder zero, travel span, fisheye intrinsics - [docs/EXAMPLES.md](docs/EXAMPLES.md) — every example script and controller parameter diff --git a/docs/USAGE_CN.md b/docs/USAGE-zh.md similarity index 99% rename from docs/USAGE_CN.md rename to docs/USAGE-zh.md index 90756da..dbeeb01 100644 --- a/docs/USAGE_CN.md +++ b/docs/USAGE-zh.md @@ -23,7 +23,7 @@ > [EXAMPLES.md](EXAMPLES.md#选择设备统一用-left--right)。 安装见 [docs/INSTALL.md](INSTALL.md);请先完成一次性的 -[主机配置](../README_CN.md#主机配置一次性)(`dialout` 组、ModemManager udev 规则、 +[主机配置](../README-zh.md#主机配置一次性)(`dialout` 组、ModemManager udev 规则、 相机 MJPEG 格式)。下文假定 `taccap` 环境已激活、 `import xense.taccap` 能成功。 @@ -625,7 +625,7 @@ finally: 一路未压缩的 YUYV(640×480 @ 30 fps ≈ 147 Mbit/s)就足以让下一台相机报 `No space left on device` 或丢帧。保持 `use_mjpg=True`,并用 `v4l2-ctl -d <设备> --get-fmt-video` 确认(见 README 的 - [主机配置](../README_CN.md#3-腕部相机必须使用-mjpeg))。即使是 MJPEG,两个 OG + 一个 + [主机配置](../README-zh.md#3-腕部相机必须使用-mjpeg))。即使是 MJPEG,两个 OG + 一个 腕相机也会占掉相当一部分总线,满配采集时先实测帧率,别假设标称值。夹爪本身走串口, 不受影响。 - **谁持有 UVC 设备。** 生产环境里外部相机服务持有 `/dev/video*`,这时 @@ -648,9 +648,9 @@ finally: | 现象 | 多半是 | | --- | --- | -| `scan_grippers()` 返回空,或 `role=Unknown` | 用户不在 `dialout` 组(见 README 的[主机配置](../README_CN.md#主机配置一次性)),或线没插好 | -| 插上后立即打开报 `Device or resource busy` | ModemManager 在探测串口 —— 添加[主机配置](../README_CN.md#2-让-modemmanager-不要占用夹爪串口)里的 udev 规则 | -| 相机报 `No space left on device` 或丢帧 | 没用 MJPEG —— 见[主机配置](../README_CN.md#3-腕部相机必须使用-mjpeg) | +| `scan_grippers()` 返回空,或 `role=Unknown` | 用户不在 `dialout` 组(见 README 的[主机配置](../README-zh.md#主机配置一次性)),或线没插好 | +| 插上后立即打开报 `Device or resource busy` | ModemManager 在探测串口 —— 添加[主机配置](../README-zh.md#2-让-modemmanager-不要占用夹爪串口)里的 udev 规则 | +| 相机报 `No space left on device` 或丢帧 | 没用 MJPEG —— 见[主机配置](../README-zh.md#3-腕部相机必须使用-mjpeg) | | `fw_sn` 为空 / `Side.Unknown` | 固件没烧 SN,或固件早于 V1.6 | | 矫正后画面全黑 | 用了 `read_fisheye()` 的全零记录 —— 改用 `resolve_fisheye()` | | 矫正后画面偏心 | 未必是错的,主点本来就不一定在画面中心 | diff --git a/docs/USAGE.md b/docs/USAGE.md index e1f466c..03b5791 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -1,6 +1,6 @@ # Usage — bringing up the three data paths -> A Chinese version is available at [USAGE_CN.md](USAGE_CN.md). This English file is authoritative. +> A Chinese version is available at [USAGE-zh.md](USAGE-zh.md). This English file is authoritative.