codroid-robot-sdk 2.1.1__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 (55) hide show
  1. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/.gitignore +95 -96
  2. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/LICENSE.txt +18 -18
  3. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/PKG-INFO +30 -2
  4. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/README.md +213 -185
  5. codroid_robot_sdk-2.1.1/CHANGELOG.md → codroid_robot_sdk-2.1.4/RELEASE_NOTES.md +90 -52
  6. codroid_robot_sdk-2.1.4/docs/01-quick-start.md +160 -0
  7. codroid_robot_sdk-2.1.4/docs/02-concepts.md +167 -0
  8. codroid_robot_sdk-2.1.4/docs/03-api-reference-codroidclient.md +945 -0
  9. codroid_robot_sdk-2.1.4/docs/04-api-reference-motion.md +324 -0
  10. codroid_robot_sdk-2.1.4/docs/05-api-reference-types.md +397 -0
  11. codroid_robot_sdk-2.1.4/docs/06-api-reference-cri.md +321 -0
  12. codroid_robot_sdk-2.1.4/docs/07-api-reference-io-register.md +247 -0
  13. codroid_robot_sdk-2.1.4/docs/08-api-reference-utilities.md +321 -0
  14. codroid_robot_sdk-2.1.4/docs/CodroidPython-SDK-Manual-v2.1.4-en.md +2939 -0
  15. codroid_robot_sdk-2.1.4/docs/CodroidPython-SDK-Manual-v2.1.4-zh.md +3468 -0
  16. codroid_robot_sdk-2.1.4/docs/CodroidPython-SDK-Manual-v2.1.4-zh.pdf +0 -0
  17. codroid_robot_sdk-2.1.4/docs/README.md +74 -0
  18. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/01_basic_usage.py +93 -93
  19. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/02_run_script.py +88 -60
  20. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/03_run_project.py +80 -80
  21. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/04_global_value.py +64 -64
  22. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/05_rs485.py +65 -65
  23. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/06_jog_mode.py +87 -87
  24. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/07_move_to.py +131 -116
  25. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/08_move.py +211 -167
  26. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/09_move_path.py +97 -97
  27. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/10_control_commands.py +74 -74
  28. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/11_io_demo.py +66 -66
  29. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/12_register_demo.py +59 -59
  30. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/13_cri_realtime.py +146 -146
  31. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/14_robot_parameters.py +202 -202
  32. codroid_robot_sdk-2.1.4/examples/15_sync_motion.py +141 -0
  33. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/codroid_cri_test.py +279 -279
  34. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/examples/codroid_test.py +308 -308
  35. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/pyproject.toml +71 -86
  36. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/Codroid.py +1697 -1361
  37. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/__about__.py +4 -4
  38. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/__init__.py +87 -86
  39. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/async_tcp_client.py +229 -229
  40. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/client.py +100 -100
  41. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/console.py +80 -80
  42. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/console_utf8.py +31 -31
  43. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/cri_realtime_dispatcher.py +85 -85
  44. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/cri_realtime_packet_parser.py +261 -261
  45. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/define.py +702 -674
  46. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/exceptions.py +15 -15
  47. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/publish.py +42 -42
  48. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/robot_motion.py +86 -84
  49. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/robot_settings.py +243 -243
  50. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/trajectory.py +302 -302
  51. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/types.py +47 -47
  52. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/utils.py +75 -75
  53. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/update1.md +439 -439
  54. codroid_robot_sdk-2.1.1/mkdocs.yml +0 -34
  55. {codroid_robot_sdk-2.1.1 → codroid_robot_sdk-2.1.4}/src/codroid/py.typed +0 -0
