Machinekit Documentation

HAL Component — OFFSETN

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

offsetn — Adds and subtracts an offset

SYNOPSIS

offsetn

USAGE SYNOPSIS

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

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

DESCRIPTION

Adds an offset to an input and subtracts it from the feedback value, 1 to 9 pin sets

FUNCTIONS

offsetn.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

offsetn.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

offsetn.N.%01d.offset float in (M=0..pincount) ( OR <newinstname>.%01d.offset float in (M=0..pincount) ) - The offset value

offsetn.N.%01d.in float in (M=0..pincount) ( OR <newinstname>.%01d.in float in (M=0..pincount) ) - The input value

offsetn.N.%01d.out float out (M=0..pincount) ( OR <newinstname>.%01d.out float out (M=0..pincount) ) - The output value

offsetn.N.%01d.fb-in float in (M=0..pincount) ( OR <newinstname>.%01d.fb-in float in (M=0..pincount) ) - The feedback input value

offsetn.N.%01d.fb-out float out (M=0..pincount) ( OR <newinstname>.%01d.fb-out float out (M=0..pincount) ) - The feedback output value

INST_PARAMETERS

pincount int (default: 1)

AUTHOR

ArcEye <arceye@mgwareDOTcoDOTuk>

LICENCE

GPL