Send push notifications in R using Pushover
R
Switch branches/tags
Clone or download
briandconnelly README updates
- fixed markdown typo
- added link to blog post

[ci skip]
Latest commit 057a664 Nov 24, 2016

README.md

pushoverr

Project Status: Active - The project has reached a stable, usable state and is being actively developed. BSD License Travis-CI Build Status CRAN_Status_Badge

pushoverr allows you to send push notifications from R to mobile devices or the desktop using Pushover. These notifications can display job status, results, scraped web data, or any other text or numeric data. Got some R code that takes a while to complete? Enough time to take a little walk or go get a coffee, but maybe not long enough to go home for the day? Now you'll be able to easily let yourself or your group know when it's done.

Prerequisites

You'll need an account with Pushover. Once you have that, log in and register an application. You should now have two codes---a user key and an API token/key. These are what identify you and your app(s) to Pushover. You'll pass these along to pushoverr whenever you send a message. You'll also need the Pushover app for iOS, Android, or your desktop.

Installation

Installing pushoverr is as easy as running:

install.packages("pushoverr")

Latest and Greatest (Fingers Crossed) via GitHub

You can use devtools to install the development version of pushoverr from GitHub. To do so:

if(!require("devtools")) install.packages("devtools")
devtools::install_github("briandconnelly/pushoverr")

Using pushoverr

Now that pushoverr's been installed, you're ready to start pushing some notifications. To begin using pushoverr, you'll need to first load the library. To do this, run:

library(pushoverr)

Example 1: Send Yourself A Message

In order to send a message, you'll need to have your user key and an app token. Then:

pushover(message = "Mr. Watson--come here--I want to see you.", user = <YOUR USER KEY>, app = <YOUR APP TOKEN>)

Within just a few seconds, your phone/tablet/watch/whatever should be abuzz with this historic message.

Our first notification message

Using other arguments to pushover, you can configure other aspects of your message, including sounds, links, and message priorities.

Saving your Credentials

By default, pushoverr will prompt you for your key and app token when needed and save them for all subsequent commands. You can directly tell pushoverr your key and token using set_pushover_user and set_pushover_app:

set_pushover_user(user = "uQiRzpo4DXghDmr9QzzfQu27cmVRsG")
set_pushover_app(token = "azGDORePK8gMaC0QOYAMyEEuzJnyUi")

pushoverr will forget these as soon as you end your session, so you'll have to re-run these commands each time you restart R.

Alternatively, you can store your keys in your .Renviron (see ?.Renviron for details).

PUSHOVER_USER = "uQiRzpo4DXghDmr9QzzfQu27cmVRsG"
PUSHOVER_APP= "azGDORePK8gMaC0QOYAMyEEuzJnyUi"

With this approach, your keys will be set whenever you use R. pushoverr will use these keys by default, but they can easily be overridden by supplying different values as arguments.

Example 2: Send Yourself an Important Message

Pushoverr provides message different message priorities. Quiet messages arrive without playing a sound, high priority messages arrive with a reddish background, and emergency messages arrive and repeat until they've been acknowledged. pushoverr provides easy methods for sending these:

pushover_quiet(message = "The kittens are sleeping")

Or more urgently:

pushover_emergency(message = "The kittens are awake, and they are ANGRY!")

An emergency notification message

Emergency messages return a receipt token that can be checked with is.acknowledged() to see whether or not it has been seen.

msg <- pushover_emergency(message = "The freezer is currently at -71 C!")
is.acknowledged(receipt = msg$receipt)

Example 3: Sending to a Specific Device

If you have more than one device using Pushover, you can also send messages to a specific device:

pushover(message = "If you pretend like this is important, you can walk out of the boring meeting", device = "Phone")

Example 4: Results on your Wrist

Pushover can now show data on constantly-updated screens like your smartwatch or lock screen (where supported). Using update_glance, you can push short text messages, numbers, and percentages to your watch right from within R.

update_glance(count = 88)

Showing a count notification on an Apple Watch

Note that these updates should be done infrequently---no more than once every 20 minutes or so---or WatchOS will stop processing updates to promote battery life. If you encounter problems, WatchOS resets this limit overnight.

Features Not Supported

pushoverr currently does not support subscriptions, licensing (I don't use Pushover in this context, so I can't test these features), or the open client API. If you'd like to see these features supported, please submit an issue or a pull request.

Feature Requests and Bug Reports

For all feature requests and bug reports, visit pushoverr on GitHub.

Related Links

Code of Conduct

This project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Disclaimer

This package and its author are not affiliated with Superblock, developers of Pushover.