Changes for page LSS-PRO Communication Protocol

Last modified by Eric Nantel on 2024/09/06 14:52

From version < 35.1 >

edited by Coleman Benson
on 2023/07/25 15:36

To version < 34.1 >

edited by Coleman Benson
on 2023/07/25 15:26

< >

Change comment: There is no comment for this version

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,7
          +1,6 @@
  {{warningBox warningText="More information coming soon"/}}
--
  (% class="wikigeneratedid" id="HTableofContents" %)
  **Page Contents**
@@ -30,88
          +30,104 @@
  == Modifiers ==
--Modifiers can only be used with certain **action commands**. The format to include a modifier is:
++{{html clean="false" wiki="true"}}
++<div class="cmdcnt"><div class="cmdpad"></div><div class="cmdtxt">
++Modifiers can only be used with certain **action commands**. The format to include a modifier is:<div class="wikimodel-emptyline"></div>
--1. Start with a number sign **#** (Unicode Character: U+0023)
++1. Start with a number sign **#** (Unicode Character: U+0023)
 . Servo ID number as an integer
 . Action command (one to three letters, no spaces, capital or lowercase from a subset of action commands below)
 . Action value in the correct units with no decimal
--1. Modifier command (one or two letters from the list of modifiers below)
++1. Modifier command (one or two letters from  the list of modifiers below)
 . Modifier value in the correct units with no decimal
--1. End with a carriage return **\r** or **<cr>** Unicode Character (U+000D)
++1. End with a carriage return **&#92;r** or **&lt;cr&gt;** Unicode Character (U+000D)
--Ex: #5D13000T1500<cr>This results in the servo with ID #5 rotating to a position (1800 in tenths of degrees) of 130.00 degrees in a time ("T") of 1500 milliseconds (1.5 seconds).
++Ex: #5D13000T1500&lt;cr&gt;<div class="wikimodel-emptyline"></div>
--== Queries ==
++This results in the servo with ID #5 rotating to a position (1800 in tenths of degrees) of 130.00 degrees in a time ("T") of 1500 milliseconds (1.5 seconds).<div class="wikimodel-emptyline"></div>
++<div class="wikimodel-emptyline"></div></div></div>
--Query commands request information from the servo. Query commands are also similar to action and configuration commands and must use the following format:
++<h2>Queries</h2>
++<div class="cmdcnt"><div class="cmdpad"></div><div class="cmdtxt">
++Query commands request information from the servo. Query commands are also similar to action and configuration commands and must use the following format:<div class="wikimodel-emptyline"></div>
--1. Start with a number sign **#** (Unicode Character: U+0023)
++1. Start with a number sign **#** (Unicode Character: U+0023)
 . Servo ID number as an integer
 . Query command (one to four letters, no spaces, capital or lower case)
--1. End with a carriage return **\r** or **<cr>** Unicode Character (U+000D)
++1. End with a carriage return **&#92;r** or **&lt;cr&gt;** Unicode Character (U+000D)<div class="wikimodel-emptyline"></div>
--Ex: #5QD<cr> Query the position in (hundredths of) degrees for servo with ID #5The query will return a serial string (almost instantaneously) via the servo's Tx in the following format:
++Ex: #5QD&lt;cr&gt; Query the position in (hundredths of) degrees for servo with ID #5<div class="wikimodel-emptyline"></div>
++The query will return a serial string (almost instantaneously) via the servo's Tx in the following format:
++
 . Start with an asterisk * (Unicode Character: U+0023)
 . Servo ID number as an integer
 . Query command (one to four letters, no spaces, capital letters)
 . The reported value in the units described, no decimals.
--1. End with a carriage return **\r** or **<cr>** Unicode Character (U+000D)
++1. End with a carriage return **&#92;r** or **&lt;cr&gt;** Unicode Character (U+000D)<div class="wikimodel-emptyline"></div>
--There is currently no option to control how fast a servo replies after it has received a query command, therefore when sending a query command to the bus, the controller should be prepared to immediately "listen" for and parse the reply. Sending multiple queries to multiple servos on a bus in fast succession may result in replies overlapping and giving incorrect or corrupt data. As such, the controller should receive a reply before sending a new query command. A reply to the query sent above might be:
++There is currently no option to control how fast a servo replies after it has received a query command, therefore when sending a query command to the bus, the controller should be prepared to immediately "listen" for and parse the reply. Sending multiple queries to multiple servos on a bus in fast succession may result in replies overlapping and giving incorrect or corrupt data. As such, the controller should receive a reply before sending a new query command. A reply to the query sent above might be:<div class="wikimodel-emptyline"></div>
--Ex: *5QD13000<cr>
++Ex: *5QD13000&lt;cr&gt;<div class="wikimodel-emptyline"></div>
  This indicates that servo #5 is currently at 130.00 degrees (13000 tenths of degrees).
