kuavo-humanoid-sdk 0.1.1__py3-none-any.whl → 1.1.2a692__py3-none-any.whl

{kuavo_humanoid_sdk-0.1.1.dist-info → kuavo_humanoid_sdk-1.1.2a692.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kuavo-humanoid-sdk
-Version: 0.1.1
+Version: 1.1.2a692
 Summary: A Python SDK for kuavo humanoid robot.
 Home-page: https://gitee.com/leju-robot/kuavo-ros-opensource/
 Author: ['lejurobot']
@@ -9,7 +9,6 @@ License: MIT
 Project-URL: Documentation, https://gitee.com/leju-robot/kuavo-ros-opensource/
 Project-URL: Source Code, https://gitee.com/leju-robot/kuavo-ros-opensource/
 Keywords: kuavo,humanoid,robot,robotics,lejurobot,ros
-Platform: UNKNOWN
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
@@ -30,6 +29,8 @@ A comprehensive Python SDK for controlling Kuavo humanoid robots. This SDK provi
 
 **Warning**: This SDK currently only supports **ROS1**. ROS2 support is not available.
 
+**Warning**: **This SDK can only be used on the onboard NUC computer located in the robot's torso.** 
+
 ![Kuavo 4Pro Robot](https://kuavo.lejurobot.com/manual/assets/images/kuavo_4pro-cf84d43f1c370666c6e810d2807ae3e4.png)
 
 ## Features
@@ -40,8 +41,9 @@ A comprehensive Python SDK for controlling Kuavo humanoid robots. This SDK provi
   - Torso state (position, orientation, velocity)
   - Odometry information
   - End-effector states:
-    - Gripper: position, velocity, torque, grasp status
-    - Dexterous hand: position, velocity, torque
+    - Gripper(lejuclaw): position, velocity, torque, grasp status
+    - Dexterous hand(qiangnao): position, velocity, torque
+    - Touch Dexterous hand(qiangnao_touch): position, velocity, torque, touch state
     - End-effector position and orientation
   - Motion states: stand, walk, step_control, trot
 
@@ -79,14 +81,56 @@ A comprehensive Python SDK for controlling Kuavo humanoid robots. This SDK provi
 
 ## Installation
 
-To install Kuavo Humanoid SDK, you can use pip:
+**Note: There are currently two versions of this SDK, the stable version and the beta version. Their differences are:**
+
+- stable version: corresponding to the functionality provided by the `master` branch of [kuavo-ros-opensource](https://gitee.com/leju-robot/kuavo-ros-opensource/).
+- Beta version: This version is more aggressive than the official version and also provides richer functionality, corresponding to the functionality provided by the `beta` branch of [kuavo-ros-opensource](https://gitee.com/leju-robot/kuavo-ros-opensource/).
+
+**Friendly reminder: Please be clear about which version you need to install. If your SDK version does not match `kuavo-ros-opensource`, some features may not be available.**
+
+Install the latest **​stable version** of Kuavo Humanoid SDK using pip:
+```bash
+pip install kuavo-humanoid-sdk  
+```
+
+Install the latest **​beta version** of Kuavo Humanoid SDK using pip:
+```bash
+pip install --pre kuavo-humanoid-sdk  
+```
+
+For local development installation (editable mode), use:
+```bash
+cd src/kuavo_humanoid_sdk  
+chmod +x install.sh  
+./install.sh   
+```
+## Upgrade Instructions
+Before upgrading, you can check the currently installed version with:
+```bash
+pip show kuavo-humanoid-sdk  
+# Output:  
+Name: kuavo-humanoid-sdk  
+Version: 0.1.2  
+...  
+```
+
+**Note: If the version number contains the letter b, it indicates a beta version, e.g., Version: 0.1.2b113**
+
+To upgrade from a stable version to the latest stable version:
+```bash
+pip install --upgrade kuavo_humanoid_sdk  
+```
+
+To upgrade from a beta version to the latest stable version:
 ```bash
- pip install kuavo-humanoid-sdk
+pip install --upgrade --force-reinstall kuavo_humanoid_sdk  
+# or  
+pip uninstall kuavo_humanoid_sdk && pip install kuavo_humanoid_sdk  
 ```
 
-For development installation (editable mode), use:
+To upgrade from a stable/beta version to the latest beta version:
 ```bash
- pip install -e .
+pip install --upgrade --pre kuavo_humanoid_sdk  
 ```
 
 ## Package Information
@@ -113,11 +157,11 @@ def main():
         print("Init KuavoSDK failed, exit!")
         exit(1)
     robot = KuavoRobot()    
-
+    
     """ arm reset """
     print("Switching to arm reset mode...")
     robot.arm_reset()
-
+    
     """ stance """
     print("Switching to stance mode...")
     robot.stance()
@@ -125,7 +169,7 @@ def main():
     """ trot """
     print("Switching to trot mode...")
     robot.trot()
-
+    
     """ walk forward """
     print("Starting forward walk...")
     duration = 4.0  # seconds
@@ -134,11 +178,29 @@ def main():
     while (time.time() - start_time < duration):
         robot.walk(linear_x=speed, linear_y=0.0, angular_z=0.0)
         time.sleep(0.1)  # Small sleep to prevent busy loop
-
+    
 if __name__ == "__main__":
     main()
 ```
 
+## Docs
+The documentation is available in two formats:
+- HTML format: [docs/html](docs/html), **needs to be generated by running the script**
+- Markdown format: [docs/markdown](docs/markdown)
+
+We recommend that you generate the documentation locally by running the documentation script. The documentation will be output to the `docs/html` and `docs/markdown` folders:
+```bash
+cd <kuavo-ros-opensource>/src/kuavo_humanoid_sdk
+chmod +x gen_docs.sh
+./gen_docs.sh
+```
+
+**We recommend that you view the documentation using `html` for a better experience.**
+
+For Markdown documentation at:
+
+https://gitee.com/leju-robot/kuavo-ros-opensource/tree/master/src/kuavo_humanoid_sdk/docs/markdown/index.md
+
 ## Examples
 
 #### WARNING
@@ -198,10 +260,6 @@ Examples showing how to control the robot’s movements step by step, including
 [https://gitee.com/leju-robot/kuavo-ros-opensource/tree/master/src/kuavo_humanoid_sdk/examples/step_control_example.py](https://gitee.com/leju-robot/kuavo-ros-opensource/tree/master/src/kuavo_humanoid_sdk/examples/step_control_example.py)
 
 
-## Docs
-
-https://gitee.com/leju-robot/kuavo-ros-opensource/tree/master/src/kuavo_humanoid_sdk/docs/markdown/index.md
-
 ## License
 
 This project is licensed under the MIT License - see the LICENSE file for details.
@@ -213,5 +271,3 @@ For any questions, support, or bug reports, please contact:
 - Website: https://gitee.com/leju-robot/kuavo-ros-opensource/
 - Source Code: https://gitee.com/leju-robot/kuavo-ros-opensource/
 - Issue Tracker: https://gitee.com/leju-robot/kuavo-ros-opensource/issues
-
-

kuavo_humanoid_sdk-1.1.2a692.dist-info/RECORD

@@ -0,0 +1,27 @@
+kuavo_humanoid_sdk/__init__.py,sha256=pdgXhpulXKUcdUPwDVFZCe47AZAkOJdh_YAM8f3g2Ek,141
+kuavo_humanoid_sdk/common/logger.py,sha256=nSIbsJaW4nDcaQdhZebZkjtji6kmWVR8tYO-sUTz3Gg,1246
+kuavo_humanoid_sdk/interfaces/__init__.py,sha256=_zXDinj2T3X7UH19-Xrotc7uYZWHmZqHaMCWU1FYR5I,100
+kuavo_humanoid_sdk/interfaces/data_types.py,sha256=TCCVE0gmbw6KzCJKCzVCiG5yUl2IY-uIjHO5RKs0y2o,5281
+kuavo_humanoid_sdk/interfaces/end_effector.py,sha256=rlvBrYd_-b5-Px_m2UiHn47wuZJwlqVBrGPdV1lu0Qg,1876
+kuavo_humanoid_sdk/interfaces/robot.py,sha256=qqnq7gRc_mK8xEWnF5pJ7AJUPtry1bpN9eDl8nmE3EM,393
+kuavo_humanoid_sdk/interfaces/robot_info.py,sha256=-rh7VXjMJFYTsx7Ktok5VuI6JF_W2BpJBUbqtYJRkkA,1176
+kuavo_humanoid_sdk/kuavo/__init__.py,sha256=O4gPIQALqxUyNqBPCzzme4EfvTbbbh-IWGhLnhnZW_c,291
+kuavo_humanoid_sdk/kuavo/dexterous_hand.py,sha256=S4giIerF44sfMim1Tp-ZwoSbj7aqX3l_sgxNBS-nZRI,8497
+kuavo_humanoid_sdk/kuavo/leju_claw.py,sha256=6GUtQC_APuWzRAQtJFrSMqq9bUg8mI-g2ZBKYbOT4No,10253
+kuavo_humanoid_sdk/kuavo/robot.py,sha256=AiBHuT2uj8n3tOPr0gEWgZO2hCalaeRhANyafAQuu-c,14239
+kuavo_humanoid_sdk/kuavo/robot_arm.py,sha256=qD8oWSlKdxqc739vvM_18dpJgnMzjBbX41xJiyI6VWg,6946
+kuavo_humanoid_sdk/kuavo/robot_head.py,sha256=8caHrPNwg98b4jf5cLJUbsGNovgtXetOqBvuG5vWSXA,1526
+kuavo_humanoid_sdk/kuavo/robot_info.py,sha256=SZ0TeI87hc69Oop4CT1PxU7zSauTxJTJe8fcIIr-h6Q,3912
+kuavo_humanoid_sdk/kuavo/robot_state.py,sha256=X9vPmIK1dYBgaKHanfj0kVaUAMqxopBJWmlbOouTIqQ,10873
+kuavo_humanoid_sdk/kuavo/core/core.py,sha256=PTUjGG6ZZaDv6p70OF4iZEA2-D2uIOKT87Xml59Xi5M,17915
+kuavo_humanoid_sdk/kuavo/core/dex_hand_control.py,sha256=51iLPIKMFKeOhc5TpRCMWTm7Aw8pt6XG9XUB-_swr4Y,5158
+kuavo_humanoid_sdk/kuavo/core/leju_claw_control.py,sha256=RCrnWTMW-L0fOMa1op7t43aGWSyMVqrOjR0lVtIFzqY,3432
+kuavo_humanoid_sdk/kuavo/core/ros_env.py,sha256=Fq7YfHFjVvoUn-jMsrcHB_gUQ4w1y54jUVKtxV7zNEg,9500
+kuavo_humanoid_sdk/kuavo/core/ros/control.py,sha256=8erUTrGEY-JcqT0u_DTLsK5RFzobjjdOcufIn4tPnek,35305
+kuavo_humanoid_sdk/kuavo/core/ros/param.py,sha256=8XtwH6V59n8IX6TtXB5-lTMvBuhrNJqQaoRkbCYyIJc,6760
+kuavo_humanoid_sdk/kuavo/core/ros/sat_utils.py,sha256=AhBNM-s9nVwRiLZ8gtqC2RvPImkT9uulONSLXk3KooI,3317
+kuavo_humanoid_sdk/kuavo/core/ros/state.py,sha256=0C-Z0YRUoxERQJScYAtRJvQmUUfP-q51T7esV3FChVo,18145
+kuavo_humanoid_sdk-1.1.2a692.dist-info/METADATA,sha256=LssvNvA5Wf4Ygmaq-KTGpO1-nfv3UWT_KpDjnx078Tk,10810
+kuavo_humanoid_sdk-1.1.2a692.dist-info/WHEEL,sha256=g4nMs7d-Xl9-xC9XovUrsDHGXt-FT0E17Yqo92DEfvY,92
+kuavo_humanoid_sdk-1.1.2a692.dist-info/top_level.txt,sha256=9uSyZoiOEykRMOf0Gm-N9mkyQQg9yOSimfsb632G99c,19
+kuavo_humanoid_sdk-1.1.2a692.dist-info/RECORD,,

{kuavo_humanoid_sdk-0.1.1.dist-info → kuavo_humanoid_sdk-1.1.2a692.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.45.0)
+Generator: bdist_wheel (0.34.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

kuavo_humanoid_sdk-0.1.1.dist-info/RECORD

@@ -1,27 +0,0 @@
-kuavo_humanoid_sdk/__init__.py,sha256=alEgqxypKm-gg2CSlhoHK5P3Crg1f8NEI74bbX37uDI,122
-kuavo_humanoid_sdk/common/logger.py,sha256=nSIbsJaW4nDcaQdhZebZkjtji6kmWVR8tYO-sUTz3Gg,1246
-kuavo_humanoid_sdk/interfaces/__init__.py,sha256=_zXDinj2T3X7UH19-Xrotc7uYZWHmZqHaMCWU1FYR5I,100
-kuavo_humanoid_sdk/interfaces/data_types.py,sha256=fQ_9ZPL8KFsFExDnfRI3II_qy7-WgcNYudywA7iLCAQ,4266
-kuavo_humanoid_sdk/interfaces/end_effector.py,sha256=gOnbZudoFHL2ZZjfcbteqcFVhF-T6khtEpoF6PjVffo,1244
-kuavo_humanoid_sdk/interfaces/robot.py,sha256=qqnq7gRc_mK8xEWnF5pJ7AJUPtry1bpN9eDl8nmE3EM,393
-kuavo_humanoid_sdk/interfaces/robot_info.py,sha256=-rh7VXjMJFYTsx7Ktok5VuI6JF_W2BpJBUbqtYJRkkA,1176
-kuavo_humanoid_sdk/kuavo/__init__.py,sha256=s4UZkSKP22K1712vLR96dBiXgOAaWd88bCr-WAKNuus,271
-kuavo_humanoid_sdk/kuavo/dexterous_hand.py,sha256=tHqpKH5Bti4qcI4U_AnAGg9s7qSAVHMwDvsPOzUwt0I,8026
-kuavo_humanoid_sdk/kuavo/leju_claw.py,sha256=HqTg3Q4NO9icwv7MJzLFxTADLJAjrD92Z3AQULJ5Epo,9624
-kuavo_humanoid_sdk/kuavo/robot.py,sha256=Xou9Zi5j8HyiClXzEXbNBgBc1QZf8Q5EKW17D37Cj2Y,13132
-kuavo_humanoid_sdk/kuavo/robot_arm.py,sha256=M7u_cwBLF7TKCbU85rGKMHAu3E3WKvUCsvadVtBMkVw,6690
-kuavo_humanoid_sdk/kuavo/robot_head.py,sha256=8caHrPNwg98b4jf5cLJUbsGNovgtXetOqBvuG5vWSXA,1526
-kuavo_humanoid_sdk/kuavo/robot_info.py,sha256=XcrShWG0yG2kuuVbiM0RW8Frh-M9dcFASlSuwJX_pVo,3850
-kuavo_humanoid_sdk/kuavo/robot_state.py,sha256=X9vPmIK1dYBgaKHanfj0kVaUAMqxopBJWmlbOouTIqQ,10873
-kuavo_humanoid_sdk/kuavo/core/core.py,sha256=QHneyt7UqX73XqrC0mCmRnMtCEOtrl9kjJPjUT6gKyU,17668
-kuavo_humanoid_sdk/kuavo/core/dex_hand_control.py,sha256=pJr50Nxx1OGJa7D5pg1w6BkX3_k8a3Ot70N-OAJ-Mlw,3665
-kuavo_humanoid_sdk/kuavo/core/leju_claw_control.py,sha256=RCrnWTMW-L0fOMa1op7t43aGWSyMVqrOjR0lVtIFzqY,3432
-kuavo_humanoid_sdk/kuavo/core/ros_env.py,sha256=P0tiURlwxhW_WUrPUmz_bigTTFm0XuQqjQsh2hK8FMs,7871
-kuavo_humanoid_sdk/kuavo/core/ros/control.py,sha256=8DKfxqKFWy3zRSTWYPWyiJWsq6NIA8Oa3yWY95qWrwg,31996
-kuavo_humanoid_sdk/kuavo/core/ros/param.py,sha256=H-Kvy5QokHuYB3vCplwd6IFuVFK4lJV0KuYErVV5Qcs,6625
-kuavo_humanoid_sdk/kuavo/core/ros/sat_utils.py,sha256=AhBNM-s9nVwRiLZ8gtqC2RvPImkT9uulONSLXk3KooI,3317
-kuavo_humanoid_sdk/kuavo/core/ros/state.py,sha256=ZmP8Ku18nTzCSO-VNWXdr9BKVN0IS-8N6xeHjNEMNHw,13776
-kuavo_humanoid_sdk-0.1.1.dist-info/METADATA,sha256=LC8k1hwb-lohKzRTdZteLsJYv_-BbqnnuGPWwzB7b3U,8336
-kuavo_humanoid_sdk-0.1.1.dist-info/WHEEL,sha256=bFJAMchF8aTQGUgMZzHJyDDMPTO3ToJ7x23SLJa1SVo,92
-kuavo_humanoid_sdk-0.1.1.dist-info/top_level.txt,sha256=9uSyZoiOEykRMOf0Gm-N9mkyQQg9yOSimfsb632G99c,19
-kuavo_humanoid_sdk-0.1.1.dist-info/RECORD,,