https://github.com/frap129/klipmi
[Klip]per for H[MI] displays like TJC and Nextion
https://github.com/frap129/klipmi
Last synced: 4 months ago
JSON representation
[Klip]per for H[MI] displays like TJC and Nextion
- Host: GitHub
- URL: https://github.com/frap129/klipmi
- Owner: frap129
- License: gpl-3.0
- Created: 2024-05-10T15:17:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-26T17:34:16.000Z (over 1 year ago)
- Last Synced: 2025-06-20T03:05:46.617Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 21.4 MB
- Stars: 13
- Watchers: 6
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```bash
git clone https://github.com/frap129/klipmi.git
cd klipmi
```
2. Run the installation script:
```bash
./install.sh
```
3. Configure `klipmi` by editing the example configuration file:
```bash
cp klipmi.toml.example ~/printer_data/config/klipmi.toml
```
## Usage
To start the service, use the following command:
```bash
sudo systemctl start klipmi.service
```
To enable the service to start on boot:
```bash
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](LICENSE) file for details.