xarm-python-sdk 1.15.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. xarm/__init__.py +2 -0
  2. xarm/build_backend.py +17 -0
  3. xarm/core/__init__.py +2 -0
  4. xarm/core/comm/__init__.py +5 -0
  5. xarm/core/comm/base.py +303 -0
  6. xarm/core/comm/serial_port.py +44 -0
  7. xarm/core/comm/socket_port.py +150 -0
  8. xarm/core/comm/uxbus_cmd_protocol.py +100 -0
  9. xarm/core/config/__init__.py +0 -0
  10. xarm/core/config/x_code.py +1427 -0
  11. xarm/core/config/x_config.py +553 -0
  12. xarm/core/utils/__init__.py +3 -0
  13. xarm/core/utils/convert.py +124 -0
  14. xarm/core/utils/crc16.py +76 -0
  15. xarm/core/utils/debug_print.py +21 -0
  16. xarm/core/utils/log.py +98 -0
  17. xarm/core/version.py +1 -0
  18. xarm/core/wrapper/__init__.py +11 -0
  19. xarm/core/wrapper/uxbus_cmd.py +1457 -0
  20. xarm/core/wrapper/uxbus_cmd_ser.py +94 -0
  21. xarm/core/wrapper/uxbus_cmd_tcp.py +305 -0
  22. xarm/tools/__init__.py +0 -0
  23. xarm/tools/blockly/__init__.py +1 -0
  24. xarm/tools/blockly/_blockly_base.py +416 -0
  25. xarm/tools/blockly/_blockly_handler.py +1338 -0
  26. xarm/tools/blockly/_blockly_highlight.py +94 -0
  27. xarm/tools/blockly/_blockly_node.py +61 -0
  28. xarm/tools/blockly/_blockly_tool.py +480 -0
  29. xarm/tools/blockly_tool.py +1864 -0
  30. xarm/tools/gcode.py +90 -0
  31. xarm/tools/list_ports.py +39 -0
  32. xarm/tools/modbus_tcp.py +205 -0
  33. xarm/tools/threads.py +30 -0
  34. xarm/tools/utils.py +36 -0
  35. xarm/version.py +1 -0
  36. xarm/wrapper/__init__.py +1 -0
  37. xarm/wrapper/studio_api.py +34 -0
  38. xarm/wrapper/xarm_api.py +4416 -0
  39. xarm/x3/__init__.py +2 -0
  40. xarm/x3/base.py +2638 -0
  41. xarm/x3/base_board.py +198 -0
  42. xarm/x3/code.py +62 -0
  43. xarm/x3/decorator.py +104 -0
  44. xarm/x3/events.py +166 -0
  45. xarm/x3/ft_sensor.py +264 -0
  46. xarm/x3/gpio.py +457 -0
  47. xarm/x3/grammar_async.py +21 -0
  48. xarm/x3/grammar_coroutine.py +24 -0
  49. xarm/x3/gripper.py +830 -0
  50. xarm/x3/modbus_tcp.py +84 -0
  51. xarm/x3/parse.py +110 -0
  52. xarm/x3/record.py +216 -0
  53. xarm/x3/report.py +204 -0
  54. xarm/x3/robotiq.py +220 -0
  55. xarm/x3/servo.py +485 -0
  56. xarm/x3/studio.py +138 -0
  57. xarm/x3/track.py +424 -0
  58. xarm/x3/utils.py +43 -0
  59. xarm/x3/xarm.py +1928 -0
  60. xarm_python_sdk-1.15.2.dist-info/METADATA +103 -0
  61. xarm_python_sdk-1.15.2.dist-info/RECORD +63 -0
  62. xarm_python_sdk-1.15.2.dist-info/WHEEL +4 -0
  63. xarm_python_sdk-1.15.2.dist-info/licenses/LICENSE +27 -0
