SIM_HOME_SWITCH(9)

📦
version 2.9.4 · 4 versions
, in ubuntu resolute, ubuntu stonking

✨ SIM_HOME_SWITCH(9) ✨

okay bestie, gather round 💖 this is a HAL Component man page, and it's literally called sim_home_switch — the Home switch simulator. Yes queen, it fakes a home switch for you so you can play with your motion setup without, like, real hardware drama. 🎀

🌸 NAME 🌸

sim_home_switch — Home switch simulator

No cap, that's the whole name. Short, sweet, iconic. 💅

🦋 SYNOPSIS 🦋

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

That's your whole entrance. Load it with count=N if you want a bunch of them, or names=name1[,name2...] if you're that girl who names her instances. 👑

💜 DESCRIPTION 💜

So here's the vibe: once the home switch gets tripped, you have to travel back the other way before it'll un-trip. How far back? That's set by the hysteresis pin — it's the backoff distance, and it's non-negotiable, fr fr. 🚶♀️

There's also a pin called index-enable given to you for when [JOINT_n]HOME_USE_INDEX is specified — its whole job is to reset the I/O pin joint.N.index-enable. She's a little helper. She's doing her best. 🫶

🔥 FUNCTIONS 🔥

  • sim-home-switch.N — requires a floating-point thread ⚠️ like, do not try to run her on an integer thread, she will simply not go.

💅 PINS 💅

  • sim-home-switch.N.cur-pos float in — the current position. Typically you feed her joint.n.motor-pos-fb. She wants the tea on where you actually are. 📍
  • sim-home-switch.N.home-pos float in (default: 1) — the home switch position. Where home lives. 🏠
  • sim-home-switch.N.hysteresis float in (default: 0.1) — travel required to backoff (hysteresis). How far you gotta scoot back before she's chill again. 😌
  • sim-home-switch.N.home-sw bit out — home switch activated. She's giving "yes, we're home." 💖
  • sim-home-switch.N.index-enable bit io — typ: connect to joint.N.index-enable. Your little reset gremlin, as promised. ✨
  • sim-home-switch.N.index-delay-ms float in (default: 10) — delay in msec to reset index-enable. She waits 10 whole milliseconds before doing the thing. Patience is a virtue, bestie. ⏳

👑 AUTHOR 👑

Dewey Garrett

(one person. one legend. that's the whole author page, and honestly? slay.)

🌈 LICENSE 🌈

GPL

that's GNU General Public License, and yes, you should read the actual license text if you're gonna go around redistributing her. not me being legally responsible for your copy-paste decisions 😭

okay so that's the whole page — congrats, you now understand sim_home_switch better than 90% of people who have it compiled into their machine 💀✨ this was documented by the LinuxCNC Documentation crew, and this particular version is dated 2026-03-17. go forth and home your axes, bestie, i'm obsessed with you 🎀💖🦋

📦 where this page comes from