Skip to content

README.md

Latest commit

 

History

History
35 lines (21 loc) · 1.98 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.98 KB
Raw

OctoPrint-Signalclirestapi

A Signal Messenger Integration for Octorpint which supports Signal Messenger Groups and uses the signal-messenger-rest-api docker image.

Features

  • Creates a separate Signal chat group per print.
  • Support for Print Started, Print Stopped, Print Paused, Print Resumed, Print Cancelled, Print Failed events
  • Support attaching webcam snapshots.
  • Supports periodic print progress notifications.

Why signal-cli-rest-api?

The main advantage of the signal-cli-rest-api is, that you don't necessarily need to run it on the same host system as Octoprint. That means, you can register one phone number with the signal-cli-rest-api and use that for various type of notifications in your house (e.g: Octoprint, Home Assistant, etc.)

Docker Container Setup

In order to use this Octoprint Plugin, you need to have a running signal-cli-rest-api docker container somewhere. The following guide describes how you can set one up.

Octoprint Plugin Installation

Install via the bundled Plugin Manager or manually using this URL:

https://github.com/bbernhard/OctoPrint-Signalclirestapi/archive/master.zip

Octoprint Plugin Configuration

Please make sure to specify the correct REST API URL in the configuration!