@@ -0,0 +1,103 @@
1
+ Metadata-Version: 2.4
2
+ Name: xarm-python-sdk
3
+ Version: 1.15.2
4
+ Summary: Python SDK for UFACTORY robotic arm 850, xArm 5/6/7, and Lite6.
5
+ Project-URL: Homepage, https://www.ufactory.cc
6
+ Project-URL: Documentation, https://github.com/xArm-Developer/xArm-Python-SDK/doc/api/xarm_api.md
7
+ Project-URL: Repository, https://github.com/xArm-Developer/xArm-Python-SDK.git
8
+ Project-URL: Issues, https://github.com/xArm-Developer/xArm-Python-SDK/issues
9
+ Author-email: Vinman <vinman.wen@ufactory.cc>
10
+ Maintainer-email: Vinman <vinman.wen@ufactory.cc>, Minna <minna.zhong@ufactory.cc>
11
+ License-File: LICENSE
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.5
17
+ Classifier: Programming Language :: Python :: 3.6
18
+ Classifier: Programming Language :: Python :: 3.7
19
+ Classifier: Programming Language :: Python :: 3.8
20
+ Classifier: Programming Language :: Python :: 3.9
21
+ Classifier: Programming Language :: Python :: 3.10
22
+ Classifier: Programming Language :: Python :: 3.11
23
+ Classifier: Programming Language :: Python :: 3.12
24
+ Classifier: Programming Language :: Python :: 3.13
25
+ Classifier: Topic :: Software Development
26
+ Requires-Python: >=3.5
27
+ Description-Content-Type: text/x-rst
28
+
29
+ xarm-python-sdk
30
+ ===============
31
+
32
+ .. image:: https://badge.fury.io/py/xarm-python-sdk.svg
33
+ :target: https://pypi.org/project/xarm-python-sdk/
34
+
35
+ .. image:: https://img.shields.io/github/license/xArm-Developer/xArm-Python-SDK.svg
36
+ :target: https://github.com/xArm-Developer/xArm-Python-SDK/blob/main/LICENSE
37
+
38
+ .. image:: https://img.shields.io/pypi/pyversions/xarm-python-sdk.svg
39
+ :target: https://pypi.org/project/xarm-python-sdk/
40
+
41
+ Official Python SDK for UFACTORY robots.
42
+
43
+ Supported Products
44
+ ------------------
45
+
46
+ - UFACTORY xArm 5/6/7
47
+ - UFACTORY 850
48
+ - UFACTORY Lite 6
49
+
50
+ Compatibility
51
+ -------------
52
+
53
+ - Python 3.5 - 3.13
54
+
55
+ Installation
56
+ ------------
57
+
58
+ Install from PyPI:
59
+
60
+ .. code-block:: bash
61
+
62
+ pip install xarm-python-sdk
63
+
64
+ Quick Start
65
+ -----------
66
+
67
+ .. code-block:: python
68
+
69
+ from xarm.wrapper import XArmAPI
70
+
71
+ # Connect to the robot
72
+ arm = XArmAPI('192.168.1.100') # Replace with your robot's IP address
73
+
74
+ # Enable motion
75
+ arm.motion_enable(enable=True)
76
+
77
+ # Set robot to ready state
78
+ arm.set_mode(0) # Position control mode
79
+ arm.set_state(0) # Set to ready state
80
+
81
+ # Move to a target position
82
+ arm.set_position(x=300, y=0, z=200, roll=180, pitch=0, yaw=0, speed=100)
83
+
84
+ # Disconnect
85
+ arm.disconnect()
86
+
87
+ Documentation
88
+ -------------
89
+
90
+ Full documentation and examples are available at:
91
+
92
+ https://github.com/xArm-Developer/xArm-Python-SDK
93
+
94
+ Website: https://www.ufactory.cc/
95
+
96
+ Release Note: https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/README.md#update-summary
97
+
98
+ Bug Reports: support@ufactory.cc
99
+
100
+ License
101
+ -------
102
+
103
+ - License: BSD 3-Clause License. See `LICENSE <https://github.com/xArm-Developer/xArm-Python-SDK/blob/master/LICENSE>`_ for details.
@@ -0,0 +1,63 @@
1
+ xarm/__init__.py,sha256=2CKJT_vhKqV0A16d4hLVdjZFIWZBTp6TSOL7pVpYRi0,62
2
+ xarm/build_backend.py,sha256=_dGolA-nNZgrP8WuYF8f8UZiccM1GJHDitYfx5IohgM,542
3
+ xarm/version.py,sha256=5GGabp58ouF__ZRILEKmrxLjEbXaO6NcJH1IWtKpOKQ,24
4
+ xarm/core/__init__.py,sha256=ncSkttNWMpFRwBCjeGsS0EqkAlEdP3Y6_tLTeBpoKrc,106
5
+ xarm/core/version.py,sha256=IMjkMO3twhQzluVTo8Z6rE7Eg-9U79_LGKMcsWLKBkY,22
6
+ xarm/core/comm/__init__.py,sha256=afSeF06Y9TJzRyoH6i9KTvlTwZYV9STncBF_ClQLLcs,111
7
+ xarm/core/comm/base.py,sha256=3FiIkaOT6K314889aHxOwUVg0ywH41zNVNwX3ceChBM,11508
8
+ xarm/core/comm/serial_port.py,sha256=tZrZ87N5dVJJA5OZ4CXNPeGk-2NJA0J3PIrGlRI47Ks,1620
9
+ xarm/core/comm/socket_port.py,sha256=5RWkDiqRyH3GHST7t3XSFFbQW5Sl0JFk7SwBn4MY0oM,5841
10
+ xarm/core/comm/uxbus_cmd_protocol.py,sha256=mTxYsWMFcFEqmVcVPkbd4nnC77sELkgd7ruRIbNchaw,3312
11
+ xarm/core/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
12
+ xarm/core/config/x_code.py,sha256=vt9VY_gqxuPdx3bxmdfUc0zLJkhte-jQazcvMkYqXsg,48859
13
+ xarm/core/config/x_config.py,sha256=cW2OIeFf5UWY5e21oy2GIAFR9pr7u6qFE10yx6YwPkA,16310
14
+ xarm/core/utils/__init__.py,sha256=uML68qseHDc8MK-QCxnjBOVSRuaD1-jq1xc65aaSrfY,44
15
+ xarm/core/utils/convert.py,sha256=nAatENB9c_citBc_sr4kTG8r-Onis-zBsgO4m_3PE8E,2797
16
+ xarm/core/utils/crc16.py,sha256=xlKXZMH0W6zaCXDsBqPTIAyeZB0ry4a9lmrTSIDiixY,3681
17
+ xarm/core/utils/debug_print.py,sha256=xb05bXe18VvpHYHQFXsPI5eimw5vzcCg_vXiOUJ9aL4,434
18
+ xarm/core/utils/log.py,sha256=9_l4Sxd1e5QdxIUFwZDgQc0NP16ZfpGvpRPasjXbuiY,3126
19
+ xarm/core/wrapper/__init__.py,sha256=6uxCDanP8gEOHjBZlIwjqiajm0Ug08owbxhzNogtRuQ,252
20
+ xarm/core/wrapper/uxbus_cmd.py,sha256=qk3fGstXqyzpbaGjnZh7ULMWtZ8ZUYGikHDuWUCcyII,63011
21
+ xarm/core/wrapper/uxbus_cmd_ser.py,sha256=mXxTnG3qY3LAKP3ZH2I0M6hCR7EnZgv8A9xKf3fhNFg,3164
22
+ xarm/core/wrapper/uxbus_cmd_tcp.py,sha256=f3q6IX1S68AEZrl8f8acB98Zm0nF8k3uzoexOrYClBo,12251
23
+ xarm/tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
24
+ xarm/tools/blockly_tool.py,sha256=-H7wj1W_B6Gr9ocFMNcBWkAzBhdamU-yaZ45R1iPNWM,107412
25
+ xarm/tools/gcode.py,sha256=OylOZy8P7bNHVS8X9RxjzMVK3awJFISskhNUq39OJUc,3272
26
+ xarm/tools/list_ports.py,sha256=iBPk60s8z43FusrcRqC_7065waZ-yxSvLp97f-QUbts,1218
27
+ xarm/tools/modbus_tcp.py,sha256=AHGVLJxSxFWO334lFDu1--t79ineNAYo7S3ErsruLQY,8374
28
+ xarm/tools/threads.py,sha256=6uDFsxDcQOFo3GgGSVsBBuwnjTpKmG4ezSgjC4XrVyw,696
29
+ xarm/tools/utils.py,sha256=biiODoC4n0cNaBGOvD9gEe-_Rv_lzmoXcKvuP00ygZ8,937
30
+ xarm/tools/blockly/__init__.py,sha256=jX1EpBaK4e9QSzkX9dmPNQpxmyUEPAkuJ-qOQgkbm10,38
31
+ xarm/tools/blockly/_blockly_base.py,sha256=peeeQba9Bmvb5UwBm10RBot-E0Lrkv2tbWYc4Rr7Sr0,19941
32
+ xarm/tools/blockly/_blockly_handler.py,sha256=pHnxBt48uM09_4OgX20NIwfOzztCrIiPU7uSpgvicrs,74577
33
+ xarm/tools/blockly/_blockly_highlight.py,sha256=LXQf9_AL1FZAXQJrmyG8vx3ENd55m3CSyPtgPxmbiaw,1989
34
+ xarm/tools/blockly/_blockly_node.py,sha256=1V3mBLJMIxlDy7ovO-W3gOYtg2iGQyAlxPTtIUvK-z8,1752
35
+ xarm/tools/blockly/_blockly_tool.py,sha256=Xq9xfWxFqrXSrHerz839MxKlZJYc4ALe-Lfk4qCT4bY,33676
36
+ xarm/wrapper/__init__.py,sha256=XFA5Am2t0ZOBifxc1AEhcx9n0B5msCn-lFMqGZgAZDE,30
37
+ xarm/wrapper/studio_api.py,sha256=fnUXK4b7n95dEY5aPbu0k6cbKICUz8zuW39-GMmuWAI,1308
38
+ xarm/wrapper/xarm_api.py,sha256=w9OtrKotEcf9SUezavhNt4G0pZxW1nikB3jCguHbm7M,206843
39
+ xarm/x3/__init__.py,sha256=0WemS_MgTReeWyhJ0c-tA1P110W-mdMPt3ZUX5zKjEM,50
40
+ xarm/x3/base.py,sha256=UMK260HE4H4DkMyHvGWlrceMI7KiVyEh1fGKZo0U6MQ,119745
41
+ xarm/x3/base_board.py,sha256=H1tKP-Ckp6xnl8HTi1Tzor-QsqlJLqTPvkOAiz57KOY,7318
42
+ xarm/x3/code.py,sha256=bECOw6dlTfYm91PJSHhIRLgIN3ddX6FSLaxu8ApIkbM,2808
43
+ xarm/x3/decorator.py,sha256=VBH1GDFTuMVGBQP4qGh6Q-hn8dTc40fz2MIw1pVU9UQ,3613
44
+ xarm/x3/events.py,sha256=Uyg-1MSljZCwEhe2pe-f7ECWZ7e0VO5cdjEucS34cbk,7430
45
+ xarm/x3/ft_sensor.py,sha256=g_ZoV8TlIBiAoXHU40RMNdcNEOTams9yOnM-gAP8x6Q,12311
46
+ xarm/x3/gpio.py,sha256=m6gUzmABmPr24lU5uUxn-8Pi4JjoC1Dihy71wgYm2sA,21000
47
+ xarm/x3/grammar_async.py,sha256=8j63CAVWMISP61GV2UNvl1mM3ffC-tH2ZCmyrzfcmKU,582
48
+ xarm/x3/grammar_coroutine.py,sha256=CejKEFc6MMnVkuQxhzEj9cptzoXbtlFXXiPhivFOvz0,630
49
+ xarm/x3/gripper.py,sha256=HolHW1lFtzEJe44WOymLT0qmSXdmGhZvtBa5nbgjtjw,36142
50
+ xarm/x3/modbus_tcp.py,sha256=hMIoPtnWD_XeLTFdTLCUZd9WiJ-2kCFqs-asSfiXceY,2584
51
+ xarm/x3/parse.py,sha256=ORAm3seAw2Z-vRjPZNWNouvMw7VSTquYW7UAXlzCzSw,4270
52
+ xarm/x3/record.py,sha256=O5Chs2hkNKQwywHAnYZZBBUL_eNLmpVoMpaklR1uoAU,9567
53
+ xarm/x3/report.py,sha256=Ik7NDTAU4O87wA-Eg__6q74F1bqQ2T-awJI8OLMP0e8,10044
54
+ xarm/x3/robotiq.py,sha256=xtK3CFbO71TNKRAvDA1P9BsW9eiseiRMp5xydhYsalI,10399
55
+ xarm/x3/servo.py,sha256=4VW4pZlGZJmQyehawuaF642gWEIfDyjFqU7jLB771VE,17256
56
+ xarm/x3/studio.py,sha256=IhqESolfdVUZBaq1yaXnI2U_FwTFO5OPSI0CDLrtzAI,4535
57
+ xarm/x3/track.py,sha256=MKIiZDuWrlqHlb6tabBqqg7CiwwwGOpdlw-6u6Wqg7s,20075
58
+ xarm/x3/utils.py,sha256=yz6c5RPBx0KZNyqqlS2cN0lQwBbBpK3IW-1UXWdL1Vo,1143
59
+ xarm/x3/xarm.py,sha256=8dCXQ-O9QO9Q1OaHQ6CnOnTV1cZyzRqkqy1xOrHb1Os,99921
60
+ xarm_python_sdk-1.15.2.dist-info/METADATA,sha256=gF1B1Y33J0FmXXre_FEwbLCS7-X0480T7JfM7mCMgtQ,3021
61
+ xarm_python_sdk-1.15.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
62
+ xarm_python_sdk-1.15.2.dist-info/licenses/LICENSE,sha256=PxSgnJeq5UbaRZ4TXRJXw7o3ppLsGmvkYo2geNOLdaQ,1521
63
+ xarm_python_sdk-1.15.2.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.27.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,27 @@
1
+ Copyright (c) 2018, UFACTORY Inc.
2
+
3
+ All rights reserved.
4
+
5
+ Redistribution and use in source and binary forms, with or without modification,
6
+ are permitted provided that the following conditions are met:
7
+
8
+ * Redistributions of source code must retain the above copyright notice,
9
+ this list of conditions and the following disclaimer.
10
+ * Redistributions in binary form must reproduce the above copyright notice,
11
+ this list of conditions and the following disclaimer in the documentation
12
+ and/or other materials provided with the distribution.
13
+ * Neither the name of the copyright holder nor the names of its contributors
14
+ may be used to endorse or promote products derived from this software
15
+ without specific prior written permission.
16
+
17
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
21
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.