PyGrbl_Streamer 1.0.0

Stream G-code to GRBL controllers over serial, with progress callbacks, pause/resume/stop and configurable connections. Files and generators are consumed lazily, keeping memory use low.

Used daily for a year in a professional workshop, operating multiple machines in production.

Requires Python 3.10+. Part of the pygrbl family alongside pygrbl_build.

Install

pip install pygrbl-streamer

Use

from pygrbl_streamer import GrblStreamer

with GrblStreamer("/dev/ttyUSB0") as laser:  # "COM3" on Windows
    laser.progress_callback = lambda percent, command: print(f"{percent}%")
    if not laser.send_file("job.gcode"):
        raise RuntimeError("Job did not complete")

This executes the file on the machine. Default connection: 115200 baud, soft reset and automatic unlock. Existing 0.2.0 calls remain supported; new connection options are optional.

Documentation

• Connections, retries and controller compatibility
• Streaming, progress and job control
• API, callbacks and state
• Versioning and publishing
• Changelog

MIT — see LICENSE.