Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yesnault/ghue
Golang Hue SDK & Command Line Interface
https://github.com/yesnault/ghue
Last synced: about 1 month ago
JSON representation
Golang Hue SDK & Command Line Interface
- Host: GitHub
- URL: https://github.com/yesnault/ghue
- Owner: yesnault
- Created: 2016-01-03T21:57:54.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-08-19T20:34:19.000Z (about 6 years ago)
- Last Synced: 2024-06-20T06:39:45.154Z (5 months ago)
- Language: Go
- Size: 594 KB
- Stars: 18
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/yesnault/ghue)
[](https://godoc.org/github.com/yesnault/ghue)
# Description
Golang Hue SDK & Command Line Interface
# Usage
## General Rules
A successful command will give you no feedback. If you want one, you can use `-v` argument.
After each command, the exit code can be found in the `$?` variable. No error if exit code equals 0.
## Quick Start
- Get latest release of ghue CLI on https://github.com/yesnault/ghue/releases
- Get IP of your bridge. See http://www.developers.meethue.com/documentation/getting-started to check how to discover your bridge's IP.
- Press button on your bridge
- If your IP is `192.168.0.17`, execute `./ghue config create --ip 192.168.0.17 --save`
- Get All your lights, execute `./ghue lights all`
- Switch Off a light : `./ghue lights state 1 --on=false`
- Switch On a light : `./ghue lights state 1 --on=true`
- Switch On a light and set brightness to minimum : `./ghue lights state 1 --on=true --bri=1`
- View all other lights parameters : `./ghue lights state -h`
## Documentation
```
Usage:
ghue [command]
Available Commands:
config Config commands: ghue config --help
lights Lights commands: ghue lights --help
groups Groups commands: ghue groups --help
schedules Schedules commands: ghue schedules --help
sensors Sensors commands: ghue sensors --help
scenes Scenes commands: ghue scenes --help
info Info commands: ghue info --help
rules Rules commands: ghue rules --help
update Update ghue to the latest release version: ghue update
version Display Version of ghue: ghue version
Flags:
-c, --configFile string configuration file, default is /Users/yvonnickesnault/.ghue/config.json (default "/Users/yvonnickesnault/.ghue/config.json")
-f, --format string choose format output. One of 'json', 'yaml' and 'pretty' (default "pretty")
-h, --help help for ghue
-v, --verbose verbose output
```
# Roadmap
- [ ] Lights
- [X] Get all lights
- [ ] Get new lights
- [ ] Search for new lights
- [X] Get lights attributes and state
- [ ] Set lights attributes (rename)
- [X] Set light state
- [ ] Delete Light
- [ ] Groups
- [X] Get all groups
- [ ] Create group
- [X] Get group attributes
- [ ] Set group attributes
- [ ] Set group state
- [ ] Delete group
- [ ] Schedules
- [X] Get all schedules
- [ ] Create schedule
- [X] Get schedule attributes
- [ ] Set schedule attributes
- [ ] Delete schedule
- [ ] Scenes
- [X] Get all scenes
- [ ] Create scene
- [ ] Modify scene
- [ ] Recall scene
- [ ] Delete scene
- [X] Get scene
- [ ] Sensors
- [X] Get all sensors
- [ ] Create sensor
- [ ] Find new sensors
- [ ] Get new sensors
- [X] Get sensor
- [ ] Update sensor
- [ ] Delete sensor
- [ ] Change sensor config
- [ ] Rules
- [X] Get all rules
- [X] Get rule
- [ ] Create rule
- [ ] Update rule
- [ ] Delete rule
- [ ] Configuration
- [X] Create user
- [X] Get configuration
- [ ] Modify configuration
- [ ] Delete user from whitelist
- [ ] Get full state (datastore)
- [X] Info
- [X] Get all timezones
# Hacking
```bash
mkdir -p $(go env GOPATH)/src/github.com/yesnault
cd $(go env GOPATH)/src/github.com/yesnault
git clone [email protected]:yesnault/ghue.git
cd $(go env GOPATH)/src/github.com/yesnault/ghue/cli
go build && ./cli -h
```