Wiki source code of LSS - Configuration Software

Last modified by RB1 on 2020/07/16 16:40

Show last authors
1 {{lightbox image="[email protected] Config - 20.7.3 - Screenshot.png" title="LSS Config - 20.7.3 - Screenshot" width="600"/}}
2
3 [[[[image:wiki-download.png]]>>https://www.robotshop.com/en/lynxmotion-smart-servo-lss-configuration-software.html||rel="noopener noreferrer" target="_blank"]]
4
5 **Table of Contents**
6
7 {{toc/}}
8
9 = Description =
10
11 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.
12
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]].
14
15 = Features =
16
17 == Connection ==
18
19 {{lightbox image="[email protected]nfig-20.7.14.2-header-controls-not-connected.png" title="LSS Config - 20.7.14.2 - Header controls (not connected)" width="552" group="header"/}} {{lightbox image="[email protected]nfig-20.7.14.2-header-controls-connected.png" title="LSS Config - 20.7.14.2 - Header controls (connected, before scan)" width="552" group="header"/}} {{lightbox image="[email protected]nfig-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"/}}
20
21 The headers above show the three main states (from top to bottom):
22
23 * Before a connection is made
24 * After a connection, before a scan
25 * After a scan with a LSS selected
26
27 The header includes (left to right):
28
29 * COM port selection
30 * CONNECT / DISCONNECT (toggle ON / OFF)
31 * SCAN: (popup) scans the bus for all available servo motors
32 * SERVO LIST: Servo selected via the dropdown menu
33 * FIRMWARE: (popup) used to update servo's firmware
34 * WIKI (link to the LSS Config guide on the Lynxmotion Wiki)
35
36 === COM Port ===
37
38 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.
39
40 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).
41
42 === Scan ===
43
44 {{lightbox image="[email protected]nfig-20.7.14.2-scan-options.png" title="LSS Config - 20.7.14.2 - Scan options" width="124"/}}
45
46 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.
47
48 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.
49
50 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).
51
52 **GREEN LED**: No Conflict
53
54 **RED LED**: Conflict Found
55
56 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).
57
58 === Servo ===
59
60 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.
61
62 **LSS-None (???; ~-~--k)**
63
64 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".
65
66 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.
67
68 **LSS-All (254; ~-~--k)**
69
70 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.
71
72 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:
73
74 **ST1 (0;115.2k [368])**
75
76 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.
77
78 == Firmware Update ==
79
80 {{lightbox image="[email protected] Config - 20.7.3 - Firmware update.png" width="416"/}}
81
82 The firmware update option is a popup which includes:
83
84 * Firmware version selection in a dropdown list, including the current recommended version
85 * Experimental firmware (optional)
86 * Cancel firmware update
87 * OK to continue firmware update
88 * Checkbox to try to save & restore the settings (config)
89 * Notes regarding the selected firmware
90
91 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.
92
93 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.
94
95 __**NOTE: Before assembling the servos as part of a robot, check to see if there is a firmware update available.**__
96
97 == Servo Control ==
98
99 {{lightbox image="lss-config-control-0003-both.png" width="485"/}}
100
101 The servo control section allows you to visually move the servo and change a variety of parameters, including:
102
103 * [[image:lss-config-20.7.14.2-carets-position-64 .png]]Position: pale blue caret
104 * [[image:lss-config-20.7.14.2-carets-offset-64.png]]Origin offset: magenta caret
105 * [[image:lss-config-20.7.14.2-carets-angular-range-64.png]]Angular range: magenta square carets
106 * [[image:lss-config-20.7.14.2-carets-speed-64.png]]RPM: green arrow / indicator
107 * [[image:lss-config-20.7.14.2-carets-first-position-64.png]]Initial position: dark blue caret
108
109 At the lower left the servo model and the LED color (session value) are shown.
110
111 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).
112
113 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).
114 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.
115 The speed caret cannot be moved directly; it only serves only as a display of the current speed.
116
117 == Configurations ==
118
119 {{lightbox image="lss-config-configurations.jpg" width="350"/}}
120
121 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.
122
123 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.
124
125 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.
126
127 (% style="margin-right:auto" %)
128 |Field|Command|Update?
129 |Pos 1/10 & Send|**D **(position in 1/10 degrees)|No
130 |E-STOP|**L** (limp)|No
131 |Hold|**H** (Halt & Hold)|No
132 |Servo ID|**CID** (Configure servo ID)|Yes
133 |Baud Rate|**CB** (Configure Baud rate)|Yes
134 |Origin Offset|**CO** (Configure Origin Offset)|Yes
135 |Angular Rng|**CAR** (Configure Angular Range)|Yes
136 |Gyre Dir|**CG** (Configure Gyre direction)|Yes
137 |LED Color|**CLED** (Configure LED)|Yes
138 |First Pos. & Active & Value:|**CFP** (Configure First Position), toggle active & input value|Yes
139 |Max Speed (RPM)|**CSD **(Configure maximum Speed in Degrees)|Yes
140 |Stiffness|**CAH** (Configure Angular Holding stiffness)|Yes
141
142 **UPDATE** Pressing this button will write all values to EEPROM, changing the configurations, and reverting all background colors to white.
143
144 **UNDO ALL** is a shortcut button which reverts all changes made which have not been written to EEPROM.
145
146 **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).
147
148 == Telemetry Graph ==
149
150 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.
151
152 {{lightbox image="lss-config-telemetry-graph.png" width="521"/}}
153
154 x-Axis: seconds
155
156 * Position: blue
157 * Speed: green
158 * Current: red
159 * Voltage: yellow
160 * Temperature: gray
161
162 |(% 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)
163 |(% 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)
164 |(% 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)
165 |(% 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)
166 |(% 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)
167 |(% style="width:76px" %)[[image:lss-config-stop-icon.jpg]]|(% style="width:488px" %)Reset Graph|(% style="width:137px" %) |(% style="width:777px" %)
168 |(% 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" %)(((
169 Export popup appears providing three options:
170
171 1) Export only recorded data ("YES") 2) Export all data (click "NO") 3) Cancel export
172 )))
173 |(% 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)
174 |(% 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)
175 |(% style="width:76px" %)[[image:lss-config-10s.jpg]]|(% style="width:488px" %)Time Window (10s)|(% style="width:137px" %)(((
176 [[image:lss-config-30s.jpg]] [[image:lss-config-60s.jpg]]
177 [[image:lss-config-300s.jpg]] [[image:lss-config-infs.jpg]]
178 )))|(% style="width:777px" %)Time Window (30s / 60s / 300s / Total)
179
180 (% class="wikigeneratedid" %)
181 Note that when multiple servos are connected, and the user changes between servos, the telemetry graph is not cleared (use the reset graph button).
182
183 (% class="wikigeneratedid" %)
184 Occasionally the telemetry values may all simultaneously drop to zero for one reading, or skip a point due to other processes taking priority.
185
186 == Command line ==
187
188 {{lightbox image="lss-config-terminal-0001" width="521"/}}
189
190 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.
191
192 Within the command interface, you might see the following:
193
194 |(% style="width:114px" %)**>>**|(% style="width:1364px" %)Command sent to the servo
195 |(% style="width:114px" %)**<<**|(% style="width:1364px" %)Reply from the servo
196 |(% style="width:114px" %)**INF ::**|(% style="width:1364px" %)Information
197 |(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader mode & firmware updates
198 |(% style="width:114px" %)**]]**|(% style="width:1364px" %)Failure
199 |(% 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)
200
201 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.
202
203 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.
204
205 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.
206
207 = Tutorials =
208
209 * [[doc:lynxmotion-smart-servo.lss-configuration-software.lss-config-configure-ids.WebHome]]
210 * [[doc:lynxmotion-smart-servo.lss-configuration-software.lss-config-firmware-update.WebHome]]
Copyright RobotShop 2018