@@ -262,7 +262,7 @@ PWM generators starts at 0.
262262unloadrt pwmgen
263263----
264264
265- === PWMgen Output Types
265+ === Output Types
266266
267267The PWM generator supports three different 'output types'.
268268
@@ -279,7 +279,7 @@ The PWM generator supports three different 'output types'.
279279 commands, the PWM signal appears on the down output, and the up output
280280 remains false. Output type 2 is suitable for driving most H-bridges.
281281
282- === PWMgen Pins
282+ === Pins
283283
284284Each PWM generator will have the following pins:
285285
@@ -299,7 +299,7 @@ output type selected:
299299* '(bit) pwmgen.<chan>.down' - PWM/PDM output for negative input value
300300 (output type 2 only).
301301
302- === PWMgen Parameters
302+ === Parameters
303303
304304* '(float) pwmgen.<chan>.scale' - Scaling factor to convert 'value'
305305 from arbitrary units to duty cycle. For example if scale is set to 4000
@@ -324,7 +324,7 @@ output type selected:
324324* '(float) pwmgen.<chan>.curr-dc' - Current duty cycle - after all
325325 limiting and rounding (read only).
326326
327- === PWMgen Functions
327+ === Functions
328328
329329The component exports two functions. Each function acts on all of the
330330PWM generators - running different generators in different threads is
@@ -385,7 +385,7 @@ of a specific counter. The first counter is number 0.
385385halcmd: unloadrt encoder
386386----
387387
388- === Encoder Pins
388+ === Pins
389389
390390* 'encoder.<chan>.counter-mode' (bit, I/O) (default: FALSE) - Enables
391391 counter mode. When true, the
@@ -463,14 +463,14 @@ halcmd: unloadrt encoder
463463 only counts once per full cycle. In counter-mode, this parameter is
464464 ignored. The 1x mode is useful for some jogwheels.
465465
466- === Encoder Parameters
466+ === Parameters
467467
468468* 'encoder.<chan>.capture-position.time (s32, RO)'
469469* 'encoder.<chan>.capture-position.tmax (s32, RW)'
470470* 'encoder.<chan>.update-counters.time (s32, RO)'
471471* 'encoder.<chan>.update-counter.tmax (s32, RW)'
472472
473- === Encoder Functions
473+ === Functions
474474
475475The component exports two functions. Each function acts on all of the
476476encoder counters - running different counters in different threads is
@@ -518,7 +518,7 @@ cluttering the pin list.
518518halcmd: unloadrt pid
519519----
520520
521- === PID Pins
521+ === Pins
522522
523523The three most important pins are
524524
@@ -588,7 +588,7 @@ additional pins will be exported:
588588* '(float) pid.<loopnum>.commandD' - Derivative of the command.
589589* '(float) pid.<loopnum>.commandDD' - 2nd derivative of the command.
590590
591- === PID Functions
591+ === Functions
592592
593593The component exports one function for each PID loop. This function
594594performs all the calculations needed for the loop. Since each loop has
@@ -625,7 +625,7 @@ defined by MAX_CHAN in sim_encoder.c).
625625halcmd: unloadrt sim-encoder
626626----
627627
628- === Sim-encoder Pins
628+ === Pins
629629
630630* '(float) sim-encoder.<chan-num>.speed' - The speed command for the
631631 simulated shaft.
@@ -635,7 +635,7 @@ halcmd: unloadrt sim-encoder
635635
636636When '.speed' is positive, '.phase-A' leads '.phase-B'.
637637
638- === Sim-encoder Parameters
638+ === Parameters
639639
640640* '(u32) sim-encoder.<chan-num>.ppr' - Pulses Per Revolution.
641641* '(float) sim-encoder.<chan-num>.scale' - Scale Factor for 'speed'.
@@ -647,7 +647,7 @@ Note that pulses per revolution is not the same as counts per
647647revolution. A pulse is a complete quadrature cycle. Most encoder
648648counters will count four times during one complete cycle.
649649
650- === Sim-encoder Functions
650+ === Functions
651651
652652The component exports two functions. Each function affects all
653653simulated encoders.
@@ -697,14 +697,14 @@ filter 0.
697697halcmd: unloadrt debounce
698698----
699699
700- === Debounce Pins
700+ === Pins
701701
702702Each individual filter has two pins.
703703
704704* '(bit) debounce.<G>.<F>.in' - Input of filter '<F>' in group '<G>'.
705705* '(bit) debounce.<G>.<F>.out' - Output of filter '<F>' in group '<G>'.
706706
707- === Debounce Parameters
707+ === Parameters
708708
709709Each group of filters has one parameterfootnote:[Each individual
710710filter also has an internal state variable. There is a
@@ -720,7 +720,7 @@ doesn't filter anything. As 'delay' increases, longer and longer
720720glitches are rejected. If 'delay' is 4, all glitches less than or
721721equal to four thread periods will be rejected.
722722
723- === Debounce Functions
723+ === Functions
724724
725725Each group of filters has one function, which updates all the filters
726726in that group 'simultaneously'. Different groups of filters can be
@@ -752,7 +752,7 @@ halcmd: loadrt siggen [num_chan=<chans>]
752752halcmd: unloadrt siggen
753753----
754754
755- === Siggen Pins
755+ === Pins
756756
757757Each generator has five output pins.
758758
@@ -778,13 +778,13 @@ For example, if 'siggen.0.amplitude' is 1.0 and 'siggen.0.offset' is
778778is 2.5 and 'siggen.0.offset' is 10.0, then the outputs will swing from
7797797.5 to 12.5.
780780
781- === Siggen Parameters
781+ === Parameters
782782
783783None. footnote:[Prior to version 2.1, frequency, amplitude, and offset
784784were parameters. They were changed to pins to allow control by other
785785components.]
786786
787- === Siggen Functions
787+ === Functions
788788
789789* '(funct) siggen.<chan>.update' - Calculates new values for all five outputs.
790790
0 commit comments