Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
peterkaminski committed Sep 30, 2015
0 parents commit 578fbeb
Show file tree
Hide file tree
Showing 4 changed files with 583 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# emacs detritus
*~
\#*\#
.\#*
22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Kingfish for Philips Hue

Copyright 2015 Peter Kaminski

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
### Kingfish for Philips Hue, by Peter Kaminski

An open-source single-file HTML/JavaScript Hue controller for
interacting directly with the API. Intended for those who want to get
a better handle on the low-level interface to their Hue system.

You can load the `kingfish.html` file from this directory in your
browser, or load or save the file from the web:
[kingfish.html](http://peterkaminski.github.io/kingfish/kingfish.html).

Hardware donations gratefully received, contact
<[email protected]>. Consider purchasing [Hue
color](http://www.amazon.com/dp/B00BSN8DN4/?tag=kfsh-20) or [Hue
Lux](http://www.amazon.com/dp/B00ME9CDQE/?tag=kfsh-20) gear via our
Amazon associate links to help support the Kingfish project.

Commands are sent on your local network directly from your device to
your Hue bridge, not through any server. (The "Get Bridge IP" command
retrieves your bridge IP address from a Philips server, but does not
send any data, nor does the Philips server send any commands.) There
are no analytics or tracking bugs in this file.

Start by doing boxes in numbered order, then repeat in any order as
desired. Green buttons set blue values, but don't send commands. Blue
and red buttons send commands to bridge. You can close and re-open
Kingfish at any time. Kingfish uses HTML5 local storage, if available
in your browser, to persist input values entered on your device.

Roadmap and other development ideas:

* XY color
* graphical color picker
* Schedules and Rules
* calendar/time picker
* Scenes
* using names of objects from bridge instead of numbers
* more attractive visually (better CSS)
* theming
* namespacing variables
* better code organization
* automatic parsing of responses
* countdown timer for monitoring transition time
* active programmatic control of lighting
* support for other similar systems

Kingfish uses [jQuery.ajax](http://api.jquery.com/jquery.ajax/) to
send commands via HTTP to the bridge. For background on Philips Hue
terminology and how the Hue API works, read [Philips hue
API](http://www.developers.meethue.com/philips-hue-api). Visit the
[Kingfish project home page](http://peterkaminski.github.io/kingfish/)
or the [Kingfish repo](https://github.com/peterkaminski/kingfish) to
comment, fork, or download the project files. Distributed under
open-source MIT license, see LICENSE.md.
Loading

0 comments on commit 578fbeb

Please sign in to comment.