thompsnm / pebblesifter

Pebble / Android app to interface with site scrapers in order to sift out important strings.

Pebble Sifter

Pebble / Android app to interface with site scrapers in order to sift out important strings.

Android Companion App Installation

To install the companion app to your Android device:

• Download and install Android Studio
• Import the Pebble Sifter project
• Run the Android configuration on your device

Pebble App Installation

To deploy the Pebble app to your smart watch:

• Install the Pebble SDK
• Use the Pebble Command Line Tool to install the app from the pebble_sifter directory

Creating Your Own Sifter

To create and use your own sifter:

• Create a new class that extends PebbleSifter in the personalSifters directory
  • Note: The contents of the personalSifters directory has been added to the .gitignore file. It is highly recommended that you store your sifters in a separate repository to prevent them from being lost when working with PebbleSifter.
• Override the sift(), getFullName(), getPebbleName(), and refresh() methods
• Instantiate your sifter and add it to the MainActivity.sifters ArrayList in the DrawApp class under the line that says "As new sifters are implemented, add them here:"
• Re-install the Android Companion App

For examples on how to create a sifter, checkout the exampleSifters directory. All examples use jsoup for parsing HTML, but you can use whatever library you would like.

Contributing

Pull requests to improve this project are more than welcome. Checkout the roadmap.txt file for ideas of what I'd like to do next. No coding conventions have been set; just try to follow the existing conventions you see in the code.

pebblesifter's Issues

Unclear error is displayed when the data connection doesn't work

Reproduction Steps:

• Turn off your data connection
• Start Pebble Sifter

Expected Result:

• An error message should inform you that a data connection could not be established.

Actual Result:

• Error message is displayed that says "Unfortunately, Pebble Sifter has stopped."

Can't scroll through sifted text

Reproduction Steps:

• Create a Sifter whose sift() method returns a string so long it extends past the bottom of the screen.
• Attempt to scroll down to the Sifter Buttons

Expected Result:

• User can scroll down to the Sifter Buttons

Actual Result:

• User can't scroll through text