Wiki source code of LSS - Communication Protocol
Version 78.1 by Eric Nantel on 2019/01/18 13:22
Show last authors
| 1 | = Table of Contents = |
| 2 | |
| 3 | {{toc depth="3"/}} |
| 4 | |
| 5 | = Protocol Concepts = |
| 6 | |
| 7 | The Lynxmotion Smart Servo (LSS) protocol was created in order to be as simple and straightforward as possible from a user perspective, while at the same time trying to stay compact and robust yet highly versatile. Almost everything one might expect to be able to configure for a smart servo motor is available. |
| 8 | |
| 9 | == Session == |
| 10 | |
| 11 | A "session" is defined as the time between when the servo is powered ON to when it is powered OFF or reset. |
| 12 | |
| 13 | == Action Commands == |
| 14 | |
| 15 | Action commands are sent serially to the servo's Rx pin and must be set in the following format: |
| 16 | |
| 17 | 1. Start with a number sign # (U+0023) |
| 18 | 1. Servo ID number as an integer |
| 19 | 1. Action command (one to three letters, no spaces, capital or lower case) |
| 20 | 1. Action value in the correct units with no decimal |
| 21 | 1. End with a control / carriage return '<cr>' |
| 22 | |
| 23 | ((( |
| 24 | Ex: #5PD1443<cr> |
| 25 | |
| 26 | Move servo with ID #5 to a position of 144.3 degrees. |
| 27 | |
| 28 | Action commands cannot be combined with query commands, and only one action command can be sent at a time. |
| 29 | |
| 30 | Action commands are session-specific, therefore once a servo is power cycled, it will not have any "memory" of previous actions or virtual positions (as described at the bottom of this page). |
| 31 | |
| 32 | == Action Modifiers == |
| 33 | |
| 34 | Two commands can be used as action modifiers only: Timed Move and Speed. The format is: |
| 35 | |
| 36 | 1. Start with a number sign # (U+0023) |
| 37 | 1. Servo ID number as an integer |
| 38 | 1. Action command (one to three letters, no spaces, capital or lower case) |
| 39 | 1. Action value in the correct units with no decimal |
| 40 | 1. Modifier command (one letter) |
| 41 | 1. Modifier value in the correct units with no decimal |
| 42 | 1. End with a control / carriage return '<cr>' |
| 43 | |
| 44 | Ex: #5P1456T1263<cr> |
| 45 | |
| 46 | Results in the servo rotating from the current angular position to a pulse position of 1456 in 1263 milliseconds. |
| 47 | |
| 48 | Action modifiers can only be used with certain commands. |
| 49 | ))) |
| 50 | |
| 51 | == Configuration Commands == |
| 52 | |
| 53 | Configuration commands affect the servo's current session* but unlike action commands, configuration commands are written to EEPROM and are retained even if the servo loses power (therefore NOT session specific). Not all action commands have a corresponding configuration and vice versa. Certain configurations are retained for when the servo is used in RC model. More information can be found on the [[LSS - RC PWM page>>doc:Lynxmotion Smart Servo (LSS).LSS - RC PWM.WebHome]]. |
| 54 | |
| 55 | 1. Start with a number sign # (U+0023) |
| 56 | 1. Servo ID number as an integer |
| 57 | 1. Configuration command (two to three letters, no spaces, capital or lower case) |
| 58 | 1. Configuration value in the correct units with no decimal |
| 59 | 1. End with a control / carriage return '<cr>' |
| 60 | |
| 61 | Ex: #5CO-50<cr> |
| 62 | |
| 63 | Assigns an absolute origin offset of -5.0 degrees (with respect to factory origin) to servo #5 and changes the offset for that session to -5.0 degrees. |
| 64 | |
| 65 | Configuration commands are not cumulative, in that if two configurations are sent at any time, only the last configuration is used and stored. |
| 66 | |
| 67 | *Important Note: the one exception is the baud rate - the servo's current session retains the given baud rate. The new baud rate will only be in place when the servo is power cycled. |
| 68 | |
| 69 | == Query Commands == |
| 70 | |
| 71 | Query commands are sent serially to the servo's Rx pin and must be set in the following format: |
| 72 | |
| 73 | 1. Start with a number sign # (U+0023) |
| 74 | 1. Servo ID number as an integer |
| 75 | 1. Query command (one to three letters, no spaces, capital or lower case) |
| 76 | 1. End with a control / carriage return '<cr>' |
| 77 | |
| 78 | ((( |
| 79 | Ex: #5QD<cr>Query position in degrees for servo #5 |
| 80 | ))) |
| 81 | |
| 82 | ((( |
| 83 | The query will return a value via the Tx pin with the following format: |
| 84 | |
| 85 | 1. Start with an asterisk (U+002A) |
| 86 | 1. Servo ID number as an integer |
| 87 | 1. Query command (one to three letters, no spaces, capital letters) |
| 88 | 1. The reported value in the units described, no decimals. |
| 89 | 1. End with a control / carriage return '<cr>' |
| 90 | |
| 91 | ((( |
| 92 | Ex: *5QD1443<cr> |
| 93 | ))) |
| 94 | |
| 95 | Indicates that servo #5 is currently at 144.3 degrees. |
| 96 | |
| 97 | **Session vs Configuration Query** |
| 98 | |
| 99 | By default, the query command returns the sessions' value; should no action commands have been sent to change, it will return the value saved in EEPROM from the last configuration command. |
| 100 | |
| 101 | In order to query the value in EEPROM, add a '1' to the query command. |
| 102 | |
| 103 | Ex: #5CSR20<cr> sets the maximum speed for servo #5 to 20rpm upon RESET (explained below). |
| 104 | |
| 105 | After RESET: #5SR4<cr> sets the session's speed to 4rpm. |
| 106 | |
| 107 | #5QSR<cr> would return *5QSR4<cr> which represents the value for that session. |
| 108 | |
| 109 | #5QSR1<cr> would return *5QSR20<cr> which represents the value in EEPROM |
| 110 | |
| 111 | == Virtual Angular Position == |
| 112 | |
| 113 | {In progress} |
| 114 | |
| 115 | A "virtual position" is one which allows for multiple rotations of the output horn, moving the center position and more. The "absolute position" would be the angle of the output shaft with respect to 360.0 degrees. |
| 116 | |
| 117 | [[image:LSS-servo-positions.jpg]] |
| 118 | |
| 119 | Example: Gyre direction / rotation is positive (clockwise), and origin offset has not been modified. Each square represents 30 degrees. |
| 120 | |
| 121 | #1D-300<cr> The servo is sent a command to move to -30.0 degrees (green arrow) |
| 122 | |
| 123 | #1D2100<cr> This second position command is sent to the servo, which moves it to 210.0 degrees (orange arrow) |
| 124 | |
| 125 | #1D-4200<cr> This next command rotates the servo counterclockwise to a position of -420 degrees (red arrow), which means one full rotation of 360 degrees, stopping at an absolute position of 60.0 degrees (420.0-360.0), with a virtual position of -420.0 degrees. |
| 126 | |
| 127 | Although the final physical position would be the same as if the servo were commanded to move to -60.0 degrees, the servo is in fact at -420.0 degrees. |
| 128 | |
| 129 | #1D4800<cr> This new command is sent which would then cause the servo to rotate from -420.0 degrees to 480.0 degrees (blue arrow), which would be a total of 900 degrees of clockwise rotation, or 2.5 complete rotations. |
| 130 | |
| 131 | #1D3300<cr> would cause the servo to rotate from 480.0 degrees to 330.0 degrees (yellow arrow). |
| 132 | |
| 133 | If / once the servo loses power or is power cycled, it also loses the virtual position associated with that session. For example, if the virtual position was 480.0 degrees before power is cycled, upon power up the servo's position will be read as +120.0 degrees from zero (assuming center position has not been modified). |
| 134 | ))) |
| 135 | |
| 136 | = Command List = |
| 137 | |
| 138 | |= #|=Description|= Action|= Query|= Config|= RC|= Serial|= Units|= Notes |
| 139 | | 1|[[**L**imp>>||anchor="H1.Limp28L29"]]| L| | | | ✓|none| |
| 140 | | 2|[[**H**alt & Hold>>||anchor="H2.Halt26Hold28H29"]]| H| | | | ✓|none| |
| 141 | | 3|[[**T**imed move>>||anchor="H3.Timedmove28T29"]]| T| | | | ✓|milliseconds| Modifier only (P, D, MD) |
| 142 | | 4|[[**S**peed>>||anchor="H4.Speed28S29"]]| S| | | | ✓|microseconds / second| Modifier only (P) |
| 143 | | 5|[[**M**ove in **D**egrees (relative)>>||anchor="H5.28Relative29MoveinDegrees28MD29"]]| MD| | | | ✓|tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| |
| 144 | | 6|[[**O**rigin Offset>>||anchor="H6.OriginOffsetAction28O29"]]| O| QO| CO| ✓| ✓|tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| |
| 145 | | 7|[[**A**ngular **R**ange>>||anchor="H7.AngularRange28AR29"]]| AR| QAR| CAR| ✓| ✓|tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| |
| 146 | | 8|[[Position in **P**ulse>>||anchor="H8.PositioninPulse28P29"]]| P| QP| | | ✓|microseconds|((( |
| 147 | See details below |
| 148 | ))) |
| 149 | | 9|[[Position in **D**egrees>>||anchor="H9.PositioninDegrees28D29"]]| D| QD| | | ✓|tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| |
| 150 | | 10|[[**W**heel mode in **D**egrees>>||anchor="H10.WheelModeinDegrees28WD29"]]| WD| QWD| | | ✓|tenths of degrees per second (ex 248 = 24.8 degrees per second)|A.K.A. "Speed mode" or "Continuous rotation" |
| 151 | | 11|[[**W**heel mode in **R**PM>>||anchor="H11.WheelModeinRPM28WR29"]]| WR| QWR| | | ✓| rpm|A.K.A. "Speed mode" or "Continuous rotation" |
| 152 | | 12|[[Max **S**peed in **D**egrees>>||anchor="H12.SpeedinDegrees28SD29"]]| SD| QSD| CSD| ✓| ✓|tenths of degrees per second (ex 248 = 24.8 degrees per second)|QSD: Add modifier "2" for instantaneous speed |
| 153 | | 13|[[Max **S**peed in **R**PM>>||anchor="H13.SpeedinRPM28SR29"]]| SR| QSR| CSR| ✓| ✓|rpm|QSR: Add modifier "2" for instantaneous speed |
| 154 | | 14|[[**A**ngular **S**tiffness>>||anchor="H14.AngularStiffness28AS29"]]| AS| QAS| CAS| ✓| ✓|none|-4 to +4, but suggested values are between 0 to +4 |
| 155 | | 15|[[**A**ngular **H**olding Stiffness>>||anchor="H15.AngularHoldStiffness28AH29"]]|AH|QAH|CAH| | ✓|none|-10 to +10, with default as 0. |
| 156 | |15b|[[**A**ngular **A**cceleration>>||anchor="H15b:AngularAcceleration28AA29"]]|AA|QAA|CAA| | ✓|degrees per second squared|Increments of 10 degrees per second squared |
| 157 | |15c|[[**A**ngular **D**eceleration>>||anchor="H15c:AngularDeceleration28AD29"]]|AD|QAD|CAD| | ✓|degrees per second squared|Increments of 10 degrees per second squared |
| 158 | |15d|[[**E**nable **M**otion control>>||anchor="H15d:MotionControl28MC29"]]|EM|QEM| | | ✓|none|EM0 to disable motion control, EM1 to enable. Session specific / does not survive power cycles |
| 159 | | 16|[[**LED** Color>>||anchor="H16.RGBLED28LED29"]]| LED| QLED| CLED| ✓| ✓|none (integer from 1 to 8)|0=OFF 1=RED 2=GREEN 3= BLUE 4=YELLOW 5=CYAN 6=MAGENTA, 7=WHITE |
| 160 | | 17|[[**ID** #>>||anchor="H17.IdentificationNumber"]]| | QID| CID| | ✓|none (integer from 0 to 250)|Note: ID 254 is a "broadcast" which all servos respond to |
| 161 | | 18|[[**B**aud rate>>||anchor="H18.BaudRate"]]| B| QB| CB| | ✓|none (integer)| |
| 162 | | 19|[[**G**yre direction (**G**)>>||anchor="H19.GyreRotationDirection"]]| G| QG| CG| ✓| ✓|none | Gyre / rotation direction where 1= CW (clockwise) -1 = CCW (counter-clockwise) |
| 163 | | 20|[[**F**irst Position (**P**ulse)>>||anchor="H20.First2InitialPosition28pulse29"]]| | QFP|CFP | ✓| ✓|none | |
| 164 | | 21|[[**F**irst Position (**D**egrees)>>||anchor="H21.First2InitialPosition28Degrees29"]]| | QFD|CFD| ✓| ✓|none | |
| 165 | | 22|[[**T**arget (**D**egree) **P**osition>>||anchor="H22.QueryTargetPositioninDegrees28QDT29"]]| | QDT| | | ✓|tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| |
| 166 | | 23|[[**M**odel **S**tring>>||anchor="H23.QueryModelString28QMS29"]]| | QMS| | | |none (string)| Recommended to determine the model| |
| 167 | | 23b|[[**M**odel>>||anchor="H23b.QueryModel28QM29"]]| | QM| | | |none (integer)| Returns a raw value representing the three model inputs (36 bit)| |
| 168 | | 24|[[Serial **N**umber>>||anchor="H24.QuerySerialNumber28QN29"]]| | QN| | | |none (integer)| |
| 169 | | 25|[[**F**irmware version>>||anchor="H25.QueryFirmware28QF29"]]| | QF| | | |none (integer)| |
| 170 | | 26|[[**Q**uery (general status)>>||anchor="H26.QueryStatus28Q29"]]| | Q| | | ✓|none (integer from 1 to 8)| See command description for details |
| 171 | | 27|[[**V**oltage>>||anchor="H27.QueryVoltage28QV29"]]| | QV| | | ✓|millivolts (ex 5936 = 5936mV = 5.936V)| |
| 172 | | 28|[[**T**emperature>>||anchor="H28.QueryTemperature28QT29"]]| | QT| | | ✓|tenths of degrees Celsius|Max temp before error: 85°C (servo goes limp) |
| 173 | | 29|[[**C**urrent>>||anchor="H29.QueryCurrent28QC29"]]| | QC| | | ✓|milliamps (ex 200 = 0.2A)| |
| 174 | | 30|[[**RC** Mode>>||anchor="H30.RCMode28CRC29"]]| | |CRC| |✓|none|((( |
| 175 | CRC: Add modifier "1" for RC-position mode. |
| 176 | CRC: Add modifier "2" for RC-wheel mode. |
| 177 | Any other value for the modifier results in staying in smart mode. |
| 178 | Puts the servo into RC mode. To revert to smart mode, use the button menu. |
| 179 | ))) |
| 180 | |31|[[**RESET**>>||anchor="H31.RESET"]]| | | | | ✓|none|Soft reset. See command for details. |
| 181 | |32|[[**DEFAULT**>>||anchor="H32.DEFAULTA026CONFIRM"]]| | | | |✓|none|Revert to firmware default values. See command for details |
| 182 | |33|[[**UPDATE**>>||anchor="H33.UPDATEA026CONFIRM"]]| | | | |✓|none|Update firmware. See command for details. |
| 183 | |
| 184 | == Details == |
| 185 | |
| 186 | ====== __1. Limp (**L**)__ ====== |
| 187 | |
| 188 | Example: #5L<cr> |
| 189 | |
| 190 | This action causes the servo to go "limp". The microcontroller will still be powered, but the motor will not. As an emergency safety feature, should the robot not be doing what it is supposed to or risks damage, use the broadcast ID to set all servos limp #254L<cr>. |
| 191 | |
| 192 | ====== __2. Halt & Hold (**H**)__ ====== |
| 193 | |
| 194 | Example: #5H<cr> |
| 195 | |
| 196 | This action overrides whatever the servo might be doing at the time the command is received (accelerating, moving continuously etc.) and causes it to stop immediately and hold that position. |
| 197 | |
| 198 | ====== __3. Timed move (**T**)__ ====== |
| 199 | |
| 200 | Example: #5P1500T2500<cr> |
| 201 | |
| 202 | Timed move can be used only as a modifier for a position (P) action. The units are in milliseconds, so a timed move of 2500 milliseconds would cause the servo to rotate from its current position to the desired position in 2.5 seconds. This command is in place to ensure backwards compatibility with the SSC-32 / 32U protocol. |
| 203 | |
| 204 | Note: If the calculated speed at which a servo must rotate for a timed move is greater than its maximum speed (which depends on voltage and load), then it will move at its maximum speed, and the time of the move may be longer than requested. |
| 205 | |
| 206 | ====== __4. Speed (**S**)__ ====== |
| 207 | |
| 208 | Example: #5P1500S750<cr> |
| 209 | |
| 210 | This command is a modifier only for a position (P) action and determines the speed of the move in microseconds per second. A speed of 750 microseconds would cause the servo to rotate from its current position to the desired position at a speed of 750 microseconds per second. This command is in place to ensure backwards compatibility with the SSC-32 / 32U protocol. |
| 211 | |
| 212 | ====== __5. (Relative) Move in Degrees (**MD**)__ ====== |
| 213 | |
| 214 | Example: #5MD123<cr> |
| 215 | |
| 216 | The relative move command causes the servo to read its current position and move the specified number of tenths of degrees in the corresponding position. For example if the servo is set to rotate CW (default) and an MD command of 123 is sent to the servo, it will cause the servo to rotate clockwise by 12.3 degrees. Negative commands would cause the servo to rotate in the opposite configured direction. |
| 217 | |
| 218 | ====== __6. Origin Offset Action (**O**)__ ====== |
| 219 | |
| 220 | Example: #5O2400<cr> |
| 221 | |
| 222 | This command allows you to temporarily change the origin of the servo in relation to the factory zero position. The setting will be lost upon servo reset / power cycle. Origin offset commands are not cumulative and always relate to factory zero. Note that for a given session, the O command overrides the CO command. In the first image, the origin at factory offset '0' (centered). |
| 223 | |
| 224 | [[image:LSS-servo-default.jpg]] |
| 225 | |
| 226 | In the second image, the origina, as well as the angular range (explained below) have been shifted by 240.0 degrees: |
| 227 | |
| 228 | [[image:LSS-servo-origin.jpg]] |
| 229 | |
| 230 | Origin Offset Query (**QO**) |
| 231 | |
| 232 | Example: #5QO<cr> Returns: *5QO-13 |
| 233 | |
| 234 | This allows you to query the angle (in tenths of degrees) of the origin in relation to the factory zero position. |
| 235 | |
| 236 | Configure Origin Offset (**CO**) |
| 237 | |
| 238 | Example: #5CO-24<cr> |
| 239 | |
| 240 | This command allows you to change the origin of the servo in relation to the factory zero position in EEPROM. The setting will be saved upon servo reset / power cycle. Origin offset configuration commands are not cumulative and always relate to factory zero. The new origin is also used in RC mode. |
| 241 | |
| 242 | ====== __7. Angular Range (**AR**)__ ====== |
| 243 | |
| 244 | Example: #5AR1800<cr> |
| 245 | |
| 246 | This command allows you to temporarily change the total angular range of the servo in tenths of degrees. This applies to the Position in Pulse (P) command and RC mode. The default for (P) and RC mode is 1800 (180.0 degrees total, or ±90.0 degrees). In the first image, |
| 247 | |
| 248 | [[image:LSS-servo-default.jpg]] |
| 249 | |
| 250 | Here, the angular range has been restricted to 180.0 degrees, or -90.0 to +90.0. The center has remained unchanged. |
| 251 | |
| 252 | [[image:LSS-servo-ar.jpg]] |
| 253 | |
| 254 | The angular range action command (ex. #5AR1800<cr>) and origin offset action command (ex. #5O-1200<cr>) an be used to move both the center and limit the angular range: |
| 255 | |
| 256 | [[image:LSS-servo-ar-o-1.jpg]] |
| 257 | |
| 258 | Query Angular Range (**QAR**) |
| 259 | |
| 260 | Example: #5QAR<cr> might return *5AR2756 |
| 261 | |
| 262 | Configure Angular Range (**CAR**) |
| 263 | |
| 264 | This command allows you to change the total angular range of the servo in tenths of degrees in EEPROM. The setting will be saved upon servo reset / power cycle. |
| 265 | |
| 266 | ====== __8. Position in Pulse (**P**)__ ====== |
| 267 | |
| 268 | Example: #5P2334<cr> |
| 269 | |
| 270 | The position in PWM pulses was retained in order to be backward compatible with the SSC-32 / 32U protocol. This relates the desired angle with an RC standard PWM pulse and is further explained in the SSC-32 and SSC-32U manuals found on Lynxmotion.com. Without any modifications to configuration considered, and a ±90.0 degrees standard range where 1500 microseconds is centered, a pulse of 2334 would set the servo to 165.1 degrees. Valid values for P are [500, 2500]. Values outside this range are corrected to end points. |
| 271 | |
| 272 | Query Position in Pulse (**QP**) |
| 273 | |
| 274 | Example: #5QP<cr> might return *5QP2334 |
| 275 | |
| 276 | This command queries the current angular position in PWM "units". The user must take into consideration that the response includes any angular range and origin configurations in order to determine the actual angle. |
| 277 | Valid values for QP are {-500, [500, 2500], -2500}. Values outside the [500, 2500] range are given a negative corresponding end point value to indicate they are out of bounds (note that if the servo is physically located at one of the endpoints, it may return a negative number if it is a fraction of a degree beyond the position). |
| 278 | |
| 279 | ====== __9. Position in Degrees (**D**)__ ====== |
| 280 | |
| 281 | Example: #5PD1456<cr> |
| 282 | |
| 283 | This moves the servo to an angle of 145.6 degrees, where the center (0) position is centered. Negative values (ex. -176 representing -17.6 degrees) are used. A full circle would be from -1800 to 1800 degrees. A value of 2700 would be the same angle as -900, except the servo would move in a different direction. |
| 284 | |
| 285 | Larger values are permitted and allow for multi-turn functionality using the concept of virtual position. |
| 286 | |
| 287 | Query Position in Degrees (**QD**) |
| 288 | |
| 289 | Example: #5QD<cr> might return *5QD132<cr> |
| 290 | |
| 291 | This means the servo is located at 13.2 degrees. |
| 292 | |
| 293 | ====== __10. Wheel Mode in Degrees (**WD**)__ ====== |
| 294 | |
| 295 | Ex: #5WD900<cr> |
| 296 | |
| 297 | This command sets the servo to wheel mode where it will rotate in the desired direction at the selected speed. The example above would have the servo rotate at 90.0 degrees per second clockwise (assuming factory default configurations). |
| 298 | |
| 299 | Query Wheel Mode in Degrees (**QWD**) |
| 300 | |
| 301 | Ex: #5QWD<cr> might return *5QWD900<cr> |
| 302 | |
| 303 | The servo replies with the angular speed in tenths of degrees per second. A negative sign would indicate the opposite direction (for factory default a negative value would be counter clockwise). |
| 304 | |
| 305 | ====== __11. Wheel Mode in RPM (**WR**)__ ====== |
| 306 | |
| 307 | Ex: #5WR40<cr> |
| 308 | |
| 309 | This command sets the servo to wheel mode where it will rotate in the desired direction at the selected rpm. Wheel mode (a.k.a. "continuous rotation") has the servo operate like a geared DC motor. The servo's maximum rpm cannot be set higher than its physical limit at a given voltage. The example above would have the servo rotate at 40 rpm clockwise (assuming factory default configurations). |
| 310 | |
| 311 | Query Wheel Mode in RPM (**QWR**) |
| 312 | |
| 313 | Ex: #5QWR<cr> might return *5QWR40<cr> |
| 314 | |
| 315 | The servo replies with the angular speed in rpm. A negative sign would indicate the opposite direction (for factory default a negative value would be counter clockwise). |
| 316 | |
| 317 | ====== __12. Speed in Degrees (**SD**)__ ====== |
| 318 | |
| 319 | Ex: #5SD1800<cr> |
| 320 | |
| 321 | This command sets the servo's maximum speed for action commands in tenths of degrees per second for that session. In the example above, the servo's maximum speed for that session would be set to 180.0 degrees per second. Therefore maximum speed for actions can be set "on the fly". The servo's maximum speed cannot be set higher than its physical limit at a given voltage. SD overrides CSD (described below) for that session. Upon reset or power cycle, the servo reverts to the value associated with CSD as described below. Note that SD and SR (described below) are effectively the same, but allow the user to specify the speed in either unit. The last command (either SR or SD) is what the servo uses for that session. |
| 322 | |
| 323 | Query Speed in Degrees (**QSD**) |
| 324 | |
| 325 | Ex: #5QSD<cr> might return *5QSD1800<cr> |
| 326 | |
| 327 | By default QSD will return the current session value, which is set to the value of CSD as reset/power cycle and changed whenever a SD/SR command is processed. |
| 328 | If #5QSD1<cr> is sent, the configured maximum speed (CSD value) will be returned instead. You can also query the current speed using "2" and the current target travel speed using "3". See the table below for an example: |
| 329 | |
| 330 | |**Command sent**|**Returned value (1/10 °)** |
| 331 | |ex: #5QSD<cr>|Session value for maximum speed (set by latest SD/SR command) |
| 332 | |ex: #5QSD1<cr>|Configured maximum speed (set by CSD/CSR) |
| 333 | |ex: #5QSD2<cr>|Instantaneous speed (same as QWD) |
| 334 | |ex: #5QSD3<cr>|Target travel speed |
| 335 | |
| 336 | Configure Speed in Degrees (**CSD**) |
| 337 | |
| 338 | Ex: #5CSD1800<cr> |
| 339 | |
| 340 | Using the CSD command sets the servo's maximum speed which is saved in EEPROM. In the example above, the servo's maximum speed will be set to 180.0 degrees per second. When the servo is powered on (or after a reset), the CSD value is used. Note that CSD and CSR (described below) are effectively the same, but allow the user to specify the speed in either unit. The last command (either CSR or CSD) is what the servo uses for that session. |
| 341 | |
| 342 | ====== __13. Speed in RPM (**SR**)__ ====== |
| 343 | |
| 344 | Ex: #5SD45<cr> |
| 345 | |
| 346 | This command sets the servo's maximum speed for action commands in rpm for that session. In the example above, the servo's maximum speed for that session would be set to 45rpm. Therefore maximum speed for actions can be set "on the fly". The servo's maximum speed cannot be set higher than its physical limit at a given voltage. SD overrides CSD (described below) for that session. Upon reset or power cycle, the servo reverts to the value associated with CSD as described below. Note that SD (described above) and SR are effectively the same, but allow the user to specify the speed in either unit. The last command (either SR or SD) is what the servo uses for that session. |
| 347 | |
| 348 | Query Speed in Degrees (**QSR**) |
| 349 | |
| 350 | Ex: #5QSR<cr> might return *5QSR45<cr> |
| 351 | |
| 352 | By default QSR will return the current session value, which is set to the value of CSR as reset/power cycle and changed whenever a SD/SR command is processed. |
| 353 | If #5QSR1<cr> is sent, the configured maximum speed (CSR value) will be returned instead. You can also query the current speed using "2" and the current target travel speed using "3". See the table below for an example: |
| 354 | |
| 355 | |**Command sent**|**Returned value (1/10 °)** |
| 356 | |ex: #5QSR<cr>|Session value for maximum speed (set by latest SD/SR command) |
| 357 | |ex: #5QSR1<cr>|Configured maximum speed (set by CSD/CSR) |
| 358 | |ex: #5QSR2<cr>|Instantaneous speed (same as QWR) |
| 359 | |ex: #5QSR3<cr>|Target travel speed |
| 360 | |
| 361 | Configure Speed in RPM (**CSR**) |
| 362 | |
| 363 | Ex: #5CSR45<cr> |
| 364 | |
| 365 | Using the CSR command sets the servo's maximum speed which is saved in EEPROM. In the example above, the servo's maximum speed will be set to 45rpm. When the servo is powered on (or after a reset), the CSR value is used. Note that CSD and CSR are effectively the same, but allow the user to specify the speed in either unit. The last command (either CSR or CSD) is what the servo uses for that session. |
| 366 | |
| 367 | ====== __14. Angular Stiffness (**AS**)__ ====== |
| 368 | |
| 369 | The servo's rigidity / angular stiffness can be thought of as (though not identical to) a damped spring in which the value affects the stiffness and embodies how much, and how quickly the servo tried keep the requested position against changes. |
| 370 | |
| 371 | A positive value of "angular stiffness": |
| 372 | |
| 373 | * The more torque will be applied to try to keep the desired position against external input / changes |
| 374 | * The faster the motor will reach its intended travel speed and the motor will decelerate faster and nearer to its target position |
| 375 | |
| 376 | A negative value on the other hand: |
| 377 | |
| 378 | * Causes a slower acceleration to the travel speed, and a slower deceleration |
| 379 | * Allows the target position to deviate more from its position before additional torque is applied to bring it back |
| 380 | |
| 381 | The default value is zero and the effect becomes extreme by -4, +4. There are no units, only integers between -4 to 4. Greater values produce increasingly erratic behavior. |
| 382 | |
| 383 | Ex: #5AS-2<cr> |
| 384 | |
| 385 | This reduces the angular stiffness to -2 for that session, allowing the servo to deviate more around the desired position. This can be beneficial in many situations such as impacts (legged robots) where more of a "spring" effect is desired. Upon reset, the servo will use the value stored in memory, based on the last configuration command. |
| 386 | |
| 387 | Ex: #5QAS<cr> |
| 388 | |
| 389 | Queries the value being used. |
| 390 | |
| 391 | Ex: #5CAS<cr> |
| 392 | |
| 393 | Writes the desired angular stiffness value to memory. |
| 394 | |
| 395 | ====== __15. Angular Hold Stiffness (**AH**)__ ====== |
| 396 | |
| 397 | The angular holding stiffness determines the servo's ability to hold a desired position under load. Values can be from -10 to 10, with the default being 0. Note that negative values mean the final position can be easily deflected. |
| 398 | |
| 399 | Ex: #5AH3<cr> |
| 400 | |
| 401 | This sets the holding stiffness for servo #5 to 3 for that session. |
| 402 | |
| 403 | Query Angular Hold Stiffness (**QAH**) |
| 404 | |
| 405 | Ex: #5QAH<cr> might return *5QAH3<cr> |
| 406 | |
| 407 | This returns the servo's angular holding stiffness value. |
| 408 | |
| 409 | Configure Angular Hold Stiffness (**CAH**) |
| 410 | |
| 411 | Ex: #5CAH2<cr> |
| 412 | |
| 413 | This writes the angular holding stiffness of servo #5 to 2 to EEPROM |
| 414 | |
| 415 | ====== __15b: Angular Acceleration (**AA**)__ ====== |
| 416 | |
| 417 | {More details to come} |
| 418 | |
| 419 | ====== __15c: Angular Deceleration (**AD**)__ ====== |
| 420 | |
| 421 | {More details to come} |
| 422 | |
| 423 | ====== __15d: Motion Control (**EM**)__ ====== |
| 424 | |
| 425 | {More details to come} |
| 426 | |
| 427 | ====== __16. RGB LED (**LED**)__ ====== |
| 428 | |
| 429 | Ex: #5LED3<cr> |
| 430 | |
| 431 | This action sets the servo's RGB LED color for that session.The LED can be used for aesthetics, or (based on user code) to provide visual status updates. Using timing can create patterns. |
| 432 | |
| 433 | 0=OFF 1=RED 2=GREEN 3= BLUE 4=YELLOW 5=CYAN 6= 7=MAGENTA, 8=WHITE |
| 434 | |
| 435 | Query LED Color (**QLED**) |
| 436 | |
| 437 | Ex: #5QLED<cr> might return *5QLED5<cr> |
| 438 | |
| 439 | This simple query returns the indicated servo's LED color. |
| 440 | |
| 441 | Configure LED Color (**CLED**) |
| 442 | |
| 443 | Configuring the LED color via the CLED command sets the startup color of the servo after a reset or power cycle. Note that it also changes the session's LED color immediately as well. |
| 444 | |
| 445 | ====== __17. Identification Number__ ====== |
| 446 | |
| 447 | A servo's identification number cannot be set "on the fly" and must be configured via the CID command described below. The factory default ID number for all servos is 0. Since smart servos are intended to be daisy chained, in order to respond differently from one another, the user must set different identification numbers. Servos with the same ID and baud rate will all receive and react to the same commands. |
| 448 | |
| 449 | Query Identification (**QID**) |
| 450 | |
| 451 | EX: #254QID<cr> might return *QID5<cr> |
| 452 | |
| 453 | When using the query ID command, it is best to only have one servo connected and thus receive only one reply using the broadcast command (ID 254). Alternatively, pushing the button upon startup and temporarily setting the servo ID to 255 will still result in the servo responding with its "real" ID. |
| 454 | |
| 455 | Configure ID (**CID**) |
| 456 | |
| 457 | Ex: #4CID5<cr> |
| 458 | |
| 459 | Setting a servo's ID in EEPROM is done via the CID command. All servos connected to the same serial bus will be assigned that ID. In most situations each servo must be set a unique ID, which means each servo must be connected individually to the serial bus and receive a unique CID number. It is best to do this before the servos are added to an assembly. Numbered stickers are provided to distinguish each servo after their ID is set, though you are free to use whatever alternative method you like. |
| 460 | |
| 461 | ====== __18. Baud Rate__ ====== |
| 462 | |
| 463 | A servo's baud rate cannot be set "on the fly" and must be configured via the CB command described below. The factory default baud rate for all servos is 9600. Since smart servos are intended to be daisy chained, in order to respond to the same serial bus, all servos in that project should ideally be set to the same baud rate. Setting different baud rates will have the servos respond differently and may create issues. Available baud rates are: 9.6 kbps, 19.2 kbps, 38.4 kbps, 57.6 kbps, 115.2 kbps, 230.4 kbps, 250.0 kbps, 460.8 kbps, 500.0 kbps, 750.0 kbps*, 921.6 kbps*. Servos are shipped with a baud rate set to 9600. The baud rates are currently restricted to those above. |
| 464 | \*: Current tests reveal baud rates above 500 kbps are unstable and can cause timeouts. Please keep this in mind if using those / testing them out. |
| 465 | |
| 466 | Query Baud Rate (**QB**) |
| 467 | |
| 468 | Ex: #5QB<cr> might return *5QB9600<cr> |
| 469 | |
| 470 | Querying the baud rate is used simply to confirm the CB configuration command before the servo is power cycled. |
| 471 | |
| 472 | Configure Baud Rate (**CB**) |
| 473 | |
| 474 | Ex: #5CB9600<cr> |
| 475 | |
| 476 | Sending this command will change the baud rate associated with servo ID 5 to 9600 bits per second. |
| 477 | |
| 478 | ====== __19. Gyre Rotation Direction__ ====== |
| 479 | |
| 480 | "Gyre" is defined as a circular course or motion. The effect of changing the gyre direction is as if you were to use a mirror image of a circle. CW = 1; CCW = -1. The factory default is clockwise (CW). |
| 481 | |
| 482 | {images showing before and after with AR and Origin offset} |
| 483 | |
| 484 | Query Gyre Direction (**QG**) |
| 485 | |
| 486 | Ex: #5QG<cr> might return *5QG-1<cr> |
| 487 | |
| 488 | The value returned above means the servo is in a counter-clockwise gyration. |
| 489 | |
| 490 | Configure Gyre (**CG**) |
| 491 | |
| 492 | Ex: #5CG-1<cr> |
| 493 | |
| 494 | This changes the gyre direction as described above and also writes to EEPROM. |
| 495 | |
| 496 | ====== __20. First / Initial Position (pulse)__ ====== |
| 497 | |
| 498 | In certain cases, a user might want to have the servo move to a specific angle upon power up. We refer to this as "first position". The factory default has no first position value stored in EEPROM and therefore upon power up, the servo remains limp until a position (or hold command) is assigned. FP and FD are different in that FP is used for RC mode only, whereas FD is used for smart mode only. |
| 499 | |
| 500 | Query First Position in Pulses (**QFP**) |
| 501 | |
| 502 | Ex: #5QFP<cr> might return *5QFP1550<cr> |
| 503 | |
| 504 | The reply above indicates that servo with ID 5 has a first position pulse of 1550 microseconds. If no first position has been set, servo will respond with DIS ("disabled"). |
| 505 | |
| 506 | Configure First Position in Pulses (**CFP**) |
| 507 | |
| 508 | Ex: #5CP1550<cr> |
| 509 | |
| 510 | This configuration command means the servo, when set to RC mode, will immediately move to an angle equivalent to having received an RC pulse of 1550 microseconds upon power up. Sending a CFP command without a number results in the servo remaining limp upon power up (i.e. disabled). |
| 511 | |
| 512 | ====== __21. First / Initial Position (Degrees)__ ====== |
| 513 | |
| 514 | In certain cases, a user might want to have the servo move to a specific angle upon power up. We refer to this as "first position". The factory default has no first position value stored in EEPROM and therefore upon power up, the servo remains limp until a position (or hold command) is assigned. FP and FD are different in that FP is used for RC mode only, whereas FD is used for smart mode only. |
| 515 | |
| 516 | Query First Position in Degrees (**QFD**) |
| 517 | |
| 518 | Ex: #5QFD<cr> might return *5QFD64<cr> |
| 519 | |
| 520 | The reply above indicates that servo with ID 5 has a first position pulse of 1550 microseconds. |
| 521 | |
| 522 | Configure First Position in Degrees (**CFD**) |
| 523 | |
| 524 | Ex: #5CD64<cr> |
| 525 | |
| 526 | This configuration command means the servo, when set to smart mode, will immediately move to 6.4 degrees upon power up. Sending a CFD command without a number results in the servo remaining limp upon power up. |
| 527 | |
| 528 | ====== __22. Query Target Position in Degrees (**QDT**)__ ====== |
| 529 | |
| 530 | Ex: #5QDT<cr> might return *5QDT6783<cr> |
| 531 | |
| 532 | The query target position command returns the target angle during and after an action which results in a rotation of the servo horn. In the example above, the servo is rotating to a virtual position of 678.3 degrees. Should the servo not have a target position or be in wheel mode, it will respond without a number (Ex: *5QDT<cr>). |
| 533 | |
| 534 | ====== __23. Query Model String (**QMS**)__ ====== |
| 535 | |
| 536 | Ex: #5QMS<cr> might return *5QMSLSS-HS1cr> |
| 537 | |
| 538 | This reply means the servo model is LSS-HS1, meaning a high speed servo, first revision. |
| 539 | |
| 540 | ====== __23b. Query Model (**QM**)__ ====== |
| 541 | |
| 542 | Ex: #5QM<cr> might return *5QM68702699520cr> |
| 543 | |
| 544 | This reply means the servo model is 0xFFF000000 or 100, meaning a high speed servo, first revision. |
| 545 | |
| 546 | ====== __24. Query Serial Number (**QN**)__ ====== |
| 547 | |
| 548 | Ex: #5QN<cr> might return *5QN~_~_<cr> |
| 549 | |
| 550 | The number in the response is the servo's serial number which is set and cannot be changed. |
| 551 | |
| 552 | ====== __25. Query Firmware (**QF**)__ ====== |
| 553 | |
| 554 | Ex: #5QF<cr> might return *5QF11<cr> |
| 555 | |
| 556 | The integer in the reply represents the firmware version with one decimal, in this example being 1.1 |
| 557 | |
| 558 | ====== __26. Query Status (**Q**)__ ====== |
| 559 | |
| 560 | Ex: #5Q<cr> might return *5Q6<cr>, which indicates the motor is holding a position. |
| 561 | |
| 562 | |*Value returned|**Status**|**Detailed description** |
| 563 | |ex: *5Q0<cr>|Unknown|LSS is unsure |
| 564 | |ex: *5Q1<cr>|Limp|Motor driving circuit is not powered and horn can be moved freely |
| 565 | |ex: *5Q2<cr>|Free moving|Motor driving circuit is not powered and horn can be moved freely |
| 566 | |ex: *5Q3<cr>|Accelerating|Increasing speed from rest (or previous speeD) towards travel speed |
| 567 | |ex: *5Q4<cr>|Traveling|Moving at a stable speed |
| 568 | |ex: *5Q5<cr>|Decelerating|Decreasing from travel speed towards final position. |
| 569 | |ex: *5Q6<cr>|Holding|Keeping current position |
| 570 | |ex: *5Q7<cr>|Stepping|Special low speed mode to maintain torque |
| 571 | |ex: *5Q8<cr>|Outside limits|{More details coming soon} |
| 572 | |ex: *5Q9<cr>|Stuck|Motor cannot perform request movement at current speed setting |
| 573 | |ex: *5Q10<cr>|Blocked|Similar to stuck, but the motor is at maximum duty and still cannot move (i.e.: stalled) |
| 574 | |
| 575 | ====== __27. Query Voltage (**QV**)__ ====== |
| 576 | |
| 577 | Ex: #5QV<cr> might return *5QV11200<cr> |
| 578 | |
| 579 | The number returned has one decimal, so in the case above, servo with ID 5 has an input voltage of 11.2V (perhaps a three cell LiPo battery). |
| 580 | |
| 581 | ====== __28. Query Temperature (**QT**)__ ====== |
| 582 | |
| 583 | Ex: #5QT<cr> might return *5QT564<cr> |
| 584 | |
| 585 | The units are in tenths of degrees Celcius, so in the example above, the servo's internal temperature is 56.4 degrees C. To convert from degrees Celcius to degrees Farenheit, multiply by 1.8 and add 32. Therefore 56.4C = 133.52F. |
| 586 | |
| 587 | ====== __29. Query Current (**QC**)__ ====== |
| 588 | |
| 589 | Ex: #5QC<cr> might return *5QC140<cr> |
| 590 | |
| 591 | The units are in milliamps, so in the example above, the servo is consuming 140mA, or 0.14A. |
| 592 | |
| 593 | ====== __30. RC Mode (**CRC**)__ ====== |
| 594 | |
| 595 | This command puts the servo into RC mode (position or continuous), where it will only respond to RC pulses. Note that because this is the case, the servo will no longer accept serial commands. The servo can be placed back into smart mode by using the button menu. |
| 596 | |
| 597 | |**Command sent**|**Note** |
| 598 | |ex: #5CRC<cr>|Stay in smart mode. |
| 599 | |ex: #5CRC1<cr>|Change to RC position mode. |
| 600 | |ex: #5CRC2<cr>|Change to RC continuous (wheel) mode. |
| 601 | |ex: #5CRC*<cr>|Where * is any number or value. Stay in smart mode. |
| 602 | |
| 603 | EX: #5CRC<cr> |
| 604 | |
| 605 | ====== __31. RESET__ ====== |
| 606 | |
| 607 | Ex: #5RESET<cr> or #5RS<cr> |
| 608 | |
| 609 | This command does a "soft reset" (no power cycle required) and reverts all commands to those stored in EEPROM (i.e. configuration commands). |
| 610 | |
| 611 | ====== __32. DEFAULT & CONFIRM__ ====== |
| 612 | |
| 613 | Ex: #5DEFAULT<cr> |
| 614 | |
| 615 | This command sets in motion the reset all values to the default values included with the version of the firmware installed on that servo. The servo then waits for the CONFIRM command. Any other command received will cause the servo to exit the DEFAULT function. |
| 616 | |
| 617 | EX: #5DEFAULT<cr> followed by #5CONFIRM<cr> |
| 618 | |
| 619 | Since it it not common to have to restore all configurations, a confirmation command is needed after a firmware command is sent. Should any command other than CONFIRM be received by the servo after the firmware command has been received, it will leave the firmware action. |
| 620 | |
| 621 | Note that after the CONFIRM command is sent, the servo will automatically perform a RESET. |
| 622 | |
| 623 | ====== __33. UPDATE & CONFIRM__ ====== |
| 624 | |
| 625 | Ex: #5UPDATE<cr> |
| 626 | |
| 627 | This command sets in motion the equivalent of a long button press when the servo is not powered in order to enter firmware update mode. This is useful should the button be broken or inaccessible. The servo then waits for the CONFIRM command. Any other command received will cause the servo to exit the UPDATE function. |
| 628 | |
| 629 | EX: #5UPDATE<cr> followed by #5CONFIRM<cr> |
| 630 | |
| 631 | Since it it not common to have to update firmware, a confirmation command is needed after an UPDATE command is sent. Should any command other than CONFIRM be received by the servo after the firmware command has been received, it will leave the firmware action. |
| 632 | |
| 633 | Note that after the CONFIRM command is sent, the servo will automatically perform a RESET. |