@@ -1,97 +1,96 @@
1
- # === 编译产物目录 (Build Directories) ===
2
- build/
3
- build_linux/
4
- build_windows/
5
- build_msvc/
6
- bin/
7
- lib/
8
- out/
9
- docs/
10
- up.md
11
-
12
- # === 编译器产生的中间文件 (Objects & Libraries) ===
13
- *.o
14
- *.obj
15
- *.so
16
- *.a
17
- *.lib
18
- *.dll
19
- *.exe
20
- *.pdb
21
- *.exp
22
- *.ilk
23
-
24
- # === CMake 产生的中间文件 (CMake Artifacts) ===
25
- CMakeCache.txt
26
- CMakeFiles/
27
- CMakeScripts/
28
- cmake_install.cmake
29
- Makefile
30
- install_manifest.txt
31
- compile_commands.json
32
- # 之前脚本自动生成的交叉编译文件
33
- mingw-toolchain.cmake
34
-
35
- # === IDE 配置文件 (IDE Specific) ===
36
- # VS Code
37
- .vscode/
38
- .vscode/settings.json
39
- .vscode/tasks.json
40
- .vscode/launch.json
41
- .vscode/c_cpp_properties.json
42
- # Visual Studio (MSVC)
43
- .vs/
44
- *.sln
45
- *.vcxproj
46
- *.filters
47
- *.user
48
- *.suo
49
- *.db
50
- *.opendb
51
-
52
- # === 系统与临时文件 (System & Temp) ===
53
- .DS_Store
54
- Thumbs.db
55
- *.tmp
56
- *.log
57
- *.bak
58
-
59
- # Python 字节码
60
- __pycache__/
61
- *.py[cod]
62
- *$py.class
63
-
64
- # 虚拟环境
65
- .venv/
66
- env/
67
- venv/
68
- .hatch/
69
-
70
- # 编译输出
71
- dist/
72
- build/
73
- *.egg-info/
74
-
75
- # 文档输出
76
- site/
77
-
78
- # IDE 设置
79
- .vscode/
80
- .idea/
81
-
82
- # 单元测试与覆盖率
83
- .pytest_cache/
84
- .tox/
85
- .coverage
86
- htmlcov/
87
-
88
- # 本地环境配置文件
89
- .env
90
-
91
- # 内部协议/设计文档(本地副本,不入库)
92
- AGENTS.md
93
- PROTOCOL_LINE_BY_LINE.md
94
- SDK_API_AND_DESIGN.md
95
- TRAJECTORY_ALGORITHM.md
96
- 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
97
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.1
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
@@ -102,6 +102,10 @@ python3 demo.py
102
102
  | `MovJ(target, speed, acceleration)` | 目标:`JointPoint` 或 `CartesianPoint` |
103
103
  | `MovL(target, speed, acceleration)` | 目标:`CartesianPoint` 或 `JointPoint` |
104
104
  | `Move([MoveInstruction.MovJ(...), ...])` | 多段路径 |
105
+ | `MovJSync(target, speed, acc, wait?)` | 阻塞式关节运动,等待到达目标 |
106
+ | `MovLSync(target, speed, acc, wait?)` | 阻塞式直线运动,等待到达目标 |
107
+ | `MovCSync(middle, target, speed, acc, wait?)` | 阻塞式圆弧运动 |
108
+ | `MoveSync(instructions, wait?)` | 阻塞式路径执行 |
105
109
 
106
110
  四组合路径示例(与 C++ `04_move` 一致):
107
111
 
@@ -127,7 +131,30 @@ robot.Move(path)
127
131
 
128
132
  打包规则:`jp` 优先;仅 `cp` 时若未提供 `rj`,JSON 中带默认 `[20,20,20,20,20,20]`(度)。
129
133
 
130
- **Breaking(2.1.1)**:公开 API 与 C# 一致,统一 **PascalCase**(`Connect`、`SwitchOn`、`GetDi`、`MovJ`、`SetToolFrame` 等);`CriData` 为属性;`move_j` / `switch_on` 等 snake_case 已移除。见 [CHANGELOG.md](CHANGELOG.md)。
134
+ ### 阻塞式运动 API
135
+
136
+ `*Sync` 方法发送运动指令后自动轮询 CRI 数据,直到机器人稳定到达目标。需要先启动 CRI 数据推送(`StartListenUdp`)。
137
+
138
+ ```python
139
+ from codroid import CodroidClient, JointPoint, MotionWaitOptions
140
+
141
+ with CodroidClient(host="192.168.1.136") as robot:
142
+ robot.ConnectRemoteAndSwitchOn()
143
+ robot.StartListenUdp()
144
+ robot.WaitForCriData() # 等待第一个 CRI 包到达
145
+
146
+ # 阻塞式关节运动,使用默认等待参数
147
+ robot.MovJSync(JointPoint.Degrees([0, 0, 90, 0, 90, 0]), speed=40, acceleration=100)
148
+
149
+ # 自定义等待参数
150
+ opts = MotionWaitOptions(timeout=30.0, joint_tolerance_deg=0.5)
151
+ robot.MovLSync(CartesianPoint.MmDeg([400, 200, 500, 180, 0, 90]),
152
+ speed=150, acceleration=500, wait=opts)
153
+ ```
154
+
155
+ `MotionWaitOptions` 可调整超时、轮询间隔、到达容差等参数。
156
+
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)。
131
158
 
132
159
  ## Windows 控制台 UTF-8
133
160
 
@@ -159,6 +186,7 @@ with CodroidClient(host="192.168.1.136") as robot:
159
186
 
160
187
  ```bash
161
188
  PYTHONPATH=src python examples/08_move.py --robot 192.168.8.136
189
+ PYTHONPATH=src python examples/15_sync_motion.py --robot 192.168.8.136
162
190
  PYTHONPATH=src python examples/14_robot_parameters.py --robot 192.168.8.136
163
191
  PYTHONPATH=src python examples/codroid_test.py motion
164
192
  PYTHONPATH=src python examples/codroid_test.py s20