Skip to content

Commit 4385731

Browse files
committed
docs: improve categories of some components
1 parent 82fd5ee commit 4385731

1 file changed

Lines changed: 42 additions & 32 deletions

File tree

docs/src/hal/components.adoc

Lines changed: 42 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[cha:hal-components]]
2-
:tab_options: cols="20s,80,0,0", frame="none", grid="none"
2+
:tab_options: cols="15s,85,0,0", frame="none", grid="none"
33

44
[[cha:hal-components]]
55
= HAL Component List((("HAL Component List")))
@@ -17,29 +17,55 @@ man axis (or perhaps 'man 1 axis' if your system requires it.)
1717
----
1818

1919

20+
=== User interface
21+
2022
[{tab_options}]
2123
|=======================
2224
| axis | AXIS LinuxCNC (The Enhanced Machine Controller) Graphical User Interface. ||
2325
| axis-remote | AXIS Remote Interface. ||
24-
| comp | Build, compile and install LinuxCNC HAL components. ||
2526
| gladevcp | Virtual Control Panel for LinuxCNC based on Glade, Gtk and HAL widgets. ||
27+
| gladevcp | Displays Virtual Control Panels built with GTK/Glade. ||
28+
| halui | Observe HAL pins and command LinuxCNC through NML. ||
29+
| pyvcp | Virtual Control Panel for LinuxCNC. ||
30+
31+
|=======================
32+
33+
=== Hardware Drivers
34+
35+
[{tab_options}]
36+
|=======================
2637
| gs2 | HAL userspace component for Automation Direct GS2 VFD's. ||
38+
| mb2hal | ||
39+
|=======================
40+
41+
=== Diagnostic and Configuration Tools
42+
43+
[{tab_options}]
44+
|=======================
45+
| halmeter | Observe HAL pins, signals, and parameters. ||
46+
| halshow |||
47+
| halscope |||
48+
|=======================
49+
50+
=== Other
51+
52+
[{tab_options}]
53+
|=======================
54+
| comp | Build, compile and install LinuxCNC HAL components. ||
2755
| halcmd | Manipulate the Enhanced Machine Controller HAL from the command line. ||
2856
| hal_input | Control HAL pins with any Linux input device, including USB HID devices. ||
29-
| halmeter | Observe HAL pins, signals, and parameters. ||
3057
| halrun | Manipulate the Enhanced Machine Controller HAL from the command line. ||
3158
| halsampler | Sample data from HAL in realtime. ||
3259
| halstreamer | Stream file data into HAL in real time. ||
33-
| halui | Observe HAL pins and command LinuxCNC through NML. ||
3460
| io | Accepts NML I/O commands, interacts with HAL in userspace. ||
3561
| iocontrol | Accepts NML I/O commands, interacts with HAL in userspace. ||
3662
| linuxcnc | LinuxCNC (The Enhanced Machine Controller). ||
37-
| pyvcp | Virtual Control Panel for LinuxCNC. ||
3863
| shuttle | control HAL pins with the ShuttleXpress and ShuttlePRO devices made by Contour Design. ||
3964
|=======================
4065

4166
[[sec:realtime-components]]
42-
== Realtime Components List
67+
68+
== Realtime Components
4369

4470
Some of these will have expanded descriptions from the man pages.
4571
Some will have limited descriptions. All of the components have man pages.
@@ -52,35 +78,17 @@ man motion
5278
man 9 motion
5379
----
5480

55-
[NOTE]
56-
If component requires a thread with a float, it is usually the slowest,
57-
thus _servo-thread_.
81+
See also the 'Man Pages' section of the link:../index.html[docs main page] or the
82+
link:../man/man9/[directory listing of man9].
5883

59-
[NOTE]
60-
See also the 'Man Pages' section of the link:../index.html[docs main page]
61-
or the link:../man/man9/[directory listing of man9].
62-
63-
[[sec:core-realtime-components]]
64-
=== Core LinuxCNC components
65-
[{tab_options}]
66-
|=======================
67-
| motion | Accepts NML motion commands, interacts with HAL in realtime. ||
68-
| axis | Accepts NML motion commands, interacts with HAL in realtime. ||
69-
| classicladder | Realtime software PLC based on ladder logic.
70-
See <<cha:classicladder,ClassicLadder>> chapter for more information. ||
71-
| gladevcp | Displays Virtual Control Panels built with GTK/Glade. ||
72-
| threads | Creates hard realtime HAL threads. ||
73-
|=======================
74-
75-
[[sec:Realtime-Components-logic]]
7684
=== Logic and Bitwise components
7785

78-
[{tab_options}]
86+
[cols="15s,85,0,0", frame="none", grid="none"]
7987
|=======================
80-
|and2|Two-input AND gate. For out to be true both inputs must be true. |link:../man/man9/and2.9.html[and2] |
81-
|not|Inverter|link:../man/man9/not.9.html[not] |
82-
|or2|Two-input OR gate|link:../man/man9/or2.9.html[or2] |
83-
|xor2|Two-input XOR (exclusive OR) gate|link:../man/man9/xor2.9.html[xor2] |
88+
| and2 | Two-input AND gate. For out to be true both inputs must be true. (link:../man/man9/and2.9.html[and2]) ||
89+
| not | Inverter ||
90+
| or2 | Two-input OR gate ||
91+
| xor2 | Two-input XOR (exclusive OR) gate ||
8492
| dbounce | Filter noisy digital inputs. link:../man/man9/dbounce.9.html[Details]. | |
8593
| debounce | Filter noisy digital inputs. link:../man/man9/debounce.9.html[Details]. <<sec:debounce, Description>> | |
8694
| edge | Edge detector. | |
@@ -95,6 +103,7 @@ See <<cha:classicladder,ClassicLadder>> chapter for more information. ||
95103

96104
[[sec:Realtime-Components-flottant]]
97105
=== Arithmetic and float-components
106+
98107
[{tab_options}]
99108
|=======================
100109
| abs | Compute the absolute value and sign of the input signal. | |
@@ -149,7 +158,6 @@ Limit its slew rate to less than maxv per second. Limit its second derivative to
149158
[[sec:Realtime-Components-pilotes]]
150159
=== Hardware Drivers
151160

152-
153161
[{tab_options}]
154162
|=======================
155163
| hal_ppmc | Pico Systems <<cha:pico-drivers,driver>> for analog servo, PWM and Stepper controller. ||
@@ -165,6 +173,7 @@ Limit its slew rate to less than maxv per second. Limit its second derivative to
165173

166174
[[sec:Realtime-Components-cinematiques]]
167175
=== Kinematics
176+
168177
[{tab_options}]
169178
|=======================
170179
| kins | kinematics definitions for LinuxCNC. ||
@@ -192,6 +201,7 @@ Limit its slew rate to less than maxv per second. Limit its second derivative to
192201
|=======================
193202

194203
=== BLDC and 3-phase motor control
204+
195205
[{tab_options}]
196206
|=======================
197207
| bldc_hall3 | 3-wire Bipolar trapezoidal commutation BLDC motor driver using Hall sensors. ||

0 commit comments

Comments
 (0)