Metadata-Version: 2.4
Name: xarm-python-sdk
Version: 1.17.0
Summary: Python SDK for UFACTORY robotic arm 850, xArm 5/6/7, and Lite6.
Project-URL: Homepage, https://www.ufactory.cc
Project-URL: Documentation, https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/doc/api/xarm_api.md
Project-URL: Repository, https://github.com/xArm-Developer/xArm-Python-SDK.git
Project-URL: Issues, https://github.com/xArm-Developer/xArm-Python-SDK/issues
Author-email: Vinman <vinman.wen@ufactory.cc>
Maintainer-email: Vinman <vinman.wen@ufactory.cc>, Minna <minna.zhong@ufactory.cc>
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Requires-Python: >=3.5
Description-Content-Type: text/x-rst

xarm-python-sdk
===============

.. image:: https://badge.fury.io/py/xarm-python-sdk.svg
    :target: https://pypi.org/project/xarm-python-sdk/

.. image:: https://static.pepy.tech/badge/xarm-python-sdk
    :target: https://pepy.tech/projects/xarm-python-sdk

.. image:: https://img.shields.io/github/license/xArm-Developer/xArm-Python-SDK.svg
    :target: https://github.com/xArm-Developer/xArm-Python-SDK/blob/main/LICENSE

.. image:: https://img.shields.io/pypi/pyversions/xarm-python-sdk.svg
    :target: https://pypi.org/project/xarm-python-sdk/

Official Python SDK for UFACTORY robots.

Supported Products
------------------

- UFACTORY xArm 5/6/7
- UFACTORY 850
- UFACTORY Lite 6

Compatibility
-------------

- Python 3.5 - 3.13

Installation
------------

Install from PyPI:

.. code-block:: bash

    pip install xarm-python-sdk

Quick Start
-----------

.. code-block:: python

    from xarm.wrapper import XArmAPI

    # Connect to the robot
    arm = XArmAPI('192.168.1.100')  # Replace with your robot's IP address

    # Enable motion
    arm.motion_enable(enable=True)

    # Set robot to ready state
    arm.set_mode(0)    # Position control mode
    arm.set_state(0)   # Set to ready state

    # Move to a target position
    arm.set_position(x=300, y=0, z=200, roll=180, pitch=0, yaw=0, speed=100)

    # Disconnect
    arm.disconnect()

Documentation
-------------

Full documentation and examples are available at:

https://github.com/xArm-Developer/xArm-Python-SDK

Website: https://www.ufactory.cc/

Release Note: https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/README.md#update-summary

Bug Reports: support@ufactory.cc

License
-------

- License: BSD 3-Clause License. See `LICENSE <https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/LICENSE>`_ for details.
