Changes for page LSS Communication Protocol
Last modified by Eric Nantel on 2025/06/06 07:47
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Tags
-
... ... @@ -1,1 +1,0 @@ 1 -LSS|communication|protocol|programming|firmware|control - Content
-
... ... @@ -42,28 +42,6 @@ 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 - 67 67 == Query Commands == 68 68 69 69 Query commands are sent serially to the servo's Rx pin and must be set in the following format: ... ... @@ -91,21 +91,25 @@ 91 91 ))) 92 92 93 93 Indicates that servo #5 is currently at 144.3 degrees. 72 +))) 94 94 95 - **SessionvsConfigurationQuery**74 +== Configuration Commands == 96 96 97 - Bydefault,thequerycommand returns the sessions'value;shouldnoaction commands havebeensenttochange,itwillreturn thevalue saved inEEPROMfromthelast configurationcommand.76 +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]]. 98 98 99 -In order to query the value in EEPROM, add a '1' to the query command. 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>' 100 100 101 -Ex: #5C SR20<cr>sets the maximum speed for servo #5 to 20rpm upon RESET (explained below).84 +Ex: #5CO-50<cr> 102 102 103 -A fterRESET:#5SR4<cr>sets the session'sspeedto4rpm.86 +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. 104 104 105 - #5QSR<cr>would return*5QSR4<cr>whichrepresentsthevalueforthat session.88 +Configuration commands are not cumulative, in that if two configurations are sent at any time, only the last configuration is used and stored. 106 106 107 -#5QSR1<cr> would return *5QSR20<cr> which represents the value in EEPROM 108 -))) 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. 109 109 110 110 = Command List = 111 111 ... ... @@ -118,7 +118,8 @@ 118 118 | 6|**O**rigin Offset| O| QO| CO| ✓| ✓| tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| 119 119 | 7|**A**ngular **R**ange| AR| QAR| CAR| ✓| ✓| tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| 120 120 | 8|Position in **P**ulse| P| QP| | | ✓| microseconds|((( 121 -See details below. 103 +Valid values for P are [500, 2500]. Values outside this range are corrected to end points. 104 +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. 122 122 ))) 123 123 | 9|Position in **D**egrees| D| QD| | | ✓| tenths of degrees (ex 325 = 32.5 degrees; 91 = 9.1 degrees)| 124 124 | 10|**W**heel mode in **D**egrees| WD| QWD| | | ✓| tenths of degrees per second (ex 248 = 24.8 degrees per second)| ... ... @@ -125,8 +125,8 @@ 125 125 | 11|**W**heel mode in **R**PM| WR| QWR| | | ✓| rpm| 126 126 | 12|**S**peed in **D**egrees| SD| QSD| CSD| ✓| ✓| tenths of degrees per second (ex 248 = 24.8 degrees per second)| 127 127 | 13|**S**peed in **R**PM| SR| QSR| CSR| ✓| ✓| rpm| 128 -| 14|** R**igidity|R| QR| CR| ✓| ✓|none|129 -| 15| //N/A(removed)//| | | | | | |111 +| 14|**A**ngular **A**cceleration| AA| QAA| CAA| ✓| ✓| tenths of degrees per second squared| 112 +| 15|**A**ngular **D**eceleration| AD| QAD| CAD| ✓| ✓| tenths of degrees per second squared| 130 130 | 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 131 131 | 17|**ID** #| ID| QID| CID| | ✓| none (integer from 0 to 250)|Note: ID 254 is a "broadcast" which all servos respond to. 132 132 | 18|**B**aud rate| B| QB| CB| | ✓| none (integer)| ... ... @@ -228,14 +228,13 @@ 228 228 229 229 Example: #5P2334<cr> 230 230 231 -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.214 +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 232 232 233 233 Query Position in Pulse (**QP**) 234 234 235 235 Example: #5QP<cr> might return *5QP 236 236 237 -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. 238 -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. 220 +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. 239 239 240 240 __9. Position in Degrees (**D**)__ 241 241 ... ... @@ -283,14 +283,8 @@ 283 283 284 284 Ex: #5QSD<cr> might return *5QSD1800<cr> 285 285 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: 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. 288 288 289 -no param = session max velocity 290 -1 = configured max velocity 291 -2 = current velocity 292 -3 = target/travel velocity (temporary until next motion command) 293 - 294 294 Configure Speed in Degrees (**CSD**) 295 295 296 296 Ex: #5CSD1800<cr> ... ... @@ -315,38 +315,46 @@ 315 315 316 316 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. 317 317 318 -__14. Rigidity(R)__294 +__14. Angular Acceleration (**AA**)__ 319 319 320 - The servo'srigidity can bethought of as (though notidentical to) a damped spring in which the rigidity value affects the stiffness and embodies how much, andhow quickly the servotriedkeep the requested positionagainst changes.296 +{More information coming soon} 321 321 322 - A positive value of "rigidity":298 +Ex: 323 323 324 -* The more torque will be applied to try to keep the desired position against external input / changes 325 -* The faster the motor will reach its intended travel speed and the motor will decelerate faster and nearer to its target position 300 +{Description coming soon} 326 326 327 - Anegativevalueon the otherhand:302 +Query Angular Acceleration (**QAA**) 328 328 329 -* Causes a slower acceleration to the travel speed, and a slower deceleration 330 -* Allows the target position to deviate more from its position before additional torque is applied to bring it back 304 +Ex: 331 331 332 - Thedefault value iszeroandthe effect becomes extreme by -4, +4. There are no units, only integersbetween -4 to 4. Greater valuesproduce increasingly erratic behavior.306 +{Description coming soon} 333 333 334 - Ex:#5R-2<cr>308 +Configure Angular Acceleration (**CAA**) 335 335 336 - Thisreduces 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.310 +Ex: 337 337 338 - Ex: #5QR<cr>312 +{Description coming soon} 339 339 340 - Queriesthevaluebeingused.314 +__15. Angular Deceleration (**AD**)__ 341 341 342 - Ex:#5CR<cr>316 +{More information coming soon} 343 343 344 - Writesthe desired rigidity value to memory.318 +Ex: 345 345 346 - __15. N/A (removed)__320 +{Description coming soon} 347 347 348 - Thiscommand hasbeenremoved.322 +Query Angular Acceleration (**QAD**) 349 349 324 +Ex: 325 + 326 +{Description coming soon} 327 + 328 +Configure Angular Acceleration (**CAD**) 329 + 330 +Ex: 331 + 332 +{Description coming soon} 333 + 350 350 __16. RGB LED (**LED**)__ 351 351 352 352 Ex: #5LED3<cr> ... ... @@ -367,7 +367,7 @@ 367 367 368 368 __17. Identification Number__ 369 369 370 -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.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 371 372 372 Query Identification (**QID**) 373 373 ... ... @@ -383,8 +383,7 @@ 383 383 384 384 __18. Baud Rate__ 385 385 386 -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. 387 -\*: 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. 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 388 388 389 389 Query Baud Rate (**QB**) 390 390 ... ... @@ -502,30 +502,23 @@ 502 502 503 503 This command does a "soft reset" (no power cycle required) and reverts all commands to those stored in EEPROM (i.e. configuration commands). 504 504 505 -**__DEFAULT __& **CONFIRM**__488 +**__DEFAULT__** 506 506 507 507 Ex: #5DEFAULT<cr> 508 508 509 -This command sets in motion the resetall 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.492 +This command sets all values to the default values included with the version of the firmware installed on that servo. 510 510 511 - EX: #5DEFAULT<cr>followedby #5CONFIRM<cr>494 +__**FIRMWARE** & **CONFIRM**__ 512 512 513 - Sinceit 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 CONFIRMbe received by the servo after the firmware command has been received, it will leave the firmware action.496 +Ex: #5FIRMWARE<cr> 514 514 515 - Note that after theCONFIRM commandissent,theservo willautomaticallyperformaRESET.498 +This command clears all user-input values in EEPROM and reverts back to factory defaults for the firmware installed. It does not overwrite any firmware updates. To revert to an older firmware version, please refer to the LSS - Firmware page. The firmware command alone does nothing other than have the servo wait for a confirmation. 516 516 517 - **__UPDATE__**__&**CONFIRM**__500 +EX: #5FIRMWARE<cr> followed by #5CONFIRM<cr> 518 518 519 - Ex:#5UPDATE<cr>502 +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. 520 520 521 -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. 522 522 523 -EX: #5UPDATE<cr> followed by #5CONFIRM<cr> 524 - 525 -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. 526 - 527 -Note that after the CONFIRM command is sent, the servo will automatically perform a RESET. 528 - 529 529 === Virtual Angular Position === 530 530 531 531 {In progress}