diff --git a/README.md b/README.md new file mode 100644 index 0000000..a0d3836 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +### Hue API Scripts + +All the Python scripts are no longer being worked on and has been replaced by a single Perl script. + +The script is [huectl.pl](https://git.high5.nl/hue/tree/huectl.pl) together with [hue.conf(https://git.high5.nl/hue/tree/hue.conf). + + $ ./huectl.pl + Usage: hue/huectl.pl bridge-name [-t type] [-i id] [-s sensor] [-b percent] [-a action] [-v] [-d] [-p] + Options: + bridge-name as defined in [HOME]./hue.conf or [HOME]./.hue.conf or /etc/hue.conf + -t | --type [ lights | sensors | groups | all | trigger ] (default: lights) + -i | --id light-id + -s | --sensor sensor-id + -b | --battery percent of battery level to report on, only relevant with sensors + -c | --climate show temperature of sensors in C, only relevant with sensors + -a | --action [ on | off | state | bright | relax | morning | dimmed | evening | nightlight ] (default: state) + -v | --verbose + -d | --debug raw JSON output + -p | --pretty pretty JSON output + + Command examples: + hue/huectl.pl bridge1 + Displays all lights of bridge1 + hue/huectl.pl bridge1 -i 8 + Check for state of light-id 8 + hue/huectl.pl bridge2 -t lights -i 8 -a bright + Turn on light-id 8 with the scene bright + hue/huectl.pl bridge2 -t trigger -i 8 -s 34 -a evening + Check for 'dark' state of sensor-id 34, turn on light-id 8 with the scene evening + hue/huectl.pl bridge1 -t sensors -c + Displays temperature of all sensors in C + + Config example: + # huectl,pl config file locations: + # ~/hue.conf, ~/.hue.conf, /etc/hue.conf, ./.hue.conf, ./hue.conf + [bridge1] + ip = 192.168.100.101 + token = bridge1token + [bridge2] + ip = 192.168.100.102 + token = bridge2token +