SIGGEN(9)

💖 SIGGEN(9) — HAL Component 💖

okay bestie, welcome to siggen, the signal generator of your dreams ✨ it lives in the HAL component family and it's literally the moment 🎀

---

✨ NAME ✨

siggen — a signal generator, periodt 💅

---

🌸 SYNOPSIS 🌸

loadrt siggen [num_chan=num | names=name1[,name2...]]

---

🦋 DESCRIPTION 🦋

so siggen is a signal generator, right? and it's the girl for testing and any other application that just needs some simple waveforms 🫶. it makes sine, cosine, triangle, sawtooth, and square waves — with variable frequency, amplitude, and offset — and you can feed all of that into other HAL components. it's giving "utility icon" ngl 👑

siggen supports a maximum of sixteen channels. how many actually get loaded? that's set by the num_chan argument when you load the module 🧚 alternatively, you can specify names= and hand it unique names separated by commas.

lowkey important: num_chan= and names= are mutually exclusive, bestie. pick one. and if you specify neither num_chan= nor names=? the default value is one. one channel. that's it. 💀

---

💜 NAMING 💜

the names for pins, parameters, and functions get prefixed like this:

• siggen.N. for N=0,1,...,num-1 when you're using num_chan=num
• nameN. for nameN=name1,name2,... when you're using names=name1,name2,...

and the siggen.N. format is the one shown in all the descriptions below, so keep that in mind 👇

---

⭐ FUNCTIONS ⭐

• siggen.N.update (uses floating-point) — updates the output pins for signal generator N. every single time it's called it calculates a new sample ✨ it should be called many times faster than the desired signal frequency, to avoid distortion and aliasing. no cap, call it fast or the waveform gets messy 😭

---

🎀 PINS 🎀

• siggen.N.frequency float in — the output frequency for signal generator N, in Hertz. the default value is 1.0 Hertz.
• siggen.N.amplitude float in — the output amplitude for signal generator N. if offset is zero, the outputs will swing from -amplitude to +amplitude. the default value is 1.00.
• siggen.N.offset float in — the output offset for signal generator N. this value is added directly to the output signal. the default value is zero.
• siggen.N.reset bit in — resets the output pins to pretermined states:
  • sine — 0
  • sawtooth — 0
  • square — -1 * amplitude
  • cosine — -1 * amplitude
  • triangle — -1 * amplitude
• siggen.N.clock bit out — the clock output. a bit type clock signal output at the commanded frequency ⏰
• siggen.N.square float out — the square wave output. it's positive while triangle and cosine are ramping upwards, and while sine is negative.
• siggen.N.sine float out — the sine output. it lags cosine by 90 degrees.
• siggen.N.cosine float out — the cosine output. it leads sine by 90 degrees.
• siggen.N.triangle float out — the triangle wave output. ramps up while square is positive, and down while square is negative. it reaches its positive and negative peaks at the same time as cosine 📈📉
• siggen.N.sawtooth float out — the sawtooth output. ramps upwards to its positive peak, then instantly drops to its negative peak and starts ramping again 🪚 the drop occurs when triangle and cosine are at their positive peaks, and it coincides with the falling edge of square.

---

🌈 PARAMETERS 🌈

None. nothing. zero. empty. the void. 🙈

---

that's the whole vibe check bestie, go make some waves 🌊💖

LinuxCNC Documentation · 2007-01-16 — mwah, xoxo, go slay some HAL 🫶✨