++<div class="wikimodel-emptyline"></div></div></div>
--== Configurations ==
++<h2>Configurations</h2>
--Configuration commands and corresponding values affect a servo's defaults which are written to and read from the servo's EEPROM. These configurations are retained in memory after the servo is reset or power is cut / lost. Some configuration commands affect the session, while others do not. In the Command table below, the column "Session" denotes if the configuration command affects the session. Not all action commands have a corresponding configuration command and vice versa. Configuration commands are not cumulative; this means that if two of the same configuration commands are sent, one after the next, only the last configuration is used and stored.
++<div class="cmdcnt"><div class="cmdpad"></div><div class="cmdtxt">
++Configuration commands and corresponding values affect a servo's defaults which are written to and read from the servo's EEPROM.<div class="wikimodel-emptyline"></div>
--The format to send a configuration command is identical to that of an action command:
++These configurations are retained in memory after the servo is reset or power is cut / lost. Some configuration commands affect the session, while others do not. In the Command table below, the column "Session" denotes if the configuration command affects the session. Not all action commands have a corresponding configuration command and vice versa. Configuration commands are not cumulative; this means that if two of the same configuration commands are sent, one after the next, only the last configuration is used and stored.<div class="wikimodel-emptyline"></div>
--1. Start with a number sign **#** (Unicode Character: U+0023)
++The format to send a configuration command is identical to that of an action command:<div class="wikimodel-emptyline"></div>
++
++1. Start with a number sign **#** (Unicode Character: U+0023)
 . Servo ID number as an integer
 . Configuration command (two to four letters, no spaces, capital or lower case)
 . Configuration value in the correct units with no decimal
--1. End with a carriage return **\r** or **<cr>** Unicode Character (U+000D)
++1. End with a carriage return **&#92;r** or **&lt;cr&gt;** Unicode Character (U+000D)<div class="wikimodel-emptyline"></div>
--Ex: #5CO-500<cr>
++Ex: #5CO-500&lt;cr&gt;<div class="wikimodel-emptyline"></div>
--This configures an absolute origin offset ("CO") with respect to factory origin of servo with ID #5 and changes the offset for that session to -5.00 degrees (500 hundredths of degrees). Once the servo is powered off and on, zeroing the servo will cause it to move to -5.00 degrees with respect to the factory origin and report its position as 0 degrees. Configuration commands can be undone / reset either by sending the servo's default value for that configuration, or by doing a factory reset that clears all configurations (through the button menu or with DEFAULT command described below).
++This configures an absolute origin offset ("CO") with respect to factory origin of servo with ID #5 and changes the offset for that session to -5.00 degrees (500 hundredths of degrees). Once the servo is powered off and on, zeroing the servo will cause it to move to -5.00 degrees with respect to the factory origin and report its position as 0 degrees. Configuration commands can be undone / reset either by sending the servo's default value for that configuration, or by doing a factory reset that clears all configurations (through the button menu or with DEFAULT command described below).<div class="wikimodel-emptyline"></div>
--**Session vs Configuration Query**
++**Session vs Configuration Query**<div class="wikimodel-emptyline"></div>
--By default, the query command returns the session's value. Should no action commands have been sent to change the session value, it will return the value saved in EEPROM which will either be the servo's default, or modified with a configuration command. In order to query the value stored in EEPROM (configuration), add a '1' to the query command:
++By default, the query command returns the session's value. Should no action commands have been sent to change the session value, it will return the value saved in EEPROM which will either be the servo's default, or modified with a configuration command. In order to query the value stored in EEPROM (configuration), add a '1' to the query command:<div class="wikimodel-emptyline"></div>
--Ex: #5CSR10<cr> immediately sets the maximum speed for servo #5 to 10rpm (explained below) and changes the value in memory.
++Ex: #5CSR10&lt;cr&gt; immediately sets the maximum speed for servo #5 to 10rpm (explained below) and changes the value in memory.<div class="wikimodel-emptyline"></div>
--After RESET, a command of #5SR4<cr> sets the session's speed to 4rpm, but does not change the configuration value in memory. Therefore:
++After RESET, a command of #5SR4&lt;cr&gt; sets the session's speed to 4rpm, but does not change the configuration value in memory. Therefore:<div class="wikimodel-emptyline"></div>
--#5QSR<cr> or #5QSR0<cr> would return *5QSR4<cr> which represents the value for that session, whereas
++#5QSR&lt;cr&gt; or #5QSR0&lt;cr&gt;  would return *5QSR4&lt;cr&gt; which represents the value for that session, whereas<div class="wikimodel-emptyline"></div>
--#5QSR1<cr> would return *5QSR10<cr> which represents the value in EEPROM
++#5QSR1&lt;cr&gt; would return *5QSR10&lt;cr&gt; which represents the value in EEPROM
++<div class="wikimodel-emptyline"></div></div></div>
--The ability to store a "virtual angular position" is a feature which allows for rotation beyond 360 degrees, permitting 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 a 360.00 degree circle and can be obtained by taking the modulus (with respect to 360 degrees) of the value. For example if the virtual position is reported as 153350 (or 1533.50 degrees), taking the modulus would give 93.5 degrees (36000 * 4 + 9350 = 153350) as the absolute position (assuming no origin offset).
++<div class="cmdcnt"><div class="cmdpad"></div><div class="cmdtxt">
++The ability to store a "virtual angular position" is a feature which allows for rotation beyond 360 degrees, permitting 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 a 360.00 degree circle and can be obtained by taking the modulus (with respect to 360 degrees) of the value. For example if the virtual position is reported as 153350 (or 1533.50 degrees), taking the modulus would give 93.5 degrees (36000 * 4 + 9350 = 153350) as the absolute position (assuming no origin offset).<div class="wikimodel-emptyline"></div>
--[[image:https://wiki.lynxmotion.com/info/wiki/lynxmotion/download/lynxmotion-smart-servo-pro/lss-p-communication-protocol/WebHome/LSS-servo-positions.jpg||alt="LSS-servo-positions.jpg"]]
++[[image:LSS-servo-positions.jpg]]<div class="wikimodel-emptyline"></div>
--In this example, the gyre direction (explained below, a.k.a. "rotation direction") is positive (clockwise), and origin offset has not been modified. Each square represents 30 degrees. The following command is sent:
++In this example, the gyre direction (explained below, a.k.a. "rotation direction") is positive (clockwise), and origin offset has not been modified. Each square represents 30 degrees. The following command is sent:<div class="wikimodel-emptyline"></div>
--#1D-3000<cr> This causes the servo to move to -30.00 degrees (green arrow)
++#1D-3000&lt;cr&gt; This causes the servo to move to -30.00 degrees (green arrow)<div class="wikimodel-emptyline"></div>
--#1D21000<cr> This second position command is sent to the servo, which moves it to 210.00 degrees (orange arrow)
++#1D21000&lt;cr&gt; This second position command is sent to the servo, which moves it to 210.00 degrees (orange arrow)<div class="wikimodel-emptyline"></div>
--#1D-42000<cr> This next command rotates the servo counterclockwise to a position of -420.00 degrees (red arrow), which means one full rotation of 360 degrees plus 60.00 degrees (420.00 - 360.00), with a virtual position of -420.0 degrees.
++#1D-42000&lt;cr&gt; This next command rotates the servo counterclockwise to a position of -420.00 degrees (red arrow), which means one full rotation of 360 degrees plus 60.00 degrees (420.00 - 360.00), with a virtual position of -420.0 degrees.<div class="wikimodel-emptyline"></div>
--Although the final physical position would be the same as if the servo were commanded to move to -60.00 degrees, the servo is in fact at -420.00 degrees.
++Although the final physical position would be the same as if the servo were commanded to move to -60.00 degrees, the servo is in fact at -420.00 degrees.<div class="wikimodel-emptyline"></div>
--#1D48000<cr> This new command is sent which would then cause the servo to rotate from -420.00 degrees to 480.00 degrees (blue arrow), which would be a total of 900 degrees of clockwise rotation, or 2.5 complete rotations.
++#1D48000&lt;cr&gt; This new command is sent which would then cause the servo to rotate from -420.00 degrees to 480.00 degrees (blue arrow), which would be a total of 900 degrees of clockwise rotation, or 2.5 complete rotations.<div class="wikimodel-emptyline"></div>
--#1D33000<cr> would cause the servo to rotate from 480.0 degrees to 330.00 degrees (yellow arrow).
++#1D33000&lt;cr&gt; would cause the servo to rotate from 480.0 degrees to 330.00 degrees (yellow arrow).<div class="wikimodel-emptyline"></div>
  If 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.00 degrees before power is cycled, upon power up the servo's position will be read as +120.00 degrees from zero (assuming center position has not been modified). The virtual position range at power-up is [-180.00°, 180.00°].
++<div class="wikimodel-emptyline"></div></div></div>
++
++{{/html}}
  )))
  = Command List =
