Wiki source code of LSS - Configuration Software

Version 98.1 by Coleman Benson on 2019/05/02 15:00

Hide last authors
RB1 64.1 1 [[image:LSS-Config-BETA.png||queryString="width=350" width="350"]]
Eric Nantel 46.1 2
Coleman Benson 54.1 3 **Page Contents**
Eric Nantel 47.1 4
Eric Nantel 44.1 5 {{toc/}}
6
RB1 63.1 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.
RB1 1.1 8
RB1 64.1 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]].
RB1 3.2 10
Eric Nantel 51.1 11 = Header =
RB1 3.1 12
RB1 28.1 13 [[image:lss-config-header.png]]
RB1 13.1 14
Coleman Benson 96.1 15 The header includes (left to right):
RB1 28.1 16
Coleman Benson 96.1 17 * Firmware version currently installed on servo
18 * Firmware update option
19 * COM port selection
20 * Connect (toggle ON / OFF)
RB1 13.1 21
Coleman Benson 96.1 22 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. 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 23
Eric Nantel 51.1 24 == Firmware Update ==
RB1 3.1 25
RB1 28.1 26 [[image:lss-config-firmware-update.png]]
RB1 3.1 27
Coleman Benson 96.1 28 The firmware update option is a popup which includes:
RB1 28.1 29
Coleman Benson 96.1 30 * Firmware version in dropdown format, including the current recommended version
31 * Experimental firmware (if available)
32 * Cancel firmware update
33 * OK to continue firmware update
34 * Notes regarding the firmware
RB1 17.1 35
Coleman Benson 96.1 36 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. 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.
RB1 17.1 37
Eric Nantel 51.1 38 = Servo Control [coming soon] =
RB1 3.2 39
Coleman Benson 96.1 40 The servo control section allows you to visually move the servo and change a variety of parameters.
RB1 3.1 41
Coleman Benson 96.1 42 * Position: blue caret
43 * First Position: magenta caret
44 * RPM: green arrow
RB1 4.1 45
RB1 1.1 46 {More to come}
RB1 3.1 47
Eric Nantel 51.1 48 == Configurations ==
RB1 5.1 49
RB1 25.1 50 [[image:lss-config-configurations.png]]
RB1 9.1 51
RB1 65.1 52 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.
RB1 5.1 53
RB1 15.1 54 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 55
RB1 15.1 56 **UPDATE** Pressing this button will write all values to EEPROM, changing the configurations, and reverting all background colors to white.
RB1 5.1 57
RB1 15.1 58 **UNDO ALL** is a shortcut button which reverts all changes made which have not been written to EEPROM.
RB1 14.1 59
RB1 15.1 60 **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 61
Eric Nantel 51.1 62 = Telemetry Graph [coming soon] =
RB1 3.1 63
RB1 3.4 64 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 65
Coleman Benson 95.1 66 [[image:lss-config-graph.jpg]]
RB1 3.1 67
Coleman Benson 95.1 68 x-Axis: seconds
69
Coleman Benson 96.1 70 * Position: Blue
71 * Speed: Green
72 * Current: Red
73 * Voltage: Yellow
74 * Temperature: Grey
Coleman Benson 95.1 75
Coleman Benson 97.1 76 |(% 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)
77 |(% style="width:76px" %)[[image:lss-config-display-query.jpg]]|(% style="width:488px" %)Display Queries (ON)|(% style="width:137px" %)[[image:lss-config-display-query-off.jpg]]|(% style="width:777px" %)Display Queries (OFF)
78 |(% 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)
79 |(% 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)
80 |(% 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)
81 |(% style="width:76px" %)[[image:lss-config-stop-icon.jpg]]|(% style="width:488px" %)Reset Graph|(% style="width:137px" %) |(% style="width:777px" %)
82 |(% 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" %)(((
83 Export popup appears providing three options:
84
85 1) Export only recorded data ("YES")  2) Export all data (click "NO") 3) Cancel export
86 )))
87 |(% 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)
88 |(% 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)
89 |(% style="width:76px" %)[[image:lss-config-10s.jpg]]|(% style="width:488px" %)Time Window (10s)|(% style="width:137px" %)(((
Coleman Benson 95.1 90 [[image:lss-config-30s.jpg]] [[image:lss-config-60s.jpg]]
91
92 [[image:lss-config-300s.jpg]] [[image:lss-config-infs.jpg]]
Coleman Benson 97.1 93 )))|(% style="width:777px" %)Time Window (30s / 60s / 300s / Total)
Coleman Benson 95.1 94
Eric Nantel 51.1 95 = Command Line =
RB1 3.1 96
RB1 10.2 97 [[image:lss-config-command-line.jpg||alt="LSS Config Command Line"]]
98
Coleman Benson 97.1 99 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 100
Coleman Benson 97.1 101 |(% style="width:114px" %)**>>**|(% style="width:1364px" %)Command sent to the servo
102 |(% style="width:114px" %)**<<**|(% style="width:1364px" %)Reply from the servo
103 |(% style="width:114px" %)**INF ::**|(% style="width:1364px" %)Information
104 |(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader
105 |(% style="width:114px" %)**]]**|(% style="width:1364px" %)Failure
RB1 20.1 106
Coleman Benson 97.1 107 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 108
Coleman Benson 97.1 109 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 110
RB1 3.4 111 {More to come}
Copyright RobotShop 2018