Machinekit Documentation

HAL Component — TIMEDELAY

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

timedelay — The equivalent of a time-delay relay

SYNOPSIS

timedelay

USAGE SYNOPSIS

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

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

FUNCTIONS

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

PINS

timedelay.N.in bit in ( OR <newinstname>.in bit in )

timedelay.N.out bit out ( OR <newinstname>.out bit out ) - Follows the value of \fBin\fR after applying the delays \fBon-delay\fR and \fBoff-delay\fR.

timedelay.N.on-delay float in (default: 0.5) ( OR <newinstname>.on-delay float in (default: 0.5) ) - The time, in seconds, for which \fBin\fR must be \fBtrue\fR before \fBout\fR becomes \fBtrue\fR

timedelay.N.off-delay float in (default: 0.5) ( OR <newinstname>.off-delay float in (default: 0.5) ) - The time, in seconds, for which \fBin\fR must be \fBfalse\fR before \fBout\fR becomes \fBfalse\fR

timedelay.N.elapsed float out ( OR <newinstname>.elapsed float out ) - Current value of the internal timer

AUTHOR

Jeff Epler, based on works by Stephen Wille Padnos and John Kasunich

LICENCE

GPL