更新文档

更新文档

Author: hejianxin79

README.md

@@ -1,3 +1,4 @@
+
 # LinkerHand-Python-SDK
 
 ## Overview
@@ -23,7 +24,7 @@ LinkerHand Python SDK
   ```
 
 ## Documentation
-
+[Linker Hand API for Python Document](doc/API-Reference.md)
 
 ## Version Information
 - > ### 1.3.6

README_CN.md

@@ -1,3 +1,4 @@
+
 # LinkerHand-Python-SDK
 
 ## Overview
@@ -23,7 +24,7 @@ LinkerHand Python SDK
   ```
 
 ## 相关文档
-
+[Linker Hand API for Python Document](doc/API-Reference.md)
 
 ## 更新说明
 - > ### 1.3.6

doc/API-Reference.md

@@ -11,45 +11,45 @@ This document provides a detailed overview of the Python API for the Linker Hand
 
 ### 设置速度
 ```python
-def set_speed(self,speed=[100]*5)
+def set_speed(self,speed=[100,100,100,100,100]) # L7则要设置7个值
 ```
 **Description**:  
 设置手部的运动速度。  
 **Parameters**:  
-- `speed`: 一个包含速度数据的 list，长度为5个元素对应每个关节的速度值，如何是L7则为7个元素，对应每个电机速度。
+- `speed`: 一个包含速度数据的 list，长度为5个元素对应每个关节的速度值，如何是L7则为7个元素，对应每个电机速度。 每个元素值范围:0~255
 
 ---
 
 ### 设置五根手指的转矩限制 - 力度
 ```python
-def set_torque(self, torque=[180] * 5)
+def set_torque(self, torque=[180,100,80,99,255]) # L7则要设置7个值
 ```
 **Description**:  
 设置手指的转矩限制或力度，用于控制抓取力度。  
 **Parameters**:  
-- `torque`: 一个包含力度数据的 list，长度为5个元素对应每个手指的力度值，如何是L7则为7个元素，对应每个电机力度值。
+- `torque`: 一个包含力度数据的 list，长度为5个元素对应每个手指的力度值，如何是L7则为7个元素，对应每个电机力度值。每个元素值范围:0~255
 
 ---
 
 ### 设置关节位置
 ```python
-def finger_move(self,pose=[])
+def finger_move(self,pose=[120,120,120,120,120,120,120,120,120,120]) # L10为例
 ```
 **Description**:  
 设置关节的目标位置，用于控制手指的运动。  
 **Parameters**:  
-- `pose`: 一个包含目标位置数据的 float类型的list，L7长度为7个元素，L10长度为10个元素，L20长度为20个元素，L25长度为25个元素。
+- `pose`: 一个包含目标位置数据的 float类型的list，L7长度为7个元素，L10长度为10个元素，L20长度为20个元素，L25长度为25个元素。每个元素值范围:0~255
 
 ---
 
 ### 设置电机电流值
 ```python
-def set_current(self, current=[])
+def set_current(self, current=[99，72，80，66，20]) # L20为例
 ```
 **Description**:  
 设置电机的电流值。  
 **Parameters**:  
-- `current`: 一个包含目标电流数据的 int类型list，长度为5个元素，当前只支持L20版本。
+- `current`: 一个包含目标电流数据的 int类型list，长度为5个元素，当前只支持L20版本。每个元素值范围:0~255
 
 ---
 
@@ -62,7 +62,7 @@ return [180, 200, 200, 200, 200]
 获取当前设置的速度值。提示：需设置关节位置后才能获取到速度值。
 
 **Returns**:  
-- 返回一个 list，包含当前的手指速度设置值。
+- 返回一个 list，包含当前的手指速度设置值。每个元素值范围:0~255
 
 ---
 
@@ -75,7 +75,7 @@ return [81, 79, 79, 79, 79, 79, 83, 76, 80, 78]
 获取当前关节的状态float类型的list信息。提示：需要设置关节位置后才能获取到状态信息，L7长度为7个元素，L10长度为10个元素，L20长度为20个元素，L25长度为25个元素。
 
 **Returns**:  
-- 返回一个 float类型的list，包含当前关节的状态数据。
+- 返回一个 float类型的list，包含当前关节的状态数据。每个元素值范围:0~255
 
 ---
 
@@ -88,7 +88,7 @@ return [[255.0, 0.0, 0.0, 77.0, 192.0], [82.0, 0.0, 0.0, 230.0, 223.0], [107.0,
 获取手部传感器的综合数据，包括法向压力、切向压力、切向方向和接近感应。  
 **Returns**:  
 - 返回一个二维list，其中每个子list包含不同类别的list压力数据[[法向压力],[切向压力],[切向压力方向],[接近感应]]。类别每一个元素对应拇指、食指、中指、无名指、小拇指
-
+每个元素值范围:0~255
 ---
 
 ### 获取版本号
@@ -112,7 +112,7 @@ return [200, 200, 200, 200, 200]
 获取当前手指扭矩list信息。表示每根手指当前电机扭矩，支持L20、L25。
 
 **Returns**:  
-- 返回一个 float类型的list。
+- 返回一个 float类型的list。每个元素值范围:0~255
 
 ---
 
@@ -149,7 +149,7 @@ def clear_faults(self)
 **Description**:  
 尝试清除电机故障，无返回值。只支持L20
 **Returns**:  
-
+无
 ---
 
 ## Example Usage