Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,23 @@ To install `klipmi`, follow these steps:

3. Configure `klipmi` by editing the example configuration file:
```bash
cp klpmi.toml.example ~/printer_data/config/klpmi.toml
cp klipmi.toml.example ~/printer_data/config/klpmi.toml
```
4. Get moonraker API key
```bash
http://IP OF PRINTER/access/api_key
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its much easier to get the API key using ~/moonraker/scripts/fetch_apikey.sh

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mks@qidi-q1:~/moonraker/scripts$ ~/moonraker/scripts/fetch-apikey.sh
/home/mks/moonraker-env/bin/python: No module named lmdb

```
## Instal Touch Screen firmware

1. Stop `klipmi`
```bash
systemctl stop klipmi
```
2. Install TFT Firmware
```bash
.venv/bin/nextion-fw-upload -b 115200 -ub 921600 /dev/ttyS1 ~/klipmi/hmi/openq1/Q1_UI.tft
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

klipmi is not specific to OpenQ1, it is extensible to many printer firmwares, printers, and screens. Any instructions documenting firmware flashing would need to be much more in depth and generic than this.

```

## Usage

To start the service, use the following command:
Expand All @@ -51,6 +65,24 @@ To enable the service to start on boot:
sudo systemctl enable klipmi.service
```

If it not working check log

```bash
sudo journalctl -xeu klipmi
```
## Errors
If you see this error No such file or directory: '/root/printer_data/config/klipmi.toml' change the service user to mks
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The guide works as written, this is unnecessary.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

klipmi or klpmi
Errors with this.


```bash
sudo nano /etc/systemd/system/klipmi.service
```

Then restart

```bash
sudo systemctl restart klipmi
```

## Contributing

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