def test_trivial(self):
adc = axidraw_control.AxiDrawWrapperClass()
adc.getoptions([])
adc.options.preview = True # otherwise the actual plotting code is never run
adc.parseFile('test/assets/AxiDraw_trivial.svg')
adc.effect()
def test_version_check_without_machine(self):
''' connected to internet but not machine '''
adc = axidraw_control.AxiDrawWrapperClass()
# mocks
axidraw_control.axidraw.versions.get_versions_online = MagicMock(
return_value=versions.Versions("0", "1", "2"))
adc.getoptions([])
adc.options.mode = "sysinfo"
adc.parseFile('test/assets/AxiDraw_trivial.svg')
adc.effect()
self.assertEqual(
len(axidraw_control.axidraw.versions.get_versions_online.mock_calls
), 1)
def test_preview(self):
# prep
adc = axidraw_control.AxiDrawWrapperClass()
axidraw_control.axidraw.AxiDraw.serial_connect = MagicMock()
axidraw_control.axidraw.AxiDraw.plot_document = MagicMock()
# run
adc.getoptions([])
adc.options.preview = True
adc.parseFile('test/assets/AxiDraw_trivial.svg')
adc.effect()
# test
# with the preview option, serial connection should not be attempted
axidraw_control.axidraw.AxiDraw.serial_connect.assert_not_called()
self.assertTrue(
len(axidraw_control.axidraw.AxiDraw.plot_document.mock_calls) > 0,
"Calls were made to simulate plotting.")
def axidraw_CLI(dev=False):
''' The core of axicli '''
desc = 'AxiDraw Command Line Interface.'
parser = argparse.ArgumentParser(description=desc, usage=quick_help)
parser.add_argument("svg_in", nargs='?', \
help="The SVG file to be plotted")
parser.add_argument("-f",
"--config",
type=str,
dest="config",
help="Filename for the custom configuration file.")
parser.add_argument("-m","--mode", \
metavar='MODENAME', type=str, \
help="Mode. One of: [plot, layers, align, toggle, manual, " \
+ "sysinfo, version, res_plot, res_home, reorder]. Default: plot.")
parser.add_argument("-s","--speed_pendown", \
metavar='SPEED', type=int, \
help="Maximum plotting speed, when pen is down (1-100)")
parser.add_argument("-S","--speed_penup", \
metavar='SPEED', type=int, \
help="Maximum transit speed, when pen is up (1-100)")
parser.add_argument("-a","--accel", \
metavar='RATE', type=int, \
help="Acceleration rate factor (1-100)")
parser.add_argument("-d","--pen_pos_down", \
metavar='HEIGHT', type=int, \
help="Height of pen when lowered (0-100)")
parser.add_argument("-u","--pen_pos_up", \
metavar='HEIGHT', type=int, \
help="Height of pen when raised (0-100)")
parser.add_argument("-r","--pen_rate_lower", \
metavar='RATE', type=int, \
help="Rate of lowering pen (1-100)")
parser.add_argument("-R","--pen_rate_raise", \
metavar='RATE', type=int, \
help="Rate of raising pen (1-100)")
parser.add_argument("-z","--pen_delay_down", \
metavar='DELAY',type=int, \
help="Optional delay after pen is lowered (ms)")
parser.add_argument("-Z","--pen_delay_up", \
metavar='DELAY',type=int, \
help="Optional delay after pen is raised (ms)")
parser.add_argument("-N","--no_rotate", \
action="store_const", const='True', \
help="Disable auto-rotate; preserve plot orientation")
parser.add_argument("-C","--const_speed",\
action="store_const", const='True', \
help="Use constant velocity when pen is down")
parser.add_argument("-T","--report_time", \
action="store_const", const='True', \
help="Report time elapsed")
parser.add_argument("-M","--manual_cmd", \
metavar='COMMAND', type=str, \
help="Manual command. One of: [ebb_version, lower_pen, raise_pen, "\
+ "walk_x, walk_y, enable_xy, disable_xy, bootload, strip_data, " \
+ "read_name, list_names, write_name]. Default: ebb_version")
parser.add_argument("-w","--walk_dist", \
metavar='DISTANCE', type=float, \
help="Distance for manual walk (inches)")
parser.add_argument("-l","--layer", \
type=int, \
help="Layer(s) selected for layers mode (1-1000). Default: 1")
parser.add_argument("-c","--copies", \
metavar='COUNT', type=int, \
help="Copies to plot, or 0 for continuous plotting. Default: 1")
parser.add_argument("-D","--page_delay", \
metavar='DELAY', type=int,\
help="Optional delay between copies (s).")
parser.add_argument("-v","--preview", \
action="store_const", const='True', \
help="Preview mode; simulate plotting only.")
parser.add_argument("-g","--rendering", \
metavar='RENDERCODE', type=int, \
help="Preview mode rendering option (0-3). 0: None. " \
+ "1: Pen-down movement. 2: Pen-up movement. 3: All movement.")
parser.add_argument("-G","--reordering", \
metavar='GROUP_CODE', type=int, \
help="SVG reordering group handling option (0-3)."\
+ "0: No reordering. 1: Reorder but preserve groups. " \
+ "2: Reorder within groups. 3: Break apart. Default: 0")
parser.add_argument("-L","--model",\
metavar='MODELCODE', type=int,\
help="AxiDraw Model (1-3). 1: AxiDraw V2 or V3. " \
+ "2:AxiDraw V3/A3. 3: AxiDraw V3 XLX.")
parser.add_argument("-p","--port",\
metavar='PORTNAME', type=str,\
help="Serial port or named AxiDraw to use")
parser.add_argument("-P","--port_config",\
metavar='PORTCODE', type=int,\
help="Port use code (0-3)."\
+" 0: Plot to first unit found, unless port is specified"\
+ "1: Plot to first AxiDraw Found. "\
+ "2: Plot to specified AxiDraw. "\
+ "3: Plot to all AxiDraw units. ")
parser.add_argument("-o","--output_file",\
metavar='FILE', \
help="Optional SVG output file name")
args = parser.parse_args()
# Handle trivial cases
from pyaxidraw import axidraw
ad = axidraw.AxiDraw()
utils.handle_info_cases(args.svg_in, quick_help, cli_version, "AxiDraw",
ad.version_string)
if args.mode == "options":
quit()
if args.mode == "timing":
quit()
# Detect certain "trivial" cases that do not require an input file
use_trivial_file = False
if args.mode == "align" or args.mode == "toggle" \
or args.mode == "version" or args.mode == "sysinfo" \
or args.mode == "manual":
use_trivial_file = True
svg_input = args.svg_in
if not use_trivial_file or args.output_file:
utils.check_for_input(
svg_input, """usage: axicli svg_in [OPTIONS]
Input file required but not found.
For help, use: axicli --help""")
if args.mode == "reorder":
from pyaxidraw import axidraw_svg_reorder
adc = axidraw_svg_reorder.ReorderEffect()
adc.getoptions([])
utils.effect_parse(adc, svg_input)
if args.reordering is not None:
adc.options.reordering = args.reordering
print("Re-ordering SVG File.")
print("This can take a while for large files.")
exit_status.run(adc.effect) # Sort the document
if args.output_file:
writeFile = open(args.output_file,
'w') # Open output file for writing.
writeFile.write(adc.get_output())
writeFile.close()
print("Done")
quit()
# For nontrivial cases, import the axidraw module and go from there:
config_dict = utils.load_configs(
[args.config, 'axidrawinternal.axidraw_conf'])
combined_config = utils.FakeConfigModule(config_dict)
from pyaxidraw import axidraw_control
adc = axidraw_control.AxiDrawWrapperClass(params=combined_config)
adc.getoptions([])
if use_trivial_file:
trivial_svg = """<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
version="1.1"
id="svg15158"
viewBox="0 0 297 210"
height="210mm"
width="297mm">
</svg>
"""
svg_string = trivial_svg.encode('utf-8') # Need consistent encoding.
p = etree.XMLParser(huge_tree=True, encoding='utf-8')
adc.document = etree.ElementTree(etree.fromstring(svg_string,
parser=p))
adc.original_document = copy.deepcopy(adc.document)
else:
utils.effect_parse(adc, svg_input)
# assign command line options to adc's options.
# additionally, look inside the config to see if any command line options were set there
option_names = [
"mode", "speed_pendown", "speed_penup", "accel", "pen_pos_down",
"pen_pos_up", "pen_rate_lower", "pen_rate_raise", "pen_delay_down",
"pen_delay_up", "reordering", "no_rotate", "const_speed",
"report_time", "manual_cmd", "walk_dist", "layer", "copies",
"page_delay", "preview", "rendering", "model", "port", "port_config"
]
utils.assign_option_values(adc.options, args, [config_dict], option_names)
# The following options are deprecated and should not be used.
# adc.options.setup_type = args.setup_type # Legacy input; not needed
# adc.options.smoothness = args.smoothness # Legacy input; not needed
# adc.options.cornering = args.cornering # Legacy input; not needed
# adc.options.resolution = args.resolution # Legacy input; not needed
# adc.options.resume_type = args.resume_type # Legacy input; not needed
# adc.options.auto_rotate = args.auto_rotate # Legacy input; not needed
exit_status.run(adc.effect) # Plot the document
if utils.has_output(adc) and not use_trivial_file:
utils.output_result(args.output_file, adc.outdoc)
return adc if dev else None # returning adc is useful for tests
def axidraw_CLI():
desc = 'AxiDraw Command Line Interface.'
parser = argparse.ArgumentParser(description=desc, usage=quickhelp())
parser.add_argument("inputfile", \
help="The SVG file to be plotted")
parser.add_argument("-m","--mode", \
metavar='MODENAME', type=str, \
help="Mode. One of: [plot, layers, align, toggle, manual, " \
+ "sysinfo, version, res_plot, res_home, reorder]. Default: plot.")
parser.add_argument("-s","--speed_pendown", \
metavar='SPEED', type=int, \
help="Maximum plotting speed, when pen is down (1-100)")
parser.add_argument("-S","--speed_penup", \
metavar='SPEED', type=int, \
help="Maximum transit speed, when pen is up (1-100)")
parser.add_argument("-a","--accel", \
metavar='RATE', type=int, \
help="Acceleration rate factor (1-100)")
parser.add_argument("-d","--pen_pos_down", \
metavar='HEIGHT', type=int, \
help="Height of pen when lowered (0-100)")
parser.add_argument("-u","--pen_pos_up", \
metavar='HEIGHT', type=int, \
help="Height of pen when raised (0-100)")
parser.add_argument("-r","--pen_rate_lower", \
metavar='RATE', type=int, \
help="Rate of lowering pen (1-100)")
parser.add_argument("-R","--pen_rate_raise", \
metavar='RATE', type=int, \
help="Rate of raising pen (1-100)")
parser.add_argument("-z","--pen_delay_down", \
metavar='DELAY',type=int, \
help="Optional delay after pen is lowered (ms)")
parser.add_argument("-Z","--pen_delay_up", \
metavar='DELAY',type=int, \
help="Optional delay after pen is raised (ms)")
parser.add_argument("-N","--no_rotate", \
action="store_true",\
help="Disable auto-rotate; preserve plot orientation")
parser.add_argument("-C","--const_speed",\
action="store_true",\
help="Use constant velocity when pen is down")
parser.add_argument("-T","--report_time", \
action="store_true", \
help="Report time elapsed")
parser.add_argument("-M","--manual_cmd", \
metavar='COMMAND', type=str, \
help="Manual command. One of: [ebb_version, lower_pen, raise_pen, "\
+ "walk_x, walk_y, enable_xy, disable_xy, bootload, strip_data, " \
+ "read_name, list_names, write_name]. Default: ebb_version")
parser.add_argument("-w","--walk_dist", \
metavar='DISTANCE', type=float, \
help="Distance for manual walk (inches)")
parser.add_argument("-l","--layer", \
type=int, \
help="Layer(s) selected for layers mode (1-1000). Default: 1")
parser.add_argument("-c","--copies", \
metavar='COUNT', type=int, \
help="Copies to plot, or 0 for continuous plotting. Default: 1")
parser.add_argument("-D","--page_delay", \
metavar='DELAY', type=int,\
help="Optional delay between copies (s).")
parser.add_argument("-v","--preview", \
action="store_true", \
help="Preview mode; simulate plotting only.")
parser.add_argument("-g","--rendering", \
metavar='RENDERCODE', type=int, \
help="Preview mode rendering option (0-3). 0: None. " \
+ "1: Pen-down movement. 2: Pen-up movement. 3: All movement.")
parser.add_argument("-G","--group_sorting", \
metavar='GROUP_CODE', type=int, \
help="SVG sorting group handling option (0-2). 0: Preserve. " \
+ "1: Sort within groups. 2: Break apart. Default: 1")
parser.add_argument("-L","--model",\
metavar='MODELCODE', type=int,\
help="AxiDraw Model (1-3). 1: AxiDraw V2 or V3. " \
+ "2:AxiDraw V3/A3. 3: AxiDraw V3 XLX.")
parser.add_argument("-p","--port",\
metavar='PORTNAME', type=str,\
help="Serial port or named AxiDraw to use")
parser.add_argument("-P","--port_config",\
metavar='PORTCODE', type=int,\
help="Port use code (0-3)."\
+" 0: Plot to first unit found, unless port is specified"\
+ "1: Plot to first AxiDraw Found. "\
+ "2: Plot to specified AxiDraw. "\
+ "3: Plot to all AxiDraw units. ")
parser.add_argument("-o","--output_file",\
metavar='FILE', \
help="Optional SVG output file name")
args = parser.parse_args()
# Handle trivial cases:
if args.inputfile == "help":
print(quickhelp())
quit()
if args.inputfile == "version":
from pyaxidraw import axidraw
ad = axidraw.AxiDraw()
print(cli_version)
print(ad.version_string)
quit()
if args.mode == "options":
quit()
if args.mode == "timing":
quit()
if not os.path.isfile(args.inputfile):
# If the input file does not exist, return an error.
print("Input file not located. For help, try:")
print(" python axicli.py --help")
quit()
if args.mode == "reorder":
from pyaxidraw import axidraw_svg_reorder
adc = axidraw_svg_reorder.ReorderEffect()
adc.getoptions([])
adc.parse(args.inputfile)
if args.rendering is not None:
if args.rendering > 1:
adc.options.rendering = True
if args.group_sorting is not None:
adc.options.group_handling = args.group_sorting
print("Re-ordering SVG File.")
print("This can take a while for large files.")
adc.effect() # Sort the document
if args.output_file:
writeFile = open(args.output_file,
'w') # Open output file for writing.
writeFile.write(adc.get_output())
writeFile.close()
print("Done")
quit()
# For nontrivial cases, import the axidraw module and go from there:
from pyaxidraw import axidraw_control
adc = axidraw_control.AxiDrawWrapperClass()
adc.getoptions([])
adc.parseFile(args.inputfile)
# Pass through each parameter that has been specified.
# Do NOT pass through parameters that are not specified;
# That will ensure that they are properly given default values.
if args.mode is not None:
adc.options.mode = args.mode
if args.speed_pendown is not None:
adc.options.speed_pendown = args.speed_pendown
if args.speed_penup is not None:
adc.options.speed_penup = args.speed_penup
if args.accel is not None:
adc.options.accel = args.accel
if args.pen_pos_down is not None:
adc.options.pen_pos_down = args.pen_pos_down
if args.pen_pos_up is not None:
adc.options.pen_pos_up = args.pen_pos_up
if args.pen_rate_lower is not None:
adc.options.pen_rate_lower = args.pen_rate_lower
if args.pen_rate_raise is not None:
adc.options.pen_rate_raise = args.pen_rate_raise
if args.pen_delay_down is not None:
adc.options.pen_delay_down = args.pen_delay_down
if args.pen_delay_up is not None:
adc.options.pen_delay_up = args.pen_delay_up
if args.no_rotate is not None:
adc.options.no_rotate = args.no_rotate
if args.const_speed is not None:
adc.options.const_speed = args.const_speed
if args.report_time is not None:
adc.options.report_time = args.report_time
if args.manual_cmd is not None:
adc.options.manual_cmd = args.manual_cmd
if args.walk_dist is not None:
adc.options.walk_dist = args.walk_dist
if args.layer is not None:
adc.options.layer = args.layer
if args.copies is not None:
adc.options.copies = args.copies
if args.page_delay is not None:
adc.options.page_delay = args.page_delay
if args.preview is not None:
adc.options.preview = args.preview
if args.rendering is not None:
adc.options.rendering = args.rendering
if args.model is not None:
adc.options.model = args.model
if args.port is not None:
adc.options.port = args.port
if args.port_config is not None:
adc.options.port_config = args.port_config
# The following options are deprecated and should not be used.
# adc.options.setup_type = args.setup_type # Legacy input; not needed
# adc.options.smoothness = args.smoothness # Legacy input; not needed
# adc.options.cornering = args.cornering # Legacy input; not needed
# adc.options.resolution = args.resolution # Legacy input; not needed
# adc.options.resume_type = args.resume_type # Legacy input; not needed
# adc.options.auto_rotate = args.auto_rotate # Legacy input; not needed
adc.effect() # Plot the document
if args.output_file:
writeFile = open(args.output_file,
'w') # Open output file for writing.
writeFile.write(adc.outdoc)
writeFile.close()