codroid-robot-sdk 2.1.2__tar.gz → 2.1.4__tar.gz

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 (57) hide show
  1. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/.gitignore +95 -95
  2. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/LICENSE.txt +18 -18
  3. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/PKG-INFO +2 -2
  4. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/README.md +213 -213
  5. codroid_robot_sdk-2.1.2/CHANGELOG.md → codroid_robot_sdk-2.1.4/RELEASE_NOTES.md +90 -65
  6. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/01-quick-start.md +160 -160
  7. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/02-concepts.md +167 -167
  8. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/03-api-reference-codroidclient.md +945 -945
  9. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/04-api-reference-motion.md +324 -324
  10. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/05-api-reference-types.md +397 -397
  11. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/06-api-reference-cri.md +321 -321
  12. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/07-api-reference-io-register.md +247 -247
  13. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/08-api-reference-utilities.md +321 -321
  14. codroid_robot_sdk-2.1.2/docs/CodroidPython-SDK-Manual-v2.1.2-en.md → codroid_robot_sdk-2.1.4/docs/CodroidPython-SDK-Manual-v2.1.4-en.md +2939 -2939
  15. codroid_robot_sdk-2.1.2/docs/CodroidPython-SDK-Manual-v2.1.2-zh.md → codroid_robot_sdk-2.1.4/docs/CodroidPython-SDK-Manual-v2.1.4-zh.md +3468 -2938
  16. codroid_robot_sdk-2.1.4/docs/CodroidPython-SDK-Manual-v2.1.4-zh.pdf +0 -0
  17. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/docs/README.md +74 -74
  18. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/01_basic_usage.py +93 -93
  19. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/02_run_script.py +88 -88
  20. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/03_run_project.py +80 -80
  21. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/04_global_value.py +64 -64
  22. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/05_rs485.py +65 -65
  23. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/06_jog_mode.py +87 -87
  24. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/07_move_to.py +131 -131
  25. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/08_move.py +211 -186
  26. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/09_move_path.py +97 -97
  27. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/10_control_commands.py +74 -74
  28. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/11_io_demo.py +66 -66
  29. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/12_register_demo.py +59 -59
  30. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/13_cri_realtime.py +146 -146
  31. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/14_robot_parameters.py +202 -202
  32. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/15_sync_motion.py +141 -138
  33. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/codroid_cri_test.py +279 -279
  34. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/examples/codroid_test.py +308 -308
  35. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/pyproject.toml +71 -71
  36. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/Codroid.py +1697 -1694
  37. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/__about__.py +4 -4
  38. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/__init__.py +87 -87
  39. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/async_tcp_client.py +229 -229
  40. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/client.py +100 -100
  41. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/console.py +80 -80
  42. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/console_utf8.py +31 -31
  43. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/cri_realtime_dispatcher.py +85 -85
  44. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/cri_realtime_packet_parser.py +261 -261
  45. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/define.py +702 -702
  46. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/exceptions.py +15 -15
  47. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/publish.py +42 -42
  48. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/robot_motion.py +86 -84
  49. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/robot_settings.py +243 -243
  50. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/trajectory.py +302 -302
  51. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/types.py +47 -47
  52. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/utils.py +75 -75
  53. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/update1.md +439 -439
  54. codroid_robot_sdk-2.1.2/.claude/settings.local.json +0 -11
  55. codroid_robot_sdk-2.1.2/docs/CodroidPython-SDK-Manual-v2.1.2-en.pdf +0 -0
  56. codroid_robot_sdk-2.1.2/docs/CodroidPython-SDK-Manual-v2.1.2-zh.pdf +0 -0
  57. {codroid_robot_sdk-2.1.2 → codroid_robot_sdk-2.1.4}/src/codroid/py.typed +0 -0
