Skip to content

Commit 6776c07

Browse files
Merge pull request #140 from DanielWang123321/master
modify rst file for pypi
2 parents 3224b8b + b7e44e2 commit 6776c07

File tree

1 file changed

+74
-6
lines changed

1 file changed

+74
-6
lines changed

README.rst

Lines changed: 74 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,75 @@
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+
Compatibility
23+
-------------
24+
25+
- Python 3.6 – 3.13
26+
27+
Installation
28+
------------
29+
30+
Install from PyPI:
31+
32+
.. code-block:: bash
33+
34+
pip install xarm-python-sdk
35+
36+
Quick Start
37+
-----------
38+
39+
.. code-block:: python
40+
41+
from xarm.wrapper import XArmAPI
42+
43+
# Connect to the robot
44+
arm = XArmAPI('192.168.1.100') # Replace with your robot's IP address
45+
46+
# Enable motion
47+
arm.motion_enable(enable=True)
48+
49+
# Set robot to ready state
50+
arm.set_mode(0) # Position control mode
51+
arm.set_state(0) # Set to ready state
52+
53+
# Move to a target position
54+
arm.set_position(x=300, y=0, z=200, roll=180, pitch=0, yaw=0, speed=100)
55+
56+
# Disconnect
57+
arm.disconnect()
58+
59+
Documentation
60+
-------------
61+
62+
Full documentation and examples are available at:
63+
64+
https://github.com/xArm-Developer/xArm-Python-SDK
65+
66+
Website: https://www.ufactory.cc/
67+
68+
Release Note: https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/README.md#update-summary
69+
70+
Bug Reports: [email protected]
71+
72+
License
73+
-------
74+
75+
- License: BSD 3-Clause License. See `LICENSE <https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/LICENSE>`_ for details.

0 commit comments

Comments
 (0)