Skip to content

Commit 40c9ba6

Browse files
committed
docs: update docs
1 parent d9f821f commit 40c9ba6

File tree

6 files changed

+2694
-208
lines changed

6 files changed

+2694
-208
lines changed

README.md

Lines changed: 60 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ LinkerHand-CPP-SDK 是由灵心巧手(北京)科技有限公司开发的官
1111
## 📋 目录
1212

1313
- [特性](#-特性)
14-
- [支持的型号](#-支持的型号)
1514
- [系统要求](#-系统要求)
1615
- [快速开始](#-快速开始)
1716
- [安装](#-安装)
@@ -20,6 +19,8 @@ LinkerHand-CPP-SDK 是由灵心巧手(北京)科技有限公司开发的官
2019
- [通信协议](#-通信协议)
2120
- [项目结构](#-项目结构)
2221
- [构建项目](#-构建项目)
22+
- [故障排查](#-故障排查)
23+
- [常见问题](#-常见问题)
2324
- [贡献](#-贡献)
2425
- [许可证](#-许可证)
2526
- [联系我们](#-联系我们)
@@ -28,7 +29,7 @@ LinkerHand-CPP-SDK 是由灵心巧手(北京)科技有限公司开发的官
2829

2930
- 🎯 **多型号支持** - 支持 O6、L6、L7、L10、L20、L21、L25 等多种型号
3031
- 🚀 **简单易用** - 提供简洁的 C++ API 接口
31-
- 🔌 **多通信协议** - 支持 CAN、Modbus、EtherCAT 等通信方式
32+
- 🔌 **通信协议** - 支持 CAN 通信
3233
- 📊 **传感器数据** - 实时获取压力、温度、电流等传感器数据
3334
- 🎮 **精确控制** - 支持关节位置、速度、扭矩的精确控制
3435
- 🔄 **实时反馈** - 获取关节状态、电机故障码等实时信息
@@ -40,7 +41,7 @@ LinkerHand-CPP-SDK 是由灵心巧手(北京)科技有限公司开发的官
4041
- **操作系统**: Linux (Ubuntu 18.04+ 推荐)
4142
- **架构**: x86_64 或 aarch64
4243
- **编译器**: GCC 7.0+ 或 Clang 5.0+
43-
- **CMake**: 3.5 或更高版本
44+
- **CMake**: 3.11+
4445
- **依赖**: pthread
4546

4647
## 🚀 快速开始
@@ -73,20 +74,20 @@ cd linkerhand-cpp-sdk
7374
int main() {
7475
// 初始化 L10 型号右手
7576
LinkerHandApi hand(LINKER_HAND::L10, HAND_TYPE::RIGHT);
76-
77+
7778
// 获取版本信息
7879
std::cout << "SDK Version: " << hand.getVersion() << std::endl;
79-
80+
8081
// 握拳动作
8182
std::vector<uint8_t> fist_pose = {101, 60, 0, 0, 0, 0, 255, 255, 255, 51};
8283
hand.fingerMove(fist_pose);
8384
std::this_thread::sleep_for(std::chrono::seconds(1));
84-
85+
8586
// 张开动作
8687
std::vector<uint8_t> open_pose = {255, 104, 255, 255, 255, 255, 255, 255, 255, 71};
8788
hand.fingerMove(open_pose);
8889
std::this_thread::sleep_for(std::chrono::seconds(1));
89-
90+
9091
return 0;
9192
}
9293
```
@@ -189,19 +190,19 @@ sudo make install
189190
int main() {
190191
// 创建 API 实例
191192
LinkerHandApi hand(LINKER_HAND::L10, HAND_TYPE::RIGHT);
192-
193+
193194
// 设置速度
194195
std::vector<uint8_t> speed = {200, 200, 200, 200, 200};
195196
hand.setSpeed(speed);
196-
197+
197198
// 设置扭矩
198199
std::vector<uint8_t> torque = {255, 255, 255, 255, 255};
199200
hand.setTorque(torque);
200-
201+
201202
// 控制手指运动
202203
std::vector<uint8_t> pose = {128, 128, 128, 128, 128, 128, 128, 128, 128, 128};
203204
hand.fingerMove(pose);
204-
205+
205206
return 0;
206207
}
207208
```
@@ -233,12 +234,18 @@ hand.fingerMoveArc(pose_arc);
233234
auto state_arc = hand.getStateArc();
234235
```
235236
236-
更多示例请参考 `examples/` 目录。
237+
更多示例请参考 `examples/` 目录。详细说明请查看 [示例代码文档](examples/README.md)。
237238
238239
## 📚 API 文档
239240
240241
详细的 API 文档请参考:[API 参考文档](docs/API-Reference.md)
241242
243+
文档包含:
244+
- 完整的 API 函数说明
245+
- 参数和返回值详解
246+
- 使用示例和注意事项
247+
- 版本兼容性说明
248+
242249
## 🧪 测试
243250
244251
### 运行测试
@@ -253,7 +260,7 @@ ctest --output-on-failure
253260

254261
### 测试文档
255262

256-
- **测试指南**: [测试文档](docs/TESTING.md) - 详细的测试框架安装、编写和运行指南
263+
- **测试指南**: [测试文档](docs/TESTING.md)(待创建) - 详细的测试框架安装、编写和运行指南
257264
- **测试说明**: [测试目录 README](tests/README.md) - 测试结构和快速参考
258265

259266
测试文档包含:
@@ -296,14 +303,13 @@ ctest --output-on-failure
296303
SDK 支持以下通信协议:
297304

298305
- **CAN** (`COMM_CAN_0`, `COMM_CAN_1`) - CAN 总线通信
299-
- **Modbus** (`COMM_MODBUS`) - Modbus 协议
300-
- **EtherCAT** (`COMM_ETHERCAT`) - EtherCAT 实时以太网
306+
301307

302308
默认使用 `COMM_CAN_0`
303309

304310
```cpp
305-
// 使用 Modbus 通信
306-
LinkerHandApi hand(LINKER_HAND::L10, HAND_TYPE::RIGHT, COMM_MODBUS);
311+
// 使用 COMM_CAN_1 通信
312+
LinkerHandApi hand(LINKER_HAND::L10, HAND_TYPE::RIGHT, COMM_CAN_1);
307313
```
308314
309315
## 📁 项目结构
@@ -321,7 +327,9 @@ linkerhand-cpp-sdk/
321327
│ ├── toolset_example.cpp
322328
│ └── action_group_show_l10.cpp
323329
├── docs/ # 文档
324-
│ └── API-Reference.md
330+
│ ├── API-Reference.md # API 参考文档
331+
│ ├── TROUBLESHOOTING.md # 故障排查指南
332+
│ └── FAQ.md # 常见问题解答
325333
├── src/ # 源代码
326334
├── third_party/ # 第三方依赖
327335
├── CMakeLists.txt # CMake 配置
@@ -379,6 +387,40 @@ cd build
379387
### L21/L25
380388
详细映射请参考 [API 文档](docs/API-Reference.md)
381389

390+
## 🔧 故障排查
391+
392+
如果遇到问题,请参考以下文档:
393+
394+
- **[故障排查指南](docs/TROUBLESHOOTING.md)** - 常见问题的排查和解决方案
395+
- 编译问题
396+
- 运行时问题
397+
- 通信问题
398+
- API 使用问题
399+
- 性能问题
400+
401+
- **[常见问题解答](docs/FAQ.md)** - 常见问题的快速解答
402+
- 安装相关问题
403+
- 使用相关问题
404+
- API 相关问题
405+
- 兼容性问题
406+
- 性能相关问题
407+
408+
如果文档无法解决您的问题,请:
409+
1. 查看 [GitHub Issues](https://github.com/linker-bot/linkerhand-cpp-sdk/issues) 查看是否有类似问题
410+
2. 提交新的 Issue,并提供详细的错误信息和复现步骤
411+
3. 联系技术支持:[https://linkerbot.cn/aboutUs](https://linkerbot.cn/aboutUs)
412+
413+
## ❓ 常见问题
414+
415+
快速查找常见问题的答案,请参考 [常见问题解答 (FAQ)](docs/FAQ.md)
416+
417+
常见问题包括:
418+
- 如何安装和配置 SDK?
419+
- 如何选择通信接口?
420+
- 不同型号的关节数量是多少?
421+
- 如何提高性能?
422+
- 如何获取技术支持?
423+
382424
## 🤝 贡献
383425

384426
我们欢迎社区贡献!请参考以下步骤:

0 commit comments

Comments
 (0)