Last modified by Eric Nantel on 2024/07/12 11:23

From version < 100.1 >
edited by Coleman Benson
on 2019/05/02 15:04
To version < 65.2 >
edited by RB1
on 2019/03/20 15:45
< >
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -LSS - Configuration Software
1 +lss-configuration-software
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.CBenson
1 +xwiki:XWiki.RB1
Content
... ... @@ -12,44 +12,35 @@
12 12  
13 13  [[image:lss-config-header.png]]
14 14  
15 -The header includes (left to right):
16 16  
17 -* Firmware version currently installed on servo
18 -* Firmware update option
19 -* COM port selection
20 -* Connect (toggle ON / OFF)
16 +== Connection ==
21 21  
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.
18 +Connection to the servo is done automatically, via any properly installed USB to serial interface like the [[LSS Adapter board>>doc:Servo Erector Set (SES) Building System.SES - Electronics.SES - Modules.LSS - Adapter Board.WebHome]]. Ensure the board is recognized by the computer and if not, install the proper drivers. 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.
23 23  
24 24  == Firmware Update ==
25 25  
26 26  [[image:lss-config-firmware-update.png]]
27 27  
28 -The firmware update option is a popup which includes:
29 29  
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
25 +The LSS Config serves as the main software 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.
35 35  
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.
27 +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.
37 37  
38 -= Servo Control [coming soon] =
29 +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.
39 39  
40 -[[image:lss-config-control.jpg]]
31 +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.
41 41  
42 -The servo control section allows you to visually move the servo and change a variety of parameters, including:
33 += Servo Control [coming soon] =
43 43  
44 -* Position: blue caret
45 -* First Position: magenta caret
46 -* RPM: green arrow
35 +The servo control section allows you to visually move the servo and change a variety of parameter.
47 47  
48 -At the lower left, the servo model is shown, as well as the LED color.
37 +The large red STOP button will send a LIMP command to the servo.
49 49  
39 +{More to come}
40 +
50 50  == Configurations ==
51 51  
52 -[[image:lss-config-configurations.jpg]]
43 +[[image:lss-config-configurations.png]]
53 53  
54 54  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.
55 55  
... ... @@ -65,49 +65,20 @@
65 65  
66 66  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.
67 67  
68 -[[image:lss-config-graph.jpg]]
59 +{More to come}
69 69  
70 -x-Axis: seconds
71 -
72 -* Position: Blue
73 -* Speed: Green
74 -* Current: Red
75 -* Voltage: Yellow
76 -* Temperature: Grey
77 -
78 -|(% 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)
79 -|(% 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)
80 -|(% 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)
81 -|(% 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)
82 -|(% 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)
83 -|(% style="width:76px" %)[[image:lss-config-stop-icon.jpg]]|(% style="width:488px" %)Reset Graph|(% style="width:137px" %) |(% style="width:777px" %)
84 -|(% 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" %)(((
85 -Export popup appears providing three options:
86 -
87 -1) Export only recorded data ("YES")  2) Export all data (click "NO") 3) Cancel export
88 -)))
89 -|(% 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)
90 -|(% 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)
91 -|(% style="width:76px" %)[[image:lss-config-10s.jpg]]|(% style="width:488px" %)Time Window (10s)|(% style="width:137px" %)(((
92 -[[image:lss-config-30s.jpg]] [[image:lss-config-60s.jpg]]
93 -
94 -[[image:lss-config-300s.jpg]] [[image:lss-config-infs.jpg]]
95 -)))|(% style="width:777px" %)Time Window (30s / 60s / 300s / Total)
96 -
97 97  = Command Line =
98 98  
99 99  [[image:lss-config-command-line.jpg||alt="LSS Config Command Line"]]
100 100  
101 -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:
65 +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.
102 102  
103 -|(% style="width:114px" %)**>>**|(% style="width:1364px" %)Command sent to the servo
104 -|(% style="width:114px" %)**<<**|(% style="width:1364px" %)Reply from the servo
105 -|(% style="width:114px" %)**INF ::**|(% style="width:1364px" %)Information
106 -|(% style="width:114px" %)**[bootloader]**|(% style="width:1364px" %)Information specific to bootloader
107 -|(% style="width:114px" %)**]]**|(% style="width:1364px" %)Failure
67 +~>>: Command sent to the servo
108 108  
109 -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
69 +<<: Reply from the servo
110 110  
111 -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.
71 +The software 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
112 112  
73 +Left clicking a line highlights that line and allows it to be copied to the clipboard by pressing the right mouse button.
74 +
113 113  {More to come}
lss-config-10s.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 KB
Content
lss-config-300s.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 KB
Content
lss-config-30s.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.7 KB
Content
lss-config-60s.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.7 KB
Content
lss-config-control.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -69.8 KB
Content
lss-config-display-query-off.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -2.6 KB
Content
lss-config-display-query.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 KB
Content
lss-config-export-graph-icon.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 KB
Content
lss-config-graph.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -49.3 KB
Content
lss-config-infs.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.8 KB
Content
lss-config-marker-circle.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.7 KB
Content
lss-config-marker-diamond.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 KB
Content
lss-config-marker-square.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 KB
Content
lss-config-pause-icon-yellow.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.8 KB
Content
lss-config-pause-icon.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.4 KB
Content
lss-config-play-icon-green.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -2.2 KB
Content
lss-config-play-icon.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 KB
Content
lss-config-record-icon-red.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -2.0 KB
Content
lss-config-record-icon.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 KB
Content
lss-config-stop-icon.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.9 KB
Content
lss-config-temperature-celcius.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -2.1 KB
Content
lss-config-temperature-faren.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -2.0 KB
Content
lss-config-visibility-off.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.1 KB
Content
lss-config-visibility.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.CBenson
Size
... ... @@ -1,1 +1,0 @@
1 -1.8 KB
Content
XWiki.XWikiRights[0]
Allow/Deny
... ... @@ -1,0 +1,1 @@
1 +Allow
Groups
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.XWikiAdminGroup
Levels
... ... @@ -1,0 +1,1 @@
1 +view
XWiki.XWikiRights[1]
Allow/Deny
... ... @@ -1,0 +1,1 @@
1 +Allow
Groups
... ... @@ -1,0 +1,1 @@
1 +XWiki.Profiles (Lynxmotion).BETA Testers
Levels
... ... @@ -1,0 +1,1 @@
1 +view
XWiki.XWikiRights[2]
Allow/Deny
... ... @@ -1,0 +1,1 @@
1 +Allow
Groups
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiAdminGroup
Levels
... ... @@ -1,0 +1,1 @@
1 +view
Copyright RobotShop 2018