gcode_reader.emulate.machines.small_scale_am
============================================

.. py:module:: gcode_reader.emulate.machines.small_scale_am


Classes
-------

.. autoapisummary::

   gcode_reader.emulate.machines.small_scale_am.DesktopAM
   gcode_reader.emulate.machines.small_scale_am.RepRap


Module Contents
---------------

.. py:class:: DesktopAM(extrusion_type=machine_options.REL_EXTRUSION, **kwargs)

   Bases: :py:obj:`gcode_reader.emulate.machine.Machine`


   Base class for desktop AM machines with Marlin Firmware

   Initializes a new Machine instance.

   :param tools: A tuple of Tool instances for
                 the machine to use. Defaults to None.
   :type tools: Tuple[Tool, ...], optional
   :param parser: An instance of a GcodeParser.
                  Defaults to a new GcodeParser().
   :type parser: GcodeParser, optional
   :param exporter: An instance of a GcodeExporter.
                    Defaults to a new GcodeExporter().
   :type exporter: GcodeExporter, optional
   :param \*\*options: Keyword arguments passed to the constructor of the
                       machine's `MachineOptions` type.


   .. py:method:: gcode_file_to_operation(filepath: str, operation_type=AdditiveOperation)

      Parses a G-code file and returns a processed Operation.

      This method uses the machine's configured parser to read a G-code
      file into a list of commands, wraps them in the specified
      `operation_type`, and then processes the operation to populate
      its process data.

      :param filepath: The path to the G-code file.
      :type filepath: str
      :param operation_type: The class of Operation to create
                             (e.g., `Operation`, `AdditiveOperation`). Defaults to `Operation`.
      :type operation_type: type, optional

      :returns: A new, processed Operation instance.
      :rtype: Operation

      :raises ValueError: If `operation_type` is not a valid subclass of `Operation`.



   .. py:property:: relative_extrusion
      :type: bool



.. py:class:: RepRap(**kwargs)

   Bases: :py:obj:`DesktopAM`


   RepRap desktop AM

   Initializes a new Machine instance.

   :param tools: A tuple of Tool instances for
                 the machine to use. Defaults to None.
   :type tools: Tuple[Tool, ...], optional
   :param parser: An instance of a GcodeParser.
                  Defaults to a new GcodeParser().
   :type parser: GcodeParser, optional
   :param exporter: An instance of a GcodeExporter.
                    Defaults to a new GcodeExporter().
   :type exporter: GcodeExporter, optional
   :param \*\*options: Keyword arguments passed to the constructor of the
                       machine's `MachineOptions` type.


   .. py:attribute:: options