Machinekit Documentation

HAL Component — OFFSET

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

offset — Adds an offset to an input, and subtracts it from the feedback value

SYNOPSIS

offset

USAGE SYNOPSIS

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

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

FUNCTIONS

offset.N.update-output.funct ( OR <newinstname>.update-output.funct (requires a floating-point thread) )

Updated the output value by adding the offset to the input

offset.N.update-feedback.funct ( OR <newinstname>.update-feedback.funct (requires a floating-point thread) )

Update the feedback value by subtracting the offset from the feedback

PINS

offset.N.offset float in ( OR <newinstname>.offset float in ) - The offset value

offset.N.in float in ( OR <newinstname>.in float in ) - The input value

offset.N.out float out ( OR <newinstname>.out float out ) - The output value

offset.N.fb-in float in ( OR <newinstname>.fb-in float in ) - The feedback input value

offset.N.fb-out float out ( OR <newinstname>.fb-out float out ) - The feedback output value

LICENCE

GPL