Module `voxelfuse.gcode_tools`

Functions for manipulating gcode files

Expand source code

"""
Functions for manipulating gcode files

----

Copyright 2020 - Cole Brauer, Dan Aukes
"""

import numpy as np
from typing import List

def import_gcode(filename: str):
    """
    Import the lines of a gcode file to a list

    Args:
        filename: File name with extension
    
    Returns:
        List of gcode lines
    """
    file = open(filename, 'r')
    print("File opened: "+file.name)
    lines = file.readlines()
    file.close()
    return lines

def export(filename: str, lines: List[str]):
    """
    Export a list of strings to a gcode file.

    Args:
        filename: File name with extension
        lines: List of gcode lines
    
    Returns:
        None
    """
    file = open(filename, 'w')
    print("File created: "+file.name)
    file.writelines(lines)
    file.close()

def remove_to_string(gcode: List[str], string: str):
    """
    Remove all gcode commands before a specified comment string.

    find_voxels can be used before this command to add comments before the
    start of each voxel layer.

    Args:
        gcode: List of gcode lines
        string: Comment string to find
    
    Returns:
        None
    """
    for i in range(len(gcode)):
        if gcode[i][0] != ';':
            gcode[i] = ''
        elif (gcode[i] == string + '\n') or (gcode[i] == ';' + string + '\n'):
            break

def pause_before_voxel(gcode: List[str], voxel: int):
    """
    Insert a pause command (M601) before a specified voxel layer.

    Before using this command, use find_voxels to add comments before the start
    of each voxel layer.

    Args:
        gcode: List of gcode lines
        voxel: Voxel layer
    
    Returns:
        None
    """
    for i in range(len(gcode)):
        if gcode[i] == (';V' + str(voxel) + '\n'):
            gcode.insert(i, 'M601 ;Pause print\n')
            break

def find_voxels(gcode: List[str], voxel_size: float = 1):
    """
    Insert comments before each voxel layer.

    Voxels are determined based on the position of the Z-axis and the specified
    voxel dimension. Comments are formatted as follows:

    ``;V0``

    ``;Start of voxel 0``

    pause_before_voxel references the ``;V0`` line of the comment. This line can
    also be used with remove_to_string to remove initialization code before the
    first voxel layer.

    Args:
        gcode: List of gcode lines
        voxel_size: Size of voxels in mm
    
    Returns:
        None
    """
    voxel = 0

    for i in range(len(gcode)):
        z_index = gcode[i].find(" Z")
        if z_index != -1:
            z = float(gcode[i][z_index+2:-1])
            if z > voxel*voxel_size:
                gcode.insert(i, ';V' + str(voxel) + '\n')
                gcode.insert(i+1, ';Start of voxel ' + str(voxel) + '\n')
                voxel = voxel+1

Functions

def export(filename: str, lines: List[str])

Export a list of strings to a gcode file.

Args

filename: File name with extension
lines: List of gcode lines

Returns

None

Expand source code

def export(filename: str, lines: List[str]):
    """
    Export a list of strings to a gcode file.

    Args:
        filename: File name with extension
        lines: List of gcode lines
    
    Returns:
        None
    """
    file = open(filename, 'w')
    print("File created: "+file.name)
    file.writelines(lines)
    file.close()

def find_voxels(gcode: List[str], voxel_size: float = 1)

Insert comments before each voxel layer.

Voxels are determined based on the position of the Z-axis and the specified voxel dimension. Comments are formatted as follows:

;V0

;Start of voxel 0

pause_before_voxel references the ;V0 line of the comment. This line can also be used with remove_to_string to remove initialization code before the first voxel layer.

Args

gcode: List of gcode lines
voxel_size: Size of voxels in mm

Returns

None

Expand source code

def find_voxels(gcode: List[str], voxel_size: float = 1):
    """
    Insert comments before each voxel layer.

    Voxels are determined based on the position of the Z-axis and the specified
    voxel dimension. Comments are formatted as follows:

    ``;V0``

    ``;Start of voxel 0``

    pause_before_voxel references the ``;V0`` line of the comment. This line can
    also be used with remove_to_string to remove initialization code before the
    first voxel layer.

    Args:
        gcode: List of gcode lines
        voxel_size: Size of voxels in mm
    
    Returns:
        None
    """
    voxel = 0

    for i in range(len(gcode)):
        z_index = gcode[i].find(" Z")
        if z_index != -1:
            z = float(gcode[i][z_index+2:-1])
            if z > voxel*voxel_size:
                gcode.insert(i, ';V' + str(voxel) + '\n')
                gcode.insert(i+1, ';Start of voxel ' + str(voxel) + '\n')
                voxel = voxel+1

def import_gcode(filename: str)

Import the lines of a gcode file to a list

Args

filename: File name with extension

Returns

List of gcode lines

Expand source code

def import_gcode(filename: str):
    """
    Import the lines of a gcode file to a list

    Args:
        filename: File name with extension
    
    Returns:
        List of gcode lines
    """
    file = open(filename, 'r')
    print("File opened: "+file.name)
    lines = file.readlines()
    file.close()
    return lines

def pause_before_voxel(gcode: List[str], voxel: int)

Insert a pause command (M601) before a specified voxel layer.

Before using this command, use find_voxels to add comments before the start of each voxel layer.

Args

gcode: List of gcode lines
voxel: Voxel layer

Returns

None

Expand source code

def pause_before_voxel(gcode: List[str], voxel: int):
    """
    Insert a pause command (M601) before a specified voxel layer.

    Before using this command, use find_voxels to add comments before the start
    of each voxel layer.

    Args:
        gcode: List of gcode lines
        voxel: Voxel layer
    
    Returns:
        None
    """
    for i in range(len(gcode)):
        if gcode[i] == (';V' + str(voxel) + '\n'):
            gcode.insert(i, 'M601 ;Pause print\n')
            break

def remove_to_string(gcode: List[str], string: str)

Remove all gcode commands before a specified comment string.

find_voxels can be used before this command to add comments before the start of each voxel layer.

Args

gcode: List of gcode lines
string: Comment string to find

Returns

None

Expand source code

def remove_to_string(gcode: List[str], string: str):
    """
    Remove all gcode commands before a specified comment string.

    find_voxels can be used before this command to add comments before the
    start of each voxel layer.

    Args:
        gcode: List of gcode lines
        string: Comment string to find
    
    Returns:
        None
    """
    for i in range(len(gcode)):
        if gcode[i][0] != ';':
            gcode[i] = ''
        elif (gcode[i] == string + '\n') or (gcode[i] == ';' + string + '\n'):
            break