XHC_HB04_UTIL(9)

💖 xhc_hb04_util 💖

okay bestie, welcome to xhc_hb04_util — a HAL component from the LinuxCNC docs, and honestly? she's a little convenience queen. the manual name is XHC_HB04_UTIL(9) and yes the (9) means kernel/HAL-component territory, iykyk 🎀

---

✨ SYNOPSIS ✨

loadrt xhc_hb04_util [count=N|names=name1[,name2...]]

---

🌸 DESCRIPTION 🌸

so what does she actually do? two main character jobs:

1. she provides the logic for a start/pause button 🔥
2. she's an interface to halui.program.is_paused, is_idle, is_running so she can generate the outputs for halui.program.pause, resume, and run 💅

she also comes with 4 simple lowpass filters, each with coef and scale pins. about those coef values, bestie: the coef value should be 0 <= coef <= 1, and smaller coef values slow the response down. if you wanna do the math on the filter time constant, go check the lowpass manpage ($ man lowpass) — she's not gonna do it for you 🦋

---

🧚 FUNCTIONS 🧚

• xhc-hb04-util.N — requires a floating-point thread ⭐

---

👑 PINS 👑

ins and outs, the whole vibe

• xhc-hb04-util.N.start-or-pause — bit in
• xhc-hb04-util.N.is-paused — bit in
• xhc-hb04-util.N.is-idle — bit in
• xhc-hb04-util.N.is-running — bit in
• xhc-hb04-util.N.pause — bit out
• xhc-hb04-util.N.resume — bit out
• xhc-hb04-util.N.run — bit out
• xhc-hb04-util.N.in0 — s32 in
• xhc-hb04-util.N.in1 — s32 in
• xhc-hb04-util.N.in2 — s32 in
• xhc-hb04-util.N.in3 — s32 in
• xhc-hb04-util.N.out0 — s32 out
• xhc-hb04-util.N.out1 — s32 out
• xhc-hb04-util.N.out2 — s32 out
• xhc-hb04-util.N.out3 — s32 out
• xhc-hb04-util.N.scale0 — float in (default: 1.0)
• xhc-hb04-util.N.scale1 — float in (default: 1.0)
• xhc-hb04-util.N.scale2 — float in (default: 1.0)
• xhc-hb04-util.N.scale3 — float in (default: 1.0)
• xhc-hb04-util.N.coef0 — float in (default: 1.0)
• xhc-hb04-util.N.coef1 — float in (default: 1.0)
• xhc-hb04-util.N.coef2 — float in (default: 1.0)
• xhc-hb04-util.N.coef3 — float in (default: 1.0)
• xhc-hb04-util.N.divide-by-k-in — float in
• xhc-hb04-util.N.divide-by-k-out — float out
• xhc-hb04-util.N.k — float in (default: 1.0)

---

🫶 AUTHOR 🫶

Dewey Garrett — we stan 🙌

---

📜 LICENSE 📜

GPL — free as in slay 💜

---

and that's the whole page, bestie!! this was LinuxCNC Documentation, dated 2026-03-17, and the page itself is XHC_HB04_UTIL(9). go wire up those buttons, icon 💅✨🌸