Skip to content

Commit 4e4fa7c

Browse files
authored
Merge pull request #1799 from petterreinholdtsen/hal-comp-ddt-man
Add description, note and author for the ddt HAL component.
2 parents 93a5d1f + bec8c06 commit 4e4fa7c

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

src/hal/components/ddt.comp

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,23 @@
1515
// along with this program; if not, write to the Free Software
1616
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
1717
component ddt "Compute the derivative of the input function";
18+
author "Jeff Epler";
19+
20+
description """
21+
For every function call from the real time thread, calculate the
22+
difference between the old and current input value divided by the
23+
timer elapsed since the last call.
24+
""";
25+
26+
notes """
27+
28+
As this only work on two consecutive input values, it will only work
29+
well if the input change every function call, and not work so well if
30+
the rate of change is very low and the input change do not happen
31+
every time the real time function is called.
32+
33+
""";
34+
1835

1936
pin in float in;
2037
pin out float out;

0 commit comments

Comments
 (0)