@@ -1,96 +1,96 @@
1
- # === 编译产物目录 (Build Directories) ===
2
- build/
3
- build_linux/
4
- build_windows/
5
- build_msvc/
6
- bin/
7
- lib/
8
- out/
9
- up.md
10
-
11
- # === 编译器产生的中间文件 (Objects & Libraries) ===
12
- *.o
13
- *.obj
14
- *.so
15
- *.a
16
- *.lib
17
- *.dll
18
- *.exe
19
- *.pdb
20
- *.exp
21
- *.ilk
22
-
23
- # === CMake 产生的中间文件 (CMake Artifacts) ===
24
- CMakeCache.txt
25
- CMakeFiles/
26
- CMakeScripts/
27
- cmake_install.cmake
28
- Makefile
29
- install_manifest.txt
30
- compile_commands.json
31
- # 之前脚本自动生成的交叉编译文件
32
- mingw-toolchain.cmake
33
-
34
- # === IDE 配置文件 (IDE Specific) ===
35
- # VS Code
36
- .vscode/
37
- .vscode/settings.json
38
- .vscode/tasks.json
39
- .vscode/launch.json
40
- .vscode/c_cpp_properties.json
41
- # Visual Studio (MSVC)
42
- .vs/
43
- *.sln
44
- *.vcxproj
45
- *.filters
46
- *.user
47
- *.suo
48
- *.db
49
- *.opendb
50
-
51
- # === 系统与临时文件 (System & Temp) ===
52
- .DS_Store
53
- Thumbs.db
54
- *.tmp
55
- *.log
56
- *.bak
57
-
58
- # Python 字节码
59
- __pycache__/
60
- *.py[cod]
61
- *$py.class
62
-
63
- # 虚拟环境
64
- .venv/
65
- env/
66
- venv/
67
- .hatch/
68
-
69
- # 编译输出
70
- dist/
71
- build/
72
- *.egg-info/
73
-
74
- # 文档输出(mkdocs 已移除,site/ 不再生成)
75
- # site/
76
-
77
- # IDE 设置
78
- .vscode/
79
- .idea/
80
-
81
- # 单元测试与覆盖率
82
- .pytest_cache/
83
- .tox/
84
- .coverage
85
- htmlcov/
86
-
87
- # 本地环境配置文件
88
- .env
89
-
90
- # 内部协议/设计文档(本地副本,不入库)
91
- AGENTS.md
92
- PROTOCOL_LINE_BY_LINE.md
93
- SDK_API_AND_DESIGN.md
94
- TRAJECTORY_ALGORITHM.md
95
- plan.md
1
+ # === 编译产物目录 (Build Directories) ===
2
+ build/
3
+ build_linux/
4
+ build_windows/
5
+ build_msvc/
6
+ bin/
7
+ lib/
8
+ out/
9
+ up.md
10
+
11
+ # === 编译器产生的中间文件 (Objects & Libraries) ===
12
+ *.o
13
+ *.obj
14
+ *.so
15
+ *.a
16
+ *.lib
17
+ *.dll
18
+ *.exe
19
+ *.pdb
20
+ *.exp
21
+ *.ilk
22
+
23
+ # === CMake 产生的中间文件 (CMake Artifacts) ===
24
+ CMakeCache.txt
25
+ CMakeFiles/
26
+ CMakeScripts/
27
+ cmake_install.cmake
28
+ Makefile
29
+ install_manifest.txt
30
+ compile_commands.json
31
+ # 之前脚本自动生成的交叉编译文件
32
+ mingw-toolchain.cmake
33
+
34
+ # === IDE 配置文件 (IDE Specific) ===
35
+ # VS Code
36
+ .vscode/
37
+ .vscode/settings.json
38
+ .vscode/tasks.json
39
+ .vscode/launch.json
40
+ .vscode/c_cpp_properties.json
41
+ # Visual Studio (MSVC)
42
+ .vs/
43
+ *.sln
44
+ *.vcxproj
45
+ *.filters
46
+ *.user
47
+ *.suo
48
+ *.db
49
+ *.opendb
50
+
51
+ # === 系统与临时文件 (System & Temp) ===
52
+ .DS_Store
53
+ Thumbs.db
54
+ *.tmp
55
+ *.log
56
+ *.bak
57
+
58
+ # Python 字节码
59
+ __pycache__/
60
+ *.py[cod]
61
+ *$py.class
62
+
63
+ # 虚拟环境
64
+ .venv/
65
+ env/
66
+ venv/
67
+ .hatch/
68
+
69
+ # 编译输出
70
+ dist/
71
+ build/
72
+ *.egg-info/
73
+
74
+ # 文档输出(mkdocs 已移除,site/ 不再生成)
75
+ # site/
76
+
77
+ # IDE 设置
78
+ .vscode/
79
+ .idea/
80
+
81
+ # 单元测试与覆盖率
82
+ .pytest_cache/
83
+ .tox/
84
+ .coverage
85
+ htmlcov/
86
+
87
+ # 本地环境配置文件
88
+ .env
89
+
90
+ # 内部协议/设计文档(本地副本,不入库)
91
+ AGENTS.md
92
+ PROTOCOL_LINE_BY_LINE.md
93
+ SDK_API_AND_DESIGN.md
94
+ TRAJECTORY_ALGORITHM.md
95
+ plan.md
96
96
  aaa.txt
