更新文档

Author: hejianxin79

LinkerHand/config/setting.yaml

@@ -1,7 +1,7 @@
 VERSION: 1.3.6 # 重构核心源码,支持动捕手套速度
 LINKER_HAND:  # 手部配置信息
   LEFT_HAND:
-    EXISTS: True # 是否存在左手
+    EXISTS: False # 是否存在左手
     TOUCH: True # 是否有压力传感器
     JOINT: L10 # 左手关节数 L7/L10/L20/L25/L25_v2
     NAME: # 无论l10还是l20 joint name都是20个
@@ -27,9 +27,9 @@ LINKER_HAND:  # 手部配置信息
       - joint60
 
   RIGHT_HAND:
-    EXISTS: False # 是否存在右手
+    EXISTS: True # 是否存在右手
     TOUCH: False # 是否有压力传感器
-    JOINT: L25 # 右手关节数量
+    JOINT: L10 # 右手关节数量
     NAME:  # 无论l10还是l20 joint name都是20个
       - joint71
       - joint72

LinkerHand/core/__pycache__/linker_hand_l10_can.cpython-38.pyc

@@ -61,7 +61,7 @@ def send_frame(self, frame_property, data_list):
             self.bus.send(msg)
         except can.CanError as e:
             print(f"Failed to send message: {e}")
-        time.sleep(0.002)
+        time.sleep(0.005)
 
     def set_joint_positions(self, joint_angles):
         """将10个关节的位置设置（joint_angles: 10个数值的列表）。"""

LinkerHand/core/linker_hand_l10_can.py

@@ -240,8 +240,8 @@ def get_current_status(self):
         self.send_command(0x03,[])
         self.send_command(0x04,[])
         return self.x01 + self.x02 + self.x03 + self.x04
-    def get_force(self):
-        return [self.normal_force,self.tangential_force , self.tangential_force_dir , self.approach_inc]
+    #def get_force(self):
+        #return [self.normal_force,self.tangential_force , self.tangential_force_dir , self.approach_inc]
     def get_speed(self):
         '''获取当前电机速度'''
         self.send_command(0x05, [0])

LinkerHand/core/linker_hand_l20_can.py

@@ -43,7 +43,7 @@ def send_frame(self, frame_property, data_list):
             self.bus.send(msg)
         except can.CanError as e:
             print(f"Failed to send message: {e}")
-        time.sleep(0.001)
+        time.sleep(0.005)
 
     def set_joint_positions(self, joint_angles):
         """将10个关节的位置设置（joint_angles: 10个数值的列表）。"""

LinkerHand/core/linker_hand_l7_can.py

@@ -2,8 +2,8 @@
 Author: HJX
 Date: 2025-04-01 14:09:21
 LastEditors: Please set LastEditors
-LastEditTime: 2025-04-11 09:19:15
-FilePath: /Linker_Hand_SDK_ROS/src/linker_hand_sdk_ros/scripts/LinkerHand/linker_hand_api.py
+LastEditTime: 2025-04-15 14:11:58
+FilePath: /LinkerHand_Python_SDK/LinkerHand/linker_hand_api.py
 Description: 
 symbol_custom_string_obkorol_copyright: 
 '''
@@ -85,14 +85,6 @@ def _get_tangential_force_dir(self):
     def _get_approach_inc(self):
         '''# 获取接近度'''
         self.hand.get_approach_inc()
-
-    def get_force(self):
-        '''获取所有压感数据'''
-        self._get_approach_inc()
-        self._get_normal_force()
-        self._get_tangential_force()
-        self._get_tangential_force_dir()
-        return self.hand.get_force()
 
     def set_speed(self,speed=[100]*5):
         '''# 设置速度'''
@@ -101,7 +93,7 @@ def set_speed(self,speed=[100]*5):
     def set_joint_speed(self,speed=[100]*5):
         '''设置速度by topic'''
         self.hand.set_speed(speed=speed)
-    def set_torque(self, torque=[]):
+    def set_torque(self, torque=[180] * 5):
         '''设置最大扭矩'''
         ColorMsg(msg=f"设置最大扭矩为{torque}", color="green")
         return self.hand.set_torque(torque=torque)
@@ -116,15 +108,19 @@ def set_current(self, current=[]):
     def get_version(self):
         '''获取版本'''
         return self.hand.get_version()
+    
     def get_current(self):
         '''获取当前电流'''
         return self.hand.get_current()
