SUPPLY(9)

πŸ’– SUPPLY(9) β€” HAL Component πŸ’–

okay bestie, gather round, because we're talking about supply, a HAL component whose whole job is set output pins with values from parameters ✨ … and also it's obsolete πŸ™ˆ so like, read this for the lore but don't go making it your whole personality.


✨ SYNOPSIS ✨

loadrt supply num_chan=num

that's it, that's the summoning ritual πŸ•―οΈ


🌸 DESCRIPTION 🌸

so back in the day, supply was the girl who let you mess with the inputs of other HAL components for testing purposes πŸ§ͺ. like, at the time it was written, the ONLY way to set the value of an input pin was to connect it to a signal, connect that signal to an output pin of some other component, and then let that component write the pin value. and supply was literally written to BE that "other component" πŸ’…. it reads values from parameters (which you set with the HAL command setp) and writes them straight to output pins. iconique behavior.

BUT. plot twist 🎬. since supply was written, the setp command got modified so it can set unconnected pins as well as parameters. plus the sets command got added, which can directly set HAL signals β€” as long as there are no output pins connected to them πŸ‘€. so yeah… therefore, supply is obsolete. it's giving retired diva, and honestly, respect.

also important: supply supports a maximum of eight channels. the number of channels actually loaded is set by the num_chan argument when the module is loaded. and if numchan is not specified, the default value is one. (yes bestie, one. lonely little channel πŸ₯Ί)


⚑ FUNCTIONS ⚑

  • supply.N.update (uses floating-point) β€” updates output pins for channel N. do it, queen πŸ‘‘

πŸŽ€ PINS πŸŽ€

  • supply.N.q bit out β€” output bit, copied from parameter supply.N.d.
  • supply.N._q bit out β€” output bit, inverted copy of parameter supply.N.d. not like other girls, she's flipped πŸ’…
  • supply.N.variable float out β€” analog output, copied from parameter supply.N.value.
  • supply.N._variable float out β€” analog output, equal to -1.0 times parameter supply.N.value. negative queen 🌈
  • supply.N.d bit rw β€” data source for q and _q output pins.
  • supply.N.value bit rw β€” data source for variable and _variable output pins.

⚠️ real talk: this whole page is stamped obsolete, so if you're out here reaching for supply in a fresh config, maybe check setp / sets first, okay? i'm not saying don't, i'm saying iykyk πŸ’€

anyway bestie, that's the whole page, no cap, every last flag and pin accounted for 🫢 this iconic little relic came from the LinuxCNC Documentation, dated 2007-01-16, and it lives under SUPPLY(9) in the HAL Component section. mwah, go forth and configure responsibly πŸ’–βœ¨