What is RatOS?
RatOS is a preconfigured Raspberry Pi image that aims to make it as painless as possible to get Klipper, Moonraker, Mainsail and KlipperScreen up and running on your printer, via an easy to use, modular configuration. It is developed and maintained by Mikkel Schmidt (miklschmidt#2036 on the Rat Rig Unofficial Discord).
How does it work?
A typical klipper setup consists of three parts, there's Klipper itself, which does all the stuff Marlin or RRF would do - read gcode and control your printer. Then there's the API, Moonraker which exposes printer status and methods for other programs to talk to Klipper. Lastly there's the user interface, sort of like octoprint / duet web control / octodash / octoscreen, there are currently three popular options for that: Mainsail, Fluidd and Klipperscreen.
Like MainsailOS and FluiddPi, RatOS is just an image for your Raspberry Pi consisting of a combination of these parts and some initial setup. RatOS goes a step further than the others and provides a complete managed modular configuration supporting several printers, extruders, hotends, boards, probes, sensors, macros, etc and some extra neat features such as automated firmware updates, easy input shaper graph generation and so on. RatOS's main design principle is that the user shouldn't be required to interact with the commandline to use Klipper on their 3D Printer.
That said, anything you can do in klipper, you can do in RatOS, if you're well versed in klipper configurations you can even use parts of the RatOS configuration to set up an unsupported printer, giving you easy access to automatic flashing of toolboards and controlboards, stowable probes and a ton of macro's to make your life easier.
What do I need?
To run RatOS on your printer you need a supported control board and a Raspberry Pi or BTT CB1 (experimental).
Currently supported raspberry pi's:
- Raspberry Pi 3 (A+/B/B+)
- Raspberry Pi 4B
- Raspberry Pi 400
- Raspberry Pi Zero 2
- Raspberry Pi Compute Module 4 Lite for use with SD Cards
- Raspberry pi Compute Module 4 with at least 16gb eMMC (more complicated to set up)
- Big Tree Tech CB1 (experimental)
Currently Supported Printers
- Rat Rig V-Core 3
- Rat Rig V-Core Pro 1.3
- Rat Rig V-Minion
- Voron V0.1 (experimental)
- Voron V2.4 (experimental)
- Prusa Mini (experimental)
- Prusa MK3S (experimental)
Contribute
Join the discussion on discord!
Join the Unnofficial RatRig Discord Community
Software Credits
RatOS is based on Klipper, Moonraker, Mainsail, MainsailOS and KlipperScreen without these and the amazing people behind them, RatOS would not have been possible.
Disclaimer
The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.