Machinekit

Machinekit

Machinekit Documentation

HAL Component — PERIOD

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

period — export nominal and actual thread period as pins

SYNOPSIS

period

USAGE SYNOPSIS

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

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

FUNCTIONS

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

PINS

period.N.period-ns float out ( OR <newinstname>.period-ns float out )

period.N.actual-period-ns float out ( OR <newinstname>.actual-period-ns float out )

LICENCE

GPL