Last modified by Eric Nantel on 2024/07/12 11:23

From version < 83.1 >
edited by Coleman Benson
on 2019/05/02 11:10
To version < 167.1 >
edited by RB1
on 2020/07/03 15:35
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.CBenson
1 +xwiki:XWiki.RB1
Tags
... ... @@ -1,1 +1,1 @@
1 -LSS-Ref
1 +LSS-Ref|LSS-Config|LSS
Content
... ... @@ -1,75 +1,190 @@
1 -[[image:LSS-Config-BETA.png||queryString="width=350" width="350"]]
1 +[[image:lynxmotion-smart-servo.lss-configuration-software.WebHome@LSS Config - 20.7.3 - Screenshot.png||alt="LSS Config - 20.7.3 - Screenshot" height="383" width="600"]]
2 2  
3 -**Page Contents**
3 +[[[[image:wiki-download.png]]>>https://www.robotshop.com/en/lynxmotion-smart-servo-lss-configuration-software.html||rel="noopener noreferrer" target="_blank"]]
4 4  
5 +**Table of Contents**
6 +
5 5  {{toc/}}
6 6  
9 += Description =
10 +
7 7  The LSS Configuration software ("LSS Config" for short) is intended to provide easy access to the main features and functionality of the [[Lynxmotion Smart Servo Motors>>doc:lynxmotion-smart-servo.WebHome]], as well as providing access to firmware updates.
8 8  
9 -NOTE: Only one servo should be connected to the software at any time. The servo must be powered correctly and in serial mode. Should your servo NOT be in serial mode, please refer to the [[button menu>>doc:lynxmotion-smart-servo.lss-button-menu.WebHome]].
13 +NOTE: The software can be connected to multiple servos, but the interface can only control one at any time. The servo(s) must be powered correctly and in serial mode. Should your servo(s) NOT be in serial mode, please refer to the [[button menu>>doc:lynxmotion-smart-servo.lss-button-menu.WebHome]].
10 10  
11 -= Header =
15 += Features =
12 12  
13 -[[image:lss-config-header.png]]
17 +== Connection ==
14 14  
19 +[[image:lss-config-top-menu.jpg]]
15 15  
16 -== Connection ==
21 +The header includes (left to right):
17 17  
18 -Connection to the servo is done automatically, via any properly installed USB to serial interface like the [[LSS Adapter board>>doc:servo-erector-set-system.ses-electronics.ses-modules.lss-adapter-board.WebHome]]. Ensure the board is recognized by the computer and if not, install the proper drivers. The software automatically scans all standard baud rates using ID254 (broadcast ID) and waits for a reply from the servo connected. Should an incorrect COM port be selected, the software will keep trying to connect. You must disconnect, select the correct COM port and reconnect. If you are not sure which COM port to select, in Windows, go to Device Manager -> Ports (COM & LPT) and select the port associated with the USB to serial device.
23 +* WIKI (link to the LSS Config guide on the Lynxmotion Wiki)
24 +* SERVO LIST: Servo selected via the dropdown menu
25 +* SCAN: (popup) scans the bus for all available servo motors
26 +* FIRMWARE: (popup) used to update servo's firmware
27 +* COM port selection
28 +* CONNECT / DISCONNECT (toggle ON / OFF)
19 19  
30 +=== COM Port ===
31 +
32 +Connection to the servo is done automatically via any properly installed USB to serial interface like the [[LSS Adapter board>>doc:servo-erector-set-system.ses-electronics.ses-modules.lss-adapter-board.WebHome]]. Once the servo is powered and properly connected to the computer, the COM port should appear in the COM port list. Ensure the board is recognized by the computer and if not, install the proper drivers. If you have multiple communication ports active, go to Windows -> Device Manager to determine which is appropriate for the USB to serial adapter you are using. Click CONNECT to connect to the servo. The software automatically scans all standard baud rates using ID254 (broadcast ID) and waits for a reply from the servo connected. Should an incorrect COM port be selected, the software will keep trying to connect. If you wish to change the COM port selected you must disconnect, select the correct COM port and reconnect. If you are not sure which COM port to select, in Windows, go to Device Manager -> Ports (COM & LPT) and select the port associated with the USB to serial device.
33 +
34 +=== Scan ===
35 +
36 +[[image:lss-config-scan.jpg||height="500" width="194"]]
37 +
38 +The next step once the COM port has been selected is to scan the port. The software can send commands to (and listen for a reply from) all servo IDs (0 to 250) at all standard baud rates on the selected COM port. In the pop-up, select the baud rates which you would like to scan, and the option of limited the IDs is also available. When in doubt, leave all baud rates selected. Once the scan starts, the command line interface will include messages for all servos found (or not found) at each baud rate, as well as any conflicts discovered.
39 +
40 +This process may take a few seconds and once completed, a list of all available servos with which the software was able to communicate will appear in the list next to "Servo" (in the top orange Connection field of the interface) as a drop-down. All servos correctly identified on the BUS will have their LED turn green (session specific as opposed to configured) to indicate no conflict. If two or more servos have the same ID (regardless of whether or not they have different baud rates), those servo's LEDs will turn red for that session, indicating an issue or overlap in IDs. To resolve this, you will need to change the ID of those servos to be distinct.
41 +
42 +**GREEN LED**: No Conflict
43 +
44 +**RED LED**: Conflict Found
45 +
46 +Note that these LED colors are SESSION specific (as opposed to configured). The LED color listed under Configurations will remain the user choice (OFF by default).
47 +
48 +=== Servo ===
49 +
50 +The scan provides a list of all servos which have been detected on the bus and lists the following choices in the drop-down. Note that the last servo in the list is automatically / arbitrarily selected for convenience.
51 +
52 +LSS-None (???; ~-~--k)
53 +
54 +This first option is used only when a servo ("???" to signify "unknown servo") cannot be reached via the LSS Config software and needs to be manually set to bootloader mode via the button menu in order to re-flash the firmware. The telemetry graph and configurations are all greyed out when this is selected. Once the servo has been set manually to bootloader mode, select this option and go through the firmware update procedure. This normally only needs to be done as a "last resort".
55 +
56 +LSS-All (254; ~-~--k)
57 +
58 +This uses the "broadcast" ID (#254) which all servos are configured to respond to (along with their own ID). Since there is no particular servo being monitored, the telemetry graph and configurations are all greyed out. This is used to send the same firmware update to all servos on the bus, or to send the same action command to all servos on the bus via the Command line interface described below.
59 +
60 +The drop-down list will be populated with all servos which the software has found on the bus, indicating their ID, servo model and firmware version. Each servo will then be listed in the following format:
61 +
62 +ST1 (0;115.2k [368])
63 +
64 +The servo model is displayed first (ST1, HS1, HT1), followed by its ID, the baud rate to which it has been st (ex. 115200, or 115.2k) and its firmware version in rectangular brackets. Selecting a servo from the list will allow the software to communicate with it.
65 +
20 20  == Firmware Update ==
21 21  
22 -[[image:lss-config-firmware-update.png]]
68 +[[image:lynxmotion-smart-servo.lss-configuration-software.WebHome@LSS Config - 20.7.3 - Firmware update.png||height="295" width="400"]]
23 23  
70 +The firmware update option is a popup which includes:
24 24  
25 -The LSS Config serves as the main software to update the servo's onboard firmware / programming. An internet connection is needed in order for the software to check if an online update is available.
72 +* Firmware version in dropdown format, including the current recommended version
73 +* Experimental firmware (if available)
74 +* Cancel firmware update
75 +* OK to continue firmware update
76 +* Notes regarding the firmware
26 26  
27 -The servo's current firmware version is displayed to the left of the FIRMWARE button. Pressing the button will open a popup window which allows you to select the firmware version to upload to the servo.
78 +The LSS Config software serves as the main software used to update the servo's onboard firmware / programming. An internet connection is needed in order for the software to check if an online update is available. The servo's current firmware version is displayed to the left of the FIRMWARE button. Pressing the button will open a popup window which allows you to select the firmware version to upload to the servo. When checked, the Exp. button will allow experimental versions of the firmware to be displayed in the list. It also allows to load directly from a local file.
28 28  
29 -When checked, the Exp. button will allow experimental versions of the firmware to be displayed in the list. It also allows to load directly from a local file.
80 +Following this pop-up your servo will be restarted and a progress bar will be displayed in the command line. Do not disconnect the servo during a firmware update. If the process does get interrupted, you can still upload firmware to the LSS by going into bootloader mode by holding the button at power up.
30 30  
31 -Once the OK button is pressed, a progress bar will be displayed in the command line. Do not disconnect the servo during a firmware update. If the process does get interrupted, you can still upload firmware to the LSS by going into bootloader mode by holding the button at power up.
82 +__**NOTE: Before assembling the servos as part of a robot, check to see if there is a firmware update available.**__
32 32  
33 -= Servo Control [coming soon] =
84 +== Servo Control ==
34 34  
35 -The servo control section allows you to visually move the servo and change a variety of parameter.
86 +{{lightbox image="lss-config-control-0003-both.png" width="485"/}}
36 36  
37 -The large red STOP button will send a LIMP command to the servo.
88 +The servo control section allows you to visually move the servo and change a variety of parameters, including:
38 38  
39 -{More to come}
90 +* Position: pale blue caret
91 +* Origin offset: magenta caret
92 +* Angular range: magenta square carets
93 +* RPM: green arrow / indicator
94 +* Initial position: dark blue caret
40 40  
96 +At the lower left the servo model and the LED color are shown.
97 +
41 41  == Configurations ==
42 42  
43 -[[image:lss-config-configurations.png]]
100 +{{lightbox image="lss-config-configurations.jpg" width="350"/}}
44 44  
45 -Upon connection, the software will read all configuration values and update the values in the "configurations" section. Visit the [[LSS Communication Protocol>>doc:lynxmotion-smart-servo.lss-communication-protocol.WebHome]] page for more information about commands, actions and configurations.
102 +Upon connection, the software will read all configuration values and update the values in the "configurations" section. Visit the [[doc:lynxmotion-smart-servo.lss-communication-protocol.WebHome]] page for more information about commands, actions and configurations.
46 46  
47 -Changing the values will not affect the session. Values which have been changed will have a yellow background. The values which can be entered are restricted to what the servo can accept; for example, servo IDs must be below 250.
104 +Changing the values will not affect the session. Values which have been changed will have a yellow background. The values which can be entered are restricted to what the servo can accept; for example, servo IDs must be below 250.
48 48  
49 -**UPDATE** Pressing this button will writall values to EEPROM, changing the configurations, and reverting all background colors to white.
106 +Each command is associated with the following protocol. Additional details for each can be found on the [[LSS Communication Protocol>>doc:lynxmotion-smart-servo.lss-communication-protocol.WebHome]] page.
50 50  
51 -**UNDO ALL** is a shortcut button which reverts all changes made which have not been written to EEPROM.
108 +(% style="margin-right:auto" %)
109 +|Field|Command|Update?
110 +|Pos 1/10 & Send|**D **(position in 1/10 degrees)|No
111 +|E-STOP|**L** (limp)|No
112 +|Hold|**H** (Halt & Hold)|No
113 +|Servo ID|**CID** (Configure servo ID)|Yes
114 +|Baud Rate|**CB** (Configure Baud rate)|Yes
115 +|Origin Offset|**CO** (Configure Origin Offset)|Yes
116 +|Angular Rng|**CAR** (Configure Angular Range)|Yes
117 +|Gyre Dir|**CG** (Configure Gyre direction)|Yes
118 +|LED Color|**CLED** (Configure LED)|Yes
119 +|First Pos. & Active & Value:|**CFP** (Configure First Position), toggle active & input value|Yes
120 +|Max Speed (RPM)|**CSD **(Configure maximum Speed in Degrees)|Yes
121 +|Stiffness|**CAH** (Configure Angular Holding stiffness)|Yes
52 52  
123 +**UPDATE** Pressing this button will write all values to EEPROM, changing the configurations, and reverting all background colors to white.
124 +
125 +**UNDO ALL** is a shortcut button which reverts all changes made which have not been written to EEPROM.
126 +
53 53  **SMART** / **RC POS** / **RC WHL**: This is a shortcut to change the servo's mode (LSS Smart Serial / RC PWM Position / RC PWM Wheel). IMPORTANT NOTE: Should you select either of the two RC modes, the LSS Config software will no longer be able to communicate with the servo. You must use the button menu to return to LSS serial mode (hold the button, release, press twice).
54 54  
55 -= Telemetry Graph [coming soon] =
129 +== Telemetry Graph ==
56 56  
57 -The sensor graphing feature of the software allows you to select, display and record, with respect to time, the output from all of the servo's sensors.
131 +The sensor graphing feature of the software allows you to select, display and record, with respect to time, the output from all of the servo's sensors.
58 58  
59 -{More to come}
133 +{{lightbox image="lss-config-telemetry-graph.png" width="521"/}}
60 60  
61 -= Command Line =
135 +x-Axis: seconds
62 62  
63 -[[image:lss-config-command-line.jpg||alt="LSS Config Command Line"]]
137 +* Position: blue
138 +* Speed: green
139 +* Current: red
140 +* Voltage: yellow
141 +* Temperature: gray
64 64  
65 -The custom command line interface both allows you to communicate directly with an individual servo, send commands to it (and view replies), as well as get responses to queries from the software.
143 +|(% style="width:76px" %)[[image:lss-config-visibility.jpg]]|(% style="width:488px" %)Sensor Feedback Visibility (ON)|(% style="width:137px" %)[[image:lss-config-visibility-off.jpg]]|(% style="width:777px" %)Sensor Feedback Visibility (OFF)
144 +|(% style="width:76px" %)[[image:lss-config-display-query.jpg]]|(% style="width:488px" %)Query value (ON)|(% style="width:137px" %)[[image:lss-config-display-query-off.jpg]]|(% style="width:777px" %)Query value (OFF)
145 +|(% style="width:76px" %)[[image:lss-config-play-icon.jpg]]|(% style="width:488px" %)Graphing (OFF)|(% style="width:137px" %)[[image:lss-config-play-icon-green.jpg]]|(% style="width:777px" %)Graphing (ON)
146 +|(% style="width:76px" %)[[image:lss-config-pause-icon.jpg]]|(% style="width:488px" %)Pause queries (OFF)|(% style="width:137px" %)[[image:lss-config-pause-icon-yellow.jpg]]|(% style="width:777px" %)Pause Queries (ON)
147 +|(% style="width:76px" %)[[image:lss-config-record-icon.jpg]]|(% style="width:488px" %)Record Sensor Queries (Not Recording)|(% style="width:137px" %)[[image:lss-config-record-icon-red.jpg]]|(% style="width:777px" %)Record Sensor Queries (Recording)
148 +|(% style="width:76px" %)[[image:lss-config-stop-icon.jpg]]|(% style="width:488px" %)Reset Graph|(% style="width:137px" %) |(% style="width:777px" %)
149 +|(% style="width:76px" %)[[image:lss-config-export-graph-icon.jpg]]|(% style="width:488px" %)Export recording to .csv (comma separated values)|(% style="width:137px" %) |(% style="width:777px" %)(((
150 +Export popup appears providing three options:
66 66  
67 -~>>: Command sent to the servo
152 +1) Export only recorded data ("YES") 2) Export all data (click "NO") 3) Cancel export
153 +)))
154 +|(% style="width:76px" %)[[image:lss-config-temperature-celcius.jpg]]|(% style="width:488px" %)Temperature Units (Celcius)|(% style="width:137px" %)[[image:lss-config-temperature-faren.jpg]]|(% style="width:777px" %)Temperature Units (Fahrenheit)
155 +|(% style="width:76px" %)[[image:lss-config-marker-circle.jpg]]|(% style="width:488px" %)Marker Icon Style (Circle)|(% style="width:137px" %)[[image:lss-config-marker-diamond.jpg]] [[image:lss-config-marker-square.jpg]]|(% style="width:777px" %)Marker Icon Style (Diamond / Square)
156 +|(% style="width:76px" %)[[image:lss-config-10s.jpg]]|(% style="width:488px" %)Time Window (10s)|(% style="width:137px" %)(((
157 +[[image:lss-config-30s.jpg]] [[image:lss-config-60s.jpg]]
158 +[[image:lss-config-300s.jpg]] [[image:lss-config-infs.jpg]]
159 +)))|(% style="width:777px" %)Time Window (30s / 60s / 300s / Total)
68 68  
69 -<<: Reply from the servo
161 +(% class="wikigeneratedid" %)
162 +Note that when multiple servos are connected, and the user changes between servos, the telemetry graph is not cleared (use the reset graph button).
70 70  
71 -The software also auto-completes each command by automatically inserting "#[ID] before each command. For example, rather than typing #4D230<cr>, you need only type D230 and the software will automatically add #4
164 +(% class="wikigeneratedid" %)
165 +Occasionally the telemetry values may all simultaneously drop to zero for one reading, or skip a point due to other processes taking priority.
72 72  
73 -Left clicking a line highlights that line and allows it to be copied to the clipboard by pressing the right mouse button.
167 +== Command Line ==
74 74  
75 -{More to come}
169 +{{lightbox image="lss-config-terminal-0001" width="521"/}}
170 +
171 +The custom command line interface both allows you to communicate directly with an individual servo, send commands to it (and view replies), as well as get responses to queries from the software. When "LSS-All (254; ~-~--k)" is selected in the list of servos, the Command Line is used to send the same action or configuration command to all servos on the bus. For example, typing D1800 and pressing enter will send that same position command to each of the servos on the bus.
172 +
173 +Within the command interface, you might see the following:
174 +
175 +|(% style="width:114px" %)**>>**|(% style="width:1364px" %)Command sent to the servo
176 +|(% style="width:114px" %)**<<**|(% style="width:1364px" %)Reply from the servo
177 +|(% style="width:114px" %)**INF ::**|(% style="width:1364px" %)Information
178 +|(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader
179 +|(% style="width:114px" %)**]]**|(% style="width:1364px" %)Failure
180 +
181 +The command line also auto-completes each command by automatically inserting "#[ID] before each command. For example, rather than typing #4D230<cr>, you need only type D230 and the software will automatically add #4
182 +
183 +Left clicking a line within the command prompt, then right clicking using your mouse highlights that line in a green border and allows it to be copied to the clipboard and pasted into another document. Scrolling is opposite that to browser navigation.
184 +
185 +The mouse wheel can be used to scroll and the holding the middle mouse button down allows for panning over the terminal area (useful if text extends to the right).
186 +
187 += Tutorials =
188 +
189 +* [[doc:lynxmotion-smart-servo.lss-configuration-software.lss-config-configure-ids.WebHome]]
190 +* [[doc:lynxmotion-smart-servo.lss-configuration-software.lss-config-firmware-update.WebHome]]
LSS-Config-BETA.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.ENantel
Size
... ... @@ -1,1 +1,0 @@
1 -292.7 KB
Content
lss-config-command-line.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.RB1
Size
... ... @@ -1,1 +1,0 @@
1 -18.2 KB
Content
lss-config-connect-firmware.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.RB1
Size
... ... @@ -1,1 +1,0 @@
1 -10.4 KB
Content
lss-config-firmware-update.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.RB1
Size
... ... @@ -1,1 +1,0 @@
1 -23.5 KB
Content
LSS Config - 20.7.3 - Firmware update.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +25.3 KB
Content
LSS Config - 20.7.3 - Screenshot.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +246.8 KB
Content
lss-config-1000px.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.ENantel
Size
... ... @@ -1,0 +1,1 @@
1 +279.7 KB
Content
lss-config-300s.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.9 KB
Content
lss-config-60s.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.7 KB
Content
lss-config-control-0003-both.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +120.3 KB
Content
lss-config-control.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +69.8 KB
Content
lss-config-display-query-off.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +2.6 KB
Content
lss-config-display-query.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.9 KB
Content
lss-config-firmware-update-restore-settings.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +7.1 KB
Content
lss-config-full-window-0001.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.ENantel
Size
... ... @@ -1,0 +1,1 @@
1 +245.7 KB
Content
lss-config-infs.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.8 KB
Content
lss-config-pause-icon-yellow.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.8 KB
Content
lss-config-pause-icon.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.4 KB
Content
lss-config-telemetry-graph.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +60.7 KB
Content
lss-config-terminal-0001.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +13.2 KB
Content
lss-config-visibility-off.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.1 KB
Content
lss-config-visibility.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +1.8 KB
Content
wiki-download.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.CBenson
Size
... ... @@ -1,0 +1,1 @@
1 +3.9 KB
Content
Copyright RobotShop 2018