Skip to content

Commit 8afb33d

Browse files
Update README.rst
add detail description for pypi
1 parent 3224b8b commit 8afb33d

File tree

1 file changed

+71
-6
lines changed

1 file changed

+71
-6
lines changed

README.rst

Lines changed: 71 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,72 @@
1-
Python SDK for UFACTORY robotic arm 850, xArm 5/6/7, and Lite6.
1+
xarm-python-sdk
2+
===============
23

3-
:Website: https://www.ufactory.cc/
4-
:Github: https://github.com/xArm-Developer/xArm-Python-SDK
5-
:Docs: http://docs.api.ufactory.cc
6-
:Release Note: https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/README.md#update-summary
7-
:Bug Reports: [email protected]
4+
.. image:: https://badge.fury.io/py/xarm-python-sdk.svg
5+
:target: https://pypi.org/project/xarm-python-sdk/
6+
7+
.. image:: https://img.shields.io/github/license/xArm-Developer/xArm-Python-SDK.svg
8+
:target: https://github.com/xArm-Developer/xArm-Python-SDK/blob/main/LICENSE
9+
10+
.. image:: https://img.shields.io/pypi/pyversions/xarm-python-sdk.svg
11+
:target: https://pypi.org/project/xarm-python-sdk/
12+
13+
Official Python SDK for UFACTORY robots.
14+
15+
Supported Products
16+
------------------
17+
18+
- UFACTORY xArm 5/6/7
19+
- UFACTORY 850
20+
- UFACTORY Lite 6
21+
22+
Installation
23+
------------
24+
25+
Install from PyPI:
26+
27+
.. code-block:: bash
28+
29+
pip install xarm-python-sdk
30+
31+
Quick Start
32+
-----------
33+
34+
.. code-block:: python
35+
36+
from xarm.wrapper import XArmAPI
37+
38+
# Connect to the robot
39+
arm = XArmAPI('192.168.1.100') # Replace with your robot's IP address
40+
41+
# Enable motion
42+
arm.motion_enable(enable=True)
43+
44+
# Set robot to ready state
45+
arm.set_mode(0) # Position control mode
46+
arm.set_state(0) # Set to ready state
47+
48+
# Move to a target position
49+
arm.set_position(x=300, y=0, z=200, roll=180, pitch=0, yaw=0, speed=100)
50+
51+
# Disconnect
52+
arm.disconnect()
53+
54+
Documentation
55+
-------------
56+
57+
Full documentation and examples are available at:
58+
59+
https://github.com/xArm-Developer/xArm-Python-SDK
60+
61+
Website: https://www.ufactory.cc/
62+
63+
GitHub: https://github.com/xArm-Developer/xArm-Python-SDK
64+
65+
Release Note: https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/README.md#update-summary
66+
67+
Bug Reports: [email protected]
68+
69+
License
70+
-------
71+
72+
MIT License. See `LICENSE <https://github.com/xArm-Developer/xArm-Python-SDK/blob/main/LICENSE>`_ for details.

0 commit comments

Comments
 (0)