Wiki source code of SES-PRO Robotic Arm UI

Version 27.2 by Eric Nantel on 2024/10/09 16:17

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:26px" %) |(% style="width:1452px" %)(((
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 |(% style="width:26px" %) |(% style="width:1452px" %)(((
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 |(% style="width:26px" %) |(% style="width:1452px" %)(((
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 |(% style="width:26px" %) |(% style="width:1452px" %)(((
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 |(% style="width:26px" %) |(% style="width:1452px" %)(((
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 the 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 |(% colspan="2" %)(((
139 == 3D Model ==
140 )))
141 |(% style="width:26px" %) |(% style="width:1452px" %)(((
142 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.
143
144 **View Controls**
145
146 Zoom: Shift + Middle Scroll
147
148 Rotate: Shift + Middle Mouse
149
150 Pan: None
151 )))
152 |(% colspan="2" %)(((
153 == Manual Move ==
154 )))
155 |(% style="width:26px" %) |(% style="width:1452px" %)(((
156 **Angular Control**
157
158 In angular mode, the user can control the angle of each joint
159
160 **Coordinates Control**
161
162 In coordinate control the user can control the cartesian position of the end effector
163
164 **End Effector Lock**
165
166 The orientation of the end effector can be locked.
167 )))
168 |(% colspan="2" %)(((
169 == Direct Command ==
170 )))
171 |(% style="width:26px" %) |(% style="width:1452px" %)(((
172 This section allow the user to send commands using the [[LSS-PRO Communication Protocol>>path:/info/wiki/lynxmotion/view/ses-pro/lss-pro/lss-p-communication-protocol/]] directly if required.
173
174 A few things to keep in mind when using this:
175
176 * Make sure you know what you are doing as you can make the arm move in __dangerous__ ways.
177 * Sending commands does not require ‘#’ and ‘\r’ chars.
178 ** example for #2\r you should enter 2Q and press the "SEND" button
179 * The commands are validated, and it shows a notification in case of error.
180 * The replies of queries are shown in the text field below.
181 )))
182 |(% colspan="2" %)(((
183 == Command Output ==
184 )))
185 |(% style="width:26px" %) |(% style="width:1452px" %)(((
186 //{Coming Soon}//
187 )))
188 |(% colspan="2" %)(((
189 == Telemetry ==
190 )))
191 |(% style="width:26px" %) |(% style="width:1452px" %)(((
192 **Data to Display**
193
194 * Position
195 * Current
196 * Linear Accel X
197 * Linear Accel Y
198 * Linear Accel Z
199 * Angular Accel α
200 * Angular Accel β
201 * Angular Accel γ
202 * MCU Temperature
203 * PCB Temperature
204 * Probe Temperature
205
206 **Display / Hide Actuator**
207
208 //{Coming Soon}//
209 )))
210 |(% colspan="2" style="width:26px" %)(((
211 == Sequencer ==
212 )))
213 |(% style="width:26px" %) |(% style="width:1452px" %)(((
214 **Frames**
215
216 //{Coming Soon}//
217
218 **Record **
219
220 //{Coming Soon}//
221
222 **Edit **
223
224 Time, angles, gripper
225
226 //Alt + Left Click = Drag time//
227
228 **Reorder**
229
230 //{Coming Soon}//
231
232 **Play**
233
234 //{Coming Soon}//
235
236 **Errors**
237
238 //{Coming Soon}//
239 )))
240 |(% style="width:26px" %) |(% style="width:1452px" %)
241 |(% style="width:26px" %) |(% style="width:1452px" %)
242 |(% style="width:26px" %) |(% style="width:1452px" %)
243 |(% style="width:26px" %) |(% style="width:1452px" %)
244 |(% style="width:26px" %) |(% style="width:1452px" %)
245 |(% style="width:26px" %) |(% style="width:1452px" %)
246 |(% style="width:26px" %) |(% style="width:1452px" %)
247 |(% style="width:26px" %) |(% style="width:1452px" %)
248 |(% style="width:26px" %) |(% style="width:1452px" %)
249 |(% style="width:26px" %) |(% style="width:1452px" %)
250 |(% style="width:26px" %) |(% style="width:1452px" %)
251 |(% style="width:26px" %) |(% style="width:1452px" %)
252 |(% style="width:26px" %) |(% style="width:1452px" %)
253 |(% style="width:26px" %) |(% style="width:1452px" %)
254 |(% style="width:26px" %) |(% style="width:1452px" %)
255 |(% style="width:26px" %) |(% style="width:1452px" %)
256 |(% style="width:26px" %) |(% style="width:1452px" %)
257 |(% style="width:26px" %) |(% style="width:1452px" %)
258 |(% style="width:26px" %) |(% style="width:1452px" %)
259 |(% style="width:26px" %) |(% style="width:1452px" %)
260 |(% style="width:26px" %) |(% style="width:1452px" %)
261 |(% style="width:26px" %) |(% style="width:1452px" %)
262 |(% style="width:26px" %) |(% style="width:1452px" %)
263 |(% style="width:26px" %) |(% style="width:1452px" %)
264 |(% style="width:26px" %) |(% style="width:1452px" %)
265 |(% style="width:26px" %) |(% style="width:1452px" %)
266 |(% style="width:26px" %) |(% style="width:1452px" %)
267 |(% style="width:26px" %) |(% style="width:1452px" %)
268 |(% style="width:26px" %) |(% style="width:1452px" %)
269 |(% style="width:26px" %) |(% style="width:1452px" %)
270 |(% style="width:26px" %) |(% style="width:1452px" %)
271 |(% style="width:26px" %) |(% style="width:1452px" %)
272 |(% style="width:26px" %) |(% style="width:1452px" %)
273 |(% style="width:26px" %) |(% style="width:1452px" %)
274 |(% style="width:26px" %) |(% style="width:1452px" %)
275 |(% style="width:26px" %) |(% style="width:1452px" %)
276 |(% style="width:26px" %) |(% style="width:1452px" %)
277 |(% style="width:26px" %) |(% style="width:1452px" %)
278 |(% style="width:26px" %) |(% style="width:1452px" %)
279 |(% style="width:26px" %) |(% style="width:1452px" %)
280 |(% style="width:26px" %) |(% style="width:1452px" %)
281 |(% style="width:26px" %) |(% style="width:1452px" %)
282 |(% style="width:26px" %) |(% style="width:1452px" %)
283 |(% style="width:26px" %) |(% style="width:1452px" %)
284 |(% style="width:26px" %) |(% style="width:1452px" %)
285 |(% style="width:26px" %) |(% style="width:1452px" %)
286 |(% style="width:26px" %) |(% style="width:1452px" %)
287 |(% style="width:26px" %) |(% style="width:1452px" %)
288 |(% style="width:26px" %) |(% style="width:1452px" %)
289 |(% style="width:26px" %) |(% style="width:1452px" %)
290 |(% style="width:26px" %) |(% style="width:1452px" %)
291 |(% style="width:26px" %) |(% style="width:1452px" %)
292 |(% style="width:26px" %) |(% style="width:1452px" %)
293 |(% style="width:26px" %) |(% style="width:1452px" %)
294
295 {{comment}}
296 = =
297
298 = User Guide =
299
300 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:
301
302 * 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
303 * 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
304
305 == IMPORTANT: Payload Considerations ==
306
307 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.
308 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.
309 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.
310 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".
311
312 == IMPORTANT: Emergency ==
313
314 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:
315
316 **Halt & Hold**
317
318 This will stop every joints and hold them in their last recorded angular positions. The corresponding command is #254H<cr>.
319
320 **Limp**
321
322 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>.
323
324 **Software Stop**
325
326 The E-stop button within the software sets all joints to limp.
327
328 **Hardware E-Stop**
329 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.
330
331 == Arm Connection ==
332
333 **Model**
334
335 The software currently supports the following Lynxmotion PRO Arms:
336
337 * 550mm 5DoF
338 * 550mm 6DoF
339 * 900mm 5DoF
340 * 900mm 6DoF
341
342 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.
343
344 **COM Port**
345
346 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. 
347
348 **Connect**
349
350 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.
351
352 == Gripper Controls ==
353
354 **Model**
355
356 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.
357
358 * PGE-50-40 (40mm default configuration)
359 * PGE-50-40 (60mm configuration)
360 * PGE-50-40 (80mm configuration)
361 * CGE-10-10 (20mm configuration)
362 * CGE-10-10 (40mm configuration)
363 * CGE-10-10 (60mm configuration)
364
365 **COM Port**
366
367 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
368
369 **Baudrate**
370
371 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.
372
373 **Initialize**
374
375 Initializing the gripper opens it fully. This is available should the user encounter issues with positioning and need to re-zero the fingers.
376
377 **Connect**
378
379 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.
380
381 **Speed**
382
383 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.
384
385 **Force**
386
387 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.
388
389 **Open / Close**
390
391 These are shortcut buttons to either fully open or fully close the gripper.
392
393 **Sequencer**
394
395 The sequencer displays the gripper position as joint 7 (J7).
396
397 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.
398
399 == 3D Model ==
400
401 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.
402
403 **View Controls**
404
405 Zoom: Shift + Middle Scroll
406
407 Rotate: Shift + Middle Mouse
408
409 Pan: None
410
411 == Manual Move ==
412
413 **Angular Control**
414
415 In angular mode, the user can control the angle of each joint
416
417 **Coordinates Control**
418
419 In coordinate control the user can control the cartesian position of the end effector
420
421 **End Effector Lock**
422
423 The orientation of the end effector can be locked.
424
425 == Direct Command ==
426
427 This section allow the user to send commands using the [[doc:ses-pro.lss-pro.lss-p-communication-protocol.WebHome]] directly if required.
428
429 A few things to keep in mind when using this:
430
431 * Make sure you know what you are doing as you can make the arm move in __dangerous__ ways.
432 * Sending commands does not require ‘#’ and ‘\r’ chars.
433 ** example for #2\r you should enter 2Q and press the "SEND" button
434 * The commands are validated, and it shows a notification in case of error.
435 * The replies of queries are shown in the text field below.
436
437 == Command Output ==
438
439 //{Coming Soon}//
440
441 == Telemetry ==
442
443 **Data to Display**
444
445 //{Coming Soon}//
446
447 **Display / Hide Actuator**
448
449 //{Coming Soon}//
450
451 == Sequencer ==
452
453 **Frames**
454
455 //{Coming Soon}//
456
457 **Record **
458
459 //{Coming Soon}//
460
461 **Edit **
462
463 Time, angles, gripper
464
465 //Alt + Left Click = Drag time//
466
467 **Reorder**
468
469 //{Coming Soon}//
470
471 **Play**
472
473 //{Coming Soon}//
474
475 **Errors**
476
477 //{Coming Soon}//
478 {{/comment}}
Copyright RobotShop 2018