@@ -1,18 +1,18 @@
1
- MIT License
2
-
3
- Copyright (c) 2026-present guybod <b13140185898@outlook.com>
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
6
- associated documentation files (the "Software"), to deal in the Software without restriction, including
7
- without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
9
- following conditions:
10
-
11
- The above copyright notice and this permission notice shall be included in all copies or substantial
12
- portions of the Software.
13
-
14
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
15
- LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
16
- EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
17
- IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
18
- USE OR OTHER DEALINGS IN THE SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026-present guybod <b13140185898@outlook.com>
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
6
+ associated documentation files (the "Software"), to deal in the Software without restriction, including
7
+ without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
9
+ following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in all copies or substantial
12
+ portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
15
+ LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
16
+ EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
17
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
18
+ USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: codroid-robot-sdk
3
- Version: 2.1.2
3
+ Version: 2.1.4
4
4
  Summary: Codroid robot controller Python SDK (TCP/CRI, typed motion API)
5
5
  Project-URL: Documentation, https://guybod.github.io/CodroidSDK/
6
6
  Project-URL: Issues, https://github.com/guybod/CodroidSDK/issues
@@ -154,7 +154,7 @@ with CodroidClient(host="192.168.1.136") as robot:
154
154
 
155
155
  `MotionWaitOptions` 可调整超时、轮询间隔、到达容差等参数。
156
156
 
157
- **Breaking(2.1.1)**:公开 API 与 C# 一致,统一 **PascalCase**(`Connect`、`SwitchOn`、`GetDi`、`MovJ`、`SetToolFrame` 等);`CriData` 为属性;`move_j` / `switch_on` 等 snake_case 已移除。见 [CHANGELOG.md](CHANGELOG.md)。
157
+ **Breaking(2.1.1)**:公开 API 与 C# 一致,统一 **PascalCase**(`Connect`、`SwitchOn`、`GetDi`、`MovJ`、`SetToolFrame` 等);`CriData` 为属性;`move_j` / `switch_on` 等 snake_case 已移除。见 [RELEASE_NOTES.md](RELEASE_NOTES.md)。
158
158
 
159
159
  ## Windows 控制台 UTF-8
160
160
 
