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

From version < 170.1 >
edited by RB1
on 2020/07/15 14:32
To version < 205.1 >
edited by Eric Nantel
on 2023/03/17 14:05
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -LSS - Configuration Software
1 +LSS Configuration Software
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.RB1
1 +xwiki:XWiki.ENantel
Content
... ... @@ -1,6 +1,6 @@
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"]]
1 +{{lightbox image="lynxmotion-smart-servo.lss-configuration-software.WebHome@LSS Config - 20.7.3 - Screenshot.png" title="LSS Config - 20.7.3 - Screenshot" width="600"/}}
2 2  
3 -[[[[image:wiki-download.png]]>>https://www.robotshop.com/en/lynxmotion-smart-servo-lss-configuration-software.html||rel="noopener noreferrer" target="_blank"]]
3 +[[[[image:wiki-download.png]]>>attach:LSS_Config_Setup.zip]]
4 4  
5 5  **Table of Contents**
6 6  
... ... @@ -16,29 +16,44 @@
16 16  
17 17  == Connection ==
18 18  
19 -[[image:lss-config-top-menu.jpg]]
19 +{{lightbox image="lynxmotion-smart-servo.lss-configuration-software.WebHome@lss-config-20.7.14.2-header-controls-not-connected.png" title="LSS Config - 20.7.14.2 - Header controls (not connected)" width="552" group="header"/}}
20 20  
21 +{{lightbox image="lynxmotion-smart-servo.lss-configuration-software.WebHome@lss-config-20.7.14.2-header-controls-connected.png" title="LSS Config - 20.7.14.2 - Header controls (connected, before scan)" width="552" group="header"/}}
22 +
23 +{{lightbox image="lynxmotion-smart-servo.lss-configuration-software.WebHome@lss-config-20.7.14.2-header-controls-lss-selected.png" title="LSS Config - 20.7.14.2 - Header controls (LSS selected, after scan)" width="552" group="header"/}}
24 +
25 +
26 +The headers above show the three main states (from top to bottom):
27 +
28 +* Before a connection is made
29 +* After a connection, before a scan
30 +* After a scan with a LSS selected
31 +
21 21  The header includes (left to right):
22 22  
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 27  * COM port selection
28 28  * CONNECT / DISCONNECT (toggle ON / OFF)
36 +* SCAN: (popup) scans the bus for all available servo motors
37 +* SERVO LIST: Servo selected via the dropdown menu
38 +* FIRMWARE: (popup) used to update servo's firmware
39 +* WIKI (link to the LSS Config guide on the Lynxmotion Wiki)
29 29  
30 30  === COM Port ===
31 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.
43 +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. If you wish to change the COM port selected you must disconnect, select the correct COM port and reconnect.
33 33  
45 +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. If it is still not clear which is the proper COM port, simply disconnect and reconnec the USB cable with Device Manager open. The proper COM port will disapear (when disconnecting the USB cable) and reappear (when connecting the USB cable).
46 +
34 34  === Scan ===
35 35  
36 -[[image:lss-config-scan.jpg||height="500" width="194"]]
49 +{{lightbox image="lynxmotion-smart-servo.lss-configuration-software.WebHome@lss-config-20.7.14.2-scan-options.png" title="LSS Config - 20.7.14.2 - Scan options" width="124"/}}
37 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.
51 +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. You press the **ALL** button to select all baud rates, press the individual check boxes to toggle each select or press the **<<** button to select only the corresponding baud rate, deselecting all others. You may also limit the IDs to scan for. When in doubt, leave all baud rates selected.
39 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.
53 +Once you press OK, the scan will start by turning off the LED of all servos on the selected baud rates (#254LED0\r). Then, each selected baud rate is scanned for servos. The command line interface will include messages for all servos found (or not found) at each baud rate, as well as any conflicts discovered (two or more LSS at the same location). In this case, a location is defined as a baud rate and ID pair.
41 41  
55 +This process will 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, those servo's LED 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 (they will need to be connected individually/separately from the other conflicting servos).
56 +
42 42  **GREEN LED**: No Conflict
43 43  
44 44  **RED LED**: Conflict Found
... ... @@ -47,37 +47,40 @@
47 47  
48 48  === Servo ===
49 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.
65 +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 selected for convenience.
51 51  
52 -LSS-None (???; ~-~--k)
67 +**LSS-None (???; ~-~--k)**
53 53  
54 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 55  
56 -LSS-All (254; ~-~--k)
71 +Note: You can use this special firmware recovery function with 2 or more servos simultaneously. Just make sure they are all in bootloader mode before stating the firmware update using this option.
57 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.
73 +**LSS-All (254; ~-~--k)**
59 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:
75 +This option allows actions that affect all detected servos in the list after a successful scan. 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 detected servos on the bus or to send the same action command via the command line interface described below.
61 61  
62 -ST1 (0;115.2k [368])
77 +The drop-down list will be populated with all servos which the software has found on the bus, indicating their servo model, ID and firmware version. Each servo will then be listed in the following format:
63 63  
79 +**ST1 (0;115.2k [368])**
80 +
64 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 65  
66 66  == Firmware Update ==
67 67  
68 -[[image:lynxmotion-smart-servo.lss-configuration-software.WebHome@LSS Config - 20.7.3 - Firmware update.png||height="295" width="400"]]
85 +{{lightbox image="lynxmotion-smart-servo.lss-configuration-software.WebHome@LSS Config - 20.7.3 - Firmware update.png" width="416"/}}
69 69  
70 70  The firmware update option is a popup which includes:
71 71  
72 -* Firmware version in dropdown format, including the current recommended version
73 -* Experimental firmware (if available)
89 +* Firmware version selection in a dropdown list, including the current recommended version
90 +* Experimental firmware (optional)
74 74  * Cancel firmware update
75 75  * OK to continue firmware update
76 -* Notes regarding the firmware
93 +* Checkbox to try to save & restore the settings (config)
94 +* Notes regarding the selected firmware
77 77  
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.
96 +The LSS Config serves as the main software used to update the servo's onboard firmware. An internet connection is needed in order for the software to check if an online update is available and obtain a copy. When checked, the Exp. button will allow experimental versions of the firmware to be displayed in the list. It also allows to load a firmware directly from a local file.
79 79  
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.
98 +Following this pop-up your servo will be restarted (unless already in bootloader mode, see LSS-None above) 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.
81 81  
82 82  __**NOTE: Before assembling the servos as part of a robot, check to see if there is a firmware update available.**__
83 83  
... ... @@ -87,14 +87,20 @@
87 87  
88 88  The servo control section allows you to visually move the servo and change a variety of parameters, including:
89 89  
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
108 +* [[image:lss-config-20.7.14.2-carets-position-64 .png]]Position: pale blue caret
109 +* [[image:lss-config-20.7.14.2-carets-offset-64.png]]Origin offset: magenta caret
110 +* [[image:lss-config-20.7.14.2-carets-angular-range-64.png]]Angular range: magenta square carets
111 +* [[image:lss-config-20.7.14.2-carets-speed-64.png]]RPM: green arrow / indicator
112 +* [[image:lss-config-20.7.14.2-carets-first-position-64.png]]Initial position: dark blue caret
95 95  
96 -At the lower left the servo model and the LED color are shown.
114 +At the lower left the servo model and the LED color (session value) are shown.
97 97  
116 +To change a value, simple use the left mouse button to hold and drag the relevant caret around its ring. Letting go of the left mouse button will update the value right away. While holding the left mouse button you can also press the right mouse button to cancel the current change to that caret (happens after right mouse click and then letting go of the left mouse button).
117 +
118 +If the caret moved is position, this will send a position command in tenths of degrees right away to the servo (#[id]D[pos]\r).
119 +If the caret moved is first position, offset or angular range then it will update the appropiate configuration (see below for details), pending an update confirmation.
120 +The speed caret cannot be moved directly; it only serves only as a display of the current speed.
121 +
98 98  == Configurations ==
99 99  
100 100  {{lightbox image="lss-config-configurations.jpg" width="350"/}}
... ... @@ -164,11 +164,11 @@
164 164  (% class="wikigeneratedid" %)
165 165  Occasionally the telemetry values may all simultaneously drop to zero for one reading, or skip a point due to other processes taking priority.
166 166  
167 -== Command Line ==
191 +== Command line ==
168 168  
169 169  {{lightbox image="lss-config-terminal-0001" width="521"/}}
170 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.
195 +The command line interface both allows you to communicate directly with an individual servo, send commands to it and view replies to queries. 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 detected servos. For example, typing D1800 and pressing enter will send that same position command to each of the detected servos.
172 172  
173 173  Within the command interface, you might see the following:
174 174  
... ... @@ -175,14 +175,15 @@
175 175  |(% style="width:114px" %)**>>**|(% style="width:1364px" %)Command sent to the servo
176 176  |(% style="width:114px" %)**<<**|(% style="width:1364px" %)Reply from the servo
177 177  |(% style="width:114px" %)**INF ::**|(% style="width:1364px" %)Information
178 -|(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader
202 +|(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader mode & firmware updates
179 179  |(% style="width:114px" %)**]]**|(% style="width:1364px" %)Failure
204 +|(% style="width:114px" %)[[image:lss-config-20.7.14.2-terminal-doublestar-bold.png]]|(% style="width:1364px" %)Configuration command redirected to config interface (left hand side)
180 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
206 +The command line also auto-completes each command by automatically inserting "#[id]" before each command for you. Therefore, you only need to type the command itself, such as "D1000" and press [enter]. For example, rather than typing #4D230<cr>, you need only type D230 and the software will automatically add #4 & \r.
182 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.
208 +Left clicking a line within the command prompt and 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 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).
210 +The mouse wheel can be used to scroll and the holding the middle mouse button down allows for panning over the command line area (useful if text extends to the right). There are also two scrolling bars that can be used with the left mouse button as normal for panning the command line view.
186 186  
187 187  = Tutorials =
188 188  
LSS_Config_Setup.zip
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.ENantel
Size
... ... @@ -1,0 +1,1 @@
1 +3.6 MB
Content
lss-config-20.7.14.2-carets-angular-range-64.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +426 bytes
Content
lss-config-20.7.14.2-carets-angular-range.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +400 bytes
Content
lss-config-20.7.14.2-carets-first-position-64.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +348 bytes
Content
lss-config-20.7.14.2-carets-first-position.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +322 bytes
Content
lss-config-20.7.14.2-carets-offset-64.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +404 bytes
Content
lss-config-20.7.14.2-carets-offset.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +362 bytes
Content
lss-config-20.7.14.2-carets-position-64 .png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +420 bytes
Content
lss-config-20.7.14.2-carets-position.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +390 bytes
Content
lss-config-20.7.14.2-carets-speed-64.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +371 bytes
Content
lss-config-20.7.14.2-carets-speed.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +334 bytes
Content
lss-config-20.7.14.2-header-controls-lss-selected.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +5.2 KB
Content
lss-config-20.7.14.2-header-controls-not-connected.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +4.7 KB
Content
lss-config-20.7.14.2-popup-firmware-update-lss-none.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +10.1 KB
Content
lss-config-20.7.14.2-scan-options.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +12.2 KB
Content
lss-config-20.7.14.2-terminal-doublestar-bold.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.RB1
Size
... ... @@ -1,0 +1,1 @@
1 +289 bytes
Content
Copyright RobotShop 2018