LATENCY-PLOT(1)

πŸ’… latency-plot(1) β€” the manual, but make it cute

okay bestie, so this page lives in the The Enhanced Machine Controller manual set, and it's basically the ✨OG✨ little strip-chart girly for your latency numbers. Let's get into it.


🌸 NAME 🌸

latency-plot β€” another way to view latency numbers πŸ¦‹


✨ SYNOPSIS ✨

latency-plot [-?|--help] [-H|--hal] [-b|--base nS] [-s|--servo nS]
[-t|--time mS] [--relative] [--actual]

πŸŽ€ DESCRIPTION πŸŽ€

so latency-plot makes a strip chart recording for a base thread and a servo thread. two threads, one chart, iconic behaviour honestly. πŸ’–

it's lowkey useful for catching spikes in latency when you start up or use other applications. like, "who did this to my timing" and the answer is on the chart. πŸ“ˆ

⚠️ real talk though: it's mainly superseded by latency-histogram. still valid, just not the main character anymore. the newer one ate.

LinuxCNC and HAL should not be running when you use this. stop them first with halrun -U. no cap, please actually do this. πŸ›‘

want more details? they're at https://linuxcnc.org/docs/html/install/latency-test.html β€” go read, it's giving educational. πŸ“š


🫢 OPTIONS 🫢

  • -?, --help β€” shows you the options and then dips out. bye! πŸ‘‹
  • -H, --hal β€” okay so this one is listed with literally no description on the page. not me leaving it blank, the original is just mysterious like that. iykyk πŸ’€
  • -b, --base nS β€” the base thread interval. default: 25000 ⏱️
  • -s, --servo nS β€” the servo thread interval. default: 1000000 ⏱️
  • -t, --time mS β€” the report interval. default: 1000, min: 100, max: 10000. so stay in your lane between 100 and 10000, bestie 🚧
  • --relative β€” relative clock time. this is the default btw, so if you don't pick anything, you already picked this πŸ•°οΈ
  • --actual β€” actual clock time πŸ•°οΈ

🌈 SEE ALSO 🌈

and there's so much more info about LinuxCNC and HAL in the LinuxCNC and HAL User Manuals, which live at /usr/share/doc/linuxcnc/. go look, it's a whole vibe πŸ’œ


πŸ’€ BUGS πŸ’€

None known at this time. (yes fr fr, we're clean. periodt. ✨)


πŸ‘‘ AUTHOR πŸ‘‘

This man page written by andypugh, as part of the LinuxCNC project. thank you andypugh, you're the moment 🫢


πŸ™ˆ REPORTING BUGS πŸ™ˆ

found something cursed? report bugs at https://github.com/LinuxCNC/linuxcnc/issues β€” they want to know, bestie πŸ›


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.

🚨 like, genuinely NO warranty. none. zero. don't come for anybody if it breaks, that's the deal.

and that's the whole page!! 🌸 this one came out of the LinuxCNC Documentation, dated 2021-08-14 β€” and it's filed under LATENCY-PLOT(1) in the manual. mwah, go plot something pretty πŸ’…βœ¨