Skip to content
A Pushover plugin for OctoPrint
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
octoprint_pushover
.editorconfig
.gitignore
LICENSE
README.md
requirements.txt
setup.py

README.md

OctoPrint-Pushover

Pushover plugin for octoprint, I wanted to receive notifications on my phone when Octoprint finished, paused or gives an error while printing, and e-mail just isn't good enough. So I build a plugin for the app/service that I use, Pushover.

Installing

Install it trought the bundled Plugin manager or manually by using this url

https://github.com/thijsbekke/OctoPrint-Pushover/archive/master.zip

Configuration

Obtain an API key through the following Link this is not necessary for this plugin to work.

You also have to enter your user key. You can find your own user key on your Pushover page. Copy and paste it to the "user key" field in the settings dialog of the Octoprint-Pushover plugin. And then you are done.

Additional you can set a priority for each event you want to be notified of.

Features

The newest feature is image's ! It is now possible to receive an capture of your camera with your notifications. This plugin can send a notification with Pushover on the following events; Print done, Print failed and Print paused. In the settings dialog beside the user key you can specify the devices, priority of the notifications and a sound.

This plugin will also append an url to your octoprint instance with the notification.

Priority

  • Lowest Priority

When this priority is set, messages will be considered lowest priority and will not generate any notification. On iOS, the application badge number will be increased.

  • Low Priority

Messages with this priority will not generate any sound or vibration, but will still generate a popup/scrolling notification depending on the client operating system.

  • Normal Priority

Messages with the normal priority trigger sound, vibration, and display an alert according to the user's device settings. On iOS, the message will display at the top of the screen or as a modal dialog, as well as in the notification center. On Android, the message will scroll at the top of the screen and appear in the notification center.

If a user has quiet hours set and your message is received during those times, your message will be delivered as though it had a priority of Low priority

  • High Priority

Messages sent with this priority bypasses a user's quiet hours. These messages will always play a sound and vibrate (if the user's device is configured to) regardless of the delivery time.

Sound

You can specify a custom sound, your device will play this sound when receiving a message. You can specify one of these sounds

Devices

You can enter the name of your device to send the message directly to that device, rather than all of your devices. An alternative option is to create a delivery group where you can specify your devices and enter that group key as an user key in this plugin.

Pause/Waiting Event

When for example a M0 or a M226 command is received and the settings are complied. This plugin will send a notification. And as bonus it will append any M70 message to the notification, so you can remind yourself which colour you need to switch.

For example

G1 X109.071 Y96.268 E3.54401
G1 X109.186 Y97.500 E3.63927
M70 Sleep Message
M0
G1 X109.186 Y102.500 E4.02408
G1 X108.789 Y104.770 E4.20140

Url

If the automatic created url is not correct you can overrule this by edit the config.yaml

example:

plugins:
  pushover:
    priority: '0'
    sound: intermission
    url: 192.168.1.24
You can’t perform that action at this time.