solarian-gripper1 0.1.0__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 (59) hide show
  1. solarian_gripper1-0.1.0/LICENSE +201 -0
  2. solarian_gripper1-0.1.0/NOTICE +49 -0
  3. solarian_gripper1-0.1.0/PKG-INFO +175 -0
  4. solarian_gripper1-0.1.0/README.md +156 -0
  5. solarian_gripper1-0.1.0/pyproject.toml +59 -0
  6. solarian_gripper1-0.1.0/setup.cfg +4 -0
  7. solarian_gripper1-0.1.0/solarian_gripper1.egg-info/PKG-INFO +175 -0
  8. solarian_gripper1-0.1.0/solarian_gripper1.egg-info/SOURCES.txt +57 -0
  9. solarian_gripper1-0.1.0/solarian_gripper1.egg-info/dependency_links.txt +1 -0
  10. solarian_gripper1-0.1.0/solarian_gripper1.egg-info/entry_points.txt +4 -0
  11. solarian_gripper1-0.1.0/solarian_gripper1.egg-info/requires.txt +8 -0
  12. solarian_gripper1-0.1.0/solarian_gripper1.egg-info/top_level.txt +1 -0
  13. solarian_gripper1-0.1.0/solarian_gripper_1/__init__.py +41 -0
  14. solarian_gripper1-0.1.0/solarian_gripper_1/aperture.py +29 -0
  15. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1.xml +161 -0
  16. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/config.json +14 -0
  17. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/board.stl +0 -0
  18. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/camera_mount_so100_bottom.stl +0 -0
  19. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/camera_mount_so100_top.stl +0 -0
  20. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/feetech_back_holder_to_horn.stl +0 -0
  21. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/feetech_camera_mount_bottom.stl +0 -0
  22. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/feetech_gripper_holder.stl +0 -0
  23. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/finger_holder_left_n.stl +0 -0
  24. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/finger_holder_right_n.stl +0 -0
  25. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/frame.stl +0 -0
  26. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/horn_spacer_3_5_mm.stl +0 -0
  27. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/left_carriage.stl +0 -0
  28. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/lens.stl +0 -0
  29. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/part_1.stl +0 -0
  30. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/rack.stl +0 -0
  31. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/rail.stl +0 -0
  32. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/raspberry_pi_hq_camera.stl +0 -0
  33. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/right_carriage.stl +0 -0
  34. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/servo.stl +0 -0
  35. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/so100_6dof_wrist_roll_to_gripper.stl +0 -0
  36. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/soft_gripper_finger.stl +0 -0
  37. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_description/meshes/sts3215_double_side_bracket.stl +0 -0
  38. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride.xml +98 -0
  39. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/config.json +14 -0
  40. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/board.stl +0 -0
  41. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/camera_mount.stl +0 -0
  42. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/el05_l7.stl +0 -0
  43. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/finger_holder_left_n.stl +0 -0
  44. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/finger_holder_right_n.stl +0 -0
  45. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/gopro_holder_bottom.stl +0 -0
  46. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/gopro_holder_top.stl +0 -0
  47. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/l7_base.stl +0 -0
  48. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/l7_cover.stl +0 -0
  49. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/left_carriage.stl +0 -0
  50. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/lens.stl +0 -0
  51. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/rack.stl +0 -0
  52. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/rail.stl +0 -0
  53. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/right_carriage.stl +0 -0
  54. solarian_gripper1-0.1.0/solarian_gripper_1/assets/gripper1_robstride_description/meshes/soft_gripper_finger.stl +0 -0
  55. solarian_gripper1-0.1.0/solarian_gripper_1/conf_gripper_feetech.yaml +33 -0
  56. solarian_gripper1-0.1.0/solarian_gripper_1/conf_gripper_robstride.yaml +34 -0
  57. solarian_gripper1-0.1.0/solarian_gripper_1/gripper_feetech.py +132 -0
  58. solarian_gripper1-0.1.0/solarian_gripper_1/gripper_robstride.py +111 -0
  59. solarian_gripper1-0.1.0/tests/test_tcp_site.py +45 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,49 @@
