Wiki source code of SES-PRO Robotic Arm UI Guide

Version 63.1 by Eric Nantel on 2024/10/17 14:31

Show last authors
1 {{toc/}}
2
3 |(% colspan="6" style="text-align:center" %)(((
4 = Quickstart Flow =
5 )))
6 |(% style="text-align:center; vertical-align:middle" %)Arm model|(% style="text-align:center; vertical-align:middle" %)Arm COM Port|(% style="text-align:center; vertical-align:middle" %)Connect|(% style="text-align:center; vertical-align:middle" %)Gripper Model|(% style="text-align:center; vertical-align:middle" %)Gripper COM Port|(% style="text-align:center; vertical-align:middle" %)Gripper Connect
7 |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-version.png"/}}|(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-com.png"/}}|(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-connect.png"/}}|(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-version.png"/}}|(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-com.png"/}}|(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-connect.png"/}}
8
9 |(% style="width:25px" %) |(% colspan="2" rowspan="1" style="width:100px" %)(((
10 Before proceeding with the guide, it is important to note the following:
11
12 * 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
13 * 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
14
15 __It's a good thing to practice with the software without an Arm connected, that way you can learn safely.__
16 )))
17 | |(% style="text-align:center; vertical-align:middle; width:150px" %){{lightbox image="ses-pro-robotic-arm-ui-info.png"/}}|Pressing the i "Information" icon in the software will bring you to the [[doc:ses-pro.ses-pro-software.ses-pro-arm-ui.WebHome]] page.
18 | |(% colspan="2" rowspan="1" %)(((
19 = IMPORTANT =
20 )))
21 | |(% colspan="2" rowspan="1" %)(((
22 == Payload Considerations ==
23 )))
24 | |(% colspan="2" rowspan="1" %)(((
25 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.
26 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.
27 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.
28 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".
29 )))
30 | |(% colspan="2" rowspan="1" %)(((
31 == Emergency ==
32 )))
33 | |(% colspan="2" rowspan="1" %)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. 
34 The following emergency options are available based on severity:
35 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-halt.png"/}}|(((
36 **Halt (and hold)**
37
38 This will stop every joints and hold them in their last recorded angular positions. The corresponding command is #254H<cr>.
39 )))
40 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-limp.png"/}}|(((
41 **Limp**
42
43 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>.
44 )))
45 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-emergency.png"/}}|(((
46 **Software E-Stop**
47
48 The E-stop button within the software sets all joints to limp, this can possibly cause the arm to fall.
49 )))
50 | |(% style="text-align:center; vertical-align:middle" %) |(((
51 **Power Supply E-Stop**
52
53 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.
54 )))
55 | |(% colspan="2" rowspan="1" %)(((
56 = Robotic Arm =
57 )))
58 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-version.png"/}}|(((
59 **Model**
60
61 The software currently supports the following Lynxmotion PRO Arms:
62
63 * 550mm 5DoF
64 * 550mm 6DoF
65 * 900mm 5DoF
66 * 900mm 6DoF
67
68 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.
69 )))
70 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-com.png"/}}|(((
71 **COM Port**
72
73 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.
74 )))
75 | |(% style="text-align:center; vertical-align:middle" %)(((
76 {{lightbox image="ses-pro-robotic-arm-ui-connect.png"/}}
77
78 {{lightbox image="ses-pro-robotic-arm-ui-disconnect.png"/}}
79 )))|(((
80 **Connect / Disconnect**
81
82 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.
83 )))
84 | |(% colspan="2" rowspan="1" %)(((
85 = Gripper =
86 )))
87 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-version-drop.png"/}}|(((
88 **Model**
89
90 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 G.
91 )))
92 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-version.png"/}}|(((
93 * PGE-50-40 (40mm default configuration)
94 * PGE-50-40 (60mm configuration)
95 * PGE-50-40 (80mm configuration)
96 * CGE-10-10 (20mm configuration)
97 * CGE-10-10 (40mm configuration)
98 * CGE-10-10 (60mm configuration)
99 )))
100 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-com.png"/}}|(((
101 **COM Port**
102
103 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
104 )))
105 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-baud.png"/}}|(((
106 **Baudrate**
107
108 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.
109 )))
110 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-connect.png"/}}|(((
111 **Connect**
112
113 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.
114 )))
115 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-init.png"/}}|(((
116 **Initialize**
117
118 Initializing the gripper opens it fully. This is available should the user encounter issues with positioning and need to re-zero the fingers.
119
120 (((
121
122 )))
123 )))
124 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-position.png"/}}|(((
125 **Position**
126
127
128 )))
129 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-speed.png"/}}|(((
130 **Speed**
131
132 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.
133 )))
134 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-force.png"/}}|(((
135 **Force**
136
137 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.
138 )))
139 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-gripper-open-close.png"/}}|(((
140 **Open / Close**
141
142 These are shortcut buttons to either fully open or fully close the gripper.
143 )))
144 | |(% style="text-align:center; vertical-align:middle" %) |(((
145 **Sequencer**
146
147 The sequencer displays the gripper position as joint G.
148
149 Ex: #GP1000
150 This command would be open the **G**ripper to **P**osition 100.0%
151
152 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 G moves.
153 )))
154 | |(% colspan="2" rowspan="1" %)(((
155 = 3D Model =
156 )))
157 | |(% colspan="2" rowspan="1" %)(((
158 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.
159 )))
160 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-3d.png"/}}|(((
161 **View Controls**
162
163 Zoom: Shift + Middle Scroll
164
165 Rotate: Shift + Middle Mouse
166
167 Pan: None
168 )))
169 | |(% colspan="2" rowspan="1" %)(((
170 = Manual Move =
171 )))
172 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-joints.png"/}}|(((
173 **Joints Control (angular)**
174
175 In Joints mode, the user can control the angle of each joint.
176
177 * The field can be clicked and changed using a keyboard.
178 * Using the + and - sings will move by the amount specified in the drop down menu.
179 * The RESET button will send the arm to Zero on all joints
180 )))
181 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-coordinates.png"/}}|(((
182 **Coordinates Control**
183
184 In coordinate control the user can control the cartesian position of the end effector
185 )))
186 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-arm-coordinates-lock.png"/}}|(((
187 **End Effector Lock**
188
189 The orientation of the end effector can be locked with the "ENABLED" button.
190 )))
191 | |(% colspan="2" rowspan="1" %)(((
192 = Direct Command =
193 )))
194 | |(% colspan="2" rowspan="1" %)(((
195 This section allow the user to send commands using the [[LSS-PRO Communication Protocol>>url:https://wiki.lynxmotion.com/info/wiki/lynxmotion/view/ses-pro/lss-pro/lss-p-communication-protocol/]] directly if required.
196
197 A few things to keep in mind when using this:
198
199 * Make sure you know what you are doing as you can make the arm move in __dangerous__ ways.
200 * Sending commands does not require ‘#’ and ‘\r’ chars.
201 ** example for #2\r you should enter 2Q and press the "SEND" button
202 * The commands are validated, and it shows a notification in case of error.
203 * The replies of queries are shown in the text field below.
204 )))
205 | |(% colspan="2" rowspan="1" %)(((
206 = Telemetry =
207 )))
208 | |(% colspan="2" %){{lightbox image="ses-pro-robotic-arm-ui-telemetry.png"/}}
209 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-telemetry-drop.png"/}}|(((
210 **Data to Display**
211
212 Various telemetry data can be retrieved from each actuators / joints, here is what the software support:
213
214 * Position
215 * Current
216 * Linear Accel X
217 * Linear Accel Y
218 * Linear Accel Z
219 * Angular Accel α
220 * Angular Accel β
221 * Angular Accel γ
222 * MCU Temperature
223 * PCB Temperature
224 * Probe Temperature
225 )))
226 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-telemetry-hide.png"/}}|(((
227 **Display / Hide **
228
229 At the bottom of the graphics you will find squares to activate / deactivate the desired actuator / joint to be displayed in the graph.
230 )))
231 | |(% colspan="2" rowspan="1" %)(((
232 = Sequencer =
233 )))
234 | |(% colspan="2" rowspan="1" %)(((
235 **Sequence**
236
237 That's where you can create and edit the sequence you need to play in your particular project.
238 )))
239 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-sequence.png"/}}|(((
240 **Sequence Selector**
241
242 Multiple sequences can be open at once and this is where you will be selecting which one will be displayed and/or played.
243 )))
244 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-sequence-add.png"/}}|(((
245 **Add**
246
247 Create a new Sequence that will be automatically selected.
248 )))
249 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-sequence-remove.png"/}}|(((
250 **Subtract**
251
252 Remove / Delete the currently selected Sequence.
253 )))
254 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-sequence-copy.png"/}}|(((
255 **Copy**
256
257 Create a copy of the currently selected Sequence and add a "- copy" to it's name.
258 )))
259 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-sequence-save.png"/}}|(((
260 **Save**
261
262 Saving the currently selected sequence for future use.
263 )))
264 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-sequence-open.png"/}}|(((
265 **Open**
266
267 Opening a previously saved sequence.
268 )))
269 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-sequence-delete.png"/}}|(((
270 **Delete**
271
272 Deleting the ALL sequence leaving an empty "Sequence 1"
273 )))
274 | |(% colspan="2" rowspan="1" %)(((
275 **Frames**
276
277 Those are frames or cards that will allow to move to specific positions. The user can either modify them by clicking on the Record button or manually edit them.
278 )))
279 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-add.png"/}}|(((
280 **Add**
281
282 Create a new frame / card in the selected sequence.
283 )))
284 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-sequence.png"/}}|(((
285 **Sequence Selector**
286
287 This button is to be removed in a future version, was there to select the sequence but ineffective at the moment.
288 )))
289 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-record.png"/}}|(((
290 **Record**
291
292 Store the current positions of each joints including the gripper in the selected frame / card.
293 )))
294 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-delete.png"/}}|(((
295 **Remove**
296
297 Delete the currently selected frame / card.
298 )))
299 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-copy.png"/}}|(((
300 **Copy**
301
302 Copy all the positions from the selected frame / card.
303 )))
304 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-paste.png"/}}|(((
305 **Paste**
306
307 Paste all the position from the previously copied frame / card to the selected one.
308 )))
309 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-invert.png"/}}|(((
310 **Invert**
311
312 Invert the frame / card so the First one become the Last and everything in between too.
313 )))
314 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame.png"/}}|(((
315 **Frame**
316
317 * **Name:** It's possible to change the name of the frame to better represent your sequence or application.
318 * **Length: **The frame length define the length of the movement and can be either entered manually or using "//Alt + Left Click" //and drag the frame.
319 )))
320 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-frame-drop.png"/}}|(((
321 **Frame Position**
322
323 Moving your cursor to the upper part of the frame will display a "hand" and then you can drag & drop the frame into a new position to re-order them.
324 )))
325 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-start.png"/}}|(((
326 **Starting Frame**
327
328 A start frame is required to calculate the speed for the first frame / card. This is usually the Zero point with all actuators being a 0deg but it's possible to make it yours by changing it manually or with the record button.
329
330 Note: This frame will always be played at a fixed speed for all actuator which means they will not Stop at the same time.
331 )))
332 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-loop.png"/}}|(((
333 **Loop**
334
335 The amount of time you want the particular sequence to play. If you click on the "Loop" test it will become Infinite.
336 )))
337 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-edit.png"/}}|(((
338 **Manual Edit**
339
340 Manually create or edit an already made frame / card in this window. Each joints and gripper can be modified that way.
341 )))
342 | |(% style="text-align:center; vertical-align:middle" %){{lightbox image="ses-pro-robotic-arm-ui-sequencer-zoom.png"/}}|(((
343 **Zoom**
344
345 Allow you to zoom In or Out making the time resolution change. Something nice when dealing with long sequences.
346 )))
347 | |(% style="text-align:center; vertical-align:middle" %) |(((
348 **Play from Start**
349
350 Start the sequence selected at the beginning.
351 )))
352 | |(% style="text-align:center; vertical-align:middle" %) |(((
353 **Play / Pause**
354
355 Start the sequence selected at the beginning and change in a Pause icon once started. Once ready the user can press play again to resume the sequence.
356 )))
357 | |(% style="text-align:center; vertical-align:middle" %) |(((
358 **Stop**
359
360 Stop the sequence & hold position.
361 )))
Copyright RobotShop 2018