Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

docs: more of them

  • Loading branch information...
commit 0277baf72b98e565bc5bf44af70e73b575dfb342 1 parent 9abf3a2
@todbot authored
View
2  commandline/blink1-tool.c
@@ -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);
}
View
52 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.
+
+
View
2  docs/blink1-tool.md
@@ -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
Please sign in to comment.
Something went wrong with that request. Please try again.