Machinekit Documentation

HAL Component — XHC_HB04_UTIL

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

xhc_hb04_util — xhc-hb04 convenience utility

SYNOPSIS

xhc_hb04_util

USAGE SYNOPSIS

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

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

DESCRIPTION

Provides logic for a start/pause button and an interface to halui.program.is_paused,is_idle,is_running to generate outputs for halui.program.pause,resume,run.

Includes 4 simple lowpass filters with coef and scale pins. The coef value should be 0 ⇐ coef ⇐1, smaller coef values slow response. Note: the xhc_hb04 component includes smoothing so these values can usually be left at 1.0

FUNCTIONS

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

PINS

xhc_hb04_util.N.start-or-pause bit in ( OR <newinstname>.start-or-pause bit in )

xhc_hb04_util.N.is-paused bit in ( OR <newinstname>.is-paused bit in )

xhc_hb04_util.N.is-idle bit in ( OR <newinstname>.is-idle bit in )

xhc_hb04_util.N.is-running bit in ( OR <newinstname>.is-running bit in )

xhc_hb04_util.N.pause bit out ( OR <newinstname>.pause bit out )

xhc_hb04_util.N.resume bit out ( OR <newinstname>.resume bit out )

xhc_hb04_util.N.run bit out ( OR <newinstname>.run bit out )

xhc_hb04_util.N.in0 s32 in ( OR <newinstname>.in0 s32 in )

xhc_hb04_util.N.in1 s32 in ( OR <newinstname>.in1 s32 in )

xhc_hb04_util.N.in2 s32 in ( OR <newinstname>.in2 s32 in )

xhc_hb04_util.N.in3 s32 in ( OR <newinstname>.in3 s32 in )

xhc_hb04_util.N.out0 s32 out ( OR <newinstname>.out0 s32 out )

xhc_hb04_util.N.out1 s32 out ( OR <newinstname>.out1 s32 out )

xhc_hb04_util.N.out2 s32 out ( OR <newinstname>.out2 s32 out )

xhc_hb04_util.N.out3 s32 out ( OR <newinstname>.out3 s32 out )

xhc_hb04_util.N.scale0 float in (default: 1.0) ( OR <newinstname>.scale0 float in (default: 1.0) )

xhc_hb04_util.N.scale1 float in (default: 1.0) ( OR <newinstname>.scale1 float in (default: 1.0) )

xhc_hb04_util.N.scale2 float in (default: 1.0) ( OR <newinstname>.scale2 float in (default: 1.0) )

xhc_hb04_util.N.scale3 float in (default: 1.0) ( OR <newinstname>.scale3 float in (default: 1.0) )

xhc_hb04_util.N.coef0 float in (default: 1.0) ( OR <newinstname>.coef0 float in (default: 1.0) )

xhc_hb04_util.N.coef1 float in (default: 1.0) ( OR <newinstname>.coef1 float in (default: 1.0) )

xhc_hb04_util.N.coef2 float in (default: 1.0) ( OR <newinstname>.coef2 float in (default: 1.0) )

xhc_hb04_util.N.coef3 float in (default: 1.0) ( OR <newinstname>.coef3 float in (default: 1.0) )

LICENCE

GPL