GitXplorerGitXplorer
e

tattle-tail

public
12 stars
2 forks
10 issues

Commits

List of commits on branch master.
Unverified
fb6c050f319affc14af60c8f087d1d3fb98f3334

(closes #2) adds headings for dependencies and requirements

eemilyemorehouse committed 8 years ago
Unverified
8f256ece3cfe1c6a9f0f5d95e41ed3ebf5781bd4

(closes #1) adds initial readme with installation and getting started info.

eemilyemorehouse committed 8 years ago
Unverified
36a2e2e7ca7e7b873d747a3c5fb2b0db718e26d6

(closes #11) fixes PEP-8 errors

eemilyemorehouse committed 8 years ago
Unverified
d480738e01225d977ac7cce3edd7ed05a2b3264b

Updating TODO

eemilyemorehouse committed 8 years ago
Unverified
433242a65b18136cb46a52a73782c13a9ffd6d58

Fix spacing in bark push

eemilyemorehouse committed 8 years ago
Unverified
774b4fca2b5c98a7ccecef27e7c92e3751ab0c9b

Initial commit

eemilyemorehouse committed 8 years ago

README

The README file for this repository.

TattleTail

A Python script you can run while you're away to notify you if your dog barks.

Installation / Getting started

Requirements

To run the program, you must have PortAudio installed. They have great documentation on this process, check it out here.

Next, install Python's requirements (virtualenvwrapper is always recommended).

$ pip install -r requirements.txt

You will need a Firebase account and a OneSignal account if you wish to track your sessions and receive push notifications (respectively). For more information on setting these accounts up and retrieving your keys, check out the Firebase section and OneSignal section.

Additionally, there is a mobile app companion that registers your device for push notifications, allows you to view session details, and analyzes your dog's behavior.

Configuration

There are a few configuations found in config.py that are integral, including:

  • AMBIENT_DB: the ambient noise level in your home (more on this in the calibration section)
  • ONESIGNAL_KEY
  • ONESIGNAL_APP_ID
  • FIREBASE_URL

As well as some optional ones:

  • DEBUG: this can be set to either True or False, it allows you to save data in Firebase to either a production or development environment
  • PUSH_TIMER: the minimum number of minutes between push notifications, used for throttling
  • DOGNAME: your sweet pooch's name

Running TattleTail

Once these things are set, you're ready to start tracking:

$ python tattletail.py

Setting Up Firebase

COMING SOON

Setting Up OneSignal

COMING SOON

Calibrating Your Script

COMING SOON