4a897203bc
groff treats '-' (the character you get when you hit the "minus" key on the keyboard) as "hyphen", not as "minus". Thus it renders incorrectly in some locales, and line-wraps strangely. groff treats the two-character sequence "\-" as "minus", and the four-character sequence "\(hy" as "hyphen". Details here: https://lists.debian.org/debian-devel/2003/03/msg01481.html This commit replaces every instance of "-" in our manpages where the meaning is "minus" with "\-", so it works right. This fixes many lintian warnings.
92 lines
3 KiB
Groff
92 lines
3 KiB
Groff
.TH SIGGEN "9" "2007-01-16" "LinuxCNC Documentation" "HAL Component"
|
|
.de TQ
|
|
.br
|
|
.ns
|
|
.TP \\$1
|
|
..
|
|
|
|
.SH NAME
|
|
siggen \- signal generator
|
|
.SH SYNOPSIS
|
|
\fBloadrt siggen [num_chan=\fInum\fB | names=\fIname1\fB[,\fIname2...\fB]]
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
\fBsiggen\fR is a signal generator that can be used for testing and
|
|
other applications that need simple waveforms. It produces sine,
|
|
cosine, triangle, sawtooth, and square waves of variable frequency,
|
|
amplitude, and offset, which can be used as inputs to other HAL
|
|
components.
|
|
|
|
.P
|
|
\fBsiggen\fR supports a maximum of sixteen channels. The number of
|
|
channels actually loaded is set by the \fBnum_chan\fR argument when
|
|
the module is loaded. Alternatively, specify \fBnames=\fR and unique names
|
|
separated by commas.
|
|
.P
|
|
The \fBnum_chan=\fR and \fBnames=\fR specifiers are mutually exclusive.
|
|
If neither \fBnum_chan=\fR nor \fBnames=\fR are specified, the default
|
|
value is one.
|
|
|
|
.SH NAMING
|
|
The names for pins, parameters, and functions are prefixed as:
|
|
\fBsiggen.N.\fR for N=0,1,...,num\-1 when using \fBnum_chan=num\fR
|
|
\fBnameN.\fR for nameN=name1,name2,... when using \fBnames=name1,name2,...\fR
|
|
|
|
The \fBsiggen.N.\fR format is shown in the following descriptions.
|
|
|
|
|
|
.SH FUNCTIONS
|
|
.TP
|
|
\fBsiggen.\fIN\fB.update\fR (uses floating-point)
|
|
Updates output pins for signal generator \fIN\fR. Each time it is
|
|
called it calculates a new sample. It should be called many times
|
|
faster than the desired signal frequency, to avoid distortion and
|
|
aliasing.
|
|
|
|
.SH PINS
|
|
|
|
.TP
|
|
\fBsiggen.\fIN\fB.frequency\fR float in
|
|
The output frequency for signal generator \fIN\fR, in Hertz. The default
|
|
value is 1.0 Hertz.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.amplitude\fR float in
|
|
The output amplitude for signal generator \fIN\fR. If \fBoffset\fR is
|
|
zero, the outputs will swing from \-\fBamplitude\fR to +\fBamplitude\fR.
|
|
The default value is 1.00.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.offset\fR float in
|
|
The output offset for signal generator \fIN\fR. This value is added
|
|
directly to the output signal. The default value is zero.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.clock\fR bit out
|
|
The clock output. Bit type clock signal output at the commanded
|
|
frequency.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.square\fR float out
|
|
The square wave output. Positive while \fBtriangle\fR and \fBcosine\fR
|
|
are ramping upwards, and while \fBsine\fR is negative.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.sine\fR float out
|
|
The sine output. Lags \fBcosine\fR by 90 degrees.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.cosine\fR float out
|
|
The cosine output. Leads \fBsine\fR by 90 degrees.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.triangle\fR float out
|
|
The triangle wave output. Ramps up while \fBsquare\fR is positive, and
|
|
down while \fBsquare\fR is negative. Reaches its positive and negative
|
|
peaks at the same time as \fBcosine\fR.
|
|
.TP
|
|
\fBsiggen.\fIN\fB.sawtooth\fR float out
|
|
The sawtooth output. Ramps upwards to its positive peak, then instantly
|
|
drops to its negative peak and starts ramping again. The drop occurs
|
|
when \fBtriangle\fR and \fBcosine\fR are at their positive peaks, and
|
|
coincides with the falling edge of \fBsquare\fR.
|
|
|
|
.SH PARAMETERS
|
|
.P
|
|
None
|
|
|