Skip to content

on_boarding.md

Latest commit

 

History

History
107 lines (66 loc) · 6.91 KB

on_boarding.md

File metadata and controls

107 lines (66 loc) · 6.91 KB
graph LR
    Klippy_Host_Application_Core["Klippy Host Application Core"]
    Microcontroller_Firmware["Microcontroller Firmware"]
    Host_MCU_Communication_Layer["Host-MCU Communication Layer"]
    G_code_Command_Processing["G-code & Command Processing"]
    Motion_Peripheral_Control["Motion & Peripheral Control"]
    Configuration_Management["Configuration Management"]
    Firmware_Toolchain["Firmware Toolchain"]
    Klippy_Host_Application_Core -- "orchestrates" --> G_code_Command_Processing
    Klippy_Host_Application_Core -- "relies on" --> Host_MCU_Communication_Layer
    Host_MCU_Communication_Layer -- "interacts with" --> Microcontroller_Firmware
    G_code_Command_Processing -- "translates commands for" --> Motion_Peripheral_Control
    Motion_Peripheral_Control -- "sends commands via" --> Host_MCU_Communication_Layer
    Configuration_Management -- "provides settings to" --> Klippy_Host_Application_Core
    Firmware_Toolchain -- "interacts with" --> Microcontroller_Firmware
    click Klippy_Host_Application_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/kalico/Klippy_Host_Application_Core.md" "Details"
    click Microcontroller_Firmware href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/kalico/Microcontroller_Firmware.md" "Details"
    click Host_MCU_Communication_Layer href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/kalico/Host_MCU_Communication_Layer.md" "Details"
    click G_code_Command_Processing href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/kalico/G_code_Command_Processing.md" "Details"
    click Motion_Peripheral_Control href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/kalico/Motion_Peripheral_Control.md" "Details"
    click Configuration_Management href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/kalico/Configuration_Management.md" "Details"
Loading

CodeBoardingDemoContact

Details

The Klippy host application operates as the central orchestrator for 3D printer control, processing G-code commands and managing real-time interactions with the microcontroller. It leverages a reactor pattern for event-driven operations and maintains a robust communication layer with the MCU, ensuring precise motion and peripheral control. Configuration settings are dynamically loaded and applied, allowing for flexible printer setups.

Klippy Host Application Core [Expand]

The central Python application orchestrating the 3D printer's high-level operations, managing system state, and coordinating modules.

Related Classes/Methods:

Microcontroller Firmware [Expand]

The low-level C/C++ code running directly on the MCU, responsible for real-time hardware control and executing precise, timed operations.

Related Classes/Methods:

Host-MCU Communication Layer [Expand]

Manages the robust communication protocol, including message serialization/deserialization and clock synchronization, between the host and MCU.

Related Classes/Methods:

G-code & Command Processing [Expand]

Interprets G-code commands, manages custom macros, and dispatches corresponding actions to other host components.

Related Classes/Methods:

Motion & Peripheral Control [Expand]

Translates high-level movements into precise stepper commands and manages various hardware peripherals like heaters, fans, and probes.

Related Classes/Methods:

Configuration Management [Expand]

Handles the loading, parsing, validation, and application of printer configuration settings from .cfg files.

Related Classes/Methods:

Firmware Toolchain

A set of external utilities and scripts for compiling and flashing the Microcontroller Firmware onto the target MCU.

Related Classes/Methods:

FAQ