1
+ solarian-gripper1
2
+ Copyright 2026 PrimaryKey Inc.
3
+
4
+ This product includes software developed by PrimaryKey Inc.
5
+
6
+
7
+ Third-party designs
8
+ ===================
9
+
10
+ solarian_gripper_1/assets/
11
+ Parts of the solarian-gripper1 mechanical design, meshes and MuJoCo models
12
+ are derived from designs of the Universal Manipulation Interface (UMI)
13
+ project, and modified:
14
+ - UMI Gripper: https://cad.onshape.com/documents/a8a98201374f5cc9c6538790
15
+ - UMI Soft Finger: https://cad.onshape.com/documents/c8d06048fc2e425772f2749c
16
+ Meshes from those designs: finger_holder_left_n, finger_holder_right_n,
17
+ left_carriage, right_carriage, rack, rail and soft_gripper_finger (both
18
+ variants), and gopro_holder_top and gopro_holder_bottom (Robstride variant).
19
+
20
+ solarian_gripper_1/assets/gripper1_robstride_description/
21
+ The Robstride L7 drive is derived from the EDULITE_A3 arm by RobStride
22
+ (https://github.com/RobStride/EDULITE_A3), MIT License, and modified.
23
+ Meshes from that design: el05_l7, l7_base and l7_cover.
24
+
25
+ MIT License
26
+
27
+ Copyright (c) 2026 RobStride
28
+
29
+ Permission is hereby granted, free of charge, to any person obtaining a copy
30
+ of this software and associated documentation files (the "Software"), to deal
31
+ in the Software without restriction, including without limitation the rights
32
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
33
+ copies of the Software, and to permit persons to whom the Software is
34
+ furnished to do so, subject to the following conditions:
35
+
36
+ The above copyright notice and this permission notice shall be included in all
37
+ copies or substantial portions of the Software.
38
+
39
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
40
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
41
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
42
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
43
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
44
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
45
+ SOFTWARE.
46
+
47
+ solarian-gripper1 is not affiliated with, sponsored by, or endorsed by UMI, its
48
+ authors, Stanford University, Columbia University, Toyota Research Institute or
49
+ RobStride.
@@ -0,0 +1,175 @@
1
+ Metadata-Version: 2.4
2
+ Name: solarian-gripper1
3
+ Version: 0.1.0
4
+ Summary: solarian-gripper1, a single-actuator parallel gripper with a wrist camera, designed with reference to UMI
5
+ Author-email: Raul Garreta <raul@solarian.dev>
6
+ License: Apache-2.0
7
+ Classifier: License :: OSI Approved :: Apache Software License
8
+ Requires-Python: >=3.10
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENSE
11
+ License-File: NOTICE
12
+ Requires-Dist: solarian>=0.1.0
13
+ Requires-Dist: solarian-feetech>=0.1.0
14
+ Provides-Extra: robstride
15
+ Requires-Dist: solarian-robstride>=0.1.0; extra == "robstride"
16
+ Provides-Extra: hardware
17
+ Requires-Dist: solarian-feetech[hardware]>=0.1.0; extra == "hardware"
18
+ Dynamic: license-file
19
+
20
+ # solarian-gripper1
21
+
22
+ A parallel gripper module for the Solarian framework. Two fingers, one actuator;
23
+ you command it by the desired **finger aperture in millimetres** and the module
24
+ handles the conversion for both real hardware and simulation.
25
+
26
+ The plugin ships **two actuator variants** that share the same finger kinematics
27
+ and aperture command space:
28
+
29
+ | Variant | Module | Default config | MJCF |
30
+ | --- | --- | --- | --- |
31
+ | Feetech STS | `Gripper1FeetechModule` | `conf_gripper_feetech.yaml` | `assets/gripper1.xml` |
32
+ | Robstride L7 | `Gripper1RobstrideModule` | `conf_gripper_robstride.yaml` | `assets/gripper1_robstride.xml` |
33
+
34
+ ## Installation
35
+
36
+ ```bash
37
+ pip install solarian-gripper1 # Feetech variant
38
+ pip install "solarian-gripper1[hardware]" # plus the Feetech servo SDK, on the machine wired to the gripper
39
+ ```
40
+
41
+ The Robstride variant needs `solarian-robstride`, which is not on PyPI yet.
42
+ Install it from source alongside the gripper:
43
+
44
+ ```bash
45
+ pip install -e "plugins/solarian-robstride[hardware]"
46
+ pip install -e "plugins/solarian-gripper1[robstride]"
47
+ ```
48
+
49
+ ## How it works
50
+
51
+ - Each module exposes a single actuator (`gripper`), matching the single
52
+ physical servo. It converts an aperture command (mm) into the servo's
53
+ normalized command space and writes that. Each backend maps normalized → physical:
54
+ - **Real**: normalized → servo counts via the actuator calibration.
55
+ - **Sim**: normalized → the `left_manifold_to_rail` prismatic joint via the
56
+ `sim:` block in the variant's yaml.
57
+ - Each MuJoCo model actuates only that one joint; an `<equality>` constraint
58
+ (ratio −1, generated by onshape-to-robot from the CAD mate relation) drives
59
+ the opposite finger, so one command opens/closes both jaws symmetrically.
60
+
61
+ ## Regenerating the sim model from Onshape
62
+
63
+ Each variant has its own CAD assembly (mates + limits + the linear finger
64
+ relation). Re-export after a CAD change with:
65
+
66
+ ```bash
67
+ # Feetech
68
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_description
69
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_description --clean-only
70
+
71
+ # Robstride
72
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_robstride_description
73
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_robstride_description --clean-only
74
+ ```
75
+
76
+ The Feetech export writes `solarian_gripper_1/assets/gripper1.xml`; the Robstride
77
+ export writes `solarian_gripper_1/assets/gripper1_robstride.xml`. The driven joint
78
+ `left_manifold_to_rail` has range `[0, 0.0545]` m (0 = fingers apart / open,
79
+ 0.0545 = fingers together / closed).
80
+
81
+ ## Using it in a robot
82
+
83
+ 1. Attach the model in your robot's sim `SceneConfig`, with a `prefix` matching
84
+ the one in the gripper yaml (`gripper/`):
85
+
86
+ ```python
87
+ from solarian.sim import SceneConfig, ModuleAttachment
88
+ from solarian_gripper_1 import MJCF_FEETECH_PATH as GRIPPER_MJCF
89
+ from solarian_gripper_1.gripper_feetech import Gripper1FeetechModule
90
+
91
+ class MyRobot(Robot):
92
+ is_sim = True
93
+ gripper = Gripper1FeetechModule()
94
+
95
+ scene = SceneConfig(
96
+ attachments=[
97
+ ModuleAttachment(
98
+ module="gripper",
99
+ # Loaded straight from the installed plugin (meshes resolve
100
+ # relative to the MJCF) -- no need to copy the model into your
101
+ # project, so there's a single source of truth.
102
+ mjcf=GRIPPER_MJCF,
103
+ parent_body="right/wrist_flange", # the arm flange body
104
+ prefix="gripper/",
105
+ ),
106
+ ],
107
+ )
108
+ ```
109
+
110
+ For the Robstride variant, import `Gripper1RobstrideModule` and
111
+ `MJCF_ROBSTRIDE_PATH` instead. The Feetech MJCF attaches at the `flange` site;
112
+ the Robstride MJCF attaches at the `base` site.
113
+
114
+ The Feetech MJCF exports CAD Frames as sites: `flange` (mate to the arm),
115
+ `camera` (wrist lens), and `tcp` (tool center point). Pass
116
+ `Gripper1FeetechModule.tcp_from_flange` to the arm as `ik_tcp` so IK tracks
117
+ the flange plus that CAD offset.
118
+
119
+ Site-mate example (solarian-arm1 and this gripper both export a `flange` Frame):
120
+
121
+ ```python
122
+ ModuleAttachment(
123
+ module="right_gripper",
124
+ mjcf=GRIPPER_MJCF,
125
+ parent_site="right/flange",
126
+ child_site="flange",
127
+ prefix="right_gripper/",
128
+ )
129
+ ```
130
+
131
+ 2. Copy the matching yaml (`conf_gripper_feetech.yaml` or
132
+ `conf_gripper_robstride.yaml`) into your project's `conf/` and set the real
133
+ `port`/`id`, then run `solarian calibrate` on the gripper: sweep the
134
+ full closed↔open travel, then move to the **fully closed** pose when asked
135
+ so `drive_mode` matches `aperture_closed_mm` / `aperture_open_mm`.
136
+
137
+ 3. Run `solarian calibrate-gripper-ranges` and read a ruler at each stop. This
138
+ records `aperture_table`, the measured aperture curve. Skipping it leaves the
139
+ module interpolating a straight line between the two endpoints, which the
140
+ linkage does not follow.
141
+
142
+ 4. Command the gripper by aperture in mm — send a waypoint whose `gripper` value
143
+ is the aperture (e.g. `85` = fully open, `0` = closed). Read the current
144
+ aperture with `module.read_aperture()`.
145
+
146
+ ## Configuration
147
+
148
+ Fields specific to both modules:
149
+
150
+ - `aperture_table` — ruler-measured `norm` / `aperture_mm` pairs written by
151
+ `solarian calibrate-gripper-ranges`. When present it defines the travel and
152
+ the mm ↔ normalized map, superseding the two endpoint fields below.
153
+ - `aperture_closed_mm` / `aperture_open_mm` — physical fingertip separation at
154
+ the two ends of travel, used for a straight-line map until a table is
155
+ measured. Keep them consistent with the servo calibration and the `sim:`
156
+ joint range.
157
+ - `actuators.gripper.sim` — maps the servo to `gripper/left_manifold_to_rail`,
158
+ `range_min: 0.0` / `range_max: 0.0545` (the joint limits), `drive_mode: 1` so
159
+ normalized -100 = closed, 100 = open.
160
+ - `interpolator_type: scalar` — GripperModule interpolates aperture in mm.
161
+
162
+ ## License
163
+
164
+ [Apache License 2.0](LICENSE). Copyright 2026 PrimaryKey Inc. Parts of the
165
+ mechanical design and meshes in `solarian_gripper_1/assets/` are derived from
166
+ the [UMI Gripper](https://cad.onshape.com/documents/a8a98201374f5cc9c6538790)
167
+ and [UMI Soft Finger](https://cad.onshape.com/documents/c8d06048fc2e425772f2749c)
168
+ of the [Universal Manipulation Interface](https://umi-gripper.github.io/) (UMI)
169
+ project, and the Robstride L7 drive from RobStride's
170
+ [EDULITE_A3](https://github.com/RobStride/EDULITE_A3) (MIT), and modified; see
171
+ [NOTICE](NOTICE). solarian-gripper1 is not affiliated with, sponsored by, or
172
+ endorsed by UMI, its authors, Stanford University, Columbia University, Toyota
173
+ Research Institute or RobStride.
174
+
175
+ Solarian and the Solarian logo are trademarks of PrimaryKey Inc. See the [trademark policy](https://github.com/solarian-dev/solarian/blob/main/TRADEMARKS.md).
@@ -0,0 +1,156 @@
1
+ # solarian-gripper1
2
+
3
+ A parallel gripper module for the Solarian framework. Two fingers, one actuator;
4
+ you command it by the desired **finger aperture in millimetres** and the module
5
+ handles the conversion for both real hardware and simulation.
6
+
7
+ The plugin ships **two actuator variants** that share the same finger kinematics
8
+ and aperture command space:
9
+
10
+ | Variant | Module | Default config | MJCF |
11
+ | --- | --- | --- | --- |
12
+ | Feetech STS | `Gripper1FeetechModule` | `conf_gripper_feetech.yaml` | `assets/gripper1.xml` |
13
+ | Robstride L7 | `Gripper1RobstrideModule` | `conf_gripper_robstride.yaml` | `assets/gripper1_robstride.xml` |
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ pip install solarian-gripper1 # Feetech variant
19
+ pip install "solarian-gripper1[hardware]" # plus the Feetech servo SDK, on the machine wired to the gripper
20
+ ```
21
+
22
+ The Robstride variant needs `solarian-robstride`, which is not on PyPI yet.
23
+ Install it from source alongside the gripper:
24
+
25
+ ```bash
26
+ pip install -e "plugins/solarian-robstride[hardware]"
27
+ pip install -e "plugins/solarian-gripper1[robstride]"
28
+ ```
29
+
30
+ ## How it works
31
+
32
+ - Each module exposes a single actuator (`gripper`), matching the single
33
+ physical servo. It converts an aperture command (mm) into the servo's
34
+ normalized command space and writes that. Each backend maps normalized → physical:
35
+ - **Real**: normalized → servo counts via the actuator calibration.
36
+ - **Sim**: normalized → the `left_manifold_to_rail` prismatic joint via the
37
+ `sim:` block in the variant's yaml.
38
+ - Each MuJoCo model actuates only that one joint; an `<equality>` constraint
39
+ (ratio −1, generated by onshape-to-robot from the CAD mate relation) drives
40
+ the opposite finger, so one command opens/closes both jaws symmetrically.
41
+
42
+ ## Regenerating the sim model from Onshape
43
+
44
+ Each variant has its own CAD assembly (mates + limits + the linear finger
45
+ relation). Re-export after a CAD change with:
46
+
47
+ ```bash
48
+ # Feetech
49
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_description
50
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_description --clean-only
51
+
52
+ # Robstride
53
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_robstride_description
54
+ solarian onshape-export plugins/solarian-gripper1/solarian_gripper_1/assets/gripper1_robstride_description --clean-only
55
+ ```
56
+
57
+ The Feetech export writes `solarian_gripper_1/assets/gripper1.xml`; the Robstride
58
+ export writes `solarian_gripper_1/assets/gripper1_robstride.xml`. The driven joint
59
+ `left_manifold_to_rail` has range `[0, 0.0545]` m (0 = fingers apart / open,
60
+ 0.0545 = fingers together / closed).
61
+
62
+ ## Using it in a robot
63
+
64
+ 1. Attach the model in your robot's sim `SceneConfig`, with a `prefix` matching
65
+ the one in the gripper yaml (`gripper/`):
66
+
67
+ ```python
68
+ from solarian.sim import SceneConfig, ModuleAttachment
69
+ from solarian_gripper_1 import MJCF_FEETECH_PATH as GRIPPER_MJCF
70
+ from solarian_gripper_1.gripper_feetech import Gripper1FeetechModule
71
+
72
+ class MyRobot(Robot):
73
+ is_sim = True
74
+ gripper = Gripper1FeetechModule()
75
+
76
+ scene = SceneConfig(
77
+ attachments=[
78
+ ModuleAttachment(
79
+ module="gripper",
80
+ # Loaded straight from the installed plugin (meshes resolve
81
+ # relative to the MJCF) -- no need to copy the model into your
82
+ # project, so there's a single source of truth.
83
+ mjcf=GRIPPER_MJCF,
84
+ parent_body="right/wrist_flange", # the arm flange body
85
+ prefix="gripper/",
86
+ ),
87
+ ],
88
+ )
89
+ ```
90
+
91
+ For the Robstride variant, import `Gripper1RobstrideModule` and
92
+ `MJCF_ROBSTRIDE_PATH` instead. The Feetech MJCF attaches at the `flange` site;
93
+ the Robstride MJCF attaches at the `base` site.
94
+
95
+ The Feetech MJCF exports CAD Frames as sites: `flange` (mate to the arm),
96
+ `camera` (wrist lens), and `tcp` (tool center point). Pass
97
+ `Gripper1FeetechModule.tcp_from_flange` to the arm as `ik_tcp` so IK tracks
98
+ the flange plus that CAD offset.
99
+
100
+ Site-mate example (solarian-arm1 and this gripper both export a `flange` Frame):
101
+
102
+ ```python
103
+ ModuleAttachment(
104
+ module="right_gripper",
105
+ mjcf=GRIPPER_MJCF,
106
+ parent_site="right/flange",
107
+ child_site="flange",
108
+ prefix="right_gripper/",
109
+ )
110
+ ```
111
+
112
+ 2. Copy the matching yaml (`conf_gripper_feetech.yaml` or
113
+ `conf_gripper_robstride.yaml`) into your project's `conf/` and set the real
114
+ `port`/`id`, then run `solarian calibrate` on the gripper: sweep the
115
+ full closed↔open travel, then move to the **fully closed** pose when asked
116
+ so `drive_mode` matches `aperture_closed_mm` / `aperture_open_mm`.
117
+
118
+ 3. Run `solarian calibrate-gripper-ranges` and read a ruler at each stop. This
119
+ records `aperture_table`, the measured aperture curve. Skipping it leaves the
120
+ module interpolating a straight line between the two endpoints, which the
121
+ linkage does not follow.
122
+
123
+ 4. Command the gripper by aperture in mm — send a waypoint whose `gripper` value
124
+ is the aperture (e.g. `85` = fully open, `0` = closed). Read the current
125
+ aperture with `module.read_aperture()`.
126
+
127
+ ## Configuration
128
+
129
+ Fields specific to both modules:
130
+
131
+ - `aperture_table` — ruler-measured `norm` / `aperture_mm` pairs written by
132
+ `solarian calibrate-gripper-ranges`. When present it defines the travel and
133
+ the mm ↔ normalized map, superseding the two endpoint fields below.
134
+ - `aperture_closed_mm` / `aperture_open_mm` — physical fingertip separation at
135
+ the two ends of travel, used for a straight-line map until a table is
136
+ measured. Keep them consistent with the servo calibration and the `sim:`
137
+ joint range.
138
+ - `actuators.gripper.sim` — maps the servo to `gripper/left_manifold_to_rail`,
139
+ `range_min: 0.0` / `range_max: 0.0545` (the joint limits), `drive_mode: 1` so
140
+ normalized -100 = closed, 100 = open.
141
+ - `interpolator_type: scalar` — GripperModule interpolates aperture in mm.
142
+
143
+ ## License
144
+
145
+ [Apache License 2.0](LICENSE). Copyright 2026 PrimaryKey Inc. Parts of the
146
+ mechanical design and meshes in `solarian_gripper_1/assets/` are derived from
147
+ the [UMI Gripper](https://cad.onshape.com/documents/a8a98201374f5cc9c6538790)
148
+ and [UMI Soft Finger](https://cad.onshape.com/documents/c8d06048fc2e425772f2749c)
149
+ of the [Universal Manipulation Interface](https://umi-gripper.github.io/) (UMI)
150
+ project, and the Robstride L7 drive from RobStride's
151
+ [EDULITE_A3](https://github.com/RobStride/EDULITE_A3) (MIT), and modified; see
152
+ [NOTICE](NOTICE). solarian-gripper1 is not affiliated with, sponsored by, or
153
+ endorsed by UMI, its authors, Stanford University, Columbia University, Toyota
154
+ Research Institute or RobStride.
155
+
156
+ Solarian and the Solarian logo are trademarks of PrimaryKey Inc. See the [trademark policy](https://github.com/solarian-dev/solarian/blob/main/TRADEMARKS.md).
@@ -0,0 +1,59 @@
1
+ [project]
2
+ name = "solarian-gripper1"
3
+ version = "0.1.0"
4
+ description = "solarian-gripper1, a single-actuator parallel gripper with a wrist camera, designed with reference to UMI"
5
+ authors = [
6
+ {name = "Raul Garreta", email = "raul@solarian.dev"}
7
+ ]
8
+ readme = "README.md"
9
+ license = {text = "Apache-2.0"}
10
+ classifiers = ["License :: OSI Approved :: Apache Software License"]
11
+ requires-python = ">=3.10"
12
+ dependencies = [
13
+ "solarian>=0.1.0",
14
+ "solarian-feetech>=0.1.0",
15
+ ]
16
+
17
+ [project.optional-dependencies]
18
+ # Only Gripper1RobstrideModule imports solarian_robstride, so the Feetech
19
+ # variant installs and runs without it.
20
+ robstride = [
21
+ "solarian-robstride>=0.1.0",
22
+ ]
23
+ # The servo SDKs, for the machine wired to the gripper. Without them the
24
+ # modules still import, so a relay or controller can build the robot's schema.
25
+ hardware = [
26
+ "solarian-feetech[hardware]>=0.1.0",
27
+ ]
28
+
29
+ [build-system]
30
+ requires = ["setuptools>=61.0"]
31
+ build-backend = "setuptools.build_meta"
32
+
33
+ [tool.setuptools.packages.find]
34
+ include = ["solarian_gripper_1*"]
35
+
36
+ # Ship the simulation models with the wheel. The assets live inside the package
37
+ # (`solarian_gripper_1/assets/`) so `MJCF_FEETECH_PATH` / `MJCF_ROBSTRIDE_PATH`
38
+ # resolve from the installed location. Only the runtime files are included --
39
+ # onshape-export byproducts (`*_raw.xml`, `scene.xml`, `meshes/*.part`) are
40
+ # intentionally left out.
41
+ [tool.setuptools.package-data]
42
+ solarian_gripper_1 = [
43
+ "conf_gripper_feetech.yaml",
44
+ "conf_gripper_robstride.yaml",
45
+ "assets/gripper1.xml",
46
+ "assets/gripper1_description/config.json",
47
+ "assets/gripper1_description/meshes/*.stl",
48
+ "assets/gripper1_robstride.xml",
49
+ "assets/gripper1_robstride_description/config.json",
50
+ "assets/gripper1_robstride_description/meshes/*.stl",
51
+ ]
52
+
53
+ # Entry points below are managed by `solarian create-plugin`. Each component
54
+ # type you scaffold adds its class(es) here so Solarian can discover them.
55
+
56
+ [project.entry-points."solarian.modules"]
57
+ gripper-1 = "solarian_gripper_1.gripper_feetech:Gripper1FeetechModule"
58
+ gripper-1-feetech = "solarian_gripper_1.gripper_feetech:Gripper1FeetechModule"
59
+ gripper-1-robstride = "solarian_gripper_1.gripper_robstride:Gripper1RobstrideModule"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+