Wiki source code of LSS - Configuration Software

Version 163.1 by Coleman Benson on 2019/09/20 15:07

Hide last authors
Eric Nantel 157.1 1 [[image:lss-config-1000px.png||width="350"]]
Eric Nantel 158.1 2
Eric Nantel 157.1 3 [[[[image:wiki-download.png]]>>https://www.robotshop.com/en/lynxmotion-smart-servo-lss-configuration-software.html||rel="noopener noreferrer" target="_blank"]]
RB1 154.1 4
Eric Nantel 107.1 5 **Table of Contents**
Eric Nantel 47.1 6
Eric Nantel 44.1 7 {{toc/}}
8
Coleman Benson 151.1 9 = Description =
10
RB1 63.1 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.
RB1 1.1 12
RB1 64.1 13 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]].
RB1 3.2 14
Coleman Benson 161.1 15 = Features =
RB1 3.1 16
Coleman Benson 161.1 17 == Connection ==
18
RB1 28.1 19 [[image:lss-config-header.png]]
RB1 13.1 20
Coleman Benson 96.1 21 The header includes (left to right):
RB1 28.1 22
Coleman Benson 96.1 23 * Firmware version currently installed on servo
24 * Firmware update option
25 * COM port selection
26 * Connect (toggle ON / OFF)
RB1 13.1 27
RB1 117.1 28 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.
RB1 3.1 29
Eric Nantel 51.1 30 == Firmware Update ==
RB1 3.1 31
RB1 134.1 32 {{lightbox image="lss-config-firmware-update.png" width="417"/}}
RB1 3.1 33
Coleman Benson 96.1 34 The firmware update option is a popup which includes:
RB1 28.1 35
Coleman Benson 96.1 36 * Firmware version in dropdown format, including the current recommended version
37 * Experimental firmware (if available)
38 * Cancel firmware update
39 * OK to continue firmware update
40 * Notes regarding the firmware
RB1 17.1 41
RB1 125.1 42 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.
RB1 17.1 43
RB1 127.1 44 Once the OK button is pressed, the software will request if you wish to save your servo's configurations and restore them after the firmware update (see image below). Clicking **Yes** will poll your servo to obtain all of its available settings and which will be restored after a successful firmware update is completed.
Coleman Benson 161.1 45
RB1 126.1 46 [[image:lss-config-firmware-update-restore-settings.png]]
RB1 125.1 47
48 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.
49
Coleman Benson 163.1 50 __**NOTE: Before assembling the servos as part of a robot, check to see if there is a firmware update available.**__
51
Coleman Benson 161.1 52 == Servo Control ==
RB1 3.2 53
RB1 131.1 54 {{lightbox image="lss-config-control-0003-both.png" width="485"/}}
RB1 3.1 55
Coleman Benson 100.1 56 The servo control section allows you to visually move the servo and change a variety of parameters, including:
57
RB1 132.1 58 * Position: pale blue caret
59 * Origin offset: magenta caret
60 * Angular range: magenta square carets
61 * RPM: green arrow / indicator
62 * Initial position: dark blue caret
RB1 4.1 63
RB1 135.1 64 At the lower left the servo model and the LED color are shown.
RB1 3.1 65
Eric Nantel 51.1 66 == Configurations ==
RB1 5.1 67
Eric Nantel 108.1 68 {{lightbox image="lss-config-configurations.jpg" width="350"/}}
RB1 9.1 69
Coleman Benson 150.1 70 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.
RB1 5.1 71
RB1 15.1 72 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.
RB1 5.1 73
RB1 15.1 74 **UPDATE** Pressing this button will write all values to EEPROM, changing the configurations, and reverting all background colors to white.
RB1 5.1 75
RB1 15.1 76 **UNDO ALL** is a shortcut button which reverts all changes made which have not been written to EEPROM.
RB1 14.1 77
RB1 15.1 78 **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).
RB1 14.1 79
Coleman Benson 161.1 80 == Telemetry Graph ==
RB1 3.1 81
RB1 3.4 82 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.
RB1 3.3 83
RB1 139.1 84 {{lightbox image="lss-config-telemetry-graph.png" width="521"/}}
RB1 3.1 85
Coleman Benson 95.1 86 x-Axis: seconds
87
RB1 140.1 88 * Position: blue
89 * Speed: green
90 * Current: red
91 * Voltage: yellow
92 * Temperature: gray
Coleman Benson 95.1 93
Coleman Benson 97.1 94 |(% 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)
RB1 142.1 95 |(% 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)
Coleman Benson 97.1 96 |(% 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)
97 |(% 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)
98 |(% 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)
99 |(% style="width:76px" %)[[image:lss-config-stop-icon.jpg]]|(% style="width:488px" %)Reset Graph|(% style="width:137px" %) |(% style="width:777px" %)
100 |(% 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" %)(((
101 Export popup appears providing three options:
102
103 1) Export only recorded data ("YES")  2) Export all data (click "NO") 3) Cancel export
104 )))
105 |(% 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)
106 |(% 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)
107 |(% style="width:76px" %)[[image:lss-config-10s.jpg]]|(% style="width:488px" %)Time Window (10s)|(% style="width:137px" %)(((
Coleman Benson 161.1 108 [[image:lss-config-30s.jpg]] [[image:lss-config-60s.jpg]]
Coleman Benson 95.1 109 [[image:lss-config-300s.jpg]] [[image:lss-config-infs.jpg]]
Coleman Benson 97.1 110 )))|(% style="width:777px" %)Time Window (30s / 60s / 300s / Total)
Coleman Benson 95.1 111
Coleman Benson 161.1 112 == Command Line ==
RB1 3.1 113
RB1 159.1 114 {{lightbox image="lss-config-terminal-0001" width="521"/}}
Eric Nantel 157.1 115
Coleman Benson 97.1 116 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. Within the command interface, you might see the following:
RB1 3.1 117
Coleman Benson 97.1 118 |(% style="width:114px" %)**>>**|(% style="width:1364px" %)Command sent to the servo
119 |(% style="width:114px" %)**<<**|(% style="width:1364px" %)Reply from the servo
120 |(% style="width:114px" %)**INF ::**|(% style="width:1364px" %)Information
121 |(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader
122 |(% style="width:114px" %)**]]**|(% style="width:1364px" %)Failure
RB1 20.1 123
Coleman Benson 97.1 124 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
RB1 20.1 125
Coleman Benson 97.1 126 Left clicking a line within the command prompt, then right clicking using your mouse highlights that line in green and allows it to be copied to the clipboard and pasted into another document.
RB1 20.1 127
RB1 148.1 128 The mouse wheel can be used to scroll and the holding the middle mouse button down allows for panning over the terminal area.
Eric Nantel 162.1 129
130 = Tutorials =
131
132 * [[doc:.lss-config-configure-ids.WebHome]]
Copyright RobotShop 2018