summaryrefslogtreecommitdiff
path: root/docs/src/hal/tools.txt
blob: d70c94c17f6656f22a8b3f4a29241acd5e5ced1a (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
= HAL Tools

[[cha:hal-tools]] (((HAL Tools)))

== Halcmd[[sec:Halcmd]]

Halcmd is a command line tool for manipulating the HAL. There is a
rather complete man page for halcmd, which will be installed if you
have installed LinuxCNC from either source or a package. If you have
compiled LinuxCNC for “run-in-place”, the man page is not installed, but it
is accessible. From the main LinuxCNC directory, do:

----
man -M docs/man halcmd
----

The <<cha:HAL-tutorial,HAL Tutorial>> has a number of examples of halcmd
usage, and is a good tutorial for halcmd.

== Halmeter[[sec:Halmeter]](((halmeter)))

Halmeter is a 'voltmeter' for the HAL. It lets you look at a pin,
signal, or parameter, and displays the current value of that item. It
is pretty simple to use. Start it by typing *halmeter* in an X 
windows shell. Halmeter is a GUI application. It will pop up
a small window, with two buttons labeled 'Select' and 'Exit'. Exit is
easy - it shuts down the program. Select pops up a larger window, with
three tabs. One tab lists all the pins currently defined in the HAL.
The next lists all the signals, and the last tab lists all the
parameters. Click on a tab, then click on a pin/signal/parameter. Then
click on 'OK'. The lists will disappear, and the small window will
display the name and value of the selected item. The display is updated
approximately 10 times per second. If you click 'Accept' instead of
'OK', the small window will display the name and value of the selected
item, but the large window will remain on the screen. This is
convenient if you want to look at a number of different items quickly.

You can have many halmeters running at the same time, if you want to
monitor several items. If you want to launch a halmeter without tying
up a shell window, type 'halmeter &' to run it in the background.
You can also make halmeter start 
displaying a specific item immediately, by adding 'pin|sig|par[am]
<name>' to the command line. It will display the pin, signal, or
parameter 
<name> as soon as it starts. (If there is no such item, it will simply
start normally.) And finally, if you specify an item to display, you
can add '-s' before the pin|sig|param to tell halmeter to use a small
window. The item name will be displayed in the title bar instead of
under the value, and there will be no buttons. Useful when you want a
lot of meters in a small amount of screen space.

Refer to <<sec:Tutorial-Halmeter,Halmeter Tutorial>> section for more
information.

Halmeter can be loaded from a terminal or from Axis. Halmeter is
faster than Halshow at displaying values. Halmeter has two windows, one
to pick the pin, signal, or parameter to monitor and one that displays
the value. Multiple Halmeters can be open at the same time. If you use
a script to open multiple Halmeters you can set the position of each
one with -g X Y relative to the upper left corner of your screen. 
For example: 

----
loadusr halmeter pin hm2.0.stepgen.00.velocity-fb -g 0 500
----

See the man page for more options. See section <<sec:Halmeter,Halmeter>>.
  
.Halmeter

image::images/hal-meter01.png[]

image::images/hal-meter02.png[]

== Halscope[[sec:Halscope]]

Halscope is an 'oscilloscope' for the HAL. It lets you capture the
value of pins, signals, and parameters as a function of time. Complete
operating instructions should be located here eventually. For now,
refer to section  <<sec:Tutorial-Halscope>> in the tutorial chapter,
which explains the basics.