Machinekit Documentation

HAL Component — WCOMP

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

wcomp — Window comparator

SYNOPSIS

wcomp

USAGE SYNOPSIS

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

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

FUNCTIONS

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

PINS

wcomp.N.in float in ( OR <newinstname>.in float in ) - Value being compared

wcomp.N.min float in ( OR <newinstname>.min float in ) - Low boundary for comparison

wcomp.N.max float in ( OR <newinstname>.max float in ) - High boundary for comparison

wcomp.N.out bit out ( OR <newinstname>.out bit out ) - True if \fBin\fR is strictly between \fBmin\fR and \fBmax\fR

wcomp.N.under bit out ( OR <newinstname>.under bit out ) - True if \fBin\fR is less than or equal to \fBmin\fR

wcomp.N.over bit out ( OR <newinstname>.over bit out ) - True if \fBin\fR is greater than or equal to \fBmax\fR

NOTES

If \fBmax\fR ⇐ \fBmin\fR then the behavior is undefined.

LICENCE

GPL