OctoprintKlipperPlugin/README.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

2018-01-23 17:08:16 +03:00
# OctoPrint Klipper Plugin
2018-01-23 17:01:58 +03:00
This plugin assists in managing and monitoring the [Klipper](https://github.com/KevinOConnor/klipper) 3D printer firmware.
2018-01-24 19:30:01 +03:00
### Features
- Simplified connection dialog.
- Restart Host and MCU processes.
- User defineable macro buttons.
- Assisted bed leveling wizard with user definable probe points.
- PID Tuning Dialog.
2018-01-27 17:04:32 +03:00
- Message log displaying messages from Klipper prepended with "//" and "!!".
2018-01-23 17:01:58 +03:00
2018-01-27 17:04:32 +03:00
### ToDo
- Add a continously updated status display in octoprints navbar.
2018-01-23 17:01:58 +03:00
## Setup
Install via the bundled [Plugin Manager](https://github.com/foosel/OctoPrint/wiki/Plugin:-Plugin-Manager)
or manually using this URL:
https://github.com/mmone/OctoPrintKlipper/archive/master.zip
## Configuration
2018-01-24 19:30:01 +03:00
Click on the wrench icon in the titlebar to open OctoPrints settings dialog. Select "Klipper" at the bottom of the settings dialog.
2018-02-06 01:14:37 +03:00
## Screenshots
2018-02-06 01:16:49 +03:00
#### Message Log
2018-02-06 01:14:37 +03:00
![Message Log](docs/assets/img/message-log.png)
2018-02-06 01:16:49 +03:00
#### Bed Leveling
2018-02-06 01:14:37 +03:00
![Bed Leveling](docs/assets/img/bed-leveling.png)
2018-02-06 01:16:49 +03:00
#### PID Tuning
![PID Tuning](docs/assets/img/pid-tuning.png)
#### Settings
2018-02-06 01:14:37 +03:00
![Settings](docs/assets/img/settings.png)