Wiki source code of LSS - Configuration Software
Hide last authors
 |
133.1 | 1 | {{lightbox image="lss-config-full-window-0001.png" width="520"/}} |
 |
46.1 | 2 | |
| |
107.1 | 3 | **Table of Contents** |
| |
47.1 | 4 | |
| |
44.1 | 5 | {{toc/}} |
| 6 | |||
| |
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. |
| |
1.1 | 8 | |
| |
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]]. |
| |
3.2 | 10 | |
| |
51.1 | 11 | = Header = |
| |
3.1 | 12 | |
| |
28.1 | 13 | [[image:lss-config-header.png]] |
| |
13.1 | 14 | |
 |
96.1 | 15 | The header includes (left to right): |
| |
28.1 | 16 | |
| |
96.1 | 17 | * Firmware version currently installed on servo |
| 18 | * Firmware update option | ||
| 19 | * COM port selection | ||
| 20 | * Connect (toggle ON / OFF) | ||
| |
13.1 | 21 | |
| |
117.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. 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. |
| |
3.1 | 23 | |
| |
51.1 | 24 | == Firmware Update == |
| |
3.1 | 25 | |
| |
134.1 | 26 | {{lightbox image="lss-config-firmware-update.png" width="417"/}} |
| |
3.1 | 27 | |
| |
96.1 | 28 | The firmware update option is a popup which includes: |
| |
28.1 | 29 | |
| |
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 | ||
| |
17.1 | 35 | |
| |
125.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. |
| |
17.1 | 37 | |
| |
127.1 | 38 | 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. |
| |
126.1 | 39 | [[image:lss-config-firmware-update-restore-settings.png]] |
| |
125.1 | 40 | |
| 41 | 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. | ||
| 42 | |||
| |
101.1 | 43 | = Servo Control = |
| |
3.2 | 44 | |
| |
131.1 | 45 | {{lightbox image="lss-config-control-0003-both.png" width="485"/}} |
| |
3.1 | 46 | |
| |
100.1 | 47 | The servo control section allows you to visually move the servo and change a variety of parameters, including: |
| 48 | |||
| |
132.1 | 49 | * Position: pale blue caret |
| 50 | * Origin offset: magenta caret | ||
| 51 | * Angular range: magenta square carets | ||
| 52 | * RPM: green arrow / indicator | ||
| 53 | * Initial position: dark blue caret | ||
| |
4.1 | 54 | |
| |
135.1 | 55 | At the lower left the servo model and the LED color are shown. |
| |
3.1 | 56 | |
| |
51.1 | 57 | == Configurations == |
| |
5.1 | 58 | |
| |
108.1 | 59 | {{lightbox image="lss-config-configurations.jpg" width="350"/}} |
| |
9.1 | 60 | |
| |
135.1 | 61 | 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. |
| |
5.1 | 62 | |
| |
15.1 | 63 | 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. |
| |
5.1 | 64 | |
| |
15.1 | 65 | **UPDATE** Pressing this button will write all values to EEPROM, changing the configurations, and reverting all background colors to white. |
| |
5.1 | 66 | |
| |
15.1 | 67 | **UNDO ALL** is a shortcut button which reverts all changes made which have not been written to EEPROM. |
| |
14.1 | 68 | |
| |
15.1 | 69 | **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). |
| |
14.1 | 70 | |
| |
101.1 | 71 | = Telemetry Graph = |
| |
3.1 | 72 | |
| |
3.4 | 73 | 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. |
| |
3.3 | 74 | |
| |
139.1 | 75 | {{lightbox image="lss-config-telemetry-graph.png" width="521"/}} |
| |
3.1 | 76 | |
| |
95.1 | 77 | x-Axis: seconds |
| 78 | |||
| |
140.1 | 79 | * Position: blue |
| 80 | * Speed: green | ||
| 81 | * Current: red | ||
| 82 | * Voltage: yellow | ||
| 83 | * Temperature: gray | ||
| |
95.1 | 84 | |
| |
97.1 | 85 | |(% 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) |
| |
142.1 | 86 | |(% 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) |
| |
97.1 | 87 | |(% 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) |
| 88 | |(% 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) | ||
| 89 | |(% 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) | ||
| 90 | |(% style="width:76px" %)[[image:lss-config-stop-icon.jpg]]|(% style="width:488px" %)Reset Graph|(% style="width:137px" %) |(% style="width:777px" %) | ||
| 91 | |(% 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" %)((( | ||
| 92 | Export popup appears providing three options: | ||
| 93 | |||
| 94 | 1) Export only recorded data ("YES") 2) Export all data (click "NO") 3) Cancel export | ||
| 95 | ))) | ||
| 96 | |(% 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) | ||
| 97 | |(% 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) | ||
| 98 | |(% style="width:76px" %)[[image:lss-config-10s.jpg]]|(% style="width:488px" %)Time Window (10s)|(% style="width:137px" %)((( | ||
| |
95.1 | 99 | [[image:lss-config-30s.jpg]] [[image:lss-config-60s.jpg]] |
| 100 | |||
| 101 | [[image:lss-config-300s.jpg]] [[image:lss-config-infs.jpg]] | ||
| |
97.1 | 102 | )))|(% style="width:777px" %)Time Window (30s / 60s / 300s / Total) |
| |
95.1 | 103 | |
| |
108.1 | 104 | = Command Line{{lightbox image="lss-config-command-line.jpg" width="700"/}} = |
| |
3.1 | 105 | |
| |
97.1 | 106 | 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: |
| |
3.1 | 107 | |
| |
97.1 | 108 | |(% style="width:114px" %)**>>**|(% style="width:1364px" %)Command sent to the servo |
| 109 | |(% style="width:114px" %)**<<**|(% style="width:1364px" %)Reply from the servo | ||
| 110 | |(% style="width:114px" %)**INF ::**|(% style="width:1364px" %)Information | ||
| 111 | |(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader | ||
| 112 | |(% style="width:114px" %)**]]**|(% style="width:1364px" %)Failure | ||
| |
20.1 | 113 | |
| |
97.1 | 114 | 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 |
| |
20.1 | 115 | |
| |
97.1 | 116 | 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. |
| |
20.1 | 117 | |
| |
3.4 | 118 | {More to come} |