Merge branch 'release/1.0.0-alpha.5'

Author: amimof

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.0.0-alpha.5
+* Added `SetState` receivers to `Group` and `Light`.
+* Renamed `SetLight` to `SetLightState` for a more consistent naming convention.
+* Implemented `Capabilities`
+
+## 1.0.0-alpha.4
+* Huego now has a logo
+* Changes to fulfill `golint`, `govet` and `gofmt`
+
 ## 1.0.0-alpha.3
 * Added `Group` receivers: `Alert()`, `Bri()`, `Ct()`, `Effect()`, `Hue()`, `IsOn()`, `Off()`, `On()`, `Rename()`, `Sat()`, `Scene()`, `TransitionTime()` and `Xy()`
 * Added `Light` receivers: `Alert()`, `Effect()` and `TransitionTime()`

README.md

@@ -64,8 +64,8 @@ This project is currently in **ALPHA** and still under heavy development. Curren
 | Scenes | `Complete` | `Complete` |
 | Rules | `Complete` | `Complete` |
 | Resourcelinks | `Complete` | `Complete` |
-| Configuration | `Complete`  | `Complete` 
-| Capabilities | `Not Started` | `Not Started` 
+| Configuration | `Complete`  | `Complete` |
+| Capabilities | `Complete` | `Complete` |
 
 Other than above core modules, each module needs additional *helper* methods for conveniance and flavour. The goal is to keep it simple, and not to bloat the library with functionality that developers might want to write on their own. 
 
@@ -76,7 +76,7 @@ The goal of this project is to provide an easy to use, stable and extensive libr
 ## To-Do
 
 * Add helper methods on each module
-* Add `SetSceneLightState`
-* Add `RecallScene`
-* Finish `Capabilities`
+* ~~Add `SetSceneLightState`~~
+* ~~Add `RecallScene`~~
+* ~~Finish `Capabilities`~~
 * More tests

bridge.go

