-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
54 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters