deploy: 118600d

foxy/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 50c0ba5481193df4631152510c85f5e9
+config: 4dbb89807a0c0a90dfa28409344791a3
 tags: 645f666f9bcd5a90fca523b33c5a78b7

foxy/index.html

@@ -150,7 +150,7 @@ <h2>Development Organisation and Communication<a class="headerlink" href="#devel
 </dd>
 </dl>
 <hr class="docutils" />
-<p>Built on 2024-12-02 at 05:40 GMT</p>
+<p>Built on 2024-12-03 at 05:39 GMT</p>
 </section>
 </section>
 

galactic/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 197a6dd390b52e75b330bfa14191a0a1
+config: 99465aa71d8565a6757984e520daec58
 tags: 645f666f9bcd5a90fca523b33c5a78b7

galactic/doc/api/classcontrol__toolbox_1_1RateLimiter.html

@@ -174,7 +174,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a08ea7cc5157568c434f5cf99
   </table>
   </dd>
 </dl>
-<dl class="section note"><dt>Note</dt><dd>If max_* values are NAN, the respective limit is deactivated If min_* values are NAN (unspecified), defaults to -max If min_first_derivative_pos/max_first_derivative_neg values are NAN, symmetric limits are used </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>If max_* values are NAN, the respective limit is deactivated If min_* values are NAN (unspecified), defaults to -max If min_first_derivative_pos/max_first_derivative_neg values are NAN, symmetric limits are used</dd></dl>
+<p>Disclaimer about the jerk limits: The jerk limit is only applied when accelerating or reverse_accelerating (i.e., "sign(jerk * accel) &gt; 0"). This condition prevents oscillating closed-loop behavior, see discussion details in <a href="https://github.com/ros-controls/control_toolbox/issues/240">https://github.com/ros-controls/control_toolbox/issues/240</a>. if you use this feature, you should perform a test to check that the behavior is really as you expect. </p>
 
 </div>
 </div>
@@ -332,6 +333,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0ef5f9ce5756456348ec6c02
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>Limiting factor (1.0 if none) </dd></dl>
 <dl class="section see"><dt>See also</dt><dd><a href="http://en.wikipedia.org/wiki/jerk_%28physics%29#Motion_control">http://en.wikipedia.org/wiki/jerk_%28physics%29#Motion_control</a> </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>The jerk limit is only applied when accelerating or reverse_accelerating (i.e., "sign(jerk * accel) &gt; 0"). </dd></dl>
 
 </div>
 </div>

galactic/index.html

@@ -150,7 +150,7 @@ <h2>Development Organisation and Communication<a class="headerlink" href="#devel
 </dd>
 </dl>
 <hr class="docutils" />
-<p>Built on 2024-12-02 at 05:40 GMT</p>
+<p>Built on 2024-12-03 at 05:39 GMT</p>
 </section>
 </section>
 

humble/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5ead842ff55eb12a3351c8891db23c1a
+config: 6612478235fcb6e599e51e288b43ff60
 tags: 645f666f9bcd5a90fca523b33c5a78b7

humble/doc/api/classcontrol__toolbox_1_1RateLimiter.html

@@ -181,7 +181,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a08ea7cc5157568c434f5cf99
   </table>
   </dd>
 </dl>
-<dl class="section note"><dt>Note</dt><dd>If max_* values are NAN, the respective limit is deactivated If min_* values are NAN (unspecified), defaults to -max If min_first_derivative_pos/max_first_derivative_neg values are NAN, symmetric limits are used </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>If max_* values are NAN, the respective limit is deactivated If min_* values are NAN (unspecified), defaults to -max If min_first_derivative_pos/max_first_derivative_neg values are NAN, symmetric limits are used</dd></dl>
+<p>Disclaimer about the jerk limits: The jerk limit is only applied when accelerating or reverse_accelerating (i.e., "sign(jerk * accel) &gt; 0"). This condition prevents oscillating closed-loop behavior, see discussion details in <a href="https://github.com/ros-controls/control_toolbox/issues/240">https://github.com/ros-controls/control_toolbox/issues/240</a>. if you use this feature, you should perform a test to check that the behavior is really as you expect. </p>
 
 </div>
 </div>
@@ -339,6 +340,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a0ef5f9ce5756456348ec6c02
 </dl>
 <dl class="section return"><dt>Returns</dt><dd>Limiting factor (1.0 if none) </dd></dl>
 <dl class="section see"><dt>See also</dt><dd><a href="http://en.wikipedia.org/wiki/jerk_%28physics%29#Motion_control">http://en.wikipedia.org/wiki/jerk_%28physics%29#Motion_control</a> </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>The jerk limit is only applied when accelerating or reverse_accelerating (i.e., "sign(jerk * accel) &gt; 0"). </dd></dl>
 
 </div>
 </div>