Machinekit Documentation

HAL Component — SPHEREPROBE

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

sphereprobe — Probe a pretend hemisphere

SYNOPSIS

sphereprobe

USAGE SYNOPSIS

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

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

FUNCTIONS

sphereprobe.N.funct ( OR <newinstname>.funct )

update probe-out based on inputs

PINS

sphereprobe.N.px s32 in ( OR <newinstname>.px s32 in )

sphereprobe.N.py s32 in ( OR <newinstname>.py s32 in )

sphereprobe.N.pz s32 in ( OR <newinstname>.pz s32 in ) - \fBrawcounts\fR position from software encoder

sphereprobe.N.cx s32 in ( OR <newinstname>.cx s32 in )

sphereprobe.N.cy s32 in ( OR <newinstname>.cy s32 in )

sphereprobe.N.cz s32 in ( OR <newinstname>.cz s32 in ) - Center of sphere in counts

sphereprobe.N.r s32 in ( OR <newinstname>.r s32 in ) - Radius of hemisphere in counts

sphereprobe.N.probe-out bit out ( OR <newinstname>.probe-out bit out )

AUTHOR

Jeff Epler

LICENCE

GPL