@@ -81,10 +81,7 @@ func (b *Bridge) CreateUser(n string) (string, error) {
 	body := struct {
 		DeviceType        string `json:"devicetype,omitempty"`
 		GenerateClientKey bool   `json:"generateclientkey,omitempty"`
-	}{
-		n,
-		true,
-	}
+	}{n, true}
 
 	url, err := b.getAPIPath("/")
 	if err != nil {
@@ -469,8 +466,8 @@ func (b *Bridge) GetLight(i int) (*Light, error) {
 	return light, nil
 }
 
-// SetLight allows for controlling one light's state
-func (b *Bridge) SetLight(i int, l State) (*Response, error) {
+// SetLightState allows for controlling one light's state
+func (b *Bridge) SetLightState(i int, l State) (*Response, error) {
 
 	var a []*APIResponse
 
@@ -676,7 +673,9 @@ func (b *Bridge) GetResourcelinks() ([]*Resourcelink, error) {
 // GetResourcelink returns one resourcelink by its id defined by i
 func (b *Bridge) GetResourcelink(i int) (*Resourcelink, error) {
 
-	var resourcelink *Resourcelink
+	g := &Resourcelink{
+		ID: i,
+	}
 
 	url, err := b.getAPIPath("/resourcelinks/", strconv.Itoa(i))
 
@@ -685,12 +684,12 @@ func (b *Bridge) GetResourcelink(i int) (*Resourcelink, error) {
 		return nil, err
 	}
 
-	err = json.Unmarshal(res, &resourcelink)
+	err = json.Unmarshal(res, &g)
 	if err != nil {
 		return nil, err
 	}
 
-	return resourcelink, nil
+	return g, nil
 
 }
 
@@ -829,7 +828,9 @@ func (b *Bridge) GetRules() ([]*Rule, error) {
 // GetRule returns one rule by its id of i
 func (b *Bridge) GetRule(i int) (*Rule, error) {
 
-	var rule *Rule
+	g := &Rule{
+		ID: i,
+	}
 
 	url, err := b.getAPIPath("/rules/", strconv.Itoa(i))
 	if err != nil {
@@ -841,12 +842,12 @@ func (b *Bridge) GetRule(i int) (*Rule, error) {
 		return nil, err
 	}
 
-	err = json.Unmarshal(res, &rule)
+	err = json.Unmarshal(res, &g)
 	if err != nil {
 		return nil, err
 	}
 
-	return rule, nil
+	return g, nil
 
 }
 
@@ -969,6 +970,7 @@ func (b *Bridge) GetScenes() ([]Scene, error) {
 
 	for i, g := range m {
 		g.ID = i
+		g.bridge = b
 		scenes = append(scenes, g)
 	}
 
@@ -979,7 +981,10 @@ func (b *Bridge) GetScenes() ([]Scene, error) {
 // GetScene returns one scene by its id of i
 func (b *Bridge) GetScene(i string) (*Scene, error) {
 
-	var g *Scene
+	g := &Scene{ID: i}
+	l := struct {
+		LightStates map[int]State `json:"lightstates"`
+	}{}
 
 	url, err := b.getAPIPath("/scenes/", i)
 	if err != nil {
@@ -991,20 +996,26 @@ func (b *Bridge) GetScene(i string) (*Scene, error) {
 		return nil, err
 	}
 
+	err = json.Unmarshal(res, &l)
+	if err != nil {
+		return nil, err
+	}
+
 	err = json.Unmarshal(res, &g)
 	if err != nil {
 		return nil, err
 	}
 
+	g.bridge = b
+
 	return g, nil
 }
 
 // UpdateScene updates one scene and its attributes by id of i
-func (b *Bridge) UpdateScene(i int, s *Scene) (*Response, error) {
+func (b *Bridge) UpdateScene(id string, s *Scene) (*Response, error) {
 
 	var a []*APIResponse
 
-	id := strconv.Itoa(i)
 	url, err := b.getAPIPath("/scenes/", id)
 	if err != nil {
 		return nil, err
@@ -1033,6 +1044,77 @@ func (b *Bridge) UpdateScene(i int, s *Scene) (*Response, error) {
 	return resp, nil
 }
 
+// SetSceneLightState allows for setting the state of a light in a scene.
+// SetSceneLightState accepts the id of the scene, the id of a light associated with the scene and the state object.
+func (b *Bridge) SetSceneLightState(id string, iid int, l *State) (*Response, error) {
+
+	var a []*APIResponse
+
+	lightid := strconv.Itoa(iid)
+	url, err := b.getAPIPath("scenes", id, "lightstates", lightid)
+	if err != nil {
+		return nil, err
+	}
+
+	data, err := json.Marshal(&l)
+	if err != nil {
+		return nil, err
+	}
+
+	res, err := put(url, data)
+	if err != nil {
+		return nil, err
+	}
+
+	err = json.Unmarshal(res, &a)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := handleResponse(a)
+	if err != nil {
+		return nil, err
+	}
+
+	return resp, nil
+}
+
+// RecallScene will recall a scene in a group identified by both scene and group identifiers
+func (b *Bridge) RecallScene(id string, gid int) (*Response, error) {
+
+	var a []*APIResponse
+
+	data, err := json.Marshal(struct {
+		Scene string `json:"scene"`
+	}{id})
+
+	if err != nil {
+		return nil, err
+	}
+
+	url, err := b.getAPIPath("/groups/", strconv.Itoa(gid), "/action")
+	if err != nil {
+		return nil, err
+	}
+
+	res, err := put(url, data)
+	if err != nil {
+		return nil, err
+	}
+
+	err = json.Unmarshal(res, &a)
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := handleResponse(a)
+	if err != nil {
+		return nil, err
+	}
+
+	return resp, err
+}
+
 // CreateScene creates one new scene with its attributes defined in s
 func (b *Bridge) CreateScene(s *Scene) (*Response, error) {
 
@@ -1067,11 +1149,10 @@ func (b *Bridge) CreateScene(s *Scene) (*Response, error) {
 }
 
 // DeleteScene deletes one scene from the bridge
-func (b *Bridge) DeleteScene(i int) error {
+func (b *Bridge) DeleteScene(id string) error {
 
 	var a []*APIResponse
 
-	id := strconv.Itoa(i)
 	url, err := b.getAPIPath("/scenes/", id)
 	if err != nil {
 		return err
@@ -1135,7 +1216,9 @@ func (b *Bridge) GetSchedules() ([]*Schedule, error) {
 // GetSchedule returns one schedule by id defined in i
 func (b *Bridge) GetSchedule(i int) (*Schedule, error) {
 
-	var schedule *Schedule
+	g := &Schedule{
+		ID: i,
+	}
 
 	url, err := b.getAPIPath("/schedules/", strconv.Itoa(i))
 	if err != nil {
@@ -1147,12 +1230,12 @@ func (b *Bridge) GetSchedule(i int) (*Schedule, error) {
 		return nil, err
 	}
 
-	err = json.Unmarshal(res, &schedule)
+	err = json.Unmarshal(res, &g)
 	if err != nil {
 		return nil, err
 	}
 
-	return schedule, nil
+	return g, nil
 
 }
 
@@ -1290,7 +1373,9 @@ func (b *Bridge) GetSensors() ([]Sensor, error) {
 // GetSensor returns one sensor by its id of i
 func (b *Bridge) GetSensor(i int) (*Sensor, error) {
 
-	var r *Sensor
+	r := &Sensor{
+		ID: i,
+	}
 
 	id := strconv.Itoa(i)
 	url, err := b.getAPIPath("/sensors/", id)
@@ -1506,3 +1591,32 @@ func (b *Bridge) UpdateSensorConfig(i int, config *SensorConfig) (*Response, err
 
 	return resp, nil
 }
+
+/*
+
+	CAPABILITIES API
+
+*/
+
+// GetCapabilities returns a list of capabilities of resources supported in the bridge.
+func (b *Bridge) GetCapabilities() (*Capabilities, error) {
+
+	s := &Capabilities{}
+
+	url, err := b.getAPIPath("/capabilities/")
+	if err != nil {
+		return nil, err
+	}
+
+	res, err := get(url)
+	if err != nil {
+		return nil, err
+	}
+
+	err = json.Unmarshal(res, &s)
+	if err != nil {
+		return nil, err
+	}
+
+	return s, err
+}

capabilities.go

@@ -0,0 +1,18 @@
+package huego
+
+// Capabilities holds a combined model of resource capabilities on the bridge: https://developers.meethue.com/documentation/lights-api
+type Capabilities struct {
+	Groups        *Capability `json:"groups,omitempty"`
+	Lights        *Capability `json:"lights,omitempty"`
+	Resourcelinks *Capability `json:"resourcelinks,omitempty"`
+	Schedules     *Capability `json:"schedules,omitempty"`
+	Rules         *Capability `json:"rules,omitempty"`
+	Scenes        *Capability `json:"scenes,omitempty"`
+	Sensors       *Capability `json:"sensors,omitempty"`
+	Streaming     *Capability `json:"streaming,omitempty"`
+}
+
+// Capability defines the resource and subresource capabilities.
+type Capability struct {
+	Available int `json:"available,omitempty"`
+}

capabilities_test.go

@@ -0,0 +1,32 @@
+package huego_test
+
+import (
+	"github.com/amimof/huego"
+	"os"
+	"testing"
+)
+
+func TestGetCapabilities(t *testing.T) {
+	b := huego.New(os.Getenv("HUE_HOSTNAME"), os.Getenv("HUE_USERNAME"))
+	c, err := b.GetCapabilities()
+	if err != nil {
+		t.Fatal(c)
+	}
+	t.Log("Capabilities:")
+	t.Log("  Groups")
+	t.Logf("    Available: %d", c.Groups.Available)
+	t.Log("  Lights")
+	t.Logf("    Available: %d", c.Lights.Available)
+	t.Log("  Resourcelinks")
+	t.Logf("    Available: %d", c.Resourcelinks.Available)
+	t.Log("  Schedules")
+	t.Logf("    Available: %d", c.Schedules.Available)
+	t.Log("  Rules")
+	t.Logf("    Available: %d", c.Rules.Available)
+	t.Log("  Scenes")
+	t.Logf("    Available: %d", c.Scenes.Available)
+	t.Log("  Sensors")
+	t.Logf("    Available: %d", c.Sensors.Available)
+	t.Log("  Streaming")
+	t.Logf("    Available: %d", c.Streaming.Available)
+}