Machinekit Documentation

HAL Component — FEEDCOMP

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

feedcomp — Multiply the input by the ratio of current velocity to the feed rate

SYNOPSIS

feedcomp

USAGE SYNOPSIS

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

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

FUNCTIONS

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

PINS

feedcomp.N.out float out ( OR <newinstname>.out float out ) - Proportionate output value

feedcomp.N.in float in ( OR <newinstname>.in float in ) - Reference value

feedcomp.N.enable bit in ( OR <newinstname>.enable bit in ) - Turn compensation on or off

feedcomp.N.vel float in ( OR <newinstname>.vel float in ) - Current velocity

feedcomp.N.feed float io ( OR <newinstname>.feed float io ) - Feed rate reference value

NOTES

Note that if enable is false, out = in

LICENCE

GPL