hex-dora-node-robot 0.0.1a1__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.
@@ -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,221 @@
1
+ Metadata-Version: 2.4
2
+ Name: hex_dora_node_robot
3
+ Version: 0.0.1a1
4
+ Summary: Dora Node for using Hex Robot
5
+ Author-email: Dong Zhaorui <847235539@qq.com>
6
+ License-Expression: Apache-2.0
7
+ Requires-Python: >=3.10
8
+ Description-Content-Type: text/markdown
9
+ License-File: LICENSE
10
+ Requires-Dist: dora-rs>=0.3.9
11
+ Requires-Dist: hex-driver-robot<0.1.0,>=0.0.0
12
+ Dynamic: license-file
13
+
14
+ # hex_dora_node_robot
15
+
16
+ Dora nodes for controlling HEXFELLOW robot arms. Supports Archer Y6, Firefly Y6, and Hello Y6 robot models with state reading and command sending over the Dora dataflow.
17
+
18
+ ## Nodes
19
+
20
+ | Node | Description | Inputs | Outputs |
21
+ | --- | --- | --- | --- |
22
+ | `hex-dora-node-archer-y6` | Archer Y6 robot driver (6-DOF arm with optional grip) | `tick`, `arm_mit_cmd`, `arm_mit_comp_cmd`, `arm_pos_cmd`, `arm_pose_cmd`, `grip_mit_cmd`, `grip_mit_comp_cmd`, `grip_pos_cmd` | `arm_motor`, `arm_end`, `grip_motor` |
23
+ | `hex-dora-node-firefly-y6` | Firefly Y6 robot driver (6-DOF arm with optional grip) | `tick`, `arm_mit_cmd`, `arm_mit_comp_cmd`, `arm_pos_cmd`, `arm_pose_cmd`, `grip_mit_cmd`, `grip_mit_comp_cmd`, `grip_pos_cmd` | `arm_motor`, `arm_end`, `grip_motor` |
24
+ | `hex-dora-node-hello-y6` | Hello Y6 robot driver (6-DOF arm with 7-DOF grip and RGB LED) | `tick`, `grip_led_cmd` | `arm_motor`, `grip_motor` |
25
+
26
+ ## Installation
27
+
28
+ ```bash
29
+ pip install hex_dora_node_robot
30
+ ```
31
+
32
+ ## YAML Examples
33
+
34
+ ### Archer Y6
35
+
36
+ ```yaml
37
+ nodes:
38
+ - id: archer_y6
39
+ build: pip install hex_dora_node_robot
40
+ path: hex-dora-node-archer-y6
41
+ inputs:
42
+ tick: dora/timer/millis/2
43
+ arm_pos_cmd: planner/arm_pos_cmd
44
+ grip_pos_cmd: planner/grip_pos_cmd
45
+ outputs:
46
+ - arm_motor
47
+ - arm_end
48
+ - grip_motor
49
+ env:
50
+ NODE_NAME: archer_y6
51
+ HOST: 192.168.1.100
52
+ PORT: 8439
53
+ CTRL_RATE: 1000
54
+ STATE_BUFFER_SIZE: 200
55
+ SEN_TS: True
56
+ GRIP_TYPE: gp80
57
+ POSE_END_IN_FLANGE: 0.187,0.0,0.0,1.0,0.0,0.0,0.0
58
+ ```
59
+
60
+ ### Firefly Y6
61
+
62
+ ```yaml
63
+ nodes:
64
+ - id: firefly_y6
65
+ build: pip install hex_dora_node_robot
66
+ path: hex-dora-node-firefly-y6
67
+ inputs:
68
+ tick: dora/timer/millis/2
69
+ arm_pos_cmd: planner/arm_pos_cmd
70
+ grip_pos_cmd: planner/grip_pos_cmd
71
+ outputs:
72
+ - arm_motor
73
+ - arm_end
74
+ - grip_motor
75
+ env:
76
+ NODE_NAME: firefly_y6
77
+ HOST: 192.168.1.100
78
+ PORT: 8439
79
+ CTRL_RATE: 1000
80
+ STATE_BUFFER_SIZE: 200
81
+ SEN_TS: True
82
+ GRIP_TYPE: gp80
83
+ POSE_END_IN_FLANGE: 0.187,0.0,0.0,1.0,0.0,0.0,0.0
84
+ ```
85
+
86
+ ### Hello Y6
87
+
88
+ ```yaml
89
+ nodes:
90
+ - id: hello_y6
91
+ build: pip install hex_dora_node_robot
92
+ path: hex-dora-node-hello-y6
93
+ inputs:
94
+ tick: dora/timer/millis/2
95
+ grip_led_cmd: planner/grip_led_cmd
96
+ outputs:
97
+ - arm_motor
98
+ - grip_motor
99
+ env:
100
+ NODE_NAME: hello_y6
101
+ HOST: 192.168.1.100
102
+ PORT: 8439
103
+ CTRL_RATE: 1000
104
+ STATE_BUFFER_SIZE: 200
105
+ SEN_TS: True
106
+ LED_BUFFER_SIZE: 10
107
+ ```
108
+
109
+ ## Inputs
110
+
111
+ ### Timer
112
+
113
+ | Input | Type | Description |
114
+ | --- | --- | --- |
115
+ | `tick` | `dora/timer/millis/*` | Timer tick to trigger state reading |
116
+
117
+ ### Arm Commands (Archer Y6 / Firefly Y6 only)
118
+
119
+ | Input | Fields | Description |
120
+ | --- | --- | --- |
121
+ | `arm_mit_cmd` | `q_tar(6)`, `dq_tar(6)`, `tau(6)`, `kp(6)`, `kd(6)` | MIT torque command for arm |
122
+ | `arm_mit_comp_cmd` | `q_tar(6)`, `dq_tar(6)`, `tau(6)`, `kp(6)`, `kd(6)` | MIT command with gravity/friction compensation |
123
+ | `arm_pos_cmd` | `q_tar(6)`, `kp(6)`, `kd(6)`, `err_limit(1)` | Joint position command for arm |
124
+ | `arm_pose_cmd` | `pos(3)`, `quat(4)`, `kp(6)`, `kd(6)`, `err_limit(1)` | Cartesian pose command for arm |
125
+
126
+ ### Grip Commands (Archer Y6 / Firefly Y6 only)
127
+
128
+ | Input | Fields | Description |
129
+ | --- | --- | --- |
130
+ | `grip_mit_cmd` | `q_tar(dof)`, `dq_tar(dof)`, `tau(dof)`, `kp(dof)`, `kd(dof)` | MIT torque command for grip |
131
+ | `grip_mit_comp_cmd` | `q_tar(dof)`, `dq_tar(dof)`, `tau(dof)`, `kp(dof)`, `kd(dof)` | MIT command with friction compensation |
132
+ | `grip_pos_cmd` | `q_tar(dof)`, `kp(dof)`, `kd(dof)`, `err_limit(1)` | Joint position command for grip |
133
+
134
+ ### Grip LED Command (Hello Y6 only)
135
+
136
+ | Input | Fields | Description |
137
+ | --- | --- | --- |
138
+ | `grip_led_cmd` | `r(6)`, `g(6)`, `b(6)` | RGB LED strip command (0-255 per channel) |
139
+
140
+ ## Outputs
141
+
142
+ ### `arm_motor`
143
+
144
+ Archer Y6 / Firefly Y6: `{"pos": float64[6], "vel": float64[6], "eff": float64[6]}`
145
+
146
+ Hello Y6: `{"pos": float64[6], "vel": float64[6]}`
147
+
148
+ ### `arm_end`
149
+
150
+ Archer Y6 / Firefly Y6 only: `{"pos": float64[3], "quat": float64[4]}`
151
+
152
+ ### `grip_motor`
153
+
154
+ Archer Y6 / Firefly Y6: `{"pos": float64[dof], "vel": float64[dof], "eff": float64[dof]}`
155
+
156
+ Hello Y6: `{"pos": float64[7]}`
157
+
158
+ ## Arrow Dict Encoding
159
+
160
+ All data is transmitted as `dict[str, arr]` via flat `float64` Arrow arrays. The `metadata` dict describes the layout using field names as keys mapped to their array lengths:
161
+
162
+ ```python
163
+ # Example arm_motor metadata for Archer/Firefly Y6
164
+ metadata = {
165
+ "fields": "pos,vel,eff", # field order in the flat array
166
+ "pos": "6", # pos occupies 6 elements
167
+ "vel": "6",
168
+ "eff": "6",
169
+ }
170
+ ```
171
+
172
+ Use `hex_dora_node_robot.util.dict_decode` to unpack and `dict_encode` to pack:
173
+
174
+ ```python
175
+ from hex_dora_node_robot.util import dict_decode, dict_encode
176
+
177
+ # Decode state from a robot node
178
+ state = dict_decode(event["value"], event["metadata"])
179
+ print(state["pos"], state["vel"])
180
+
181
+ # Encode command to send to the robot node
182
+ import numpy as np
183
+ cmd = {
184
+ "q_tar": np.zeros(6),
185
+ "kp": np.array([400.0, 400.0, 500.0, 200.0, 100.0, 100.0]),
186
+ "kd": np.array([5.0, 5.0, 5.0, 5.0, 2.0, 2.0]),
187
+ "err_limit": np.array([0.03]),
188
+ }
189
+ storage, metadata = dict_encode(cmd, event["metadata"])
190
+ node.send_output("arm_pos_cmd", storage, metadata)
191
+ ```
192
+
193
+ ## Environment Variables
194
+
195
+ ### Common (all robot nodes)
196
+
197
+ | Variable | Type | Default | Description |
198
+ | --- | --- | --- | --- |
199
+ | `NODE_NAME` | `str` | `""` | Dora node name |
200
+ | `HOST` | `str` | `192.168.1.100` | Robot controller IP address |
201
+ | `PORT` | `int` | `8439` | WebSocket port |
202
+ | `CTRL_RATE` | `float` | `1000` | Control loop rate (Hz) |
203
+ | `STATE_BUFFER_SIZE` | `int` | `200` | Size of the state ring buffer |
204
+ | `SEN_TS` | `bool` | `True` | Use sensor timestamps |
205
+
206
+ ### Archer Y6 / Firefly Y6
207
+
208
+ | Variable | Type | Default | Description |
209
+ | --- | --- | --- | --- |
210
+ | `GRIP_TYPE` | `str` | `gp80` | Grip model (`gp80` or `empty` for no grip) |
211
+ | `POSE_END_IN_FLANGE` | `str` | `0.187,0.0,0.0,1.0,0.0,0.0,0.0` | End-effector pose in flange frame `[x,y,z,qw,qx,qy,qz]` |
212
+
213
+ ### Hello Y6
214
+
215
+ | Variable | Type | Default | Description |
216
+ | --- | --- | --- | --- |
217
+ | `LED_BUFFER_SIZE` | `int` | `10` | Size of the LED command buffer |
218
+
219
+ ## License
220
+
221
+ This project is licensed under Apache-2.0.
@@ -0,0 +1,208 @@
1
+ # hex_dora_node_robot
2
+
3
+ Dora nodes for controlling HEXFELLOW robot arms. Supports Archer Y6, Firefly Y6, and Hello Y6 robot models with state reading and command sending over the Dora dataflow.
4
+
5
+ ## Nodes
6
+
7
+ | Node | Description | Inputs | Outputs |
8
+ | --- | --- | --- | --- |
9
+ | `hex-dora-node-archer-y6` | Archer Y6 robot driver (6-DOF arm with optional grip) | `tick`, `arm_mit_cmd`, `arm_mit_comp_cmd`, `arm_pos_cmd`, `arm_pose_cmd`, `grip_mit_cmd`, `grip_mit_comp_cmd`, `grip_pos_cmd` | `arm_motor`, `arm_end`, `grip_motor` |
10
+ | `hex-dora-node-firefly-y6` | Firefly Y6 robot driver (6-DOF arm with optional grip) | `tick`, `arm_mit_cmd`, `arm_mit_comp_cmd`, `arm_pos_cmd`, `arm_pose_cmd`, `grip_mit_cmd`, `grip_mit_comp_cmd`, `grip_pos_cmd` | `arm_motor`, `arm_end`, `grip_motor` |
11
+ | `hex-dora-node-hello-y6` | Hello Y6 robot driver (6-DOF arm with 7-DOF grip and RGB LED) | `tick`, `grip_led_cmd` | `arm_motor`, `grip_motor` |
12
+
13
+ ## Installation
14
+
15
+ ```bash
16
+ pip install hex_dora_node_robot
17
+ ```
18
+
19
+ ## YAML Examples
20
+
21
+ ### Archer Y6
22
+
23
+ ```yaml
24
+ nodes:
25
+ - id: archer_y6
26
+ build: pip install hex_dora_node_robot
27
+ path: hex-dora-node-archer-y6
28
+ inputs:
29
+ tick: dora/timer/millis/2
30
+ arm_pos_cmd: planner/arm_pos_cmd
31
+ grip_pos_cmd: planner/grip_pos_cmd
32
+ outputs:
33
+ - arm_motor
34
+ - arm_end
35
+ - grip_motor
36
+ env:
37
+ NODE_NAME: archer_y6
38
+ HOST: 192.168.1.100
39
+ PORT: 8439
40
+ CTRL_RATE: 1000
41
+ STATE_BUFFER_SIZE: 200
42
+ SEN_TS: True
43
+ GRIP_TYPE: gp80
44
+ POSE_END_IN_FLANGE: 0.187,0.0,0.0,1.0,0.0,0.0,0.0
45
+ ```
46
+
47
+ ### Firefly Y6
48
+
49
+ ```yaml
50
+ nodes:
51
+ - id: firefly_y6
52
+ build: pip install hex_dora_node_robot
53
+ path: hex-dora-node-firefly-y6
54
+ inputs:
55
+ tick: dora/timer/millis/2
56
+ arm_pos_cmd: planner/arm_pos_cmd
57
+ grip_pos_cmd: planner/grip_pos_cmd
58
+ outputs:
59
+ - arm_motor
60
+ - arm_end
61
+ - grip_motor
62
+ env:
63
+ NODE_NAME: firefly_y6
64
+ HOST: 192.168.1.100
65
+ PORT: 8439
66
+ CTRL_RATE: 1000
67
+ STATE_BUFFER_SIZE: 200
68
+ SEN_TS: True
69
+ GRIP_TYPE: gp80
70
+ POSE_END_IN_FLANGE: 0.187,0.0,0.0,1.0,0.0,0.0,0.0
71
+ ```
72
+
73
+ ### Hello Y6
74
+
75
+ ```yaml
76
+ nodes:
77
+ - id: hello_y6
78
+ build: pip install hex_dora_node_robot
79
+ path: hex-dora-node-hello-y6
80
+ inputs:
81
+ tick: dora/timer/millis/2
82
+ grip_led_cmd: planner/grip_led_cmd
83
+ outputs:
84
+ - arm_motor
85
+ - grip_motor
86
+ env:
87
+ NODE_NAME: hello_y6
88
+ HOST: 192.168.1.100
89
+ PORT: 8439
90
+ CTRL_RATE: 1000
91
+ STATE_BUFFER_SIZE: 200
92
+ SEN_TS: True
93
+ LED_BUFFER_SIZE: 10
94
+ ```
95
+
96
+ ## Inputs
97
+
98
+ ### Timer
99
+
100
+ | Input | Type | Description |
101
+ | --- | --- | --- |
102
+ | `tick` | `dora/timer/millis/*` | Timer tick to trigger state reading |
103
+
104
+ ### Arm Commands (Archer Y6 / Firefly Y6 only)
105
+
106
+ | Input | Fields | Description |
107
+ | --- | --- | --- |
108
+ | `arm_mit_cmd` | `q_tar(6)`, `dq_tar(6)`, `tau(6)`, `kp(6)`, `kd(6)` | MIT torque command for arm |
109
+ | `arm_mit_comp_cmd` | `q_tar(6)`, `dq_tar(6)`, `tau(6)`, `kp(6)`, `kd(6)` | MIT command with gravity/friction compensation |
110
+ | `arm_pos_cmd` | `q_tar(6)`, `kp(6)`, `kd(6)`, `err_limit(1)` | Joint position command for arm |
111
+ | `arm_pose_cmd` | `pos(3)`, `quat(4)`, `kp(6)`, `kd(6)`, `err_limit(1)` | Cartesian pose command for arm |
112
+
113
+ ### Grip Commands (Archer Y6 / Firefly Y6 only)
114
+
115
+ | Input | Fields | Description |
116
+ | --- | --- | --- |
117
+ | `grip_mit_cmd` | `q_tar(dof)`, `dq_tar(dof)`, `tau(dof)`, `kp(dof)`, `kd(dof)` | MIT torque command for grip |
118
+ | `grip_mit_comp_cmd` | `q_tar(dof)`, `dq_tar(dof)`, `tau(dof)`, `kp(dof)`, `kd(dof)` | MIT command with friction compensation |
119
+ | `grip_pos_cmd` | `q_tar(dof)`, `kp(dof)`, `kd(dof)`, `err_limit(1)` | Joint position command for grip |
120
+
121
+ ### Grip LED Command (Hello Y6 only)
122
+
123
+ | Input | Fields | Description |
124
+ | --- | --- | --- |
125
+ | `grip_led_cmd` | `r(6)`, `g(6)`, `b(6)` | RGB LED strip command (0-255 per channel) |
126
+
127
+ ## Outputs
128
+
129
+ ### `arm_motor`
130
+
131
+ Archer Y6 / Firefly Y6: `{"pos": float64[6], "vel": float64[6], "eff": float64[6]}`
132
+
133
+ Hello Y6: `{"pos": float64[6], "vel": float64[6]}`
134
+
135
+ ### `arm_end`
136
+
137
+ Archer Y6 / Firefly Y6 only: `{"pos": float64[3], "quat": float64[4]}`
138
+
139
+ ### `grip_motor`
140
+
141
+ Archer Y6 / Firefly Y6: `{"pos": float64[dof], "vel": float64[dof], "eff": float64[dof]}`
142
+
143
+ Hello Y6: `{"pos": float64[7]}`
144
+
145
+ ## Arrow Dict Encoding
146
+
147
+ All data is transmitted as `dict[str, arr]` via flat `float64` Arrow arrays. The `metadata` dict describes the layout using field names as keys mapped to their array lengths:
148
+
149
+ ```python
150
+ # Example arm_motor metadata for Archer/Firefly Y6
151
+ metadata = {
152
+ "fields": "pos,vel,eff", # field order in the flat array
153
+ "pos": "6", # pos occupies 6 elements
154
+ "vel": "6",
155
+ "eff": "6",
156
+ }
157
+ ```
158
+
159
+ Use `hex_dora_node_robot.util.dict_decode` to unpack and `dict_encode` to pack:
160
+
161
+ ```python
162
+ from hex_dora_node_robot.util import dict_decode, dict_encode
163
+
164
+ # Decode state from a robot node
165
+ state = dict_decode(event["value"], event["metadata"])
166
+ print(state["pos"], state["vel"])
167
+
168
+ # Encode command to send to the robot node
169
+ import numpy as np
170
+ cmd = {
171
+ "q_tar": np.zeros(6),
172
+ "kp": np.array([400.0, 400.0, 500.0, 200.0, 100.0, 100.0]),
173
+ "kd": np.array([5.0, 5.0, 5.0, 5.0, 2.0, 2.0]),
174
+ "err_limit": np.array([0.03]),
175
+ }
176
+ storage, metadata = dict_encode(cmd, event["metadata"])
177
+ node.send_output("arm_pos_cmd", storage, metadata)
178
+ ```
179
+
180
+ ## Environment Variables
181
+
182
+ ### Common (all robot nodes)
183
+
184
+ | Variable | Type | Default | Description |
185
+ | --- | --- | --- | --- |
186
+ | `NODE_NAME` | `str` | `""` | Dora node name |
187
+ | `HOST` | `str` | `192.168.1.100` | Robot controller IP address |
188
+ | `PORT` | `int` | `8439` | WebSocket port |
189
+ | `CTRL_RATE` | `float` | `1000` | Control loop rate (Hz) |
190
+ | `STATE_BUFFER_SIZE` | `int` | `200` | Size of the state ring buffer |
191
+ | `SEN_TS` | `bool` | `True` | Use sensor timestamps |
192
+
193
+ ### Archer Y6 / Firefly Y6
194
+
195
+ | Variable | Type | Default | Description |
196
+ | --- | --- | --- | --- |
197
+ | `GRIP_TYPE` | `str` | `gp80` | Grip model (`gp80` or `empty` for no grip) |
198
+ | `POSE_END_IN_FLANGE` | `str` | `0.187,0.0,0.0,1.0,0.0,0.0,0.0` | End-effector pose in flange frame `[x,y,z,qw,qx,qy,qz]` |
199
+
200
+ ### Hello Y6
201
+
202
+ | Variable | Type | Default | Description |
203
+ | --- | --- | --- | --- |
204
+ | `LED_BUFFER_SIZE` | `int` | `10` | Size of the LED command buffer |
205
+
206
+ ## License
207
+
208
+ This project is licensed under Apache-2.0.
@@ -0,0 +1,118 @@
1
+ #!/usr/bin/env python3
2
+ # -*- coding:utf-8 -*-
3
+ ################################################################
4
+ # Copyright 2026 Dong Zhaorui. All rights reserved.
5
+ # Author: Dong Zhaorui 847235539@qq.com
6
+ # Date : 2026-04-13
7
+ ################################################################
8
+
9
+ import os, traceback
10
+ import numpy as np
11
+ from dora import Node
12
+ from hex_util_runtime import get_dora_node_name, get_dora_bool
13
+ from hex_driver_robot import HexRobotArcherY6, HexRobotArcherY6Params
14
+
15
+ from .util import dict_encode, dict_decode
16
+
17
+
18
+ def main():
19
+ node_name = get_dora_node_name(os.getenv('NODE_NAME', ""))
20
+ params = HexRobotArcherY6Params(
21
+ host=os.getenv('HOST', '192.168.1.100'),
22
+ port=int(os.getenv('PORT', '8439')),
23
+ ctrl_rate=float(os.getenv('CTRL_RATE', '1000')),
24
+ state_buffer_size=int(os.getenv('STATE_BUFFER_SIZE', '200')),
25
+ sens_ts=get_dora_bool(os.getenv('SEN_TS', 'True')),
26
+ grip_type=os.getenv('GRIP_TYPE', 'gp80'),
27
+ pose_end_in_flange=np.fromstring(
28
+ os.getenv('POSE_END_IN_FLANGE',
29
+ '0.187,0.0,0.0,1.0,0.0,0.0,0.0'),
30
+ sep=',',
31
+ ),
32
+ )
33
+ robot = None
34
+ try:
35
+ robot = HexRobotArcherY6(params)
36
+ robot.start()
37
+ dofs = robot.get_dofs()
38
+ grip_dof = dofs["grip"]
39
+
40
+ node = Node(node_name)
41
+ for event in node:
42
+ if event["type"] == "INPUT":
43
+ event_id = event["id"]
44
+
45
+ if event_id == "tick":
46
+ arm_motor = robot.get_arm_motor(latest=True)
47
+ if arm_motor is not None:
48
+ storage, metadata = dict_encode(
49
+ {
50
+ "pos": arm_motor["pos"],
51
+ "vel": arm_motor["vel"],
52
+ "eff": arm_motor["eff"],
53
+ },
54
+ event["metadata"],
55
+ )
56
+ node.send_output("arm_motor", storage, metadata)
57
+
58
+ arm_end = robot.get_arm_end(latest=True)
59
+ if arm_end is not None:
60
+ storage, metadata = dict_encode(
61
+ {
62
+ "pos": arm_end["pos"],
63
+ "quat": arm_end["quat"],
64
+ },
65
+ event["metadata"],
66
+ )
67
+ node.send_output("arm_end", storage, metadata)
68
+
69
+ if grip_dof > 0:
70
+ grip_motor = robot.get_grip_motor(latest=True)
71
+ if grip_motor is not None:
72
+ storage, metadata = dict_encode(
73
+ {
74
+ "pos": grip_motor["pos"],
75
+ "vel": grip_motor["vel"],
76
+ "eff": grip_motor["eff"],
77
+ },
78
+ event["metadata"],
79
+ )
80
+ node.send_output("grip_motor", storage, metadata)
81
+
82
+ elif event_id == "arm_mit_cmd":
83
+ cmd = dict_decode(event["value"], event["metadata"])
84
+ robot.set_arm_mit_cmd(cmd)
85
+
86
+ elif event_id == "arm_mit_comp_cmd":
87
+ cmd = dict_decode(event["value"], event["metadata"])
88
+ robot.set_arm_mit_comp_cmd(cmd)
89
+
90
+ elif event_id == "arm_pos_cmd":
91
+ cmd = dict_decode(event["value"], event["metadata"])
92
+ robot.set_arm_pos_cmd(cmd)
93
+
94
+ elif event_id == "arm_pose_cmd":
95
+ cmd = dict_decode(event["value"], event["metadata"])
96
+ robot.set_arm_pose_cmd(cmd)
97
+
98
+ elif event_id == "grip_mit_cmd":
99
+ cmd = dict_decode(event["value"], event["metadata"])
100
+ robot.set_grip_mit_cmd(cmd)
101
+
102
+ elif event_id == "grip_mit_comp_cmd":
103
+ cmd = dict_decode(event["value"], event["metadata"])
104
+ robot.set_grip_mit_comp_cmd(cmd)
105
+
106
+ elif event_id == "grip_pos_cmd":
107
+ cmd = dict_decode(event["value"], event["metadata"])
108
+ robot.set_grip_pos_cmd(cmd)
109
+
110
+ elif event["type"] == "ERROR":
111
+ raise RuntimeError(event["error"])
112
+
113
+ except Exception:
114
+ traceback.print_exc()
115
+ finally:
116
+ if robot is not None:
117
+ robot.stop()
118
+ robot.deinit_robot()
@@ -0,0 +1,118 @@
1
+ #!/usr/bin/env python3
2
+ # -*- coding:utf-8 -*-
3
+ ################################################################
4
+ # Copyright 2026 Dong Zhaorui. All rights reserved.
5
+ # Author: Dong Zhaorui 847235539@qq.com
6
+ # Date : 2026-04-13
7
+ ################################################################
8
+
9
+ import os, traceback
10
+ import numpy as np
11
+ from dora import Node
12
+ from hex_util_runtime import get_dora_node_name, get_dora_bool
13
+ from hex_driver_robot import HexRobotFireflyY6, HexRobotFireflyY6Params
14
+
15
+ from .util import dict_encode, dict_decode
16
+
17
+
18
+ def main():
19
+ node_name = get_dora_node_name(os.getenv('NODE_NAME', ""))
20
+ params = HexRobotFireflyY6Params(
21
+ host=os.getenv('HOST', '192.168.1.100'),
22
+ port=int(os.getenv('PORT', '8439')),
23
+ ctrl_rate=float(os.getenv('CTRL_RATE', '1000')),
24
+ state_buffer_size=int(os.getenv('STATE_BUFFER_SIZE', '200')),
25
+ sens_ts=get_dora_bool(os.getenv('SEN_TS', 'True')),
26
+ grip_type=os.getenv('GRIP_TYPE', 'gp80'),
27
+ pose_end_in_flange=np.fromstring(
28
+ os.getenv('POSE_END_IN_FLANGE',
29
+ '0.187,0.0,0.0,1.0,0.0,0.0,0.0'),
30
+ sep=',',
31
+ ),
32
+ )
33
+ robot = None
34
+ try:
35
+ robot = HexRobotFireflyY6(params)
36
+ robot.start()
37
+ dofs = robot.get_dofs()
38
+ grip_dof = dofs["grip"]
39
+
40
+ node = Node(node_name)
41
+ for event in node:
42
+ if event["type"] == "INPUT":
43
+ event_id = event["id"]
44
+
45
+ if event_id == "tick":
46
+ arm_motor = robot.get_arm_motor(latest=True)
47
+ if arm_motor is not None:
48
+ storage, metadata = dict_encode(
49
+ {
50
+ "pos": arm_motor["pos"],
51
+ "vel": arm_motor["vel"],
52
+ "eff": arm_motor["eff"],
53
+ },
54
+ event["metadata"],
55
+ )
56
+ node.send_output("arm_motor", storage, metadata)
57
+
58
+ arm_end = robot.get_arm_end(latest=True)
59
+ if arm_end is not None:
60
+ storage, metadata = dict_encode(
61
+ {
62
+ "pos": arm_end["pos"],
63
+ "quat": arm_end["quat"],
64
+ },
65
+ event["metadata"],
66
+ )
67
+ node.send_output("arm_end", storage, metadata)
68
+
69
+ if grip_dof > 0:
70
+ grip_motor = robot.get_grip_motor(latest=True)
71
+ if grip_motor is not None:
72
+ storage, metadata = dict_encode(
73
+ {
74
+ "pos": grip_motor["pos"],
75
+ "vel": grip_motor["vel"],
76
+ "eff": grip_motor["eff"],
77
+ },
78
+ event["metadata"],
79
+ )
80
+ node.send_output("grip_motor", storage, metadata)
81
+
82
+ elif event_id == "arm_mit_cmd":
83
+ cmd = dict_decode(event["value"], event["metadata"])
84
+ robot.set_arm_mit_cmd(cmd)
85
+
86
+ elif event_id == "arm_mit_comp_cmd":
87
+ cmd = dict_decode(event["value"], event["metadata"])
88
+ robot.set_arm_mit_comp_cmd(cmd)
89
+
90
+ elif event_id == "arm_pos_cmd":
91
+ cmd = dict_decode(event["value"], event["metadata"])
92
+ robot.set_arm_pos_cmd(cmd)
93
+
94
+ elif event_id == "arm_pose_cmd":
95
+ cmd = dict_decode(event["value"], event["metadata"])
96
+ robot.set_arm_pose_cmd(cmd)
97
+
98
+ elif event_id == "grip_mit_cmd":
99
+ cmd = dict_decode(event["value"], event["metadata"])
100
+ robot.set_grip_mit_cmd(cmd)
101
+
102
+ elif event_id == "grip_mit_comp_cmd":
103
+ cmd = dict_decode(event["value"], event["metadata"])
104
+ robot.set_grip_mit_comp_cmd(cmd)
105
+
106
+ elif event_id == "grip_pos_cmd":
107
+ cmd = dict_decode(event["value"], event["metadata"])
108
+ robot.set_grip_pos_cmd(cmd)
109
+
110
+ elif event["type"] == "ERROR":
111
+ raise RuntimeError(event["error"])
112
+
113
+ except Exception:
114
+ traceback.print_exc()
115
+ finally:
116
+ if robot is not None:
117
+ robot.stop()
118
+ robot.deinit_robot()
@@ -0,0 +1,73 @@
1
+ #!/usr/bin/env python3
2
+ # -*- coding:utf-8 -*-
3
+ ################################################################
4
+ # Copyright 2026 Dong Zhaorui. All rights reserved.
5
+ # Author: Dong Zhaorui 847235539@qq.com
6
+ # Date : 2026-04-13
7
+ ################################################################
8
+
9
+ import os, traceback
10
+ import numpy as np
11
+ from dora import Node
12
+ from hex_util_runtime import get_dora_node_name, get_dora_bool
13
+ from hex_driver_robot import HexRobotHelloY6, HexRobotHelloY6Params
14
+
15
+ from .util import dict_encode, dict_decode
16
+
17
+
18
+ def main():
19
+ node_name = get_dora_node_name(os.getenv('NODE_NAME', ""))
20
+ params = HexRobotHelloY6Params(
21
+ host=os.getenv('HOST', '192.168.1.100'),
22
+ port=int(os.getenv('PORT', '8439')),
23
+ ctrl_rate=float(os.getenv('CTRL_RATE', '1000')),
24
+ state_buffer_size=int(os.getenv('STATE_BUFFER_SIZE', '200')),
25
+ sens_ts=get_dora_bool(os.getenv('SEN_TS', 'True')),
26
+ led_buffer_size=int(os.getenv('LED_BUFFER_SIZE', '10')),
27
+ )
28
+ robot = None
29
+ try:
30
+ robot = HexRobotHelloY6(params)
31
+ robot.start()
32
+
33
+ node = Node(node_name)
34
+ for event in node:
35
+ if event["type"] == "INPUT":
36
+ event_id = event["id"]
37
+
38
+ if event_id == "tick":
39
+ arm_motor = robot.get_arm_motor(latest=True)
40
+ if arm_motor is not None:
41
+ storage, metadata = dict_encode(
42
+ ["pos", "vel"],
43
+ arm_motor,
44
+ event["metadata"],
45
+ )
46
+ node.send_output("arm_motor", storage, metadata)
47
+
48
+ grip_motor = robot.get_grip_motor(latest=True)
49
+ if grip_motor is not None:
50
+ storage, metadata = dict_encode(
51
+ {
52
+ "pos": grip_motor["pos"],
53
+ },
54
+ event["metadata"],
55
+ )
56
+ node.send_output("grip_motor", storage, metadata)
57
+
58
+ elif event_id == "grip_led_cmd":
59
+ cmd = dict_decode(event["value"], event["metadata"])
60
+ cmd["r"] = cmd["r"].astype(np.int64)
61
+ cmd["g"] = cmd["g"].astype(np.int64)
62
+ cmd["b"] = cmd["b"].astype(np.int64)
63
+ robot.set_grip_led_cmd(cmd)
64
+
65
+ elif event["type"] == "ERROR":
66
+ raise RuntimeError(event["error"])
67
+
68
+ except Exception:
69
+ traceback.print_exc()
70
+ finally:
71
+ if robot is not None:
72
+ robot.stop()
73
+ robot.deinit_robot()
@@ -0,0 +1,37 @@
1
+ #!/usr/bin/env python3
2
+ # -*- coding:utf-8 -*-
3
+ ################################################################
4
+ # Copyright 2026 Dong Zhaorui. All rights reserved.
5
+ # Author: Dong Zhaorui 847235539@qq.com
6
+ # Date : 2026-04-13
7
+ ################################################################
8
+
9
+ import numpy as np
10
+ import pyarrow as pa
11
+
12
+
13
+ def dict_encode(keys, data_dict, metadata):
14
+ metadata.pop("timestamp", None)
15
+ metadata["fields"] = ",".join(keys)
16
+
17
+ parts = []
18
+ for key in keys:
19
+ val = np.atleast_1d(np.asarray(data_dict[key],
20
+ dtype=np.float64)).ravel()
21
+ parts.append(val)
22
+ metadata[key] = str(len(val))
23
+
24
+ storage = pa.array(np.concatenate(parts))
25
+ return storage, metadata
26
+
27
+
28
+ def dict_decode(storage, metadata):
29
+ data = storage.to_numpy().astype(np.float64)
30
+ fields = metadata["fields"].split(",")
31
+ result = {}
32
+ offset = 0
33
+ for f in fields:
34
+ size = int(metadata[f])
35
+ result[f] = data[offset:offset + size] if size > 1 else data[offset]
36
+ offset += size
37
+ return result
@@ -0,0 +1,221 @@
1
+ Metadata-Version: 2.4
2
+ Name: hex_dora_node_robot
3
+ Version: 0.0.1a1
4
+ Summary: Dora Node for using Hex Robot
5
+ Author-email: Dong Zhaorui <847235539@qq.com>
6
+ License-Expression: Apache-2.0
7
+ Requires-Python: >=3.10
8
+ Description-Content-Type: text/markdown
9
+ License-File: LICENSE
10
+ Requires-Dist: dora-rs>=0.3.9
11
+ Requires-Dist: hex-driver-robot<0.1.0,>=0.0.0
12
+ Dynamic: license-file
13
+
14
+ # hex_dora_node_robot
15
+
16
+ Dora nodes for controlling HEXFELLOW robot arms. Supports Archer Y6, Firefly Y6, and Hello Y6 robot models with state reading and command sending over the Dora dataflow.
17
+
18
+ ## Nodes
19
+
20
+ | Node | Description | Inputs | Outputs |
21
+ | --- | --- | --- | --- |
22
+ | `hex-dora-node-archer-y6` | Archer Y6 robot driver (6-DOF arm with optional grip) | `tick`, `arm_mit_cmd`, `arm_mit_comp_cmd`, `arm_pos_cmd`, `arm_pose_cmd`, `grip_mit_cmd`, `grip_mit_comp_cmd`, `grip_pos_cmd` | `arm_motor`, `arm_end`, `grip_motor` |
23
+ | `hex-dora-node-firefly-y6` | Firefly Y6 robot driver (6-DOF arm with optional grip) | `tick`, `arm_mit_cmd`, `arm_mit_comp_cmd`, `arm_pos_cmd`, `arm_pose_cmd`, `grip_mit_cmd`, `grip_mit_comp_cmd`, `grip_pos_cmd` | `arm_motor`, `arm_end`, `grip_motor` |
24
+ | `hex-dora-node-hello-y6` | Hello Y6 robot driver (6-DOF arm with 7-DOF grip and RGB LED) | `tick`, `grip_led_cmd` | `arm_motor`, `grip_motor` |
25
+
26
+ ## Installation
27
+
28
+ ```bash
29
+ pip install hex_dora_node_robot
30
+ ```
31
+
32
+ ## YAML Examples
33
+
34
+ ### Archer Y6
35
+
36
+ ```yaml
37
+ nodes:
38
+ - id: archer_y6
39
+ build: pip install hex_dora_node_robot
40
+ path: hex-dora-node-archer-y6
41
+ inputs:
42
+ tick: dora/timer/millis/2
43
+ arm_pos_cmd: planner/arm_pos_cmd
44
+ grip_pos_cmd: planner/grip_pos_cmd
45
+ outputs:
46
+ - arm_motor
47
+ - arm_end
48
+ - grip_motor
49
+ env:
50
+ NODE_NAME: archer_y6
51
+ HOST: 192.168.1.100
52
+ PORT: 8439
53
+ CTRL_RATE: 1000
54
+ STATE_BUFFER_SIZE: 200
55
+ SEN_TS: True
56
+ GRIP_TYPE: gp80
57
+ POSE_END_IN_FLANGE: 0.187,0.0,0.0,1.0,0.0,0.0,0.0
58
+ ```
59
+
60
+ ### Firefly Y6
61
+
62
+ ```yaml
63
+ nodes:
64
+ - id: firefly_y6
65
+ build: pip install hex_dora_node_robot
66
+ path: hex-dora-node-firefly-y6
67
+ inputs:
68
+ tick: dora/timer/millis/2
69
+ arm_pos_cmd: planner/arm_pos_cmd
70
+ grip_pos_cmd: planner/grip_pos_cmd
71
+ outputs:
72
+ - arm_motor
73
+ - arm_end
74
+ - grip_motor
75
+ env:
76
+ NODE_NAME: firefly_y6
77
+ HOST: 192.168.1.100
78
+ PORT: 8439
79
+ CTRL_RATE: 1000
80
+ STATE_BUFFER_SIZE: 200
81
+ SEN_TS: True
82
+ GRIP_TYPE: gp80
83
+ POSE_END_IN_FLANGE: 0.187,0.0,0.0,1.0,0.0,0.0,0.0
84
+ ```
85
+
86
+ ### Hello Y6
87
+
88
+ ```yaml
89
+ nodes:
90
+ - id: hello_y6
91
+ build: pip install hex_dora_node_robot
92
+ path: hex-dora-node-hello-y6
93
+ inputs:
94
+ tick: dora/timer/millis/2
95
+ grip_led_cmd: planner/grip_led_cmd
96
+ outputs:
97
+ - arm_motor
98
+ - grip_motor
99
+ env:
100
+ NODE_NAME: hello_y6
101
+ HOST: 192.168.1.100
102
+ PORT: 8439
103
+ CTRL_RATE: 1000
104
+ STATE_BUFFER_SIZE: 200
105
+ SEN_TS: True
106
+ LED_BUFFER_SIZE: 10
107
+ ```
108
+
109
+ ## Inputs
110
+
111
+ ### Timer
112
+
113
+ | Input | Type | Description |
114
+ | --- | --- | --- |
115
+ | `tick` | `dora/timer/millis/*` | Timer tick to trigger state reading |
116
+
117
+ ### Arm Commands (Archer Y6 / Firefly Y6 only)
118
+
119
+ | Input | Fields | Description |
120
+ | --- | --- | --- |
121
+ | `arm_mit_cmd` | `q_tar(6)`, `dq_tar(6)`, `tau(6)`, `kp(6)`, `kd(6)` | MIT torque command for arm |
122
+ | `arm_mit_comp_cmd` | `q_tar(6)`, `dq_tar(6)`, `tau(6)`, `kp(6)`, `kd(6)` | MIT command with gravity/friction compensation |
123
+ | `arm_pos_cmd` | `q_tar(6)`, `kp(6)`, `kd(6)`, `err_limit(1)` | Joint position command for arm |
124
+ | `arm_pose_cmd` | `pos(3)`, `quat(4)`, `kp(6)`, `kd(6)`, `err_limit(1)` | Cartesian pose command for arm |
125
+
126
+ ### Grip Commands (Archer Y6 / Firefly Y6 only)
127
+
128
+ | Input | Fields | Description |
129
+ | --- | --- | --- |
130
+ | `grip_mit_cmd` | `q_tar(dof)`, `dq_tar(dof)`, `tau(dof)`, `kp(dof)`, `kd(dof)` | MIT torque command for grip |
131
+ | `grip_mit_comp_cmd` | `q_tar(dof)`, `dq_tar(dof)`, `tau(dof)`, `kp(dof)`, `kd(dof)` | MIT command with friction compensation |
132
+ | `grip_pos_cmd` | `q_tar(dof)`, `kp(dof)`, `kd(dof)`, `err_limit(1)` | Joint position command for grip |
133
+
134
+ ### Grip LED Command (Hello Y6 only)
135
+
136
+ | Input | Fields | Description |
137
+ | --- | --- | --- |
138
+ | `grip_led_cmd` | `r(6)`, `g(6)`, `b(6)` | RGB LED strip command (0-255 per channel) |
139
+
140
+ ## Outputs
141
+
142
+ ### `arm_motor`
143
+
144
+ Archer Y6 / Firefly Y6: `{"pos": float64[6], "vel": float64[6], "eff": float64[6]}`
145
+
146
+ Hello Y6: `{"pos": float64[6], "vel": float64[6]}`
147
+
148
+ ### `arm_end`
149
+
150
+ Archer Y6 / Firefly Y6 only: `{"pos": float64[3], "quat": float64[4]}`
151
+
152
+ ### `grip_motor`
153
+
154
+ Archer Y6 / Firefly Y6: `{"pos": float64[dof], "vel": float64[dof], "eff": float64[dof]}`
155
+
156
+ Hello Y6: `{"pos": float64[7]}`
157
+
158
+ ## Arrow Dict Encoding
159
+
160
+ All data is transmitted as `dict[str, arr]` via flat `float64` Arrow arrays. The `metadata` dict describes the layout using field names as keys mapped to their array lengths:
161
+
162
+ ```python
163
+ # Example arm_motor metadata for Archer/Firefly Y6
164
+ metadata = {
165
+ "fields": "pos,vel,eff", # field order in the flat array
166
+ "pos": "6", # pos occupies 6 elements
167
+ "vel": "6",
168
+ "eff": "6",
169
+ }
170
+ ```
171
+
172
+ Use `hex_dora_node_robot.util.dict_decode` to unpack and `dict_encode` to pack:
173
+
174
+ ```python
175
+ from hex_dora_node_robot.util import dict_decode, dict_encode
176
+
177
+ # Decode state from a robot node
178
+ state = dict_decode(event["value"], event["metadata"])
179
+ print(state["pos"], state["vel"])
180
+
181
+ # Encode command to send to the robot node
182
+ import numpy as np
183
+ cmd = {
184
+ "q_tar": np.zeros(6),
185
+ "kp": np.array([400.0, 400.0, 500.0, 200.0, 100.0, 100.0]),
186
+ "kd": np.array([5.0, 5.0, 5.0, 5.0, 2.0, 2.0]),
187
+ "err_limit": np.array([0.03]),
188
+ }
189
+ storage, metadata = dict_encode(cmd, event["metadata"])
190
+ node.send_output("arm_pos_cmd", storage, metadata)
191
+ ```
192
+
193
+ ## Environment Variables
194
+
195
+ ### Common (all robot nodes)
196
+
197
+ | Variable | Type | Default | Description |
198
+ | --- | --- | --- | --- |
199
+ | `NODE_NAME` | `str` | `""` | Dora node name |
200
+ | `HOST` | `str` | `192.168.1.100` | Robot controller IP address |
201
+ | `PORT` | `int` | `8439` | WebSocket port |
202
+ | `CTRL_RATE` | `float` | `1000` | Control loop rate (Hz) |
203
+ | `STATE_BUFFER_SIZE` | `int` | `200` | Size of the state ring buffer |
204
+ | `SEN_TS` | `bool` | `True` | Use sensor timestamps |
205
+
206
+ ### Archer Y6 / Firefly Y6
207
+
208
+ | Variable | Type | Default | Description |
209
+ | --- | --- | --- | --- |
210
+ | `GRIP_TYPE` | `str` | `gp80` | Grip model (`gp80` or `empty` for no grip) |
211
+ | `POSE_END_IN_FLANGE` | `str` | `0.187,0.0,0.0,1.0,0.0,0.0,0.0` | End-effector pose in flange frame `[x,y,z,qw,qx,qy,qz]` |
212
+
213
+ ### Hello Y6
214
+
215
+ | Variable | Type | Default | Description |
216
+ | --- | --- | --- | --- |
217
+ | `LED_BUFFER_SIZE` | `int` | `10` | Size of the LED command buffer |
218
+
219
+ ## License
220
+
221
+ This project is licensed under Apache-2.0.
@@ -0,0 +1,15 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ hex_dora_node_robot/__init__.py
5
+ hex_dora_node_robot/main_archer_y6.py
6
+ hex_dora_node_robot/main_firefly_y6.py
7
+ hex_dora_node_robot/main_hello_y6.py
8
+ hex_dora_node_robot/main_robot_test.py
9
+ hex_dora_node_robot/util.py
10
+ hex_dora_node_robot.egg-info/PKG-INFO
11
+ hex_dora_node_robot.egg-info/SOURCES.txt
12
+ hex_dora_node_robot.egg-info/dependency_links.txt
13
+ hex_dora_node_robot.egg-info/entry_points.txt
14
+ hex_dora_node_robot.egg-info/requires.txt
15
+ hex_dora_node_robot.egg-info/top_level.txt
@@ -0,0 +1,4 @@
1
+ [console_scripts]
2
+ hex-dora-node-archer-y6 = hex_dora_node_robot.main_archer_y6:main
3
+ hex-dora-node-firefly-y6 = hex_dora_node_robot.main_firefly_y6:main
4
+ hex-dora-node-hello-y6 = hex_dora_node_robot.main_hello_y6:main
@@ -0,0 +1,2 @@
1
+ dora-rs>=0.3.9
2
+ hex-driver-robot<0.1.0,>=0.0.0
@@ -0,0 +1 @@
1
+ hex_dora_node_robot
@@ -0,0 +1,33 @@
1
+ [project]
2
+ name = "hex_dora_node_robot"
3
+ version = "0.0.1-alpha.1"
4
+ authors = [{ name = "Dong Zhaorui", email = "847235539@qq.com" }]
5
+ description = "Dora Node for using Hex Robot"
6
+ license = "Apache-2.0"
7
+ readme = "README.md"
8
+ requires-python = ">=3.10"
9
+
10
+ dependencies = [
11
+ "dora-rs>=0.3.9",
12
+ "hex-driver-robot>=0.0.0,<0.1.0",
13
+ ]
14
+
15
+ [dependency-groups]
16
+ dev = ["pytest>=8.1.1", "ruff>=0.9.1"]
17
+
18
+ [project.scripts]
19
+ hex-dora-node-archer-y6 = "hex_dora_node_robot.main_archer_y6:main"
20
+ hex-dora-node-firefly-y6 = "hex_dora_node_robot.main_firefly_y6:main"
21
+ hex-dora-node-hello-y6 = "hex_dora_node_robot.main_hello_y6:main"
22
+
23
+ [tool.ruff.lint]
24
+ extend-select = [
25
+ "D", # pydocstyle
26
+ "UP", # Ruff's UP rule
27
+ "PERF", # Ruff's PERF rule
28
+ "RET", # Ruff's RET rule
29
+ "RSE", # Ruff's RSE rule
30
+ "NPY", # Ruff's NPY rule
31
+ "N", # Ruff's N rule
32
+ "I", # Ruff's I rule
33
+ ]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+