@@ -1,213 +1,213 @@
1
- # Codroid 机器人 Python SDK
2
-
3
- Codroid 控制器 Python SDK,提供 TCP 控制、实时数据(CRI)与轨迹相关能力。
4
-
5
- [![PyPI - Version](https://img.shields.io/pypi/v/codroid-robot-sdk.svg)](https://pypi.org/project/codroid-robot-sdk)
6
- [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/codroid-robot-sdk.svg)](https://pypi.org/project/codroid-robot-sdk)
7
-
8
- ---
9
-
10
- ## 教程:5 分钟跑通
11
-
12
- ### 1) 环境准备
13
-
14
- - Python 3.7 及以上(建议 3.8+)
15
- - 机器人控制器与运行脚本的电脑网络互通
16
-
17
- ### 2) 安装 SDK
18
-
19
- ```bash
20
- pip install codroid-robot-sdk
21
- ```
22
-
23
- 可选彩色终端输出:
24
-
25
- ```bash
26
- pip install "codroid-robot-sdk[color]"
27
- ```
28
-
29
- ### 3) 验证安装
30
-
31
- ```bash
32
- python3 -c "import codroid; print(codroid.__version__)"
33
- ```
34
-
35
- ### 4) 第一个控制脚本
36
-
37
- 新建 `demo.py`:
38
-
39
- ```python
40
- from codroid import CodroidControlInterface, InitConsoleUtf8
41
-
42
- InitConsoleUtf8() # Windows cmd 下中文日志不乱码;Linux 上为 no-op
43
-
44
- ROBOT_IP = "192.168.1.136" # 改成实际控制器 IP
45
-
46
- with CodroidControlInterface(host=ROBOT_IP) as robot:
47
- robot.ToRemote()
48
- robot.SwitchOn()
49
- ```
50
-
51
- 运行:
52
-
53
- ```bash
54
- python3 demo.py
55
- ```
56
-
57
- ### 5) 常见下一步
58
-
59
- - 进入远程模式后,继续调用运动、IO、寄存器等 API。
60
- - 需要持续收包和 publish 分发时,改用 `CodroidClient`。
61
- - 运动示例见 `examples/08_move.py`(四组合路径)与 `examples/codroid_test.py motion`。
62
-
63
- ## 运动 API(2.1+)
64
-
65
- 协议 JSON 未变;业务层须用类型区分关节与 TCP,避免把位姿当关节角下发。
66
-
67
- | 业务类型 | 工厂 | 用于 |
68
- |----------|------|------|
69
- | `JointPoint` | `Degrees([j1..j6])` | 六轴角(度) |
70
- | `CartesianPoint` | `MmDeg([x,y,z,rx,ry,rz])` | TCP(mm + 度) |
71
- | | `MmDegWithRef(pose, ref_joints)` | TCP + 逆解参考关节(推荐) |
72
-
73
- | 门面 API | 说明 |
74
- |----------|------|
75
- | `MovJ(target, speed, acceleration)` | 目标:`JointPoint` 或 `CartesianPoint` |
76
- | `MovL(target, speed, acceleration)` | 目标:`CartesianPoint` 或 `JointPoint` |
77
- | `Move([MoveInstruction.MovJ(...), ...])` | 多段路径 |
78
- | `MovJSync(target, speed, acc, wait?)` | 阻塞式关节运动,等待到达目标 |
79
- | `MovLSync(target, speed, acc, wait?)` | 阻塞式直线运动,等待到达目标 |
80
- | `MovCSync(middle, target, speed, acc, wait?)` | 阻塞式圆弧运动 |
81
- | `MoveSync(instructions, wait?)` | 阻塞式路径执行 |
82
-
83
- 四组合路径示例(与 C++ `04_move` 一致):
84
-
85
- ```python
86
- from codroid import (
87
- CodroidClient,
88
- JointPoint,
89
- CartesianPoint,
90
- MoveInstruction,
91
- InitConsoleUtf8,
92
- )
93
-
94
- InitConsoleUtf8()
95
-
96
- path = [
97
- MoveInstruction.MovJ(JointPoint.Degrees([0, 0, 90, 0, 90, 0]), speed=40, acc=100),
98
- MoveInstruction.MovJ(CartesianPoint.MmDeg([...]), speed=40, acc=100),
99
- MoveInstruction.MovL(CartesianPoint.MmDeg([...]), speed=150, acc=500),
100
- MoveInstruction.MovL(JointPoint.Degrees([0, 0, 0, 0, 0, 0]), speed=150, acc=500),
101
- ]
102
- robot.Move(path)
103
- ```
104
-
105
- 打包规则:`jp` 优先;仅 `cp` 时若未提供 `rj`,JSON 中带默认 `[20,20,20,20,20,20]`(度)。
106
-
107
- ### 阻塞式运动 API
108
-
109
- `*Sync` 方法发送运动指令后自动轮询 CRI 数据,直到机器人稳定到达目标。需要先启动 CRI 数据推送(`StartListenUdp`)。
110
-
111
- ```python
112
- from codroid import CodroidClient, JointPoint, MotionWaitOptions
113
-
114
- with CodroidClient(host="192.168.1.136") as robot:
115
- robot.ConnectRemoteAndSwitchOn()
116
- robot.StartListenUdp()
117
- robot.WaitForCriData() # 等待第一个 CRI 包到达
118
-
119
- # 阻塞式关节运动,使用默认等待参数
120
- robot.MovJSync(JointPoint.Degrees([0, 0, 90, 0, 90, 0]), speed=40, acceleration=100)
121
-
122
- # 自定义等待参数
123
- opts = MotionWaitOptions(timeout=30.0, joint_tolerance_deg=0.5)
124
- robot.MovLSync(CartesianPoint.MmDeg([400, 200, 500, 180, 0, 90]),
125
- speed=150, acceleration=500, wait=opts)
126
- ```
127
-
128
- `MotionWaitOptions` 可调整超时、轮询间隔、到达容差等参数。
129
-
130
- **Breaking(2.1.1)**:公开 API 与 C# 一致,统一 **PascalCase**(`Connect`、`SwitchOn`、`GetDi`、`MovJ`、`SetToolFrame` 等);`CriData` 为属性;`move_j` / `switch_on` 等 snake_case 已移除。见 [CHANGELOG.md](CHANGELOG.md)。
131
-
132
- ## Windows 控制台 UTF-8
133
-
134
- 在 `cmd`(非 Windows Terminal)下运行含中文的示例时,请在入口调用:
135
-
136
- ```python
137
- from codroid import InitConsoleUtf8
138
-
139
- InitConsoleUtf8()
140
- ```
141
-
142
- 所有 `examples/*.py` 已在 `if __name__ == "__main__"` 首行调用。自建 CLI 请同样处理;`chcp 65001` 不能替代此调用。
143
-
144
- ## 教程:进阶连接方式
145
-
146
- `CodroidClient` 适用于后台持续接收、请求 `id` 配对、publish 分发:
147
-
148
- ```python
149
- from codroid import CodroidClient, InitConsoleUtf8
150
-
151
- InitConsoleUtf8()
152
-
153
- with CodroidClient(host="192.168.1.136") as robot:
154
- robot.ToRemote()
155
- robot.SwitchOn()
156
- ```
157
-
158
- ## 示例
159
-
160
- ```bash
161
- PYTHONPATH=src python examples/08_move.py --robot 192.168.8.136
162
- PYTHONPATH=src python examples/15_sync_motion.py --robot 192.168.8.136
163
- PYTHONPATH=src python examples/14_robot_parameters.py --robot 192.168.8.136
164
- PYTHONPATH=src python examples/codroid_test.py motion
165
- PYTHONPATH=src python examples/codroid_test.py s20
166
- PYTHONPATH=src python examples/codroid_test.py robotparam
167
- ```
168
-
169
- 机器人设置(协议 19.x):`GetRobotParameters`、`SetToolFrame`、`SetDefaultToolId` 等见 `examples/14_robot_parameters.py`。
170
-
171
- 寄存器与 S20 运动常量见仓库根目录 `AGENTS.md` §5.1。
172
-
173
- ## 常见问题
174
-
175
- ### `ModuleNotFoundError: No module named codroid`
176
-
177
- 未在当前 Python 环境安装 SDK。重新执行:
178
-
179
- ```bash
180
- pip install codroid-robot-sdk
181
- ```
182
-
183
- ### 脚本无响应或连接失败
184
-
185
- - 检查控制器 IP 与端口配置。
186
- - 检查本机与控制器网络连通性、防火墙策略。
187
- - 确认控制器处于可远程控制状态。
188
-
189
- ## 项目架构
190
-
191
- ```text
192
- src/codroid/
193
- ├── __init__.py # 公开 API 导出(含 __version__)
194
- ├── __about__.py # 版本号
195
- ├── Codroid.py # CodroidSession / CodroidControlInterface
196
- ├── client.py # CodroidClient
197
- ├── async_tcp_client.py # JsonStreamClient、TransportClient
198
- ├── define.py # DTO / 常量(JointPoint、MoveInstruction 等)
199
- ├── robot_motion.py # pack_move_point / pack_instruction
200
- ├── types.py # DTO 再导出
201
- ├── exceptions.py # 异常定义
202
- ├── publish.py # 发布订阅模型
203
- ├── trajectory.py # 轨迹生成
204
- ├── cri_realtime_packet_parser.py # CRI UDP 数据解析
205
- ├── cri_realtime_dispatcher.py # CRI 实时控制下发
206
- ├── console.py # PrintBanner
207
- ├── console_utf8.py # InitConsoleUtf8
208
- └── utils.py # 通用工具
209
- ```
210
-
211
- ## 许可证
212
-
213
- 本项目采用 [MIT](https://spdx.org/licenses/MIT.html) 许可证。
1
+ # Codroid 机器人 Python SDK
2
+
3
+ Codroid 控制器 Python SDK,提供 TCP 控制、实时数据(CRI)与轨迹相关能力。
4
+
5
+ [![PyPI - Version](https://img.shields.io/pypi/v/codroid-robot-sdk.svg)](https://pypi.org/project/codroid-robot-sdk)
6
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/codroid-robot-sdk.svg)](https://pypi.org/project/codroid-robot-sdk)
7
+
8
+ ---
9
+
10
+ ## 教程:5 分钟跑通
11
+
12
+ ### 1) 环境准备
13
+
14
+ - Python 3.7 及以上(建议 3.8+)
15
+ - 机器人控制器与运行脚本的电脑网络互通
16
+
17
+ ### 2) 安装 SDK
18
+
19
+ ```bash
20
+ pip install codroid-robot-sdk
21
+ ```
22
+
23
+ 可选彩色终端输出:
24
+
25
+ ```bash
26
+ pip install "codroid-robot-sdk[color]"
27
+ ```
28
+
29
+ ### 3) 验证安装
30
+
31
+ ```bash
32
+ python3 -c "import codroid; print(codroid.__version__)"
33
+ ```
34
+
35
+ ### 4) 第一个控制脚本
36
+
37
+ 新建 `demo.py`:
38
+
39
+ ```python
40
+ from codroid import CodroidControlInterface, InitConsoleUtf8
41
+
42
+ InitConsoleUtf8() # Windows cmd 下中文日志不乱码;Linux 上为 no-op
43
+
44
+ ROBOT_IP = "192.168.1.136" # 改成实际控制器 IP
45
+
46
+ with CodroidControlInterface(host=ROBOT_IP) as robot:
47
+ robot.ToRemote()
48
+ robot.SwitchOn()
49
+ ```
50
+
51
+ 运行:
52
+
53
+ ```bash
54
+ python3 demo.py
55
+ ```
56
+
57
+ ### 5) 常见下一步
58
+
59
+ - 进入远程模式后,继续调用运动、IO、寄存器等 API。
60
+ - 需要持续收包和 publish 分发时,改用 `CodroidClient`。
61
+ - 运动示例见 `examples/08_move.py`(四组合路径)与 `examples/codroid_test.py motion`。
62
+
63
+ ## 运动 API(2.1+)
64
+
65
+ 协议 JSON 未变;业务层须用类型区分关节与 TCP,避免把位姿当关节角下发。
66
+
67
+ | 业务类型 | 工厂 | 用于 |
68
+ |----------|------|------|
69
+ | `JointPoint` | `Degrees([j1..j6])` | 六轴角(度) |
70
+ | `CartesianPoint` | `MmDeg([x,y,z,rx,ry,rz])` | TCP(mm + 度) |
71
+ | | `MmDegWithRef(pose, ref_joints)` | TCP + 逆解参考关节(推荐) |
72
+
73
+ | 门面 API | 说明 |
74
+ |----------|------|
75
+ | `MovJ(target, speed, acceleration)` | 目标:`JointPoint` 或 `CartesianPoint` |
76
+ | `MovL(target, speed, acceleration)` | 目标:`CartesianPoint` 或 `JointPoint` |
77
+ | `Move([MoveInstruction.MovJ(...), ...])` | 多段路径 |
78
+ | `MovJSync(target, speed, acc, wait?)` | 阻塞式关节运动,等待到达目标 |
79
+ | `MovLSync(target, speed, acc, wait?)` | 阻塞式直线运动,等待到达目标 |
80
+ | `MovCSync(middle, target, speed, acc, wait?)` | 阻塞式圆弧运动 |
81
+ | `MoveSync(instructions, wait?)` | 阻塞式路径执行 |
82
+
83
+ 四组合路径示例(与 C++ `04_move` 一致):
84
+
85
+ ```python
86
+ from codroid import (
87
+ CodroidClient,
88
+ JointPoint,
89
+ CartesianPoint,
90
+ MoveInstruction,
91
+ InitConsoleUtf8,
92
+ )
93
+
94
+ InitConsoleUtf8()
95
+
96
+ path = [
97
+ MoveInstruction.MovJ(JointPoint.Degrees([0, 0, 90, 0, 90, 0]), speed=40, acc=100),
98
+ MoveInstruction.MovJ(CartesianPoint.MmDeg([...]), speed=40, acc=100),
99
+ MoveInstruction.MovL(CartesianPoint.MmDeg([...]), speed=150, acc=500),
100
+ MoveInstruction.MovL(JointPoint.Degrees([0, 0, 0, 0, 0, 0]), speed=150, acc=500),
101
+ ]
102
+ robot.Move(path)
103
+ ```
104
+
105
+ 打包规则:`jp` 优先;仅 `cp` 时若未提供 `rj`,JSON 中带默认 `[20,20,20,20,20,20]`(度)。
106
+
107
+ ### 阻塞式运动 API
108
+
109
+ `*Sync` 方法发送运动指令后自动轮询 CRI 数据,直到机器人稳定到达目标。需要先启动 CRI 数据推送(`StartListenUdp`)。
110
+
111
+ ```python
112
+ from codroid import CodroidClient, JointPoint, MotionWaitOptions
113
+
114
+ with CodroidClient(host="192.168.1.136") as robot:
115
+ robot.ConnectRemoteAndSwitchOn()
116
+ robot.StartListenUdp()
117
+ robot.WaitForCriData() # 等待第一个 CRI 包到达
118
+
119
+ # 阻塞式关节运动,使用默认等待参数
120
+ robot.MovJSync(JointPoint.Degrees([0, 0, 90, 0, 90, 0]), speed=40, acceleration=100)
121
+
122
+ # 自定义等待参数
123
+ opts = MotionWaitOptions(timeout=30.0, joint_tolerance_deg=0.5)
124
+ robot.MovLSync(CartesianPoint.MmDeg([400, 200, 500, 180, 0, 90]),
125
+ speed=150, acceleration=500, wait=opts)
126
+ ```
127
+
128
+ `MotionWaitOptions` 可调整超时、轮询间隔、到达容差等参数。
129
+
130
+ **Breaking(2.1.1)**:公开 API 与 C# 一致,统一 **PascalCase**(`Connect`、`SwitchOn`、`GetDi`、`MovJ`、`SetToolFrame` 等);`CriData` 为属性;`move_j` / `switch_on` 等 snake_case 已移除。见 [RELEASE_NOTES.md](RELEASE_NOTES.md)。
131
+
132
+ ## Windows 控制台 UTF-8
133
+
134
+ 在 `cmd`(非 Windows Terminal)下运行含中文的示例时,请在入口调用:
135
+
136
+ ```python
137
+ from codroid import InitConsoleUtf8
138
+
139
+ InitConsoleUtf8()
140
+ ```
141
+
142
+ 所有 `examples/*.py` 已在 `if __name__ == "__main__"` 首行调用。自建 CLI 请同样处理;`chcp 65001` 不能替代此调用。
143
+
144
+ ## 教程:进阶连接方式
145
+
146
+ `CodroidClient` 适用于后台持续接收、请求 `id` 配对、publish 分发:
147
+
148
+ ```python
149
+ from codroid import CodroidClient, InitConsoleUtf8
150
+
151
+ InitConsoleUtf8()
152
+
153
+ with CodroidClient(host="192.168.1.136") as robot:
154
+ robot.ToRemote()
155
+ robot.SwitchOn()
156
+ ```
157
+
158
+ ## 示例
159
+
160
+ ```bash
161
+ PYTHONPATH=src python examples/08_move.py --robot 192.168.8.136
162
+ PYTHONPATH=src python examples/15_sync_motion.py --robot 192.168.8.136
163
+ PYTHONPATH=src python examples/14_robot_parameters.py --robot 192.168.8.136
164
+ PYTHONPATH=src python examples/codroid_test.py motion
165
+ PYTHONPATH=src python examples/codroid_test.py s20
166
+ PYTHONPATH=src python examples/codroid_test.py robotparam
167
+ ```
168
+
169
+ 机器人设置(协议 19.x):`GetRobotParameters`、`SetToolFrame`、`SetDefaultToolId` 等见 `examples/14_robot_parameters.py`。
170
+
171
+ 寄存器与 S20 运动常量见仓库根目录 `AGENTS.md` §5.1。
172
+
173
+ ## 常见问题
174
+
175
+ ### `ModuleNotFoundError: No module named codroid`
176
+
177
+ 未在当前 Python 环境安装 SDK。重新执行:
178
+
179
+ ```bash
180
+ pip install codroid-robot-sdk
181
+ ```
182
+
183
+ ### 脚本无响应或连接失败
184
+
185
+ - 检查控制器 IP 与端口配置。
186
+ - 检查本机与控制器网络连通性、防火墙策略。
187
+ - 确认控制器处于可远程控制状态。
188
+
189
+ ## 项目架构
190
+
191
+ ```text
192
+ src/codroid/
193
+ ├── __init__.py # 公开 API 导出(含 __version__)
194
+ ├── __about__.py # 版本号
195
+ ├── Codroid.py # CodroidSession / CodroidControlInterface
196
+ ├── client.py # CodroidClient
197
+ ├── async_tcp_client.py # JsonStreamClient、TransportClient
198
+ ├── define.py # DTO / 常量(JointPoint、MoveInstruction 等)
199
+ ├── robot_motion.py # pack_move_point / pack_instruction
200
+ ├── types.py # DTO 再导出
201
+ ├── exceptions.py # 异常定义
202
+ ├── publish.py # 发布订阅模型
203
+ ├── trajectory.py # 轨迹生成
204
+ ├── cri_realtime_packet_parser.py # CRI UDP 数据解析
205
+ ├── cri_realtime_dispatcher.py # CRI 实时控制下发
206
+ ├── console.py # PrintBanner
207
+ ├── console_utf8.py # InitConsoleUtf8
208
+ └── utils.py # 通用工具
209
+ ```
210
+
211
+ ## 许可证
212
+
213
+ 本项目采用 [MIT](https://spdx.org/licenses/MIT.html) 许可证。