Skip to content

rajivsarvepalli/homebridge-moonraker

Repository files navigation

homebridge-moonraker

Homebridge plugin to control Moonraker enabled 3D printers

npm npm build status verified-by-homebridge

🏠 Homebridge Moonraker

Homebridge Moonraker is a Homebridge plugin designed to enable HomeKit integrations (Apple Home) with Moonraker-enabled 3D printers. Moonraker is a web server developed for the Klipper 3D printing firmware.

Below is a summary of the accessories/features that homebridge-moonraker provides:

  • A thermostat for the bed heater.
  • A thermostat for the extruder heater.
  • A humidity sensor representing print progress.
  • A light for print controls.

Multiple printers for a single plugin instance are supported.

I would recommend running homebridge-camera-ui to have your printer camera available on Homebridge and Apple Home. You can supply a URL inside the config of this plugin to notify Camera.UI to trigger recordings for printer failures.

📚 Documentation

Refer to the 📦 Installing section to understand how to install and configure this library.

The following features are available via accessories (each one is opted into via the plugin configuration):

  • A thermostat for the bed heater - which can control your bed heater
  • A thermostat for the extruder heater - which can control your extruder heater.
  • A humidity sensor representing progress.
  • A temperature sensor for the chamber.
  • 2 contact sensors for print canceled or print error occurrences. These sensors can be enabled for notifications inside Apple Home to provide printer errors or cancellations directly to your phone.
  • A light for print controls where the following is true:
    • Light brightness represents print progress.
    • Turning the light off pauses the print.
    • Setting the light brightness cancels the print (analogous to forcing completion of a print since brightness represents print progress).

📦 Installing

If you are new to Homebridge, please first read the Homebridge documentation and installation instructions before proceeding.

If you have installed the Homebridge Config UI, you can install this plugin by going to the Plugins tab and searching for homebridge-moonraker and installing it. Configuration is available via that same UI post-installation.

👷 Contributing

Contributions are welcome. Please open a PR or an issue to discuss further.

📕 License

Distributed under the terms of the APACHE license.

💥 Issues

If you encounter any issues or problems, please file an issue along with a detailed description.