Machinekit

Machinekit

Machinekit Documentation

HAL Component — LOWPASS

INSTANTIABLE COMPONENTS — General

All instantiable components can be loaded in two manners

Using loadrt with or without count= | names= parameters as per legacy components
Using newinst, which names the instance and allows further parameters and arguments
primarily pincount= which can set the number of pins created for that instance (where applicable)

NAME

lowpass — Low-pass filter

SYNOPSIS

lowpass

USAGE SYNOPSIS

loadrt lowpass
OR
newinst lowpass <newinstname> [ pincount=N | iprefix=prefix ] [instanceparamX=X | argX=X ]

( args in [ ] denote possible args and parameters, may not be used in all components )

FUNCTIONS

lowpass.N.funct ( OR <newinstname>.funct (requires a floating-point thread) )

PINS

lowpass.N.in float in ( OR <newinstname>.in float in )

lowpass.N.out float out ( OR <newinstname>.out float out ) - out += (in - out) * gain

lowpass.N.load bit in ( OR <newinstname>.load bit in ) - When TRUE, copy \fBin\fR to \fBout\fR instead of applying the filter equation.

lowpass.N.gain float in ( OR <newinstname>.gain float in )

NOTES

The effect of a specific \fBgain\fR value is dependent on the period of the function that \fBlowpass.\fIN\fR is added to

LICENCE

GPL