Creality Printer Integration (for Home Assistant)

This is a custom integration for handling Creality printers in Home Assistant (inspired by the work of Klangen82).

Initialliy created for the Creality K1C model but several other models have been added to the list of printers that can be selected. Some might be missing and some of them might not support network connection natively (or at all). You'll have to test if it works with your printer model and if it does not, you can modify the integration to support it.

The default behavior is the one supported by the Creality K1C model so any printer using the same network communication protocol should work as well (ie: K1, K1 Max). Also, the password part of the code has been integrated from Klangen82's code but has not been tested.

Installation

1. Install & configure Advanced SSH & Web Terminal addon (or equivalent) in Home Assistant.

2. Using a SFTP application like WinSCP (Windows), connect to home assistant file system.

3. Upload the files from the creality_printer folder to the remote path /homeassistant/custom_components/creality_printer.

4. Restart Home Assistant.

5. Turn on the printer (make sure it's on the same network as Home Assistant).

6. In Home Assistant: go to Devices & Services, click Add integration then select Creality Printer.

7. Set the following values when adding the printer:

   • Model: Model of the printer.
   • Host: Network name or IP address of the printer.
   • Port: Port to connect to the printer.
   • Password: Password (leave empty if no password)

Features

• Supports

  • Multiple printers at the same time
  • Live Camera stream (use Picture entity)

• Sensors:

  • Bed/Nozzle/Case temperatures
  • Current layer, Layer Count
  • Filename, Progress, Flow, Speed
  • Material State (for Runout detection), Material used
  • Start Time, Time Elapsed, Time Left
  • Printer state, Position

• Controls:

  • Light
  • Back/Side/Model Fans
  • Pause/Resume/Stop buttons

• Languages:

  • Chinese, Dutch, English, French, German, Italian
  • Japanese, Korean, Polish, Russian, Spanish, Swedish

Support & Contributing

If you find any issue, you can submit it via the Issue tracker.

Click here for detailed contributing instructions.

Disclaimer

This custom integration is not affiliated in any way with Creality. Use it at your own risk.

Licence

This project is licensed under the MIT License.