+    
     def get_state(self):
         '''获取当前关节状态'''
         return self.hand.get_current_status()
+    
     def get_speed(self):
         '''获取速度'''
         return self.hand.get_speed()
+    
     def get_joint_speed(self):
         speed = self.hand.get_speed()
         if self.hand_joint == "L7":
@@ -136,6 +132,15 @@ def get_joint_speed(self):
         elif self.hand_joint == "L25":
             return speed
 
+    def get_force(self):
+        '''获取法向压力、切向压力、切向压力方向、接近感应数据'''
+        self._get_normal_force()
+        self._get_tangential_force()
+        self._get_tangential_force_dir()
+        self._get_approach_inc()
+        return self.hand.get_force()
+
+
     def get_torque(self):
         '''获取当前最大扭矩'''
         return self.hand.get_torque()
@@ -177,4 +182,5 @@ def set_disable(self):
 
 
 if __name__ == "__main__":
-    hand = LinkerHandApi()
+    hand = LinkerHandApi(hand_type="right", hand_joint="L10")
+    

LinkerHand/linker_hand_api.py

@@ -60,32 +60,8 @@ LinkerHand Python SDK
 
 
 
-- #### Import
-  ```python
-  from LinkerHand.linker_hand_api import LinkerHandApi
-  # Initialize API for L10 left hand
-  hand = LinkerHandApi(hand_joint="L10",hand_type="left")
-  # Initialize API for L10 right hand
-  hand = LinkerHandApi(hand_joint="L10",hand_type="right")
-  ```
-
-
-- #### Move
-  ```python
-  hand.finger_move(...)
-  ```
-
-- #### Set
-  ```python
-  hand.set_speed(...)
-  ```
-
-- #### Get
-  ```python
-  hand.get_force()
-  hand.get_speed()
-  hand.get_state()
-  ```
+## API Document
+[Linker Hand API for Python Document](linker_hand/doc/API-Reference.md)
 
 
 

README.md

@@ -1,3 +1,4 @@
+
 # LinkerHand-Python-SDK
 
 ## Overview
@@ -66,32 +67,8 @@ LinkerHand Python SDK
 
 
 
-- #### Import
-  ```python
-  from LinkerHand.linker_hand_api import LinkerHandApi
-  # 初始化API L10 左手
-  hand = LinkerHandApi(hand_joint="L10",hand_type="left")
-  # 初始化API L10 右手
-  hand = LinkerHandApi(hand_joint="L10",hand_type="right")
-  ```
-
-
-- #### Move
-  ```python
-  hand.finger_move(...)
-  ```
-
-- #### Set
-  ```python
-  hand.set_speed(...)
-  ```
-
-- #### Get
-  ```python
-  hand.get_force()
-  hand.get_speed()
-  hand.get_state()
-  ```
+## API 说明文档
+[Linker Hand API for Python Document](linker_hand/doc/API-Reference.md)
 
 
 

README_CN.md

