LATENCY-HISTOGRAM(1)

💖 LATENCY-HISTOGRAM(1) 💖

okay bestie, so this is latency-histogram, part of The Enhanced Machine Controller — yes that's the LinuxCNC fam, you already know 👑

---

✨ NAME ✨

latency-histogram — plot a histogram of machine latency 🎀

---

🌸 SYNOPSIS 🌸

latency-histogram [-?|--help] [--base ns] [--servo ns] [--bbinsize ns]
[--sbinsize ns] [--bbins ns] [--sbins ns] [--logscale 0|1] [--text note]
[--show] [--nobase] [--verbose] [--nox]

---

🦋 DESCRIPTION 🦋

so like, the latency test is literally the moment when you're configuring a LinuxCNC system, right? it's giving main character energy fr. And latency-histogram is the bestie sidekick to the standard latency-test — instead of just vibing with one number, it plots the whole distribution of latency 📊✨. That's lowkey so useful because it lets you get a feel for how frequent those high-latency excursions actually are, and honestly, knowing that? iconic. 👑

heads up bestie 🚨 LinuxCNC and HAL should not be running. stop them with halrun -U first, no cap.

also, a big number of bins and/or tiny binsizes will slow updates down 😭 so keep that in mind. For a single thread, specify --nobase (plus the options for the servo thread). Measured latencies that land outside the +/- bin range get reported with special end bars 🌈. And if you wanna see the count for the off-chart [pos|neg] pin, use --show 👀.

More details? they're right here, go off: https://linuxcnc.org/docs/html/install/latency-test.html

---

💅 OPTIONS 💅

• -?, --help — shows you the options and then dips out. show options and exit. periodt. ✨
• --base ns — the base thread interval. default: 25000, min: 5000 ⏱️
• --servo ns — the servo thread interval. default: 1000000, min: 25000 🕰️
• --bbinsize ns — base bin size. default: 100 🍓
• --sbinsize ns — servo bin size. default: 100 🍓
• --bbins ns — base bins. default: 200 🧺
• --sbins ns — servo bins. default: 200 🧺
• --logscale 0|1 — y axis log scale. default: 1 📈
• --text note — an additional note. default: "" 📝
• --show — show count of undisplayed bins 👀
• --nobase — servo thread only, no base thread 💫
• --verbose — progress and debug, so you can see everything happening in real time 🐛
• --nox — no GUI. instead it displays elapsed, min, max, sdev for each thread 🖥️

---

👑 SEE ALSO 👑

• latency-plot(1)
• latency-test(1)
• linuxcnc(1)

And fr fr, there's so much more info about LinuxCNC and HAL in the LinuxCNC and HAL User Manuals, which you can find at /usr/share/doc/linuxcnc/ 📚💜

---

💀 BUGS 💀

None known at this time. (not me being shocked — slay, honestly 🎉)

---

🌈 AUTHOR 🌈

This man page written by andypugh, as part of the LinuxCNC project. 🫶

---

🚨 REPORTING BUGS 🚨

Report bugs at https://github.com/LinuxCNC/linuxcnc/issues — the devs wanna hear it, bestie 🐛➡️💌

---

💖 COPYRIGHT 💖

Copyright © 2020 andypugh.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. ⚠️ (yes, all caps, they mean it)

---

okay and that's a wrap! this was brought to you by LinuxCNC Documentation, dated 2021-08-14, and you're reading LATENCY-HISTOGRAM(1) — go plot that histogram, you absolute legend 💅✨🎀