_command

Functions to command the GRBL device.

The grbl device command functions

class grbl_ros._command.command[source]

Command class to hold all command functions for the grbl device class.

send(gcode)[source]

Send some specified GCODE to the GRBL machine.

Args:

gcode (str): GCODE string to send

Return:

str: response of GRBL device to GCODE

shutdown()[source]

Shutdown the GRBL machine.

startup(machine_id, port, baud, acc, maxx, maxy, maxz, spdf, spdx, spdy, spdz, stepsx, stepsy, stepsz)[source]

Startup the GRBL machine with the specified parameters.

Args:

self (obj): the grbl object machine_id (str): the name of the machine port (str): the serial port that connects to the grbl device baud (int): the baud rate to use for serial communication with the grbl device acc (int): the grbl device axis acceleration (mm/s^2) maxx (int): workable travel of the grbl device for its x axis (mm) maxy (int): workable travel of the grbl device for its y axis (mm) maxz (int): workable travel of the grbl device for tts z axis (mm) spdf (int): default speed of the grbl device (mm/min) spdx (int): maximum speed for x axis (mm/min) spdy (int): maximum speed for y axis (mm/min) spdz (int): maximum speed for z axis (mm/min) stepsx (int): number of steps per mm for x axis (steps) stepsy (int): number of steps per mm for y axis (steps) stepsz (int): number of steps per mm for z axis (steps)

stream(fpath)[source]

Send an entire file of GCODE commands to the GRBL machine.

Args:

fpath (str): filepath to GCODE (.nc, .gcode) file to send

Return:

str: status of sending the file