HALMETER(1)

📦
version 2.9.4 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

✨ HALMETER(1) ✨

okay bestie, welcome to the HAL User's Manual glow-up 💅 this one's all about halmeter, and it's literally the cutest little spy for your HAL world. let's get into it 🫶

🌸 NAME 🌸

halmeter — observe HAL pins, signals, and parameters 👀✨

🎀 SYNOPSIS 🎀

halmeter [-s] [pin|sig|param name] [-g X-position Y-position [Width]]

that's it. that's the whole vibe. 🦋

💖 DESCRIPTION 💖

so halmeter is how you observe HAL (Hardware Abstraction Layer) pins, signals, or parameters. think of it as your multimeter but make it software — same energy as when you're poking around a physical system with an actual meter, except now you're doing it on screen and nobody's gonna get shocked 💀✨

🌈 OPTIONS 🌈

  • pin name — shows you the HAL pin called name. 🎯
  • sig name — shows you the HAL signal called name. 📶
  • param name — shows you the HAL parameter called name. ⚙️
  • if you don't pass pin, sig, or param? no stress — the window just starts out blank and you get to pick what to watch. choose your own adventure, main character style 👑
  • -s — small window mode. this one is non-interactive, so it must be used together with pin, sig, or param to say what to display. the item name shows up in the title bar instead of in the window, and there are no "Select" or "Exit" buttons. super handy when you want a whole army of meters crammed into a tiny space 🐜🐜🐜
  • -g — geometry position. lets you set the initial starting position, and optionally the width of the meter too. it's referenced from the top left of the screen in pixel units. chef's kiss when you're loading a bunch of meters from a script and you do NOT want them all stacking on top of each other 🙈

💅 USAGE 💅

unless you passed \-s, you get two buttons: "Select" and "Exit".

  • "Select" opens a dialog box so you can pick the item (pin, signal, or parameter) to be observed.
  • "Exit" does exactly what you think it does. iconic behaviour, no notes. ✨

the selection dialog itself has "OK", "Apply", and "Cancel" buttons:

  • "OK" displays the selected item and closes the dialog. done and dusted 🎀
  • "Apply" displays the selected item but keeps the selection dialog open. stay a while, bestie 🫶
  • "Cancel" closes the dialog without changing the displayed item. no take-backs, just no changes 💜

🔥 EXAMPLES 🔥

halmeter

opens a meter window with nothing initially displayed. hit the "Select" button to choose an item to observe. does not return until the window is closed. it's committed, fr fr 😭

halmeter &

opens a meter window with nothing initially displayed. use "Select" to choose an item. runs in the background, leaving your shell free for other commands. multitasking queen 👑

halmeter pin parport.0.pin-03-out &

opens a meter window that's initially displaying HAL pin parport.0.pin-03-out. the "Select" button can still be used to display other items. runs in the background. 🌈

halmeter -s pin parport.0.pin-03-out &

opens a small meter window, displaying HAL pin parport.0.pin-03-out. the displayed item cannot be changed. runs in the background. locked in 🔒

halmeter -s pin parport.0.pin-03-out -g 100 500 &

opens a small meter window displaying HAL pin parport.0.pin-03-out, and places it 100 pixels to the left and 500 pixels down from the top of the screen. the displayed item cannot be changed. runs in the background. 📍

halmeter -s pin parport.0.pin-03-out -g 100 500 400 &

opens a small meter window displaying HAL pin parport.0.pin-03-out, places it 100 pixels to the left and 500 pixels down from the top of the screen, and the width will be 400 pixels (270 is the default). the displayed item cannot be changed. runs in the background. custom sizing era 🎀

👑 AUTHOR 👑

original version by John Kasunich, as part of the LinuxCNC project. improvements by several other members of the LinuxCNC development team. we stan a collaborative glow-up 💖

💀 REPORTING BUGS 💀

found a bug? report it at https://github.com/LinuxCNC/linuxcnc/issues — do NOT suffer in silence bestie, the devs wanna know 🐛

Copyright © 2003 John Kasunich.

this is free software; see the source for copying conditions. there is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

ngl that warranty disclaimer is giving "you're on your own" but in a legally responsible way 😭

and that's the whole page, bestie!! this was the LinuxCNC Documentation version of halmeter, dated 2006-03-13, filed under HALMETER(1) — go forth and observe some pins, you absolute legend 💅✨🫶

📦 where this page comes from