/OctoPrint-Pushover

A Pushover plugin for OctoPrint

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

OctoPrint-Pushover

Pushover plugin for octoprint, I wanted too receive notifications on my phone when Octoprint finished a job, and e-mail just isn't good enough. So I build a plugin for the app 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

The only thing you have too configure is the user key. You can find your own user key on your Pushover page. Copy and paste it too the "user key" field in the settings dialog of the Octoprint-Pushover plugin. And then you are done, the rest of the settings are optional.

Features

In the settings dialog beside the user key you can specify the priority of the notifications and a sound. This plugin will also append an url too 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

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