pixel-tweets

Stream tweet events and convert them to pixel data for a Spark Internet Button!

Summary

Clone this repository and run npm install inside the root of the project directory.
Configure your Twitter API keys (see Keys & Secrets below).
Run npm start.
Tweet! (see Usage below).

Configuration

Keys & Secrets

You must create your own application to use the API. Please do so by going to the Twitter Application Management page.

CONSUMER_KEY
CONSUMER_SECRET
ACCESS_TOKEN_KEY
ACCESS_TOKEN_SECRET

You need all four of these to run the twitter stream included in npm start. Configuration options are detected via nconf, and you may specify them in your config.json file (placed at the root of the project directory):

Configuration file format

{
	"consumer_key": "",
	"consumer_secret": "",
	"access_token_key": "",
	"access_token_secret": "",
  "spark_username": "",
  "spark_password": "",
  "filter": ""
}

Installation

Firmware

The easiest way to flash the firmware is to put your Core into DFU mode, and use the Spark CLI to directly flash the firmware binary to your Core:

spark flash --usb ./firmware/bin/firmware.bin

JavaScript

Just use npm to start the server!

npm start

Usage

Tweeting

Once you have your Spark Core flashed, your Twitter application created, and your Node process running; you may tweet at your Internet Button! Use the following format:

<hashtag> <pixel number> <color>

Any of the following tweets are valid:

#pixeltweets 1 blue
#pixeltweets green 9
#pixeltweets 3 #ff00ff
11 #fff #pixeltweets
#pixeltweets 5 off

The order of hashtag, pixel number, and color are irrelevant. Any tweet that can be parsed to find a number between 1-11 and a valid CSS color name or hex value (in 3 or 6 digit format) will work. The filter can also be something other than a hashtag!

Picking the right colors to tweet

Choosing the perfect hue can be challenging. See this lovely list of CSS color names on W3schools.com for inspiring color choices!

particle-iot/pixel-tweets