Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.42 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.42 KB
Raw

klipmi

[Klip]per for H[MI] displays like TJC and Nextion

Overview

klipmi is a framework for integrate Klipper with HMI displays such as TJC and Nextion. This repository contains the necessary code and configuration files to build klipper support for any UI running on a TJC or Nextion diplay

Note: Currently designed for TJC displays, though little work is needed to support Nextion. Open an issue if you need this.

Features

  • Handles TJC/Nextion diplay communication
  • Handles interacting with moonraker
  • Provides a simplified framework for interacting with both

Supported HMIs

Currently klipmi supports:

  • OpenQ1 for TJC4827X243_011

Installation

To install klipmi, follow these steps:

  1. Clone the repository:

    git clone https://github.com/frap129/klipmi.git
cd klipmi

  2. Run the installation script:

    ./install.sh

  3. Configure klipmi by editing the example configuration file:

    cp klpmi.toml.example ~/printer_data/config/klpmi.toml

Usage

To start the service, use the following command:

sudo systemctl start klipmi.service

To enable the service to start on boot:

sudo systemctl enable klipmi.service

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the GPL-3.0 License. See the LICENSE file for details.