README.md

Vortex GCode Emulator

Overview

Vortex is a software-define CNC machine emulator. It provides a set of emulated objects that can be instanciated to make up any HW configuration. The objects then emulate the appropriate HW behavior.

Initially, Vortex was meant to be a 3D printer emulator. However, the ultimate goal is for it to be able to emulate any CNC machine.

Documentation

1. Installation Guide
2. Quick Start Guide
3. Guides
   • User Guide
   • Configuration Guide
   • Object Reference
   • Klipper Documentation
     • Klipper MCU Protocol
     • Klipper Command Reference
4. Emulator Architecture
5. Development Guide
6. Coding Standard

Credits

• KevinOConner Creator of the Klipper firmware which was the trigger for the start of this project.
• Paniel Detersson Creator of the heat exchange algorithm used in the heater object.