This custom integration allows Home Assistant users to monitor and control their Creality 3D printers. It offers capabilities such as viewing current print status and sending pause/resume and stop commands directly from the Home Assistant interface. This integration has been specifically tested with the Creality Halot resin printer and is based on WebSocket communication discovered through Wireshark capture while running the Halot software connected to the printer.
- Print Status Monitoring: Track the status of ongoing prints, including progress, remaining time, current layer, and more.
- Print Control: Directly pause/resume and stop prints from within Home Assistant.
- Notifications: Configure Home Assistant to notify you about print completions or issues (additional configuration required).
- A compatible Creality 3D printer connected to your network.
- Home Assistant Core 2021.6.0 or newer.
- Clone this repository or download the latest release.
- Copy the
creality_controlfolder to yourcustom_componentsdirectory in your Home Assistant configuration directory. - Restart Home Assistant to recognize the new integration.
- Navigate to Configuration > Integrations and click + Add Integration.
- Search for "Creality Control" and input your printer's details as prompted.
You will need the following information to set up the integration:
- Host: IP address of your Creality printer.
- Port: Network port for the printer (default:
18188). - Password: Your printer's password, if set.
- Printer Online: Ensure your printer is online and connected to the same network as Home Assistant for successful integration. The integration is specifically tested with the Creality Halot resin printer.
- Control Limitations: Pause/Resume and Stop commands are only functional when there is an active print job. Home Assistant does not support uploading print files or starting prints due to limitations.
For support, questions, or contributions, please visit the GitHub issue tracker.
This integration is not officially affiliated with Creality. Use it at your own risk. Always ensure your printer's firmware is up to date with the latest version recommended by Creality. The integration's communication mechanism was discovered via Wireshark capture while running Halot software and connected to the printer, and it may not apply universally to all Creality printers.
This Home Assistant integration is released under the MIT License.
