drallieiv/PokeAlarm

PokeAlarm is a third party extension of PokemonGo-Map that allows you to receive external notifications via one or more message services. Customized notifications are available by configuring the alarms.json file.

We currently support the following services:

Pushbullet (support likely be discontinued soon due to changes in the API pricing structure)
Pushover
Slack
Telegram
Twilio (SMS)
Twitter

Support

Wiki

Please read the Wiki before contacting us for support. It should answer all your questions about installation and configuration.

Discord

Visit us at our Discord channel if you still have issues with your setup. Please stick to the #troubleshooting and #general chats and avoid sending private messages to devs. We're working hard, we promise!

Github

If you are experiencing issues with the alarm or would like to see new features, please open a ticket on github here. Be sure to complete the included suppport template and provide as much information as possible. Support tickets that do not fully complete the request template may be closed without notice.

What exactly is PokeAlarm?

PokeAlarm is a lightweight webserver designed to receive POST requests from your local PokemonGo-Map server. It sorts through these requests, letting you know through your favorite service something has happend. It might be a tweet when a rare pokemon spawning down the street, a Telegram message letting you know a lured pokestop only a few minutes away, or else a Pushbullet notification letting you know your teams gym has fallen.

FAQ

Which version of PokemonGo-Map do I need?

Use the develop branch. Most work in PokemonGo-Map is being done there. They do not currently have a master. PokeAlarm is a webhook - an extension of PokemonGo-Map. We can update PokeAlarm without affecting your PokemonGo-Map installation, or vice-versa.

Will you be adding support for XYZ?

Please make a request in the NEW/UPCOMING SERVICE MEGA-THREAD. New standalone issue tickets will be closed without notice.

Man I wish this could do XYZ!

Open an issue on github and fill out the appropriate issue template and we'll look into it.

I am receiving XYZ error from PokemonGo-Map! What do I do?

Visit our Discord channel, Checkout the PokemonGo-Map Wiki or the reddit thread to see if anyone has any suggestions for you.

I am receiving an error about JSON input from PokeAlarm (e.g., "expecting delimiter"). What gives?

If you are a Windows user, stop using notepad and start using Notepad++. Make a fresh copy of the alarms.json and remake your changes. If you aren't a Windows user (or you are already using Notepad++) check your JSON format with a JSON formatter for issues (jsoneditoronline.org is an excellent site to start.)

Can I run multiple simultaneous alarms services?

Yes. You may configure as few or as many simultaneous alarm services in alarms.json like Twitter, Slack and Telegram. For example, you can post to 2 Twitter accounts, 3 Slack channels and have a Twilio SMS service running from one alarms.json configuration. Visit the Alarm Configuation wiki for more details.

Alternatively, you can run PokemonGo-Map with multiple webhooks and have multiple instances of PokeAlarm, each assigned to a different http://<host>:<port>, e.g., http://127.0.0.1:4000, http://127.0.0.1:4001, http://127.0.0.1:4002.

I'm having issues with setting a location, it is not showing distance, maps are not showing up, walking directions, etc.

These errors are Google Maps API related. Ensure you have an API key with all the necssary APIs enabled. Visit the Google Maps API Key wiki for more details.

drallieiv / PokeAlarm