marlin-lulzbot-laser/tests/gcodeSender.py

#!/usr/bin/python
#
# A tool to send a GCODE file to Marlin via a serial or USB connection.
#
# This tool can also exercise error correction and recovery in Marlin by
# corrupting a fraction of the GCODE packets that are sent.
#

#
# (c) 2017 Aleph Objects, Inc.
#
# The code in this page is free software: you can
# redistribute it and/or modify it under the terms of the GNU
# General Public License (GNU GPL) as published by the Free Software
# Foundation, either version 3 of the License, or (at your option)
# any later version.  The code is distributed WITHOUT ANY WARRANTY;
# without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
#

from __future__ import print_function
from pyMarlin   import *

import argparse
import serial
import random
import sys

def load_gcode(filename):
  with open(filename, "r") as f:
    gcode = f.readlines()
  print("Read %d lines" % len(gcode))
  return gcode

def generate_synthetic_gcode():
  gcode = []
  non_acting_gcodes = ["G90", "G91", "G92 X0 Y0 Z0", "G92 X123 Y456", "M31", "M114", "M115", "M119"]
  for i in range(1, 10000):
    which = random.randrange(0,len(non_acting_gcodes))
    gcode.append(non_acting_gcodes[which])
  return gcode

def send_gcode_test(filename, serial):
  if filename == "TEST":
    gcode = generate_synthetic_gcode()
  else:
    gcode = load_gcode(filename)

  for i, line in enumerate(gcode):
    serial.sendCmdReliable(line)
    while(not serial.clearToSend()):
      serial.readline()
    if(i % 1000 == 0):
      print("Progress: %d" % (i*100/len(gcode)), end='\r')
      sys.stdout.flush()

parser = argparse.ArgumentParser(description='''sends gcode to a printer while injecting errors to test error recovery.''')
parser.add_argument('-p', '--port',   help='Serial port.', default='/dev/ttyACM1')
parser.add_argument('-f', '--fake',   help='Use a fake Marlin simulation instead of serial port, for self-testing.', action='store_false', dest='port')
parser.add_argument('-e', '--errors', help='Corrupt 1 out N lines written to exercise error recovery.', default='0', type=int)
parser.add_argument('-r', '--readerrors', help='Corrupt 1 out N lines read to exercise error recovery.', default='0', type=int)
parser.add_argument('-l', '--log',    help='Write log file.')
parser.add_argument('-b', '--baud',   help='Sets the baud rate for the serial port.', default='115000', type=int)
parser.add_argument('filename',       help='file containing gcode, or TEST for synthetic non-printing GCODE')
args = parser.parse_args()

print()

if args.port:
  print("Serial port: ", args.port)
  print("Baud rate:   ", args.baud)
  sio = serial.Serial(args.port, args.baud, timeout = 3, writeTimeout = 10000)
else:
  print("Using simulated Marlin device.")
  sio = FakeMarlinSerialDevice()

if args.readerrors:
  print("1 out of %d lines read will be corrupted." % args.readerrors)
  sio = NoisySerialConnection(sio)
  sio.setReadErrorRate(1, args.readerrors)

if args.log:
  print("Writing log file: ", args.log)
  sio = LoggingSerialConnection(sio, args.log)

if args.errors:
  print("1 out of %d lines written will be corrupted." % args.errors)
  sio = NoisySerialConnection(sio)
  sio.setWriteErrorRate(1, args.errors)

print()

def onResendCallback(line):
  print("Resending from: %d" % (line))
proto = MarlinSerialProtocol(sio, onResendCallback)
send_gcode_test(args.filename, proto)
proto.close()