@@ -0,0 +1,187 @@
+
+---
+
+# Linker Hand Python API Documentation
+
+## API Overview
+
+This document provides a detailed overview of the Python API for the Linker Hand, including functions for controlling the hand's movements, retrieving sensor data, and setting operational parameters.
+
+## Public API
+
+### 设置速度
+```python
+def set_speed(self,speed=[100]*5)
+```
+**Description**:  
+设置手部的运动速度。  
+**Parameters**:  
+- `speed`: 一个包含速度数据的 list，长度为5个元素对应每个关节的速度值，如何是L7则为7个元素，对应每个电机速度。
+
+---
+
+### 设置五根手指的转矩限制 - 力度
+```python
+def set_torque(self, torque=[180] * 5)
+```
+**Description**:  
+设置手指的转矩限制或力度，用于控制抓取力度。  
+**Parameters**:  
+- `torque`: 一个包含力度数据的 list，长度为5个元素对应每个手指的力度值，如何是L7则为7个元素，对应每个电机力度值。
+
+---
+
+### 设置关节位置
+```python
+def finger_move(self,pose=[])
+```
+**Description**:  
+设置关节的目标位置，用于控制手指的运动。  
+**Parameters**:  
+- `pose`: 一个包含目标位置数据的 float类型的list，L7长度为7个元素，L10长度为10个元素，L20长度为20个元素，L25长度为25个元素。
+
+---
+
+### 设置电机电流值
+```python
+def set_current(self, current=[])
+```
+**Description**:  
+设置电机的电流值。  
+**Parameters**:  
+- `current`: 一个包含目标电流数据的 int类型list，长度为5个元素，当前只支持L20版本。
+
+---
+
+### 获取速度
+```python
+def get_speed(self)
+return [180, 200, 200, 200, 200]
+```
+**Description**:  
+获取当前设置的速度值。提示：需设置关节位置后才能获取到速度值。
+
+**Returns**:  
+- 返回一个 list，包含当前的手指速度设置值。
+
+---
+
+### 获取当前关节状态
+```python
+def get_state(self)
+return [81, 79, 79, 79, 79, 79, 83, 76, 80, 78]
+```
+**Description**:  
+获取当前关节的状态float类型的list信息。提示：需要设置关节位置后才能获取到状态信息，L7长度为7个元素，L10长度为10个元素，L20长度为20个元素，L25长度为25个元素。
+
+**Returns**:  
+- 返回一个 float类型的list，包含当前关节的状态数据。
+
+---
+
+### 获取法向压力、切向压力、切向方向、接近感应
+```python
+def get_force(self)
+return [[255.0, 0.0, 0.0, 77.0, 192.0], [82.0, 0.0, 0.0, 230.0, 223.0], [107.0, 255.0, 255.0, 31.0, 110.0], [255.0, 0.0, 20.0, 255.0, 255.0]]
+```
+**Description**:  
+获取手部传感器的综合数据，包括法向压力、切向压力、切向方向和接近感应。  
+**Returns**:  
+- 返回一个二维list，其中每个子list包含不同类别的list压力数据[[法向压力],[切向压力],[切向压力方向],[接近感应]]。类别每一个元素对应拇指、食指、中指、无名指、小拇指
+
+---
+
+### 获取版本号
+```python
+def get_version(self)
+return [10, 6, 22, 82, 20, 17, 0]
+```
+**Description**:  
+获取当前软件或硬件的版本号。  
+**Returns**:  
+- 返回一个字符串，表示当前的版本号。list元素依次表示:自由度\版本号\序号\左手76右手82\内部序列号
+
+---
+--------------------------------------------------------------
+### 获取扭矩
+```python
+def get_torque(self)
+return [200, 200, 200, 200, 200]
+```
+**Description**:  
+获取当前手指扭矩list信息。表示每根手指当前电机扭矩，支持L20、L25。
+
+**Returns**:  
+- 返回一个 float类型的list。
+
+---
+
+### 获取电机温度
+```python
+def get_temperature(self)
+return [41, 71, 45, 40, 50, 47, 58, 50, 63, 70]
+```
+**Description**:  
+获取当前关节的电机温度。
+
+**Returns**:  
+- 返回一个 list数据，包含当前关节的电机温度。
+
+---
+
+### 获取电机故障码
+```python
+def get_fault(self)
+return [0, 4, 0, 0, 0, 0, 0, 0, 0, 0]
+```
+**Description**:  
+获取当前关节电机故障，0表示正常 数字1电流过载 数字2温度过高 数字3编码错误 数字4过压/欠压。
+
+**Returns**:  
+- 返回一个 float类型的list，包含当前关节电机故障。
+
+---
+
+### 清除电机故障码
+```python
+def clear_faults(self)
+```
+**Description**:  
+尝试清除电机故障，无返回值。只支持L20
+**Returns**:  
+
+---
+
+## Example Usage
+
+以下是一个完整的示例代码，展示如何使用上述 API：
+
+```python
+
+from LinkerHand.linker_hand_api import LinkerHandApi
+def main():
+    # 初始化API hand_type:left or right   hand_joint:L7 or L10 or L20 or L25
+    linker_hand = LinkerHandApi(hand_type="left", hand_joint="L10")
+    # 设置手指速度
+    linker_hand.set_speed(speed=[120,200,200,200,200])
+    # 设置手扭矩
+    linker_hand.set_torque(torque=[200,200,200,200,200])
+    # 获取手当前状态
+    hand_state = linker_hand.get_state()
+    # 打印状态值
+    print(hand_state)
+
+```
+
+---
+
+## Notes
+- 在使用 API 之前，请确保手部设备已正确连接并初始化。
+- 参数值（如速度、力度等）的具体范围和含义请参考设备的技术手册。
+
+---
+
+## Contact
+- 如果有任何问题或需要进一步支持，请联系 [[email protected]](mailto:[email protected])。
+
+---