Skip to content

Commit

Permalink
docs: more of them
Browse files Browse the repository at this point in the history
  • Loading branch information
todbot committed Oct 23, 2012
1 parent 9abf3a2 commit 0277baf
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 2 deletions.
2 changes: 1 addition & 1 deletion commandline/blink1-tool.c
Expand Up @@ -118,7 +118,7 @@ static void usage(char *myName)
"\n"
"Examples \n"
" blink1-tool -m 100 --rgb 255,0,255 # fade to #FF00FF in 0.1 seconds \n"
" blink1-tool -t 2000 --random 100 # every 2 seconds fade a random color\n"
" blink1-tool -t 2000 --random 100 # every 2 seconds new random color\n"
"\n"
,myName);
}
Expand Down
52 changes: 52 additions & 0 deletions docs/README.md
@@ -0,0 +1,52 @@

Device API Documentation for blink(1)
=====================================

There are multiple ways to communicate with a blink(1) device.

- Raw HID SetFeature & GetFeature reports
- C API
- Java / Processing API
- Command-line API
- Local Web API
- IFTTT API

Raw HID SetFeature & GetFeature reports
---------------------------------------

C API
-----
For the C API, check out the "blink1-lib.h" and "blink1-lib.c" files.

For an example of them in use, see the command-line tool "blink1-tool.c".


Java / Processing API
---------------------


Command-line API
----------------
The command-line program "blink1-tool" lets you have full control over
one or more blink(1) devices. You can use this program inside of
shell scripts or batch files, or in a pinch, call them from within PHP
web pages.

It is documented in [blink1-tool.md].


Local Web API
-------------
The local Web API is a REST API with JSON responses that comes with
the Mac OS X and Windows control applications.

It is documented in "app-url-api".
And has a set of step-by-step examples in "app-url-api-examples".


IFTTT API
---------
You can use IFTTT.com to hook up all sorts of Net-based data sources to
your blink(1). Details on that coming shortly.


2 changes: 1 addition & 1 deletion docs/blink1-tool.md
Expand Up @@ -32,7 +32,7 @@ The below is created from capturing the output of "blink1-tool" with no argument

Examples
blink1-tool -m 100 --rgb 255,0,255 # fade to #FF00FF in 0.1 seconds
blink1-tool -t 2000 --random 100 # every 2 seconds fade a random color
blink1-tool -t 2000 --random 100 # every 2 seconds new random color



Expand Down

0 comments on commit 0277baf

Please sign in to comment.