ONESHOT(9)

✨ ONESHOT ✨ (that's oneshot(9) bestie, HAL Component energy 💅)

okay so picture this: you need a pulse. a little blip. a moment of YES that goes away again. that's literally what oneshot is for and it's giving icon behavior 🎀

---

🌸 NAME 🌸

oneshot — one-shot pulse generator 🫶

✨ SYNOPSIS ✨

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

💖 DESCRIPTION 💖

So basically oneshot creates a variable-length output pulse when the input changes state. That's the whole vibe. Input wiggles → output pulses → output chills out again. 🦋

Here's the tea tho, no cap: this function needs to run in a thread which supports floating point — typically the servo thread. and because of that, the pulse length has to be a multiple of that thread period, typically 1mS. so like, your pulse can't be whatever cute arbitrary number you want, it's gotta land on the grid bestie 😭

If you want something similar that can run in the base thread, and that also offers higher resolution, go look at "edge" instead. she's right there. she's a whole different girl. 🔥

---

⭐ FUNCTIONS ⭐

• oneshot.N — this one requires a floating-point thread (remember what we said 💅). what does it do? it produces output pulses from input edges. that's it. that's the function. ate and left no crumbs 👑

---

🎀 PINS 🎀

• oneshot.N.in bit in — the trigger input. poke it, that's the whole job 🍓
• oneshot.N.reset bit in — reset. hits the little undo button 🫧
• oneshot.N.out bit out — active high pulse ✨
• oneshot.N.out-not bit out — active low pulse (the mirror twin, the inverse icon 💜)
• oneshot.N.width float in (default: 0) — pulse width in seconds. this is the how-long-is-my-pulse dial 🌈
• oneshot.N.time-left float out — time left in the current output pulse. like a countdown but make it wires 🕐

---

💜 PARAMETERS 💜

• oneshot.N.retriggerable bit rw (default: TRUE) — allow additional edges to extend the pulse. more edges, longer vibe, obsessed 🌀
• oneshot.N.rising bit rw (default: TRUE) — trigger on rising edge 📈
• oneshot.N.falling bit rw (default: FALSE) — trigger on falling edge 📉

lowkey important: rising defaults to TRUE and falling defaults to FALSE, so out of the box she only listens to rising edges. flip falling on if you want her paying attention on the way down too. 👀

---

👑 AUTHOR 👑

John Kasunich — ty for your service king 🫡

🌈 LICENSE 🌈

GPL — free as in freedom, slay 🧚

---

and that's the whole page bestie, you're so welcome 💖

this was ONESHOT(9) from the HAL Component section of the LinuxCNC Documentation, dated 2026-03-17 — mwah, go build something cute with it ✨🎀