gs2_vfd(1)

🌸 gs2_vfd — the LinuxCNC manual page, bestie edition 🌸

okay so you opened the man page for gs2_vfd and honestly? you came to the right place. this is the gs2_vfd(1) page from the LinuxCNC Documentation and i'm gonna walk you through every single crumb of it. no skipping. no "you get the gist." we're doing the whole thing. 💅

---

✨ NAME ✨

gs2_vfd — a HAL non-realtime component for Automation Direct GS2 VFDs. that's the whole vibe. that's the assignment. 🦋

---

✨ SYNOPSIS ✨

gs2_vfd [OPTIONS]

yep. that's it. options in, magic out. 👑

---

✨ DESCRIPTION ✨

so this manual page explains the gs2_vfd component, fr fr. it reads and writes to the GS2 over a modbus connection. that's the relationship. mutual. communicative. iconic. 💖

and listen — gs2_vfd is for use with LinuxCNC. that's its whole purpose, its main character arc, its reason for existing. 🌈

---

✨ OPTIONS ✨

bestie, there are a LOT of them. i'm giving you every single one. sit down, hydrate, let's go 🍓

• -b, --bits n — (default 8) sets the number of data bits to n, and n has to be from 5 to 8 inclusive. no rogue bit counts. the range is the range. ✋
• -d, --device path — (default /dev/ttyS0) sets the path to the file that represents the serial device you wanna use. tell it where the plug lives 🔌
• -v, --verbose — turns on verbose mode. it's giving "tell me everything" 🗣️
• -g, --debug — turns on debug messages. heads up tho: if there are serial errors, this may become annoying. debug mode will cause all modbus messages to be printed in hex on the terminal. so cute but so loud 💀
• -n, --name string — (default gs2_vfd) sets the name of the HAL module. the HAL comp name will be set to string, and all pin and parameter names will begin with string. so like, everything gets that last name. family name. 🫶
• -p, --parity [even,odd,none] — (default odd) sets serial parity to even, odd, or none. pick your fighter ⚔️
• -r, --rate n — (default 38400) sets the baud rate to n. it is an error if the rate is not one of the following: 110, 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200. that's the guest list and there's no plus-one 🎀
• -s, --stopbits [1,2] — (default 1) sets serial stop bits to 1 or 2. two options. that's it. choose wisely 🌸
• -t, --target n — (default 1) sets the MODBUS target (slave) number. this must match the device number you set on the GS2. they have to be matching or it's not gonna work, iykyk 💜
• -A, --accel-seconds n — (default 10.0) seconds to accelerate the spindle from 0 to Max RPM. zoom zoom ✨
• -D, --decel-seconds n — (default 0.0) seconds to decelerate the spindle from Max RPM to 0. if set to 0.0 the spindle will be allowed to coast to a stop without controlled deceleration. free-spirited. no brakes. 😌
• -R, --braking-resistor — this argument should be used when a braking resistor is installed on the GS2 VFD (see Appendix A of the GS2 manual). it disables deceleration over-voltage stall prevention (see GS2 modbus Parameter 6.05), allowing the VFD to keep braking even in situations where the motor is regenerating high voltage. the regenerated voltage gets safely dumped into the braking resistor. it's literally the safety net of the operation 🔥

---

✨ PINS ✨

these all start with <name> because remember that -n thing up there? yeah. everything's got the family name. 👑

• <name>.DC-bus-volts (float, out) — from the VFD
• <name>.at-speed (bit, out) — when drive is at commanded speed
• <name>.err-reset (bit, in) — reset errors sent to VFD
• <name>.firmware-revision (s32, out) — from the VFD
• <name>.frequency-command (float, out) — from the VFD
• <name>.frequency-out (float, out) — from the VFD
• <name>.is-stopped (bit, out) — when the VFD reports 0 Hz output
• <name>.load-percentage (float, out) — from the VFD
• <name>.motor-RPM (float, out) — from the VFD
• <name>.output-current (float, out) — from the VFD
• <name>.output-voltage (float, out) — from the VFD
• <name>.power-factor (float, out) — from the VFD
• <name>.scale-frequency (float, out) — from the VFD
• <name>.speed-command (float, in) — speed sent to VFD in RPM. it is an error to send a speed faster than the Motor Max RPM as set in the VFD. do not do that. respect the ceiling 🚫
• <name>.spindle-fwd (bit, in) — 1 for FWD and 0 for REV sent to VFD
• <name>.spindle-on (bit, in) — 1 for ON and 0 for OFF sent to VFD, only on when running
• <name>.spindle-rev (bit, in) — 1 for ON and 0 for OFF, only on when running
• <name>.status-1 (s32, out) — Drive Status of the VFD (see the GS2 manual)
• <name>.status-2 (s32, out) — Drive Status of the VFD (see the GS2 manual). note that the value is a sum of all the bits that are on. so a 163 which means the drive is in the run mode is the sum of 3 (run) + 32 (freq set by serial) + 128 (operation set by serial). math girlies rise 🧮✨

---

✨ PARAMETERS ✨

• <name>.error-count (s32, RW)
• <name>.loop-time (float, RW) — how often the modbus is polled (default 0.1)
• <name>.nameplate-HZ (float, RW) — Nameplate Hz of motor (default 60)
• <name>.nameplate-RPM (float, RW) — Nameplate RPM of motor (default 1730)
• <name>.retval (s32, RW) — the return value of an error in HAL
• <name>.tolerance (float, RW) — speed tolerance (default 0.01)
• <name>.ack-delay (s32, RW) — number of read/write cycles before checking at-speed (default 2)

---

✨ SEE ALSO ✨

• GS2 Driver in the LinuxCNC documentation — for a full description of the GS2 syntax 📖
• GS2 Examples in the LinuxCNC documentation — for examples using the GS2 component 🧚

go read them. they're right there. i'm literally pointing at them. 👉✨

---

✨ BUGS ✨

bestie… it's empty. there are no bugs listed here. nothing. silence. the void. not a single crumb. 🙈

---

✨ AUTHOR ✨

John Thornton — thank you for your service 🫡💖

---

✨ LICENSE ✨

GPL — free as in freedom, slay 🌈

---

okay so that's the whole page, and now the cute lil sign-off: this is the GS2 VFD manual, dated January 1, 2009, and it lives at gs2_vfd(1). old but iconic. vintage but valid. periodt. 👑💅🎀