GitXplorerGitXplorer
e

tattle-tail

public
12 stars
2 forks
10 issues

Commits

List of commits on branch master.
Verified
429a667afa6eee632306e02ea7b2d8a5b36f9355

(closes #14) fixes links to Firebase and OneSignal in README

eemilyemorehouse committed 5 years ago
Unverified
c6b2342b0af137838757edc86f658a00213678c3

(closes #13) handles closing stream and pyaudio gracefully when exiting.

eemilyemorehouse committed 8 years ago
Unverified
d1c95c86cc066d46def79bdf980243be1c77709e

adds return statements back to helpers.

eemilyemorehouse committed 8 years ago
Unverified
89b34d77ee80197eab5c29a4ad52550d5a4b46f3

maybe actually fixes mobile app repo link

eemilyemorehouse committed 8 years ago
Unverified
00161ab2a0d5ee28bfdc03f548d47cb9b3c9bfe4

fixes mobile app repo link

eemilyemorehouse committed 8 years ago
Unverified
9691a65345f86d7c29c98fb1c09c517bacf1d7c2

(closes #4) adds info on mobile app companion. fixes a link in readme.

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