repetier / Repetier-Firmware

Firmware for Arduino based RepRap 3D printer.
815 stars 734 forks source link

Repetier-Firmware - the fast and user friendly firmware

Notes for developers/pull requests

This software is open source licensed under the GPL V3. As any free project we like contributions from other sources, especially since the firmware is very hardware related and many things can only be implemented/tested with the right hardware. To allow easy integration of new features you should follow some simple principals.

  1. Only send pull requests against development version. This is where we add and test new features and bug fixes. From time to time we push these to master as a new version.
  2. Do not include your personal configuration files. If you need new configuration options, add them to the official configuration.h file.
  3. We have two folders for different processor architectures. So for most changes modifications need to be in both folders. The general files are identical. In fact we develop on avr and just copy them to due. Only pins.h/fastio.h/hal.* and configuration.h are architecture dependent, so changes there need to be made twice and not copied.
  4. Document what your pull request will change/fix/introduce. Please also mention new configurations since we need to add them also to our online tool, so users can set them correctly.

.0 will be the last 1 version. Fixes for this will be done in the dev branch and moved to stable after a while as 1.0.x patch updates. With the release of the official 1.0 version we will start developing version 2.0 in the branch dev2 where all the new features will be added.

Version 2.0 information

Version 2 will be a incompatible refactoring of version 1.0. We will try to keep commands and communication identical to 1.0, but for the configuration we see a much more flexible way that makes it much easier to adjust the firmware to nowadays needs. But that requires a different configuration at several parts.

Planned stages:

  1. Merge AVR and Due into one fileset.
  2. Split long files like boards, displays, languages in several files into a subfolder. That way it gets much faster to search the right place.
  3. Update used libraries.
  4. Change configuration.
  5. Change motion planner.
  6. Create a config tool.
  7. Public testing with more users. We assume until a config tool is available the configuration will get several changes and only users with programming skills will do it manually to benefit already from improvements achieved.

Until 6. the version should be considered alpha stage. We do expect errors from all the changes and there may be bigger mods with an update. Of course we will try to keep every release workable, but as work in progress there is no guarantee.

Installation

Please use your configuration tool at http://www.repetier.com/firmware/v100 or for latest 1.0.x development version at http://www.repetier.com/firmware/dev for easy and fast configuration. You get the complete sources you need to compile from the online configurator. This system also allows it to upload configurations created with this tool and modify the configuration. This is handy for updates as you get all newly introduced parameter just by uploading the old version and downloading the latest version. New parameter are initalized with default values.

Version 1.0.0

Version 0.92.8

Version 0.91 released 2013-12-30

WARNING: This version only compiles with older Arduino IDE 1.0.x, for compilation with newest version use 0.92

Improvements over old code:

Documentation

For documentation please visit http://www.repetier.com/documentation/repetier-firmware/

Developer

The sources are managed by the Hot-World GmbH & Co. KG It was initially based on the Sprinter firmware from Kliment, but the code has run through many changes since them. Other developers:

Introduction

Repetier-Firmware is a firmware for RepRap like 3d-printer powered with an arduino compatible controller. This firmware is a nearly complete rewrite of the sprinter firmware by kliment which based on Tonokip RepRap firmware rewrite based off of Hydra-mmm firmware. Some ideas were also taken from Teacup, Grbl and Marlin.

Features

Controlling firmware

Also you can control the firmware with any reprap compatible host, you will only get the full benefits with the following products, which have special code for this firmware:

Installation

For documentation and installation please visit http://www.repetier.com/documentation/repetier-firmware/.

Changelog

See changelog.txt