Changes for page LSS Communication Protocol
Last modified by Eric Nantel on 2025/06/06 07:47
Change comment: There is no comment for this version
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -xwiki:XWiki. CBenson1 +xwiki:XWiki.RB1 - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +LSS|communication|protocol|programming|firmware|control - Content
-
... ... @@ -42,6 +42,28 @@ 42 42 Modified commands are command specific. 43 43 ))) 44 44 45 +((( 46 + 47 +))) 48 + 49 +== Configuration Commands == 50 + 51 +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 Servos (LSS).LSS - RC PWM.WebHome]]. 52 + 53 +1. Start with a number sign # (U+0023) 54 +1. Servo ID number as an integer 55 +1. Configuration command (two to three letters, no spaces, capital or lower case) 56 +1. Configuration value in the correct units with no decimal 57 +1. End with a control / carriage return '<cr>' 58 + 59 +Ex: #5CO-50<cr> 60 + 61 +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. 62 + 63 +Configuration commands are not cumulative, in that if two configurations are sent at any time, only the last configuration is used and stored. 64 + 65 +*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. 66 + 45 45 == Query Commands == 46 46 47 47 Query commands are sent serially to the servo's Rx pin and must be set in the following format: ... ... @@ -69,25 +69,21 @@ 69 69 ))) 70 70 71 71 Indicates that servo #5 is currently at 144.3 degrees. 72 -))) 73 73 74 - ==ConfigurationCommands ==95 +**Session vs Configuration Query** 75 75 76 - Configurationcommands affect theservo's current session* but unlike action commands, configurationcommandsarewritten to EEPROM and are retained even if theservoloses power (thereforeNOTsessionpecific).Not allaction commands havea correspondingconfigurationand viceversa. Certainconfigurationsareretained forwhen theservoisused in RC model.Moreinformationcan be found onthe[[LSS - RC PWM page>>doc:LynxmotionSmart Servos (LSS).LSS - RC PWM.WebHome]].97 +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. 77 77 78 -1. Start with a number sign # (U+0023) 79 -1. Servo ID number as an integer 80 -1. Configuration command (two to three letters, no spaces, capital or lower case) 81 -1. Configuration value in the correct units with no decimal 82 -1. End with a control / carriage return '<cr>' 99 +In order to query the value in EEPROM, add a '1' to the query command. 83 83 84 -Ex: #5C O-50<cr>101 +Ex: #5CSR20<cr> sets the maximum speed for servo #5 to 20rpm upon RESET (explained below). 85 85 86 -A ssigns an absoluteoriginoffsetof -5.0 degrees(with respectto factory origin) toservo#5 and changestheoffset for thatsession to-5.0 degrees.103 +After RESET: #5SR4<cr> sets the session's speed to 4rpm. 87 87 88 - Configurationcommandsarenotcumulative, inthatif two configurationsareat any time,onlythe lastconfiguration isused andstored.105 +#5QSR<cr> would return *5QSR4<cr> which represents the value for that session. 89 89 90 -*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. 107 +#5QSR1<cr> would return *5QSR20<cr> which represents the value in EEPROM 108 +))) 91 91 92 92 = Command List = 93 93 ... ... @@ -107,8 +107,8 @@ 107 107 | 11|**W**heel mode in **R**PM| WR| QWR| | | ✓| rpm| 108 108 | 12|**S**peed in **D**egrees| SD| QSD| CSD| ✓| ✓| tenths of degrees per second (ex 248 = 24.8 degrees per second)| 109 109 | 13|**S**peed in **R**PM| SR| QSR| CSR| ✓| ✓| rpm| 110 -| 14|** A**ngular **A**cceleration|AA| QAA| CAA| ✓| ✓|tenthsof degrees per second squared|111 -| 15| **A**ngular**D**eceleration|AD|QAD|CAD|✓|✓|tenths of degrees per second squared|128 +| 14|**R**igidity| R| QR| CR| ✓| ✓|none| 129 +| 15|//N/A (removed)//| | | | | | | 112 112 | 16|**LED** Color| LED| QLED| CLED| ✓| ✓| none (integer from 1 to 8)|0=OFF 1=RED 2=GREEN 3= BLUE 4=YELLOW 5=CYAN 6= 7=MAGENTA, 8=WHITE 113 113 | 17|**ID** #| ID| QID| CID| | ✓| none (integer from 0 to 250)|Note: ID 254 is a "broadcast" which all servos respond to. 114 114 | 18|**B**aud rate| B| QB| CB| | ✓| none (integer)| ... ... @@ -265,8 +265,15 @@ 265 265 266 266 Ex: #5QSD<cr> might return *5QSD1800<cr> 267 267 268 -Note that the QSD query will return the current servo speed. Querying the last maximum speed value set using SD or CSD is not possible. 286 +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 command is processed. 287 +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: 269 269 289 +|**Command sent**|**Returned value (1/10 °)** 290 +|ex: #5QSR<cr>|Current session value for maximum speed (set by latest SD/SR command) 291 +|ex: #5QSR1<cr>|Current maximum speed configured (set by CSD/CSR) 292 +|ex: #5QSR2<cr>|Current speed. 293 +|ex: #5QSR3<cr>|Target travel speed. 294 + 270 270 Configure Speed in Degrees (**CSD**) 271 271 272 272 Ex: #5CSD1800<cr> ... ... @@ -291,46 +291,38 @@ 291 291 292 292 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 45rpm. When the servo is powered on (or after a reset), the CSD 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. 293 293 294 -__14. Angular Acceleration(**AA**)__319 +__14. Rigidity (R)__ 295 295 296 - {More information comingsoon}321 +The servo's rigidity can be thought of as (though not identical to) a damped spring in which the rigidity value affects the stiffness and embodies how much, and how quickly the servo tried keep the requested position against changes. 297 297 298 - Ex:323 +A positive value of "rigidity": 299 299 300 -{Description coming soon} 325 +* The more torque will be applied to try to keep the desired position against external input / changes 326 +* The faster the motor will reach its intended travel speed and the motor will decelerate faster and nearer to its target position 301 301 302 - QueryAngular Acceleration(**QAA**)328 +A negative value on the other hand: 303 303 304 -Ex: 330 +* Causes a slower acceleration to the travel speed, and a slower deceleration 331 +* Allows the target position to deviate more from its position before additional torque is applied to bring it back 305 305 306 - {Description coming soon}333 +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. 307 307 308 - ConfigureAngular Acceleration (**CAA**)335 +Ex: #5R-2<cr> 309 309 310 - Ex:337 +This reduces the rigidity 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. 311 311 312 - {Descriptioncoming soon}339 +Ex: #5QR<cr> 313 313 314 - __15. AngularDeceleration(**AD**)__341 +Queries the value being used. 315 315 316 - {Moreinformationcoming soon}343 +Ex: #5CR<cr> 317 317 318 - Ex:345 +Writes the desired rigidity value to memory. 319 319 320 - {Descriptioncomingsoon}347 +__15. N/A (removed)__ 321 321 322 - QueryAngularAcceleration(**QAD**)349 +This command has been removed. 323 323 324 -Ex: 325 - 326 -{Description coming soon} 327 - 328 -Configure Angular Acceleration (**CAD**) 329 - 330 -Ex: 331 - 332 -{Description coming soon} 333 - 334 334 __16. RGB LED (**LED**)__ 335 335 336 336 Ex: #5LED3<cr> ... ... @@ -351,7 +351,7 @@ 351 351 352 352 __17. Identification Number__ 353 353 354 -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 1. 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.371 +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. 355 355 356 356 Query Identification (**QID**) 357 357 ... ... @@ -367,7 +367,8 @@ 367 367 368 368 __18. Baud Rate__ 369 369 370 -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. Standard / suggested baud rates are: 4800; 9600; 14400; 19200; 38400; 57600; 115200; 128000; 256000, 512000 bits per second. Servos are shipped with a baud rate set to 9600. The baud rates are currently restricted to those above 387 +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. 388 +\*: 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. 371 371 372 372 Query Baud Rate (**QB**) 373 373 ... ... @@ -485,23 +485,30 @@ 485 485 486 486 This command does a "soft reset" (no power cycle required) and reverts all commands to those stored in EEPROM (i.e. configuration commands). 487 487 488 -**__DEFAULT__** 506 +**__DEFAULT __**__& **CONFIRM**__ 489 489 490 490 Ex: #5DEFAULT<cr> 491 491 492 -This command sets all values to the default values included with the version of the firmware installed on that servo. 510 +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. 493 493 494 - __**FIRMWARE**&**CONFIRM**__512 +EX: #5DEFAULT<cr> followed by #5CONFIRM<cr> 495 495 496 - Ex:#5FIRMWARE<cr>514 +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. 497 497 498 - This command clears all user-inputvaluesin EEPROM and reverts backtofactory defaults for thefirmware installed.It does notoverwriteany firmware updates. To revert toan older firmware version, pleaserefertothe LSS - Firmware page. The firmwarecommand alonedoes nothing otherthan have the servo waitfor aconfirmation.516 +Note that after the CONFIRM command is sent, the servo will automatically perform a RESET. 499 499 500 - EX: #5FIRMWARE<cr>followedby #5CONFIRM<cr>518 +**__UPDATE __**__& **CONFIRM**__ 501 501 502 - Sinceit it notcommon to have torestore 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.520 +Ex: #5UPDATE<cr> 503 503 522 +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. 504 504 524 +EX: #5UPDATE<cr> followed by #5CONFIRM<cr> 525 + 526 +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. 527 + 528 +Note that after the CONFIRM command is sent, the servo will automatically perform a RESET. 529 + 505 505 === Virtual Angular Position === 506 506 507 507 {In progress}