Wiki source code of SES-PRO Robotic Arm UI

Version 25.2 by Eric Nantel on 2024/10/09 16:01

Show last authors
1 {{lightbox image="https://wiki.lynxmotion.com/info/wiki/lynxmotion/download/ses-pro/ses-pro-software/ses-pro-arm-ui/WebHome/LSS-PRO-UI.png" width="350"/}}
2
3 [[image:[email protected]]]
4
5 **Table of Contents**
6
7 {{toc/}}
8
9 = Installation =
10
11 Windows 7 Operating System or above
12
13 = Description =
14
15 The Lynxmotion Servo Erector Set Professional (SES PRO) Arm Interface is a simple software which allows a user to control any of the Lynxmotion Professional Modular robotic arms in their default configuration. The two compatible gripper kits which are compatible with the SES PRO system (based on the DH Robotics PGE-50-40 and CGE-10-10 DC grillers) can also be controlled via this interface in each of their possible configurations. The included manual jog feature can be used to either position each joint angle, or move to specific cartesian coordinates. Arm (and gripper) positions can then be recorded as part of the built-in sequencer. A 3D display of the arm shows the position of the arm, and a graph can be used to show various information to the user. In order to get a better understanding of the protocol, commands sent to the arm are shown in the interface, and a user input field are standard.
16
17 = Features =
18
19 * Angular and cartesian positioning of the end effector
20 * 3D graphical display of the appropriate robotic arm and end effector
21 * Sequencer to record and play back frames (single, looped or infinite)
22 * Error checking (speed, temperature etc.)
23 * Command output and user input
24 * Safety (Software E-Stop, Halt&Hold & Limp)
25
26 |(% colspan="2" %)(((
27 = User Guide =
28 )))
29 |(% style="width:25px" %) |(((
30 Pressing the i "Information" icon in the software will bring you to this page. Before proceeding with the guide, it is important to note the following:
31
32 * Neither the servos nor the arm are meant to be operated in proximity of humans as they do not have "collaborative" (COBOT) features and do not detect collision
33 * The servos use stepper motors and do NOT include mechanical brakes. If the stepper motor is unable to retain or move to a desired angle (insufficient torque), the motor will rotate freely as opposed to hold the last position
34 )))
35 |(% colspan="2" %)(((
36 == IMPORTANT ==
37 )))
38 | |(((
39 === Payload Considerations ===
40
41 1. The rated payload for each arm does NOT include an end effector, nor any added distance between the center of mass of the payload and the output of the final joint. Each of the two compatible Lynxmotion PRO grippers reduce the maximum payload of each arm, and it is up to the user to known and understand the concept of "torque" and center of mass before adding an end effector and payload.
42 1. The rated maximum payload for each arm (at full reach) is at the rated speed for each motor. Moving any joint at a higher speed will decrease the payload capacity of the robot.
43 1. Although each servo can provide significantly more torque than is needed for the rated payload (and therefore means the arm can support much higher loads at lower speeds, the mechanical and modular structure of the arms may fail. We strongly suggest testing and using each arm in a highly controlled and safe setting where, if a failure should occur with one or more joints, that nothing will break should the arm fall.
44 1. The stepper motors provide the highest torque at low speeds, and lower torque at high speeds. Note that the maxium torque is not at the lowest speed as the torque to rpm curve for each servo resembles a "mountain".
45 )))
46 | |(((
47 === Emergency ===
48
49 Before using the arm, it is important that a user know what to do when an issue or emergency arises where the arm must be stopped quickly. The following emergency options are available based on severity:
50
51 **Halt & Hold**
52
53 This will stop every joints and hold them in their last recorded angular positions. The corresponding command is #254H<cr>.
54
55 **Limp**
56
57 All joints will go limp which mean there will be nothing avoiding them to turn freely (potentially causing the arm to fall). The high gear ratio of the strain wave gearing does mean there is some (low) level of resistant to rotation, but the gears and motor are nto "locked" and as such, the arm may fall. The corresponding command is #254L<cr>.
58
59 **Software Stop**
60
61 The E-stop button within the software sets all joints to limp.
62
63 **Hardware E-Stop**
64 A hardware E-stop (push to cut power) button is located on the power supply which will cut electricity to all actuators. Similar to a limp command, this can possibly cause the arm to fall. To reset this button, rotate the red "mushroom" in the direction indicated by the white arrows and it will spring out.
65 )))
66 |(% colspan="2" %)(((
67 == Arm Connection ==
68 )))
69 | |(((
70 **Model**
71
72 The software currently supports the following Lynxmotion PRO Arms:
73
74 * 550mm 5DoF
75 * 550mm 6DoF
76 * 900mm 5DoF
77 * 900mm 6DoF
78
79 In practice, each 5DoF arm has joint 4 at a fixed angle, otherwise the arms are identical to the 6DoF. Users can always purchase the missing actuator to upgrade to a 6DoF.
80
81 **COM Port**
82
83 The first joint at the base (J1) must be connected via USB to a computer running the sofware. No other joints should have a USB connection. A USB 3.0 port or higher on the computer is suggested, as the lower communication speeds fo USB 2.0 or 1.0 may impede communication and cause unecessary delay or issues. 
84
85 **Connect**
86
87 Once the COM port has been selection, the CONNECT button can be pressed, and once a servo has been found, the light next to it will go from red to green.
88 )))
89 |(% colspan="2" %)(((
90 == Gripper Controls ==
91 )))
92 | |(((
93 **Model**
94
95 The software currently supports two models of Lynxmotion PRO compatible grippers based on DH Robots' PGE-50-40 and CGE-10-10 electric grippers. The Lynxmotion kits include hardware to mount the fingers in multiple different offsets for smaller or larger objects. In the sequencer, the position of the fingers for each gripper are included in the sequencer as J7.
96
97 * PGE-50-40 (40mm default configuration)
98 * PGE-50-40 (60mm configuration)
99 * PGE-50-40 (80mm configuration)
100 * CGE-10-10 (20mm configuration)
101 * CGE-10-10 (40mm configuration)
102 * CGE-10-10 (60mm configuration)
103
104 **COM Port**
105
106 Choose the appropriate COM port to which the gripper is connected (via its own USB cable). If you are not certain, you can check Windows -> Device Manager
107
108 **Baudrate**
109
110 The DH Robotics grippers provide the option to change the baud rate, though the default is 115200. If the gripper is configured by the user to a different baud rate, it is important to select the corresponding baud rate in teh software.
111
112 **Initialize**
113
114 Initializing the gripper opens it fully. This is available should the user encounter issues with positioning and need to re-zero the fingers.
115
116 **Connect**
117
118 Pressing CONNECT establishes a connection to the gripper and goes through the initilization process once, opening the gripper fully. Once connection has been established, the light next to the button will go from red to green.
119
120 **Speed**
121
122 The speed of motion can be adjusted either via the plus or minus buttons or entering a value between 0 and 100 and pressing enter.
123
124 **Force**
125
126 The maximum force exerted by the gripper can be adjusted either via the plus or minus buttons or entering a value between 0 and 100 and pressing enter.
127
128 **Open / Close**
129
130 These are shortcut buttons to either fully open or fully close the gripper.
131
132 **Sequencer**
133
134 The sequencer displays the gripper position as joint 7 (J7).
135
136 HINT: If you want the gripper to open or close on an object only at the end of a motion, create a separate frame where only J7 moves.
137 )))
138 | |
139 | |
140 | |
141 | |
142 | |
143 | |
144 | |
145 | |
146 | |
147 | |
148 | |
149 | |
150 | |
151 | |
152 | |
153 | |
154 | |
155 | |
156 | |
157 | |
158 | |
159 | |
160 | |
161 | |
162 | |
163 | |
164 | |
165 | |
166 | |
167 | |
168 | |
169 | |
170 | |
171 | |
172 | |
173 | |
174 | |
175 | |
176 | |
177 | |
178 | |
179 | |
180 | |
181 | |
182 | |
183 | |
184 | |
185 | |
186 | |
187 | |
188 | |
189 | |
190 | |
191 | |
192 | |
193 | |
194 | |
195 | |
196 | |
197 | |
198 | |
199 | |
200 | |
201 | |
202 | |
203 | |
204
205 = =
206
207 = User Guide =
208
209 Pressing the i "Information" icon in the software will bring you to this page. Before proceeding with the guide, it is important to note the following:
210
211 * Neither the servos nor the arm are meant to be operated in proximity of humans as they do not have "collaborative" (COBOT) features and do not detect collision
212 * The servos use stepper motors and do NOT include mechanical brakes. If the stepper motor is unable to retain or move to a desired angle (insufficient torque), the motor will rotate freely as opposed to hold the last position
213
214 == IMPORTANT: Payload Considerations ==
215
216 1. The rated payload for each arm does NOT include an end effector, nor any added distance between the center of mass of the payload and the output of the final joint. Each of the two compatible Lynxmotion PRO grippers reduce the maximum payload of each arm, and it is up to the user to known and understand the concept of "torque" and center of mass before adding an end effector and payload.
217 1. The rated maximum payload for each arm (at full reach) is at the rated speed for each motor. Moving any joint at a higher speed will decrease the payload capacity of the robot.
218 1. Although each servo can provide significantly more torque than is needed for the rated payload (and therefore means the arm can support much higher loads at lower speeds, the mechanical and modular structure of the arms may fail. We strongly suggest testing and using each arm in a highly controlled and safe setting where, if a failure should occur with one or more joints, that nothing will break should the arm fall.
219 1. The stepper motors provide the highest torque at low speeds, and lower torque at high speeds. Note that the maxium torque is not at the lowest speed as the torque to rpm curve for each servo resembles a "mountain".
220
221 == IMPORTANT: Emergency ==
222
223 Before using the arm, it is important that a user know what to do when an issue or emergency arises where the arm must be stopped quickly. The following emergency options are available based on severity:
224
225 **Halt & Hold**
226
227 This will stop every joints and hold them in their last recorded angular positions. The corresponding command is #254H<cr>.
228
229 **Limp**
230
231 All joints will go limp which mean there will be nothing avoiding them to turn freely (potentially causing the arm to fall). The high gear ratio of the strain wave gearing does mean there is some (low) level of resistant to rotation, but the gears and motor are nto "locked" and as such, the arm may fall. The corresponding command is #254L<cr>.
232
233 **Software Stop**
234
235 The E-stop button within the software sets all joints to limp.
236
237 **Hardware E-Stop**
238 A hardware E-stop (push to cut power) button is located on the power supply which will cut electricity to all actuators. Similar to a limp command, this can possibly cause the arm to fall. To reset this button, rotate the red "mushroom" in the direction indicated by the white arrows and it will spring out.
239
240 == Arm Connection ==
241
242 **Model**
243
244 The software currently supports the following Lynxmotion PRO Arms:
245
246 * 550mm 5DoF
247 * 550mm 6DoF
248 * 900mm 5DoF
249 * 900mm 6DoF
250
251 In practice, each 5DoF arm has joint 4 at a fixed angle, otherwise the arms are identical to the 6DoF. Users can always purchase the missing actuator to upgrade to a 6DoF.
252
253 **COM Port**
254
255 The first joint at the base (J1) must be connected via USB to a computer running the sofware. No other joints should have a USB connection. A USB 3.0 port or higher on the computer is suggested, as the lower communication speeds fo USB 2.0 or 1.0 may impede communication and cause unecessary delay or issues. 
256
257 **Connect**
258
259 Once the COM port has been selection, the CONNECT button can be pressed, and once a servo has been found, the light next to it will go from red to green.
260
261 == Gripper Controls ==
262
263 **Model**
264
265 The software currently supports two models of Lynxmotion PRO compatible grippers based on DH Robots' PGE-50-40 and CGE-10-10 electric grippers. The Lynxmotion kits include hardware to mount the fingers in multiple different offsets for smaller or larger objects. In the sequencer, the position of the fingers for each gripper are included in the sequencer as J7.
266
267 * PGE-50-40 (40mm default configuration)
268 * PGE-50-40 (60mm configuration)
269 * PGE-50-40 (80mm configuration)
270 * CGE-10-10 (20mm configuration)
271 * CGE-10-10 (40mm configuration)
272 * CGE-10-10 (60mm configuration)
273
274 **COM Port**
275
276 Choose the appropriate COM port to which the gripper is connected (via its own USB cable). If you are not certain, you can check Windows -> Device Manager
277
278 **Baudrate**
279
280 The DH Robotics grippers provide the option to change the baud rate, though the default is 115200. If the gripper is configured by the user to a different baud rate, it is important to select the corresponding baud rate in teh software.
281
282 **Initialize**
283
284 Initializing the gripper opens it fully. This is available should the user encounter issues with positioning and need to re-zero the fingers.
285
286 **Connect**
287
288 Pressing CONNECT establishes a connection to the gripper and goes through the initilization process once, opening the gripper fully. Once connection has been established, the light next to the button will go from red to green.
289
290 **Speed**
291
292 The speed of motion can be adjusted either via the plus or minus buttons or entering a value between 0 and 100 and pressing enter.
293
294 **Force**
295
296 The maximum force exerted by the gripper can be adjusted either via the plus or minus buttons or entering a value between 0 and 100 and pressing enter.
297
298 **Open / Close**
299
300 These are shortcut buttons to either fully open or fully close the gripper.
301
302 **Sequencer**
303
304 The sequencer displays the gripper position as joint 7 (J7).
305
306 HINT: If you want the gripper to open or close on an object only at the end of a motion, create a separate frame where only J7 moves.
307
308 == 3D Model ==
309
310 The 3D model of the arm is shown as reference at all times. The display also includes a virtual plane to denote  the X-Y plane. The model updates based on the selection of the arm, gripper and finger configuration.
311
312 **View Controls**
313
314 Zoom: Shift + Middle Scroll
315
316 Rotate: Shift + Middle Mouse
317
318 Pan: None
319
320 == Manual Move ==
321
322 **Angular Control**
323
324 In angular mode, the user can control the angle of each joint
325
326 **Coordinates Control**
327
328 In coordinate control the user can control the cartesian position of the end effector
329
330 **End Effector Lock**
331
332 The orientation of the end effector can be locked.
333
334 == Direct Command ==
335
336 This section allow the user to send commands using the [[doc:ses-pro.lss-pro.lss-p-communication-protocol.WebHome]] directly if required.
337
338 A few things to keep in mind when using this:
339
340 * Make sure you know what you are doing as you can make the arm move in __dangerous__ ways.
341 * Sending commands does not require ‘#’ and ‘\r’ chars.
342 ** example for #2\r you should enter 2Q and press the "SEND" button
343 * The commands are validated, and it shows a notification in case of error.
344 * The replies of queries are shown in the text field below.
345
346 == Command Output ==
347
348 //{Coming Soon}//
349
350 == Telemetry ==
351
352 **Data to Display**
353
354 //{Coming Soon}//
355
356 **Display / Hide Actuator**
357
358 //{Coming Soon}//
359
360 == Sequencer ==
361
362 **Frames**
363
364 //{Coming Soon}//
365
366 **Record **
367
368 //{Coming Soon}//
369
370 **Edit **
371
372 Time, angles, gripper
373
374 //Alt + Left Click = Drag time//
375
376 **Reorder**
377
378 //{Coming Soon}//
379
380 **Play**
381
382 //{Coming Soon}//
383
384 **Errors**
385
386 //{Coming Soon}//
Copyright RobotShop 2018