8000 fullcontrol/fullcontrol at master · kuzja111/fullcontrol · GitHub
[go: up one dir, main page]
Skip to content

fullcontrol

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

fullcontrol

README.md

FullControl python package

more details of the structure of this library will be given in a future release of FullControl aimed at developers

however, it is briefly summarised here along with instructions for some modifications anticipated to be quite common (e.g. adding a new printer / changing the format of gcode strings)

structure

the structure of the fullcontrol package and subpackages are likely to change considerably. any efforts to add new functionality should be done with an understanding that such changes will likely need to be significantly edited to work with future releases of FullControl

  1. fullcontrol
    1. top-level modules define generic classes for FullControl's state-changing objects
    2. attributes/methods at the top level are relevant to common state in extrusion additive manufacturing
    3. common.py imports relevant classes/functions from these modules for easy import into subpackages
    4. __init__.py imports the classes/functions with capabilities for both gcode and visualization (fullcontrol/combinations described below) to achieve a simple import statement by the end user
  2. fullcontrol/gcode
    1. most modules in the gcode subpackage import the generic classes defined in the top-level modules and add new gcode-specific attributes and methods
    2. other modules create new functions and objects to control the generation of gcode
    3. __init__.py imports relevant classes/functions from these modules
    4. the module fullcontrol/gcode/point.py can be edited to change the text string format of gcode
    5. interesting subpackage fullcontrol/gcode/primer_library:
      • modules here are the primer options included in FullControl - they add steps to the beginning of a design
      • if you want to add a new primer to FullControl rather than include primer steps directly in a design, do the following:
        1. copy, paste, rename, and edit an existing primer module (e.g. x.py) to create a custom primer routine
        2. use a GcodeControls object with {"primer": "name_of_new_module_excluding_.py"} included in the initialization_data parameter when transforming the design to a gcode result
  3. fullcontrol/visualize
    1. most modules in the visualize subpackage import the generic classes defined in the top-level modules and add new attributes and methods to generate a visual preview
    2. other modules create new functions and objects to control the generation of the visual preview
    3. __init__.py imports relevant classes/functions from these modules
  4. fullcontrol/combinations
    1. this subpackage is used to combine functionality in multiple result-specific subpackages
    2. the conceptual approach and code in this subpackage are likely to change significantly in the future
    3. the module fullcontrol/combinations/gcode_and_visualize/common.py imports relevant classes/functions for the current implementation of FullControl (gcode and visualize)
  5. fullcontrol/geometry
    1. modules in this subpackage define functions that create/modify/measure geometry, where 'geometry' refers to a point or list of points.
    2. __init__.py imports relevant classes/functions from these modules
    3. the import order in __init__.py is important since the modules import functions from each other
    4. in the currently implementation, points created in this subpackage have both gcode and visualize functionality. hence the import of Point from fullcontrol.combinations.gcode_and_visualize.classes at the top of __init__.py - this means all the modules in this subpackage generate Points with relevant attributes/methods for both gcode and visualize results. similar for the Extruder object
    5. adding new geometry functions to existing modules, or adding new modules by copying and editing one of the existing modules, is possible if the appropriate import statement is edited or added to the bottom of __init__.py. However, such additions may require a greater understanding of the FullControl code than intended for this initial release of FullControl (e.g. to avoid circular imports). currently, it is advised to create new geometry functions in your design script rather than editing the FullControl package
  6. fullcontrol/devices
    1. this subpackage contains libraries of systems (3D printers) which is used to format gcode correctly for a given system
    2. three printer libraries exist currently: community, community_minimal, and cura
      1. community (fullcontrol/devices/community) is a community-created library of 3D printers in a format that most embraces the fullcontrol design method
        1. starting procedures are defined instead of start_gcode strings as have been used historically. this means the procedures can easily adapt to other manufacturing platforms (e.g. robots)
        2. base_settings.py defines default printer settings
        3. other modules in this subpackage import base_settings.py to initialize a printer
        4. currently set up for single tool system, but could extend to multitool if desired
      2. community_minimal (fullcontrol/devices/community_minimal) implements a much simpler printer definition
        1. start_gcode and end_gcode are written as strings
        2. these strings can contain references to other settings (e.g. nozzle temperature) within the printer library entry or base_settings.py or initialization_data in GcodeControls supplied by the user
        3. these strings can also contain code within {} that is evaluated during gcode generation
        4. aside from these strings, the other only information that must be defined is the printer name. all other settings are inherited from base_setting.py, so are optional.
      3. cura (fullcontrol/devices/cura) adopts the format of community_minimal with start/end gcode strings stored alongside other relevant printer information, but the data has been extracted from the cura printer library
    3. to add a new printer:
      1. in community:
        1. copy an existing module (e.g. ultimaker2plus.py)
        2. rename it to your printer name
        3. change 'printer_overrides', 'starting_procedure_steps' and 'ending_procedure_steps' - leave the rest of the module unchanged
        4. in your design set 'printer_name' in a GcodeControls object to be the name of the new module
      2. in community_minimal:
        1. copy and existing module (e.g. generic.py or template.py) into fullcontrol/devices/community_minimal/settings
        2. update the printer name, start/end gcode entries and any other settings you wish
        3. update fullcontrol/devices/community_minimal/library.json to include your new printer name, which is written by the user in the design, and module filename
      3. in cura:
        1. scripts have been created to extract the relevant information from all cura profiles, these can be re-run when the cura github repo updates. more information can be supplied if needed (raise as issue)

lab package structure

in addition to the 'fullcontrol' package, there is a 'lab.fullcontrol' package

  1. lab/fullcontrol
    1. __init__.py imports relevant classes/functions from lab/fullcontrol/geomtry to achieve a simple import statement by the end user
    2. fiveaxis.py imports the relevant classes/functions from lab/fullcontrol/multiaxis to achieve a simple import statement by the end user
    3. subpackages:
      1. lab/fullcontrol/geomtry
        1. extra geometric features to supplement those in the regular FullControl package
      2. lab/fullcontrol/multiaxis
        1. demo implementation of five-axis toolpath design. this demo was not created to be adaptable to different hardware systems. more flexibility to alternative printing hardware will be considered for future releases of FullControl along with additional functionality
0