Skip to content

Latest commit

 

History

History
109 lines (86 loc) · 4.71 KB

Pushbullet.md

File metadata and controls

109 lines (86 loc) · 4.71 KB
Raw

Overview

Prerequisities

This guide assumes:

  1. You are familiar with JSON formatting
  2. You have read and understood the Alarm Configuration Wiki
  3. You are comfortable with the layout of alarms.json.

Please familiarize yourself with all of the above before proceeding.

Introduction

PokeAlarm offers the following for Pushbullet:

  • Notifications to multiple Pushbullet channels
  • Customizable Google Map image of the pokemon, gym, and/or pokestop location
  • Personalized notifications via Dynamic Text Substitution

Basic Config

Required Parameters

These alarm.json parameters are required to enable the Pushbullet alarm service:

Parameters Description
type must be pushbullet
active True for alarm to be active
api_key Your Pushbullet API key

Example: Basic Alarm Configuration using Required Parameters

Below is how a basic Pushbullet alarm configuration would appear in alarms.json.

{
	"active":"True",
	"type":"pushbullet",
	"api_key":"YOUR_API_KEY"
}

Note: The above code is to be inserted into the alarms section of alarms.json. It does not represent the entire alarms.json file.

Advanced Config

Optional Parameters

In addition to the required parameters, several alarm.json optional parameters are available to personalize your notifications. Below is an example of these optional parameters and how they are incorporated into a functional alarm layout.

These optional alarms.json parameters are entered at the same level as "type":"pushbullet".

Parameters Description Default
startup_message Confirmation post when PokeAlarm initialized True
startup_list First post will list all alarmed pokemon enabled in alarms.json True

These optional parameters below are applicable to the pokemon, pokestop, and gym sections of the JSON file.

Parameters Description Default
channel Channel tag of the target channel Sends to all devices
title Notification title attached to the push A wild <pkmn> has appeared!
url Link to be attached to the push <gmaps>
body Message attched to the push Available until <24h_time> (<time_left>).

Example: Alarm Configuration Using Optional Parameters

{
	"active":"True",
	"type":"pushbullet",
	"api_key":"YOUR_API_KEY",
	"channel":"DEFAULT_CHANNEL",
	"pokemon":{
		"title":"A wild <pkmn> has appeared!",
		"url":"<gmaps>",
		"body":"Available until <24h_time> (<time_left>).",
		"channel":"OVERRIDES_DEFAULT_CHANNEL"
	},
	"pokestop":{
		"title":"Someone has placed a lure on a Pokestop!",
		"url":"<gmaps>",
		"body":"Lure will expire at <24h_time> (<time_left>).",
		"channel":"OVERRIDES_DEFAULT_CHANNEL"
	},
	"gym":{
		"title":"A Team <old_team> gym has fallen!",
		"url":"<gmaps>",
		"body":"It is now controlled by <new_team>.",
		"channel":"OVERRIDES_DEFAULT_CHANNEL"
	}
}

Note: The above code is to be inserted into the alarms section of alarms.json. It does not represent the entire alarms.json file.

How to get a Pushbullet API Key

  1. Go to Pushbullet.com and click one of the 'Sign up' options.

  2. In the top right corner, click on the letter and select 'My Account'.

  3. Scroll down to 'Create Access Token`. Copy this token and place it in api_key parmater.