blob: 5b17a6b977757db5d51ca6a48de3087bcfcf217c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
.TH SUPPLY "9" "2007-01-16" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..
.SH NAME
supply \- set output pins with values from parameters (obsolete)
.SH SYNOPSIS
\fBloadrt supply num_chan=\fInum\fR
.SH DESCRIPTION
\fBsupply\fR was used to allow the inputs of other HAL components
to be manipulated for testing purposes. When it was written, the
only way to set the value of an input pin was to connect it to a
signal and connect that signal to an output pin of some other
component, and then let that component write the pin value.
\fBsupply\fR was written to be that "other component". It reads
values from parameters (set with the HAL command \fBsetp\fR) and
writes them to output pins.
Since \fBsupply\fR was written, the \fBsetp\fR command has been
modified to allow it to set unconnected pins as well as parameters.
In addition, the \fBsets\fR command was added, which can directly
set HAL signals, as long as there are no output pins connected to
them. Therefore, \fBsupply\fR is obsolete.
.P
\fBsupply\fR supports a maximum of eight channels. The number of
channels actually loaded is set by the \fBnum_chan\fR argument when
the module is loaded. If \fBnumchan\fR is not specified, the default
value is one.
.SH FUNCTIONS
.TP
\fBsupply.\fIN\fB.update\fR (uses floating-point)
Updates output pins for channel \fIN\fR.
.SH PINS
.TP
\fBsupply.\fIN\fB.q\fR bit out
Output bit, copied from parameter \fBsupply.\fIN\fB.d\fR.
.TP
\fBsupply.\fIN\fB._q\fR bit out
Output bit, inverted copy of parameter \fBsupply.\fIN\fB.\fBd\fR.
.TP
\fBsupply.\fIN\fB.variable\fR float out
Analog output, copied from parameter \fBsupply.\fIN\fB.value\fR.
.TP
\fBsupply.\fIN\fB._variable\fR float out
Analog output, equal to -1.0 times parameter \fBsupply.\fIN\fB.value\fR.
.TP
\fBsupply.\fIN\fB.d\fR bit rw
Data source for \fBq\fR and \fB_q\fR output pins.
.TP
\fBsupply.\fIN\fB.value\fR bit rw
Data source for \fBvariable\fR and \fB_variable\fR output pins.
|
