Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amimof/huego
An extensive Philips Hue client library for Go with an emphasis on simplicity
https://github.com/amimof/huego
golang hue-bridge hue-lights philips-hue
Last synced: about 2 months ago
JSON representation
An extensive Philips Hue client library for Go with an emphasis on simplicity
- Host: GitHub
- URL: https://github.com/amimof/huego
- Owner: amimof
- License: mit
- Created: 2017-05-16T05:31:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-30T07:46:10.000Z (over 1 year ago)
- Last Synced: 2024-07-31T20:52:02.282Z (5 months ago)
- Topics: golang, hue-bridge, hue-lights, philips-hue
- Language: Go
- Homepage:
- Size: 591 KB
- Stars: 249
- Watchers: 5
- Forks: 36
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - huego - An extensive Philips Hue client library for Go. (IoT (Internet of Things) / Search and Analytic Databases)
- awesome-go-extra - huego - 05-16T05:31:45Z|2022-07-08T11:51:54Z| (IoT (Internet of Things) / Advanced Console UIs)
README
[](https://github.com/amimof/huego/actions/workflows/go.yaml) [](https://goreportcard.com/report/github.com/amimof/huego) [](https://codecov.io/gh/amimof/huego) [](https://github.com/avelino/awesome-go)
# Huego
An extensive Philips Hue client library for [`Go`](https://golang.org/) with an emphasis on simplicity. It is designed to be clean, unbloated and extensible. With `Huego` you can interact with any Philips Hue bridge and its resources including `Lights`, `Groups`, `Scenes`, `Sensors`, `Rules`, `Schedules`, `Resourcelinks`, `Capabilities` and `Configuration` .
## Installation
Get the package and import it in your code.
```
go get github.com/amimof/huego
```
You may use [`New()`](https://godoc.org/github.com/amimof/huego#New) if you have already created an user and know the IP address to your bridge.
```Go
package main
import (
"github.com/amimof/huego"
"fmt"
)
func main() {
bridge := huego.New("192.168.1.59", "username")
l, err := bridge.GetLights()
if err != nil {
panic(err)
}
fmt.Printf("Found %d lights", len(l))
}
```
Or discover a bridge on your network with [`Discover()`](https://godoc.org/github.com/amimof/huego#Discover) and create a new user with [`CreateUser()`](https://godoc.org/github.com/amimof/huego#Bridge.CreateUser). To successfully create a user, the link button on your bridge must have been pressed before calling `CreateUser()` in order to authorise the request.
```Go
func main() {
bridge, _ := huego.Discover()
user, _ := bridge.CreateUser("my awesome hue app") // Link button needs to be pressed
bridge = bridge.Login(user)
light, _ := bridge.GetLight(3)
light.Off()
}
```
## Documentation
See [godoc.org/github.com/amimof/huego](https://godoc.org/github.com/amimof/huego) for the full package documentation.
## Contributing
All help in any form is highly appreciated and your are welcome participate in developing `Huego` together. To contribute submit a `Pull Request`. If you want to provide feedback, open up a Github `Issue` or contact me personally.