Wiki source code of LSS-PRO Configuration Software
Last modified by Eric Nantel on 2024/10/04 08:08
Hide last authors
 |
128.1 | 1 | |
| |
12.1 | 2 | |
| |
128.1 | 3 | {{lightbox image="https://wiki.lynxmotion.com/info/wiki/lynxmotion/download/ses-pro/lss-pro/lss-p-configuration-software/WebHome/LSS-P-Configuration-Software.png" width="350"/}} |
| 4 | |||
| |
122.1 | 5 | [[[[image:[email protected]]]>>attach:LSS_PRO_Config_Setup.zip]] |
| |
1.2 | 6 | |
| 7 | **Table of Contents** | ||
| 8 | |||
| 9 | {{toc/}} | ||
| 10 | |||
| 11 | = Description = | ||
| |
21.1 | 12 | |
 |
117.1 | 13 | The Lynxmotion Smart Servo PRO Configuration Software (“LSS PRO Config” for short) is intended to be a tool to quickly interact with the Lynxmotion Professional Smart Servos (LSS-P) loaded with proprietary Lynxmotion firmware. Features include sending action and configuration commands, queries (and receiving the reply), updating the firmware, monitoring sensor data and more. The software works on Windows 7 operating systems and above. The software is intended as a quick starting point to better understand the servo before developing custom applications using the human-readable communication protocol. |
| |
21.1 | 14 | |
| |
44.2 | 15 | Note: The software can be connected to multiple servos, but the interface can only control and communicate with one at any time (unless using the free format commands described below). Each servo must have a unique ID. The servo(s) must be powered correctly and connected to the computer via USB from the first servo in the BUS. |
| |
23.1 | 16 | |
| |
44.2 | 17 | = Features = |
| 18 | |||
| 19 | * Send action, configuration and query commands to an individual PRO servo | ||
| 20 | * Obtain visual feedback from various onboard sensors | ||
| 21 | * Create custom actions for testing purpose | ||
| 22 | * Update PRO servo’s firmware | ||
| 23 | * Auto-Update if connected to Internet | ||
| 24 | |||
| |
24.1 | 25 | = User Guide = |
| 26 | |||
| |
116.1 | 27 | This section provides step-by-step instructions and tips to help you get the most out of your LSS-P actuator. Whether you are setting up your hardware, configuring your servos, or troubleshooting, you'll find detailed information to assist you. Follow the guidelines below to ensure optimal performance and a smooth experience. |
| |
24.1 | 28 | |
| |
44.2 | 29 | == Information == |
| 30 | |||
| 31 | [[image:LSS-P-Config-Info.png]] | ||
| 32 | |||
| 33 | 1. The Information (capital I) button at the top right of the interface leads to this user guide. | ||
| 34 | |||
| |
26.1 | 35 | == Connection == |
| 36 | |||
| |
118.1 | 37 | In order for the LSS PRO Config software to detect the servos, the correct USB to serial drivers must be installed on the computer, and the servo must be powered. Windows will automatically detect and install the drivers. |
| |
44.2 | 38 | |
| 39 | |||
| |
32.1 | 40 | [[image:LSS-P-Config-Connection.png]] |
| |
26.1 | 41 | |
| |
44.2 | 42 | 1. Select the appropriate COM port |
| 43 | 1. Click on the "Connect" button (All servos in the communication BUS should be detected) | ||
| 44 | 1. Select a particular servo from the list | ||
| |
30.1 | 45 | |
| |
44.2 | 46 | Note: The interface will then display and control that single actuator. |
| |
30.1 | 47 | |
| |
67.1 | 48 | == Safety & Useful Buttons == |
| 49 | |||
| |
68.1 | 50 | This section includes the important emergency stop (removes power from the motors via software) and other useful commands. |
| |
67.1 | 51 | |
| |
68.1 | 52 | Note: Those commands are sent to the selected servo, if "254 - All servos" is selected then it will be sent to all of them. |
| 53 | |||
| |
67.1 | 54 | [[image:LSS-P-Config-Buttons.png]] |
| 55 | |||
| |
68.1 | 56 | 1. This button sends a RESET command. More information [[HERE>>doc:ses-pro.lss-pro.lss-p-communication-protocol.WebHome||anchor="HReset"]] |
| |
121.1 | 57 | 1. This resets the servo to factory default settings, removing all configurations, including the ID. More information [[HERE>>doc:ses-pro.lss-pro.lss-p-communication-protocol.WebHome||anchor="HDefault26confirm"]] |
| 58 | 1. This command stops the actuator at whatever angle it is (whether during a motion or already at an angle) and causes it to hold that position (motor is powered and holding). The following command is sent to all servos, not just the one connected via USB. | ||
| |
67.1 | 59 | \\Command sent: #254H<cr> |
| 60 | |||
| 61 | 1. ((( | ||
| |
121.1 | 62 | This command stops the actuator at whatever angle it is (whether during a motion or already at an angle) and causes it to hold that position (motor is powered and holding). The following command is sent to all servos, not just the one connected via USB. |
| |
67.1 | 63 | |
| 64 | Command sent: #254L<cr> | ||
| 65 | |||
| |
121.1 | 66 | Just like the emergency stop button on the 36V large power supply (provided with each PRO arm), the E-Stop is meant to be used in emergency only since power is cut to all motors, which may result in joints rotating because of high counter-torque or forces being applied. In the case of a robotic arm, __the arm may fall and damage itself__ or whatever is in its environment. |
| |
67.1 | 67 | ))) |
| 68 | |||
| |
26.1 | 69 | == Status == |
| 70 | |||
| |
123.1 | 71 | As a servo is intended to be moved to specific angles, the position of the servo, this section provides relevant angular and motion information to the user on what's happening with their actuator. |
| |
68.1 | 72 | |
| |
34.1 | 73 | [[image:LSS-P-Config-Status.png]] |
| |
26.1 | 74 | |
| |
123.1 | 75 | 1. The position section shows the current angle of the output shaft of the servo in relation to its configured angular origin (0 degrees, including any adjustments using the Origin Offset command). It also displays angles to 0.01 degrees of accuracy, as well as below 0 degrees and over 360 degrees. It’s important to note any angle beyond 0 to 360 is a calculated, or "virtual" position as the internal sensor can only read 0 to 360 degrees. The multi-turn angle is retained even after a power cycle. |
| |
68.1 | 76 | 1. Status of what the actuator is currently doing. More information HERE |
| |
123.1 | 77 | 1. Error encountered. More information HERE |
| |
34.1 | 78 | |
| |
123.1 | 79 | Note: Most errors will require that the cause of the problem to be solved before proceeding. The servo should either be Reset or set Limp. To view and resolve any errors, go to the troubleshooting section |
| |
44.2 | 80 | |
| |
49.2 | 81 | == Servo Control == |
| |
48.1 | 82 | |
| |
65.2 | 83 | In order to view the various commands available for each drop-down, a PRO servo needs to be properly connected to the computer, powered, turned on and detected. |
| |
48.1 | 84 | |
| |
97.1 | 85 | === Query === |
| |
26.1 | 86 | |
| |
38.1 | 87 | [[image:LSS-P-Config-Query.png]] |
| |
26.1 | 88 | |
| |
65.2 | 89 | 1. The drop down list below Query provides a list of most query commands possible. More information click HERE |
| |
38.1 | 90 | 1. Click the "Send" button to initiate the Query. |
| 91 | 1. The Query protocol command will be displayed here as well as the answer from the actuator. (ex: #1QID / *1QID1) | ||
| 92 | |||
| |
49.2 | 93 | === Action === |
| |
26.1 | 94 | |
| |
38.1 | 95 | [[image:LSS-P-Config-Action.png]] |
| |
26.1 | 96 | |
| |
65.2 | 97 | 1. The drop down list below Action provides a list of most action commands possible. More information click HERE. |
| |
38.1 | 98 | 1. Input the value of the Action required in the text input field. (ex: 9000 for a 90deg move) |
| 99 | 1. Click the "Send" button to initiate the Action. | ||
| 100 | 1. The Action protocol command will be displayed here and the actuator should be doing it. | ||
| 101 | |||
| |
49.2 | 102 | === Configuration === |
| |
26.1 | 103 | |
| |
38.1 | 104 | [[image:LSS-P-Config-Config.png]] |
| |
26.1 | 105 | |
| |
65.2 | 106 | 1. The drop down list below Configuration provides a list of most configuration commands possible. More information click HERE. |
| |
49.1 | 107 | 1. Input the value of the Configuration required in the text input field. (ex: 1 for an ID change to 1) |
| |
38.1 | 108 | 1. Click the "Send" button to initiate the Configuration. |
| 109 | 1. The Configuration protocol command will be displayed here. | ||
| 110 | |||
| |
48.1 | 111 | === Free format command === |
| 112 | |||
| |
65.2 | 113 | This command line interface allows the user to send commands, including those not otherwise found in the drop-down list, as well as any special commands provided by Lynxmotion staff. Once sent the commands will be displayed in the area bellow (like a terminal) and can be cleared if required. This can help with debugging or better understanding the communication protocol. |
| |
48.1 | 114 | |
| 115 | [[image:LSS-P-Config-Free-Cmd.png]] | ||
| 116 | |||
| |
26.1 | 117 | == Telemetry == |
| 118 | |||
| |
53.1 | 119 | A graph within the software is used to display output of any query commands, which can include sensor data or calculated data. |
| |
26.1 | 120 | |
| |
53.1 | 121 | [[image:LSS-P-Config-Telemetry.png]] |
| |
52.1 | 122 | |
| |
125.1 | 123 | 1. To activate a specific value, click on the button once, and click again if you'd like to disable it. The software starts recording and displaying the data as soon as one query is activated. |
| 124 | 1. Pressing Pause will stop recording until clicked again to resume. | ||
| 125 | 1. Pressing Restart will wipe all the recorded values and start fresh. | ||
| 126 | 1. The Y-axis of the graph auto-scales depending on what output is selected. To switch between traces, use the mouse wheel and confirm that the y axis label is the one you want. | ||
| 127 | 1. The X-axis displays the time & expands up to 20 minutes then scrolls a 20 minute time window. | ||
| 128 | 1. Saving the data is possible by right clicking on the graph and selecting Copy. It's then possible to paste the data in a spreadsheet application (Excel / Google Sheets). | ||
| |
52.1 | 129 | |
| |
125.1 | 130 | === Personalized Query === |
| |
52.1 | 131 | |
| |
125.1 | 132 | To change the query for a specific button, "CTRL + CLICK" on the desired button and the following popup interface will be displayed: |
| |
40.1 | 133 | |
| 134 | [[image:LSS-P-Config-Telemetry-Custom.png]] | ||
| 135 | |||
| 136 | 1. Trace Name: Displayed name for that particular query. | ||
| |
125.1 | 137 | 1. Two separate "Add" buttons with corresponding drop down menus are present which are shortcuts to add to the query in (3) |
| 138 | 1. The specific Query that will be sent to the actuator plus displayed units for the interface. | ||
| |
40.1 | 139 | |
| |
26.1 | 140 | == Custom Actions == |
| 141 | |||
| |
64.1 | 142 | This list of assignable buttons allows the user to select specific commands to send to the servo. These can be used to quickly position the servo to specific angles, experiment with different speeds and more. |
| |
26.1 | 143 | |
| |
64.1 | 144 | [[image:LSS-P-Config-Custom-Actions.png]] |
| 145 | |||
| 146 | 1. All of those buttons can be set to trigger any action required. | ||
| 147 | 1. Save will let you do a backup of the current Custom Actions. | ||
| 148 | 1. Load will let you select and load a previously saved Custom Action file. | ||
| 149 | |||
| |
126.1 | 150 | === Personalized Action === |
| |
65.1 | 151 | |
| |
126.1 | 152 | To change the Action for a specific button, "CTRL + CLICK" on the desired button, and this interface will then be displayed: |
| |
64.1 | 153 | |
| 154 | [[image:LSS-P-Config-Custom-Actions-Custom.png]] | ||
| 155 | |||
| 156 | 1. Action Name: Displayed name for that particular action. | ||
| |
126.1 | 157 | 1. Two separate "Add" button and corresponding drop down menus which are shortcuts to add to the action in (3) |
| |
64.1 | 158 | 1. Action command that will be sent to the actuator plus displayed units for the interface. |
| 159 | |||
| |
78.1 | 160 | == Firmware Update == |
| |
28.1 | 161 | |
| |
69.1 | 162 | It is good to periodically check for firmware updates for the servos. A firmware update requires that the computer running the software be connected to the Internet. |
| |
61.1 | 163 | |
| |
69.1 | 164 | Firmware updates can resolve bugs or add improvements. The information in this Wiki (for example the PRO Communication Protocol Page) will always refer to the latest version of firmware (though in certain instances will detail which firmware version of the firmware the feature or function started with). |
| |
61.1 | 165 | |
| 166 | [[image:LSS-P-Config-Firmware-Available.png]] | ||
| 167 | |||
| |
127.1 | 168 | When a firmware update is available, the __logo will turn green__, as shown in the image above.. |
| |
72.1 | 169 | |
| 170 | Note: Only a servo connected via USB can be updated and all the other servos on the bus will not be displayed with a green logo unless connected directly via USB. | ||
| 171 | |||
| |
78.1 | 172 | === Online Update === |
| |
72.1 | 173 | |
| |
127.1 | 174 | 1. Select the servo ID to see if a firmware update is available for that servo |
| |
72.1 | 175 | 1. If the logo is green, click on the "Firmware Update" button |
| 176 | 1. A message will ask you if you want do download the latest firmware, click Yes. | ||
| |
82.1 | 177 | [[image:LSS-P-Config-Firmware-Download-Yes.png||alt="LSS-P-Config-Firmware-Download.png"]] |
| |
127.1 | 178 | 1. The time to download the update should be fast, and once downloaded another message will ask you if you want to proceed; click Yes. |
| |
92.1 | 179 | [[image:LSS-P-Config-Firmware-Write-Acknowledge.png]] |
| |
127.1 | 180 | 1. The servo will be put in "Firmware Update" mode and the LED on the servo will start flashing. A progress bar will show the progress. DO NOT UNPLUG or REMOVE POWER from the servo while updating. |
| |
74.1 | 181 | [[image:LSS-P-Config-Firmware-Uploading.png]] |
| |
77.1 | 182 | 1. Once the procedure is done you will have a confirmation pop-up. |
| 183 | [[image:LSS-P-Config-Firmware-Success.png]] | ||
| |
61.1 | 184 | |
| |
78.1 | 185 | === Offline Update === |
| |
72.1 | 186 | |
| |
127.1 | 187 | In rare occasions, our staff could ask you to upload a firmware which they provided. A link to this procedure will also be provided. |
| |
77.1 | 188 | |
| |
90.1 | 189 | 1. Select the servo ID that requires a firmware update |
| |
85.1 | 190 | 1. Click on the "Firmware Update" button and depending on the pop-up select as shown. |
| |
90.1 | 191 | [[image:LSS-P-Config-Firmware-Download-No.png||alt="LSS-P-Config-Firmware-Download.png"]] [[image:LSS-P-Config-Firmware-Write-Yes.png||alt="LSS-P-Config-Firmware-Local.png"]] |
| |
127.1 | 192 | 1. Browse to and select & open the firmware file provided by our staff (saved locally on your computer). |
| |
87.1 | 193 | [[image:LSS-P-Config-Firmware-Local-Browse.png]] |
| |
127.1 | 194 | 1. Another message will ask you if you want to proceed; click Yes. |
| |
92.1 | 195 | [[image:LSS-P-Config-Firmware-Write-Acknowledge.png]] |
| |
127.1 | 196 | 1. The servo will be put in "Firmware Update" mode and the LED on the servo will start flashing. A progress bar will show the progress. DO NOT UNPLUG or REMOVE POWER from the servo while updating. |
| |
77.1 | 197 | [[image:LSS-P-Config-Firmware-Uploading.png]] |
| 198 | 1. Once the procedure is done you will have a confirmation pop-up. | ||
| |
61.1 | 199 | [[image:LSS-P-Config-Firmware-Success.png]] |
| |
107.2 | 200 | |
| 201 | == Troubleshooting == | ||
| 202 | |||
| |
108.1 | 203 | === Connection Error === |
| |
107.2 | 204 | |
| |
108.1 | 205 | **LSS PRO device not found at this port!** |
| |
107.2 | 206 | |
| |
108.1 | 207 | If the software does not detect any servos, this can be for multiple reasons: |
| 208 | |||
| 209 | * Forgot to connect the USB port to ONLY the first servo of the assembly | ||
| 210 | * Servo not connected to the power supply, or power supply not turned on. | ||
| 211 | * Wrong COM port selected in the software | ||
| 212 | * USB drivers have not been properly installed | ||
| 213 | * Advanced users may have written their own firmware (Arduino format) and uploaded it to the microcontroller within the servo. The PRO Config software cannot be used in this instance. | ||
| 214 | |||
| 215 | To resolve this issue: | ||
| 216 | |||
| 217 | * Ensure the power is ON. | ||
| 218 | ** If you have the 30V power supply, ensure the switch is set to ON | ||
| 219 | ** If you have the 36V power supply, also ensure the switch is set to ON & E-Stop button is not pressed | ||
| 220 | * Verify the Device Manager in Windows to see if the COM port is present | ||
| 221 | |||
| 222 | === Software Issues === | ||
| 223 | |||
| 224 | **Firmware update stalled / frozen** | ||
| 225 | |||
| 226 | If the LSS Config screen freezes during a firmware update or the process takes many minutes without an update. | ||
| 227 | |||
| 228 | To resolve this issue: | ||
| 229 | |||
| 230 | * Power cycle the servo, keeping it connected via USB to the computer. | ||
| 231 | * Restart the LSS PRO Config application | ||
| 232 | * The update should resume. | ||
| 233 | |||
| 234 | If the firmware was being updated using a local file (rare), then the Firmware Update button needs to be pressed again for the update process to restart. | ||
| 235 | |||
| 236 | **Interface freezes** | ||
| 237 | |||
| 238 | If the interface freezes for any reason outside of a Firmware update, end the Windows Task corresponding to the LSS Config via Windows’ Task Manager (accessible via shortcut by simultaneously pressing CTRL + SHIFT + ESC on the keyboard). | ||
| 239 | |||
| 240 | **Wrong Servo Detected** | ||
| 241 | |||
| 242 | If the display is showing the wrong servo detected (for example if you have a STANDARD servo connected, but it’s appearing as a MEGA), which should not happen, please reach out to RobotShop with details and instructions will be provided on how to correct this. | ||
| 243 | |||
| 244 | **Appearance** | ||
| 245 | |||
| 246 | If the appearance or aesthetics seem “off”, this may be due to the "Scale" factor in Windows 11, set it to 100%. | ||
| 247 |