DOCSEARCHbyAlgolia
Submit Docs

RatOS Documentation

website·Indexed 33 days ago

https://os.ratrig.com/

Documentation for RatOS, featuring wiring guides, firmware installation, and configuration for 3D printer boards and toolboards from Big Tree Tech and Mellow. Includes support for printers such as Voron V2.4, Voron V0.1, Rat Rig V-Minion, and V-Core Pro, with version-specific guides for 2.0.x, 2.1.x, and 2.1.0-RC3.

Tokens
85.3K
Snippets
427
Records
828
Agent score
62%

What's inside RatOS

  1. Overview of RatOS for 3D Printers

    RatOS is a preconfigured Raspberry Pi image designed to simplify the installation and management of Klipper, Moonraker, Mainsail, and KlipperScreen. Unlike standard images, RatOS provides a managed modular configuration supporting various printers, extruders, hotends, boards, probes, and sensors. Key features include automated firmware updates and easy input shaper graph generation, with a design goal of eliminating the need for command-line interaction for standard operations.

  2. Overview of RatOS print macros

    RatOS provides standardized START_PRINT and END_PRINT macros to handle print initialization and cleanup. Using these macros allows users to switch between different slicers without duplicating complex G-code logic. The G-code definitions for these macros are located in config/printers/[PRINTER_NAME]/macros.cfg.

  3. Overview of RatOS print macros

    RatOS provides built-in START_PRINT and END_PRINT macros to standardize how the printer begins and ends a print job. Using these macros allows users to switch between different slicers without needing to redefine the startup and shutdown sequences in each one. The G-code definitions for these macros are located in config/printers/[PRINTER_NAME]/macros.cfg.

  4. Overview of RatOS for 3D Printers

    RatOS is an open-source operating system for custom-built 3D printers built around the Klipper firmware. It simplifies the 3D printing experience by providing an intuitive point-and-click configuration interface, a managed auto-generated Klipper configuration, and an intelligent setup wizard for wiring and control board flashing. Key features include support for Mainsail and Fluidd web interfaces, advanced built-in macros, real-time analysis tools for mechanical debugging, and 'ToolShift' technology for IDEX printers.

  5. Overview of RatOS for 3D Printers

    RatOS is a preconfigured Raspberry Pi image designed to simplify the deployment of Klipper, Moonraker, Mainsail, and KlipperScreen. Unlike standard images, RatOS provides a managed modular configuration system that supports various printers, extruders, hotends, boards, probes, and sensors. Key features include automatic firmware updates and easy input shaper graph generation, with a design goal of eliminating the need for users to interact with the command line.

  6. Overview of Mainsail in RatOS

    Mainsail is the primary web-based control interface for the printer. It communicates with Klipper via the Moonraker API. It is used for starting prints, monitoring progress, and configuring Klipper. It is accessible at http://RatOS.local/.

  7. Overview of RatOS firmware solution

    RatOS is a comprehensive 3D printer firmware solution that simplifies Klipper-based printing by combining Klipper, Moonraker, Mainsail, and KlipperScreen. It replaces manual command-line configuration with a web-based configurator that automatically generates and maintains printer configuration files. Key features include a pre-configured Raspberry Pi image, automated system updates, and a wide array of configurable macros for print sequences, filament handling, and calibration.

  8. Overview of RatOS firmware solution

    RatOS is a comprehensive 3D printer firmware solution that integrates Klipper, Moonraker, Mainsail, and KlipperScreen. It is designed to remove the need for command-line knowledge by providing a pre-configured Raspberry Pi image and a web-based configurator. The system automatically generates and maintains configuration files, though it remains fully compatible with standard Klipper configurations for advanced users.

  9. Understand Beacon Adaptive Heat Soak

    Beacon Adaptive Heat Soak monitors the thermal stability of the printer using proximity measurements. It delays the start of the print until thermal stability is reached, which minimizes thermal Z deflection during the first layer.

  10. Execute shell commands via RatOS macros

    RatOS includes the gcode_shell_command.py Klipper extension. This enables macros to perform advanced tasks without requiring SSH or Linux knowledge, such as compiling binaries, selecting printer configurations, and generating input shaper graphs.

  11. Compare CAN bus and USB for Klipper 3D printers

    When configuring a 3D printer running Klipper, USB is generally preferred over CAN bus because Klipper operates on a strict master/slave architecture where the Raspberry Pi (Klippy) acts as the master. CAN bus strengths (redundancy, long-distance noise tolerance) are largely irrelevant for 3D printing environments, while USB provides lower latency, higher throughput, and plug-and-play simplicity.

    Comparison Summary:

    FeatureUSBCAN bus
    ArchitectureMaster/Slave (Plug & Play)Multi-master (Requires config)
    LatencyUltra lowHigher
    ThroughputHighLow
    OverheadLowHigh
    Wiring3 wires (Cable + Power)4 wires (Data + Power)
    ReliabilityHigh (with shielded cables)High (designed for vehicles)

    Key Considerations for 3D Printing:

    • Noise: Modern USB 3.1+ shielded cables are sufficient for the short distances (typically <1.5m) found in 3D printers.
    • Durability: Braided USB cables are durable enough for printer wiring and are easier/cheaper to replace than CAN setups.
    • Redundancy: Since the Raspberry Pi is a single point of failure, the redundancy offered by CAN bus provides no actual benefit to the system's overall uptime.

  12. Understand Beacon True Zero Correction (Multipoint Probing)

    RatOS extends the BEACON_AUTO_CALIBRATE command with a true zero correction feature (also known as multipoint probing). This feature addresses positional variability where neighboring points on a 1mm grid can differ by up to 100 microns, which can negatively impact first layer consistency. The system performs six additional single-dive probes at random positions near the nominal true zero position and applies a statistical method to determine a correction value. This is particularly beneficial for textured surfaces or new textured PEI sheets, which typically exhibit higher variability than smooth or worn sheets.