PokeCron GO (node) v2.2.0

PokeCron is an example of pinging the pokemon go server, and triggering a notification service (pushbullet) about new nearby pokemon, complete with walking directions. New updates include filtering.

Requirements

Node 6

Why?

Passive play. I could run the app on my phone all day, but this uses less of my data plan. This can check pokemon at work, at home, near an outing I plan to be at later, etc.

Sure, there are plenty of pokemon maps out there, but I have to actually look at the map, wait for it to load, hope the information is still accurate, and figure out how to get to where the pokemon is. PokeCron go notifies me about new pokemon, and gives walking directions to that location.

With PushBullet, I can choose to mute it when I'm busy, and activate it when I'm ready.

You're incredibly lazy.

Yes.

Configuration

Every instance of PokeCron Go requires a config file (for running a tracker on more than one location, see "Tracking Multiple Locations" below). By default, it uses config.js. You'll want to either set environment variables, or replace the values provided.

Currently, the only option not in configuration is the cron expression.

//SAMPLE CONFIGURATION FILE
module.exports = {
  // the location you're scanning
  location: {
    // each of these should be a number, and probably a float.
    latitude: 38.618385,
    longitude: -90.217331,
  },
  // the datastore - a basic cache to determine if we've already seen the Pokemon received.
  db: {
    // whether or not to write the datastore to disk. Compacts every 5 minutes.
    memoryOnly: false
    // (optional) a path, relative to the root of the directory.
    datastore: './store/pokemon.db',
  },
  // information used to log into the pokemon servers.
  // ... probably don't want to use your main account here.
  pokemon: {
    username: 'username',
    password: 'pass',
    // one of the following: 'google' or 'ptc' (pokemon trainer's club)
    provider: 'google',
    // list of pokemon ids: see pokelist.json
    filter: [21, 151]
  },
  // Services that get notified about updates.
  notifications: {
    // pushbullet is used, because it's a mutable notification system.
    pushbullet: {
      channel: 'a string.',
      token: 'your pushbullet API key.'
    },
    // Coming Soon: slack notification option
    slack: {
      channel: 'some slack channel',
      token: 'some slack api key'
    }
  }

Running

Got a PushBullet API key and Channel? Set up your secondary Pokemon account? Great! Throw all of that into config.js and type the magic words: npm run start

For best results, run with a process monitor, such as pm2, forever, or nodemon.

Tracking Multiple locations

Each instance needs it's own config file, and must be constructed separately.

Example cron setup for work, home, and a nearby park.

const cron = require('node-cron')
const configOffice = require('./configOffice')
const configHome = require('./configHome')
const configPark = require('./configPark')
const Tracker = require('./src/main')

// don't miss a beat at home.
const home = new Tracker(configHome)
const homeTask = cron.schedule('0,30 * 17-22 * * *',home, false)
homeTask.start()

// grab those cubicle-dwelling Pokemon.
const office = new Tracker(configOffice)
const officeTask = cron.schedule('0,30 * 9-17 * * MON-FRI',office, false)
officeTask.start()

// It's the weekend, go outside!
const park = new Tracker(configPark)
const parkTask = cron.schedule('0,30 * 9-17 * * SAT-SUN',park, false)
parkTask.start()

While there are no hard and fast rules for how many times you can ping the server, or how often, but I'd be wary of hitting the API faster than 4 times per minute, per account.

Changelog

2.2
Added winston logging.
Made main method a constructor, to preserve instances (and stop repeating pokemon).
2.1
Replaced AWS DynamoDB with nedb
2.0
Heavy code refactor.
Pass in config, rather than reference it via require. Now multiple configs/cron tasks can be used on a single thread.
Added Cron tasks.
Removal any use of process.env outside config file.
expanded .gitignore

Roadmap

Write Tests. It's all functional you big dummy, this should be easy.
Electron UI?
Slack updates?
Cron Expression in config.

ashlux/pokecron-go