@@ -190,10
          +190,14 @@
  == (% style="color:inherit; font-family:inherit" %)Communication Setup(%%) ==
++
++======  ======
++
  == Motion ==
  ====== __Position in Degrees (**D**)__ ======
++
  Example: #5D1456<cr>
  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) could also be used. A full circle would be from -1800 to 1800 degrees. A value of 2700 would be the same angle (absolute position) as -900, except the servo would move in a different direction.
@@ -221,6
          +221,7 @@
  ====== __Wheel Mode in Degrees (**WD**)__ ======
++
  Ex: #5WD90<cr>
  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).
@@ -233,6
          +233,7 @@
  ====== __Wheel Mode in RPM (**WR**)__ ======
++
  Ex: #5WR40<cr>
  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).
@@ -243,16
          +243,19 @@
  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).
++======  ======
++
  ====== __(Relative) Move in Degrees (**MD**)__ ======
--(% class="wikigeneratedid" id="HExample:235M15003Ccr3E" %)
--Example: #5M1500<cr>
++======
++Example: #5M1500<cr> ======
--(% class="wikigeneratedid" id="HTherelativemoveinPWMcommandcausestheservotoreaditscurrentpositionandmovebythespecifiednumberofPWMsignal.ForexampleiftheservoissettorotateCW28default29andanMcommandof1500issenttotheservo2Citwillcausetheservotorotateclockwiseby90degrees.NegativePWMvaluewouldcausetheservotorotateintheoppositeconfigureddirection." %)
--The relative move in PWM command causes the servo to read its current position and move by the specified number of PWM signal. For example if the servo is set to rotate CW (default) and an M command of 1500 is sent to the servo, it will cause the servo to rotate clockwise by 90 degrees. Negative PWM value would cause the servo to rotate in the opposite configured direction.
++(% class="wikigeneratedid" %)
++====== The relative move in PWM command causes the servo to read its current position and move by the specified number of PWM signal. For example if the servo is set to rotate CW (default) and an M command of 1500 is sent to the servo, it will cause the servo to rotate clockwise by 90 degrees. Negative PWM value would cause the servo to rotate in the opposite configured direction. ======
  ====== __Query Status (**Q**)__ ======
++
  The status query describes what the servo is currently doing. The query returns an integer which must be looked up in the table below.
  Ex: #5Q<cr> might return *5Q6<cr>, which indicates the motor is holding a position.
@@ -276,6
          +276,7 @@
  If a safety limit has been reached and exceeded, the LED will flash red and the servo will stop providing torque (no longer react to commands which cause the motor to rotate). In order to determine which limit has been reached, send a Q1 command. The servo must be RESET in order to return to normal operation, though if a limit is still detected (for example the servo is still too hot), it will revert back to Safe Mode.
++
  |(% style="width:25px" %) |***Value returned (Q1)**|**Status**|**Detailed description**
  | |ex: *5Q0<cr>|No limits have been passed|Nothing is wrong
  | |ex: *5Q1<cr>|Current limit has been passed|Something cause the current to either spike, or remain too high for too long
@@ -284,6
          +284,7 @@
  ====== __Limp (**L**)__ ======
++
  Example: #5L<cr>
  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>.
@@ -290,6
          +290,7 @@
  ====== __Halt & Hold (**H**)__ ======
++
  Example: #5H<cr>
  This command causes the servo to stop immediately and hold that angular position. It overrides whatever the servo might be doing at the time the command is received (accelerating, travelling, deccelerating, etc.)
@@ -298,6
          +298,7 @@
  ====== __Origin Offset (**O**)__ ======
++
  Example: #5O2400<cr>This command allows you to change the origin of the servo in relation to the factory zero position for that session. As with all action commands, the setting will be lost upon servo reset / power cycle. Origin offset commands are not cumulative and always relate to factory zero. In the first image, the origin at factory offset '0' (centered).
  [[image:https://wiki.lynxmotion.com/info/wiki/lynxmotion/download/lynxmotion-smart-servo-pro/lss-p-communication-protocol/WebHome/LSS-servo-default.jpg||alt="LSS-servo-default.jpg"]]
@@ -451,6
          +451,7 @@
  (% class="wikigeneratedid" %)
  This command queries the current speed in microseconds per second.
++(% class="wikigeneratedid" %)
  ====== __Timed move (**T**) modifier__ ======
  Example: #5D15000T2500<cr>
@@ -459,7
          +459,7 @@
  **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
--======   ======
++======  ======
  == Telemetry ==

Changes for page LSS-PRO Communication Protocol

Summary

Details

Navigation

Recently Visited