Changes for page FlowArm LSS

Last modified by Eric Nantel on 2024/07/03 09:39

From version < 140.1 >
edited by RB1
on 2020/01/03 10:35
To version < 131.1 >
edited by Eric Nantel
on 2019/10/18 10:25
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.RB1
1 +xwiki:XWiki.ENantel
Content
... ... @@ -1,18 +1,14 @@
1 1  {{lightbox image="LSS-FlowArm.png" width="400"/}}
2 2  
3 -[[[[image:[email protected]]]>>https://www.robotshop.com/en/lss-flowarm-app-download.html||rel="noopener noreferrer" target="_blank"]]
3 +[[[[image:[email protected]]]>>https://www.lynxmotion.com/tools/LSS_FlowArm.zip]]
4 4  
5 5  **Page Contents**
6 6  
7 -{{showhide showmessage="Show..." hidemessage="Hide"}}
8 -
9 - {{toc depth="2"/}}
10 -
11 -{{/showhide}}
7 +{{toc/}}
12 12  
13 13  = Description =
14 14  
15 -The LSS FlowArm application is intended to allow easy control of the standard Lynxmotion Servo Erector Set (S.E.S.) v2 articulated robotic arm. The graphical interface shows multiple views of the arm which can be controlled via drag and drop, as well as by manually inputting coordinates. The full-featured built-in sequencer allows you create sequences which have the arm move automatically from one position ("frame") to the next. Make use of the "teach mode" to position the arm where you want and record frames which can be modified and played back. Associating each pattern with input keys means you can easily play back and test multiple sequences.
11 +The LSS FlowArm application is intended to allow easy control of the standard Lynxmotion Servo Erector Set (S.E.S.) v2 articulated robotic arm. The graphical interface shows multiple views of the arm which can be controlled via drag and drop, as well as by manually inputting coordinates. The full-featured built-in sequencer allows you create sequences which have the arm move automatically from one position ("frame") to the next. Make use of the "teach mode" to position the arm where you want and record frames which can be modified and played back. Associating each pattern with input keys means you can easily play back and test multiple sequences.
16 16  
17 17  FlowBotics Studio was used to create this app and includes hundreds of built-in components that allow you to interface your PC to many standard computer peripherals and robotics components, and you can quickly design new components for new hardware. Easily create new projects with custom GUI screens, knobs, buttons, switches, etc. that will run live from within FlowBotics Studio without needing to wait for compilation, or export as stand-alone executable files. FlowBotics Studio includes a powerful graphics engine that allows you to make custom graphical objects by using standard bitmaps or by drawing your own shapes on the screen. Using this system, you can build entirely custom interfaces like this one for your projects and integrate photographs, drawings, and graphs.
18 18  
... ... @@ -59,19 +59,17 @@
59 59  
60 60  = Interface =
61 61  
62 -Following are informations regarding the user interface of LSS FlowArm.
63 -
64 64  == Header ==
65 65  
66 66  [[image:lss-flowarm-header.png||alt="lss-flowarm-header"]]
67 67  
68 -=== Emergency stop ===
62 +**EMERGENCY STOP**
69 69  
70 70  At any given time you can click this button to stop the arm. This will send a "LIMP" command directly to all servos.
71 71  
72 -=== Store offsets (calibration) ===
66 +**STORE OFFSETS**
73 73  
74 -The "STORE OFFSETS" button configures all of the servo offsets (this makes use of the CO command as part of the [[LSS Communication Protocol>>doc:lynxmotion-smart-servo.lss-communication-protocol.WebHome]]). Before pressing the button, orient the arm as shown below (with the gripper closed), and only then click the STORE OFFSETS button. This setup only need to be done once when first setting up the arm.
68 +The "STORE OFFSETS" button configures all of the servo offsets (this makes use of the CO command as part of the [[LSS Communication Protocol>>doc:lynxmotion-smart-servo.lss-communication-protocol.WebHome]]). Before pressing the button, orient the arm as shown below (with the gripper closed), and only then click the STORE OFFSETS button.
75 75  
76 76  * Base servo aligned with the x axis
77 77  * Shoulder to elbow along z axis (straight up)
... ... @@ -82,15 +82,15 @@
82 82  (% style="width:700px" %)
83 83  |(% style="text-align:center; vertical-align:middle" %)[[image:lss-flowarm-offset-left.png||alt="lss-flowarm-left.png" height="300" width="300"]]|(% style="text-align:center; vertical-align:middle" %)[[image:lss-flowarm-offset-top.png||alt="lss-flowarm-top.png" height="300" width="300"]]
84 84  
85 -=== Limp ===
79 +**LIMP**
86 86  
87 87  Causes all servos to slowly go LIMP (i.e. lose torque), gradually loosing torque until hitting the ground. It's important to note that the software will not constantly query all servos for their position, and as such the virtual arm on screen will not update frequently if at all. If you want the virtual arm on screen to update as you move the real arm, use TEACH mode described below.
88 88  
89 -=== Halt & hold ===
83 +**STOP**
90 90  
91 91  Causes all servos to immediately stop their motion and hold their position.
92 92  
93 -=== Teach ===
87 +**TEACH**
94 94  
95 95  Teach mode allows a user to physically move the arm and have the virtual arm on screen follow. This is used primarily to manually add frames to sequences, determine the optimal closed position for the gripper etc. In order to ensure the arm does not collapse, pressing the TEACH button will start a 5 second countdown during which the arm will slowly lose torque (angular force) until all servos are limp. When in teach mode, an orange outline appears over all on-screen fields which would cause a conflict and therefore cannot be used.
96 96  
... ... @@ -98,15 +98,15 @@
98 98  
99 99  Once the arm is limp, it can be moved physically, and the application will regularly send position query commands to all of the servos and update the virtual arm on screen to match the servo's responses. Use the sequencer to record each position (frame) while in teach mode. For more information on the sequencer, refer to the sequencer section below.
100 100  
101 -=== Grid / units ===
95 +**GRID / Units**
102 102  
103 103  Grid spacing can be toggled between Metric or Imperial. Options include 2cm, 3cm, 5cm and 1in, 2in and 3in.
104 104  
105 -=== Baud ===
99 +**BAUD**
106 106  
107 107  The default (and suggested) baud rate is 115200, which is the baud rate at which the servos are shipped. Should a user have changed the baud rate on the servos, it can be selected using the drop down. Note that the baud rate must be configured to the same value for all servos in order to work.
108 108  
109 -=== COM ===
103 +**COM**
110 110  
111 111  When the software is opened, a scan of all of your computer's COM ports is done automatically and a list of all available COM ports will be found in the drop down menu, along with OFF (stop searching for a COM port), and AUTO (the application tries to automatically find the correct COM port by sending a query command at the corresponding BAUD rate). Select which of your computer's COM ports is connected to the [[LSS Adapter>>doc:servo-erector-set-system.ses-electronics.ses-modules.lss-adapter-board.WebHome]] (which is provided with the standard SES v2 articulated robot arm). If you have a list of available COM ports and are unsure which is associated with the LSS Adapter, go to Device Manager in Windows, and view the list of USB devices connected. The LSS Adapter uses an FTDI USB to serial chip. Alternatively, simply unplug the USB from the arm and see which of the COM ports disappears from the list.
112 112  
... ... @@ -114,9 +114,9 @@
114 114  * If the red light is solid, then no correct COM port has been located.
115 115  * If the green light is solid, the a COM port has been located.
116 116  
117 -=== Window size ===
111 +**Window Size**
118 118  
119 -[[image:lss-flowarm-size.jpg]]
113 +**[[image:lss-flowarm-size.jpg]]**
120 120  
121 121  A the top right of the window, there are three dark rectangles allowing you to change the application's window size.
122 122  
... ... @@ -125,17 +125,17 @@
125 125  (% class="wikigeneratedid" id="HArmConfiguration" %)
126 126  The arm shown on screen is based on the assembly guide. The aesthetics of the arms will be changing for the next release version of the LSS Flowarm software.
127 127  
128 -=== Side view ===
122 +**Side View**
129 129  
130 -The left view is a representation of the arm, where the orange circles represent the location of each axis of rotation. You can move the arm in this view by clicking on and dragging anywhere in that side view screen.
124 +The left view is a representation of the arm, where the orange circles represent the location of each axis of rotation. You can move the arm in this view by clicking on and dragging the wrist rotation servo.
131 131  
132 132  [[image:lss-flowarm-left.png||width="300"]]
133 133  
134 -=== Top view ===
128 +**Top View**
135 135  
136 -The top view shows the arm top down. You can move the arm within this view by clicking on and dragging the dot right next to the gripper.
130 +The top view shows the arm top down. You can move the arm within this view by clicking on and dragging the wrist rotation servo.
137 137  
138 -[[image:lss-flowarm-top.png||width="300"]]
132 +**[[image:lss-flowarm-top.png||width="300"]]**
139 139  
140 140  == Shortcuts ==
141 141  
... ... @@ -155,19 +155,19 @@
155 155  
156 156  == Left Menu ==
157 157  
158 -=== Gripper ===
152 +**Gripper**
159 159  
160 160  Assuming the gripper has been properly calibrated, The number below represents the opening at the tip. Fully closed should correspond to 0 degrees. We added a feature where the servo stop when it feel a current raising, this allows the user to ask for a full close and have a good grip on the item picked.
161 161  
162 162  [[image:lss-flowarm-gripper-view.png||alt="lss-flowarm-gripper-view.jpg"]]
163 163  
164 -=== Wrist ===
158 +**Wrist**
165 165  
166 166  The wrist angle can be locked or unlocked. The field allows for user input (click the numbers) or fine adjustments using the arrows.
167 167  
168 168  [[image:lss-flowarm-wrist-view.png||alt="lss-flowarm-wrist-view.jpg"]]
169 169  
170 -=== End effector position ===
164 +**End Effector Position**
171 171  
172 172  The position of the end effector can be controlled either by manually entering the information for R (radius), or the Cartesian x, y, z coordinates, or using the arrows.
173 173  
... ... @@ -175,7 +175,7 @@
175 175  
176 176  [[image:lss-flowarm-positioning.png||alt="lss-flowarm-positioning.jpg"]]
177 177  
178 -== Data Log ==
172 +== **Data Log** ==
179 179  
180 180  The optional Data log (normally hidden) can be toggled on or off and allows the user to see all commands being sent to and received from the smart servos. The data can be saved to a file in a Comma Separated Values (.csv) format.
181 181  
... ... @@ -187,25 +187,25 @@
187 187  
188 188  LSS FlowArm has a powerful pattern sequencer component (normally found only in the full version of FlowBotics Studio) that is used to create reusable patterns within minutes, instead of hours or days.
189 189  
190 -(% style="width:1037px" %)
191 -|(% style="width:207px" %)[[image:lss-flowarm-association.jpg]]|(% style="width:186px" %)Assign Input|(% style="width:662px" %)Patterns can be associated to keyboard keys F1 to F12, and keys E, F, G, and H
192 -|(% style="width:207px" %)[[image:lss-flowarm-pattern-list.jpg]]|(% style="width:186px" %)Sequence List|(% style="width:662px" %)The sequence list is the first control on the sequencer.
193 -|(% style="width:207px" %)[[image:lss-flowarm-patterns.jpg]]|(% style="width:186px" %)Sequence Management|(% style="width:662px" %)(((
184 +(% style="width:1303px" %)
185 +|(% style="width:257px" %)[[image:lss-flowarm-association.jpg]]|(% style="width:306px" %)Assign Input|(% style="width:758px" %)Patterns can be associated to keyboard keys F1 to F12, and keys E, F, G, and H
186 +|(% style="width:257px" %)[[image:lss-flowarm-pattern-list.jpg]]|(% style="width:306px" %)Sequence List|(% style="width:758px" %)The sequence list is the first control on the sequencer.
187 +|(% style="width:257px" %)[[image:lss-flowarm-patterns.jpg]]|(% style="width:306px" %)Sequence Management|(% style="width:758px" %)(((
194 194  Add, remove, duplicate, save, load and clear all patterns.
195 195  )))
196 -|(% style="width:207px" %)[[image:lss-flowarm-frames.jpg]]|(% style="width:186px" %)Frame Options|(% style="width:662px" %)Adding a frame adds a blank frame to the list. The drop-down list gives "useful" pre-made frames. Recording a frame copies the arm's current on-screen position. The X removes a selected frame.
197 -|(% style="width:207px" %)[[image:lss-flowarm-copy-paste.jpg]]|(% style="width:186px" %)Copy / Paste Frame|(% style="width:662px" %)Copy and paste a frame
198 -|(% style="width:207px" %)[[image:lss-flowarm-settings.jpg]]|(% style="width:186px" %)Operations / Settings|(% style="width:662px" %)Useful features include: Toggle pause before frame; Remove gaps between frames; Reverse frames
199 -|(% style="width:207px" %)[[image:lss-flowarm-lock.jpg]]|(% style="width:186px" %)Lock |(% style="width:662px" %)Timeline locking
200 -|(% style="width:207px" %)[[image:lss-flowarm-loop.jpg]]|(% style="width:186px" %)Repeat / Loop Pattern|(% style="width:662px" %)Play once or loop; Set the playback speed using the up and down arrows.
201 -|(% style="width:207px" %)[[image:lss-flowarm-play.jpg]]|(% style="width:186px" %)Sequence Playback|(% style="width:662px" %)Restart sequence, play or stop
202 -|(% style="width:207px" %)[[image:lss-flowarm-inspector.png]]|(% style="width:186px" %)Frame Inspector|(% style="width:662px" %)Allows to modify the values sent in a particular frame manually.
190 +|(% style="width:257px" %)[[image:lss-flowarm-frames.jpg]]|(% style="width:306px" %)Frame Options|(% style="width:758px" %)Adding a frame adds a blank frame to the list. The drop-down list gives "useful" pre-made frames. Recording a frame copies the arm's current on-screen position. The X removes a selected frame.
191 +|(% style="width:257px" %)[[image:lss-flowarm-copy-paste.jpg]]|(% style="width:306px" %)Copy / Paste Frame|(% style="width:758px" %)Copy and paste a frame
192 +|(% style="width:257px" %)[[image:lss-flowarm-settings.jpg]]|(% style="width:306px" %)Operations / Settings|(% style="width:758px" %)Useful features include: Toggle pause before frame; Remove gaps between frames; Reverse frames
193 +|(% style="width:257px" %)[[image:lss-flowarm-lock.jpg]]|(% style="width:306px" %)Lock |(% style="width:758px" %)Timeline locking
194 +|(% style="width:257px" %)[[image:lss-flowarm-loop.jpg]]|(% style="width:306px" %)Repeat / Loop Pattern|(% style="width:758px" %)Play once or loop; Set the playback speed using the up and down arrows.
195 +|(% style="width:257px" %)[[image:lss-flowarm-play.jpg]]|(% style="width:306px" %)Sequence Playback|(% style="width:758px" %)Restart sequence, play or stop
196 +|(% style="width:257px" %)[[image:lss-flowarm-inspector.png]]|(% style="width:306px" %)Frame Inspector|(% style="width:758px" %)Allows to modify the values sent in a particular frame manually.
203 203  
204 -=== Sequences ===
198 +**Sequences**
205 205  
206 206  The sequencer allows you to make your robot move over time by transitioning from one position to another. Each transition we call a frame and a sequence of frames we call a sequence. You can create as many sequences as you like. You can play sequences back manually or using the keyboard inputs mentioned below. This section describes the sequence management functions of the Sequencer.
207 207  
208 -=== Sequence List ===
202 +**Sequence List**
209 209  
210 210  [[image:lss-flowarm-pattern-list.jpg]]
211 211  
... ... @@ -215,36 +215,36 @@
215 215  
216 216  [[image:lss-flowarm-patterns.jpg]]
217 217  
218 -=== Add a Sequence ===
212 +**Add a Sequence**
219 219  
220 220  To add a sequence click the add button. A new sequence will appear in the list and its name will open for editing.
221 221  
222 -=== Remove a Sequence ===
216 +**Remove a Sequence**
223 223  
224 224  Click the remove sequence button to delete the currently selected sequence from the list. This action is irreversible so you will be asked for confirmation.
225 225  
226 -=== Duplicate a Sequence ===
220 +**Duplicate a Sequence**
227 227  
228 228  If you want to make a new sequence based on an existing one then you can duplicate it.
229 229  
230 -=== Saving Sequences ===
224 +**Saving Sequences**
231 231  
232 232  IMPORTANT: If you want to keep any sequences you create then you must export them otherwise they will be lost when you return to the project browser. 
233 233  To do this click the export button. You can choose whether to export all your sequences or just the currently selected one. Sequences are saved to files so you'll need to pick a filename and folder to save to. If a sequence uses sub sequences these will be saved even if you choose only to save the selected sequence.
234 234  
235 -=== Loading Sequences ===
229 +**Loading Sequences**
236 236  
237 237  If you have saved sequences that you want to restore then click the Import button. You will be asked to choose a previously saved sequence file.
238 238  The sequences in the file will be added to the list. They do not replace the sequence list. Also it doesn't
239 239  matter how many sequences the file contains, all of them will be imported.
240 240  
241 -=== Clear All Sequences ===
235 +**Clear All Sequences**
242 242  
243 243  If you want to start from scratch you can clear all the sequences from the list using the clear all button.
244 244  
245 -== Frames ==
239 +== **Frames** ==
246 246  
247 -[[image:lss-flowarm-frame.jpg]]
241 +**[[image:lss-flowarm-frame.jpg]]**
248 248  
249 249  We now know how to manage sequences now lets see how you build one. As we said earlier a sequence is made up of frames. A frame represents a transition between robot states over time.
250 250  In addition to frames, you can also add other sequences to a sequence. This allows quite complex series of movements to be built up very quickly and easily.
... ... @@ -251,38 +251,38 @@
251 251  
252 252  [[image:lss-flowarm-frames.jpg]]
253 253  
254 -=== Adding Frames ===
248 +**Adding Frames**
255 255  
256 256  To add a frame click the Add button. A new frame will be added at the end of the sequence. The duration of the frame will be whatever the last frame duration was. The frame will record whatever position the robot is currently set to. You can add a sub sequence to the sequence by clicking the arrow to the right of the Add button. A drop list of the available sequences will appear. Select one and it will be added to the end of the sequence.
257 257  
258 -=== Recording to a Frame ===
252 +**Recording to a Frame**
259 259  
260 260  When you add a frame it will record the state that the robot is currently in. If you want to change this state first select the frame by clicking on it. Next move the robot to the position you want to record. When you're happy press the record button. The frame will flash to indicate that it has been updated.
261 261  
262 -=== Deleting Frames ===
256 +**Deleting Frames**
263 263  
264 264  To delete a sequence or frame from a sequence, click the Delete button.
265 265  
266 -=== Naming Frames ===
260 +**Naming Frames**
267 267  
268 268  To name a frame, simply double-click the top blue part of it. You will then be able to enter a name by typing text directly. Save the new name by pressing the [Enter] key once donce. Warning: please note that when double-clicking a frame to name it, it will play the frame which may move your robotic arm suddenly. You may want to activate the STOP button first to prevent movement when naming frames.
269 269  
270 -=== Timeline Locking ===
264 +**Timeline Locking**
271 271  
272 272  [[image:lss-flowarm-lock.jpg]]
273 273  
274 274  The timeline is locked by default. This means that frames will automatically run from one to the next – you cannot create space in between. Moving a frame past another one will move it along the order in the timeline. If the timeline is unlocked then you can move frames independently of each other and also create gaps of time in between.
275 275  
276 -=== Moving and Resizing ===
270 +**Moving and Resizing**
277 277  
278 278  To move a frame on the timeline, simply click on it and drag it to the time you want it to start. The start time will be displayed as you drag. How frames move relative to each other is determined by whether the timeline is locked (see previous section). To resize a frame grab the right-hand edge and drag it. When moving or resizing the mouse snaps to the nearest unit on the timeline. If you hold SHIFT while moving or resizing no snap will be applied. When the timeline is unlocked then if you hold CTRL while dragging or resizing a frame all frames to
279 279  the right of the selected frame will be moved so that the time interval between the selected frame and the next one is maintained.
280 280  
281 -=== Auto Record ===
275 +**Auto Record**
282 282  
283 283  If you want changes you make to be automatically recorded you can lock the record button in place by double-clicking on it. Now whenever you change the robot position the currently elected frame will be updated. The record button will light up to show that auto record is on. To switch auto record off, double-click on the record button again.
284 284  
285 -=== Copy and Paste ===
279 +**Copy and Paste**
286 286  
287 287  [[image:lss-flowarm-copy-paste.jpg]]
288 288  
... ... @@ -289,17 +289,17 @@
289 289  Sometimes you might want to copy the robot state from one frame to another. To do this we have copy and paste. To copy the data from a frame, select it then click the Copy button.
290 290  To duplicate the data on another frame, select the target frame and click the Paste button.
291 291  
292 -=== Pause Before Frame ===
286 +**Pause Before Frame**
293 293  
294 294  You can insert a pause before a frame commences. This is useful if you want the sequencer to stop and wait for some external event before continuing. First select the frame then click the Operations button and select Toggle Pause Before Frame. A red line will show at the start of the frame to show the pause. To remove the pause select the frame again and select Toggle Pause Before Frame after clicking on the Operations button.
295 295  
296 -=== Remove Gaps Between Frames ===
290 +**Remove Gaps Between Frames**
297 297  
298 298  [[image:lss-flowarm-settings.jpg]]
299 299  
300 300  If the timeline is unlocked then you can instantly remove all the gaps between frames and push them up against each other by clicking the Operations button and choosing Remove Gaps Between Frames from the menu.
301 301  
302 -=== Frame Inspector ===
296 +**Frame Inspector**
303 303  
304 304  [[image:lss-flowarm-inspector-frame.png]]
305 305  
... ... @@ -307,13 +307,13 @@
307 307  
308 308  == Sequencer ==
309 309  
310 -=== Reverse Frames ===
304 +**Reverse Frames**
311 311  
312 312  [[image:lss-flowarm-settings.jpg]]
313 313  
314 314  It's useful to be able to reverse the order of frames in a sequence. To do this click the Operations button and choose Reverse Frames.
315 315  
316 -=== Sequence Playback ===
310 +**Sequence Playback**
317 317  
318 318  [[image:lss-flowarm-play.jpg]]
319 319  
... ... @@ -321,7 +321,7 @@
321 321  
322 322  [[image:lss-sequencer-handle.jpg||height="70" width="241"]]
323 323  
324 -=== Assign an input to a sequence ===
318 +**Assign an input to a sequence**
325 325  
326 326  [[image:lss-flowarm-association.jpg]]
327 327  
... ... @@ -328,9 +328,9 @@
328 328  You can assign an input to a sequence by choosing one in the drop-down list left of the sequence name. By default a sequence does not have a input associated with it. When you click on that box, you will be presented with a list of possible inputs. A sequence can only have one input associated with it. Similarly, an input can only be associated with one sequence at a time. If you choose an input in the list that is already associated, it will be removed from its previous sequence and assigned to the current one. By clicking on the sequence list, you will see which input is associated to each sequence to the right of their name:
329 329  If a sequence is already playing when its associated input is triggered, it will ignore that input and continue playing as normal. If an input that is associated is triggered when a different sequence is playing, it will be stopped and the
330 330  
331 -=== Decision Frame ===
325 +**Decision Frame**
332 332  
333 -[[image:lss-flowarm-decision-frame.jpg]]
327 +**[[image:lss-flowarm-decision-frame.jpg]]**
334 334  
335 335  At the end of every sequence there is a permanent frame called the decision frame (it is orange for easy identification). Click on the top part (orange) to change the last action of the sequence. There are 3 options:
336 336  
... ... @@ -342,6 +342,7 @@
342 342  
343 343  = Notifications =
344 344  
339 +
345 345  (% style="width:1300px" %)
346 346  |(% style="text-align:center; width:450px" %)**Displayed Error**|(% style="text-align:center; width:100px" %)**LED Status**|(% style="text-align:center" %)**Informations**
347 347  |{{lightbox image="lss-flowarm-notification-limp.png"/}}|(% colspan="1" rowspan="2" style="text-align:center; vertical-align:middle" %)(((
... ... @@ -374,3 +374,5 @@
374 374  = Troubleshooting =
375 375  
376 376  If you encounter any bugs or issues when installing or using the LSS FlowArm application, please submit a new post on the Lynxmotion community sub-forum here: [[https:~~/~~/www.robotshop.com/community/forum/c/lynxmotion/electronics-software>>url:https://www.robotshop.com/community/forum/c/lynxmotion/electronics-software]]
372 +
373 +{Work in progress}
Copyright RobotShop 2018