1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* light.go
* GoHue library for Philips Hue
* Copyright (C) 2016 Collin Guarino (Collinux) collin.guarino@gmail.com
* License: GPL version 2 or higher http://www.gnu.org/licenses/gpl.html
*/
// http://www.developers.meethue.com/documentation/lights-api
package hue
import (
"fmt"
"encoding/json"
"strings"
"errors"
"time"
)
// Light struct defines attributes of a light.
type Light struct {
State struct {
On bool `json:"on"` // On or Off state of the light ("true" or "false")
Bri int `json:"bri"` // Brightness value 1-254
Hue int `json:"hue"` // Hue value 1-65535
Saturation int `json:"sat"` // Saturation value 0-254
Effect string `json:"effect"` // "None" or "Colorloop"
XY [2]float32 `json:"xy"` // Coordinates of color in CIE color space
CT int `json:"ct"` // Mired Color Temperature (google it)
Alert string `json:"alert"`
ColorMode string `json:"colormode"`
Reachable bool `json:"reachable"`
} `json:"state"`
Type string `json:"type"`
Name string `json:"name"`
ModelID string `json:"modelid"`
ManufacturerName string `json:"manufacturername"`
UniqueID string `json:"uniqueid"`
SWVersion string `json:"swversion"`
Index int // Set by index of light array response // TODO: change to smaller int
Bridge *Bridge
}
// LightState used in SetLightState to amend light attributes.
type LightState struct {
On bool `json:"on"`
Bri uint8 `json:"bri,omitempty"`
Hue uint16 `json:"hue,omitempty"`
Sat uint8 `json:"sat,omitempty"`
XY *[2]float32 `json:"xy,omitempty"`
CT uint16 `json:"ct,omitempty"`
Effect string `json:"effect,omitempty"`
Alert string `json:"alert,omitempty"`
TransitionTime string `json:"transitiontime,omitempty"`
SaturationIncrement int `json:"sat_inc,omitempty"` // TODO: -254 to 254
HueIncrement int `json:"hue_inc,omitempty"` // TODO: -65534 to 65534
BrightnessIncrement int `json:"bri_inc,omitempty"` // TODO: -254 to 254
CTIncrement int `json:"ct_inc,omitempty"` // TODO: -65534 to 65534
XYIncrement *[2]float32 `json:"xy_inc,omitempty"`
Name string `json:"name,omitempty"`
}
// Light.SetName will assign a new name in the light's
// attributes as recognized by the bridge.
func (self *Light) SetName(name string) error {
uri := fmt.Sprintf("/api/%s/lights/%d", self.Bridge.Username, self.Index)
body := make(map[string]string)
body["name"] = name
_, _, err := self.Bridge.Put(uri, body)
if err != nil {
return err
}
return nil
}
// Light.Off will turn the light source off
func (self *Light) Off() error {
return SetLightState(self, LightState{On: false})
}
// Light.Off will turn the light source on
func (self *Light) On() error {
return SetLightState(self, LightState{On: true})
}
// Light.Toggle will toggle the light source on and off
func (self *Light) Toggle() error {
if self.State.On {
return self.Off()
} else {
return self.On()
}
return nil
}
// Light.Delete will remove the light from the list of
// lights available on the bridge.
func (self *Light) Delete() error {
uri := fmt.Sprintf("/api/%s/lights/%d", self.Bridge.Username, self.Index)
err := self.Bridge.Delete(uri)
if err != nil {
return err
}
return nil
}
// Light.Blink will turn the light off and on repeatedly for a given seconds
// interval and return the light back to its off or on state afterwards.
// Note: time will vary based on connection speed and algorithm speed.
func (self *Light) Blink(seconds int) error {
originalState := self.State.On
// Toggle the light on and off
for i := 0; i <= seconds; i++ {
err := self.Toggle()
if err != nil {
return err
}
time.Sleep(time.Second)
}
// Return the light to its original on or off state
if self.State.On != originalState {
err := self.Toggle()
if err != nil {
return err
}
}
return nil
}
// Light.ColorLoop will set the light state to 'colorloop' if `active`
// is true or it will set the light state to "none" if `activate` is false.
func (self *Light) ColorLoop(activate bool) error {
var state = "none"
if activate {
state = "colorloop"
}
return SetLightState(self, LightState{On: true, Effect: state})
}
// SetLightState will modify light attributes such as on/off, saturation,
// brightness, and more. See `SetLightState` struct.
func SetLightState(light *Light, newState LightState) error {
uri := fmt.Sprintf("/api/%s/lights/%d/state", light.Bridge.Username, light.Index)
_, _, err := light.Bridge.Put(uri, newState)
if err != nil {
return err
}
// Get the new light state and update the current Light struct
*light, err = GetLightByIndex(light.Bridge, light.Index)
if err != nil {
return err
}
return nil
}
// GetAllLights retreives the state of all lights that the bridge is aware of.
func GetAllLights(bridge *Bridge) ([]Light, error) {
// Loop through all light indicies to see if they exist
// and parse their values. Supports 100 lights.
var lights []Light
for index := 1; index < 101; index++ {
light, err := GetLightByIndex(bridge, index)
if err != nil {
break
}
lights = append(lights, light)
}
return lights, nil
}
// GetLightByIndex will return a light struct containing data on
// a light given its index stored on the bridge. This is used for
// quickly updating an individual light.
func GetLightByIndex(bridge *Bridge, index int) (Light, error) {
// Send an http GET and inspect the response
uri := fmt.Sprintf("/api/%s/lights/%d", bridge.Username, index)
body, _, err := bridge.Get(uri)
if err != nil {
return Light{}, err
}
if strings.Contains(string(body), "not available") {
return Light{}, errors.New("Index Error")
}
// Parse and load the response into the light array
light := Light{}
err = json.Unmarshal(body, &light)
if err != nil {
trace("", err)
}
light.Index = index
light.Bridge = bridge
return light, nil
}
// GetLight will return a light struct containing data on a given name.
func GetLightByName(bridge *Bridge, name string) (Light, error) {
lights, _ := GetAllLights(bridge)
for _, light := range lights {
if light.Name == name {
return light, nil
}
}
return Light{}, errors.New("Light not found.")
}
|
