python_to_grbl

A simple open-source python 🐍 to grbl 🤖 sender || Controlling 3-axis GRBL/CNC/gcode machines with python over a serial/usb connection that waits for completion of movement before sending the next command

https://github.com/sam-freitas/python_to_grbl

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary

Keywords

cnc cnc-controller cnc-programming grbl grbl-control grbl-firmware grblhal matlab motion-control python python-3 python-ioc
Last synced: 6 months ago · JSON representation ·

Repository

A simple open-source python 🐍 to grbl 🤖 sender || Controlling 3-axis GRBL/CNC/gcode machines with python over a serial/usb connection that waits for completion of movement before sending the next command

Basic Info
  • Host: GitHub
  • Owner: Sam-Freitas
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 18.2 MB
Statistics
  • Stars: 30
  • Watchers: 3
  • Forks: 10
  • Open Issues: 0
  • Releases: 0
Topics
cnc cnc-controller cnc-programming grbl grbl-control grbl-firmware grblhal matlab motion-control python python-3 python-ioc
Created about 4 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation

README.md

Controlling GRBL/CNC/gcode machines with python or MATLAB

This simple implementation is an example of how to contol CNC machines running GRBL with python

This script converts the supplied .gcode into movement without the use of a dedicated controlling application (e.g. CNCjs, OpenbuildsCONTROL, etc)

I built this becuase a lot of the documentation for sending a stream of gcode to a grbl controller was written in python2 and no longer worked with python3 syntax. Additionally, many of the implementations did not buffer or wait for commands to finish before going onto the next, my script is an attempt to fix these issues

All tweaking and setup of the grbl controller should be done in an outside program (I recommend CNCjs), all this script does is read grbl_test.gcode and feeds each individual line to the grbl controller, waits for completion of said line, and then moves onto the next line of gcode.


How to use:

install python prerequisites python -m pip install pyserial

You most likely will have to change the COM port in simple_stream.py (or .m) to the associated port (Correct port can be found in an external CNC control software ex. CNCjs).

Note: Linux/Max COM ports have a different name and path type than windows com ports

run:

python simple_stream.py


tested on:

MacOs (M1 Monterey arm64) Python 3.9.5 | packaged by conda-forge | (default, Jun 19 2021, 00:24:55) [Clang 11.1.0 ] on darwin Vscode 1.62.3 Openbuilds BlackBox GRBL controller GRBL 1.1

Alt Text

Owner

  • Name: Samuel "Sam" Freitas
  • Login: Sam-Freitas
  • Kind: user
  • Location: Tucson, Arizona
  • Company: University of Arizona

R&D Engineer at the University of Arizona studying the biology of aging || Robotics || AI || Data science || Biology ||

Citation (CITATION.cff)

cff-version: 1.2.0
title: python_to_GRBL
message: Please Cite if Used
type: software
authors:
  - given-names: Samuel
    family-names: Freitas
    email: samfreitas@arizona.edu
    name-particle: Samuel
    affiliation: University of Arizona
    orcid: 'https://orcid.org/0000-0002-9129-4715'
repository-code: 'https://github.com/Sam-Freitas/python_to_GRBL'
abstract: This simple implementation is an example of how to contol CNC machines running GRBL with python. This script converts the supplied .gcode into movement without the use of a dedicated controlling application (e.g. CNCjs, OpenbuildsCONTROL, etc). I built this becuase a lot of the documentation for sending a stream of gcode to a grbl controller was written in python2 and no longer worked with python3 syntax. Additionally, many of the implementations did not buffer or wait for commands to finish before going onto the next, my script is an attempt to fix these issues. All tweaking and setup of the grbl controller should be done in an outside program (I recommend CNCjs), all this script does is read grbl_test.gcode and feeds each individual line to the grbl controller, waits for completion of said line, and then moves onto the next line of gcode
keywords:
  - CNC control
  - GRBL
  - python-robotics
license: GPL-3.0
commit: Beta release
version: '0.1'
date-released: '2021-12-1'

GitHub Events

Total
  • Watch event: 8
  • Fork event: 1
Last Year
  • Watch event: 8
  • Fork event: 1