Hue.h
14.9 KB
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
/**
\file Hue.h
Copyright Notice\n
Copyright (C) 2017 Jan Rogall - developer\n
Copyright (C) 2017 Moritz Wirger - developer\n
This file is part of hueplusplus.
hueplusplus is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
hueplusplus is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with hueplusplus. If not, see <http://www.gnu.org/licenses/>.
**/
#ifndef INCLUDE_HUEPLUSPLUS_HUE_H
#define INCLUDE_HUEPLUSPLUS_HUE_H
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "APICache.h"
#include "BrightnessStrategy.h"
#include "ColorHueStrategy.h"
#include "ColorTemperatureStrategy.h"
#include "Group.h"
#include "HueCommandAPI.h"
#include "HueLight.h"
#include "IHttpHandler.h"
#include "json/json.hpp"
namespace hueplusplus
{
// forward declarations
class Hue;
//!
//! Class to find all Hue bridges on the network and create usernames for them.
//!
class HueFinder
{
public:
struct HueIdentification
{
std::string ip;
int port = 80;
std::string mac;
};
public:
//! \brief Constructor of HueFinder class
//!
//! \param handler HttpHandler of type \ref IHttpHandler for communication with the bridge
HueFinder(std::shared_ptr<const IHttpHandler> handler);
//! \brief Finds all bridges in the network and returns them.
//!
//! The user should be given the opportunity to select the correct one based on the mac address.
//! \return vector containing ip and mac of all found bridges
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contained no body
std::vector<HueIdentification> FindBridges() const;
//! \brief Gets a \ref Hue bridge based on its identification
//!
//! \param identification \ref HueIdentification that specifies a bridge
//! \return \ref Hue class object
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contained no body or username could not be requested
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
Hue GetBridge(const HueIdentification& identification);
//! \brief Function that adds a username to the usernames map
//!
//! \param mac MAC address of Hue bridge
//! \param username Username that is used to control the Hue bridge
void AddUsername(const std::string& mac, const std::string& username);
//! \brief Function that returns a map of mac addresses and usernames.
//!
//! Note these should be saved at the end and re-loaded with \ref AddUsername
//! next time, so only one username is generated per bridge. \returns A map
//! mapping mac address to username for every bridge
const std::map<std::string, std::string>& GetAllUsernames() const;
//! \brief Normalizes mac address to plain hex number.
//! \returns \p input without separators and whitespace, in lower case.
static std::string NormalizeMac(std::string input);
private:
//! \brief Parses mac address from description.xml
//!
//! \param description Content of description.xml file as returned by GET request.
//! \returns Content of xml element \c serialNumber if description matches a Hue bridge, otherwise an empty
//! string.
static std::string ParseDescription(const std::string& description);
std::map<std::string, std::string> usernames; //!< Maps all macs to usernames added by \ref
//!< HueFinder::AddUsername
std::shared_ptr<const IHttpHandler> http_handler;
};
//! \brief Hue class for a bridge.
//!
//! This is the main class used to interact with the Hue bridge.
class Hue
{
friend class HueFinder;
public:
//! \brief Constructor of Hue class
//!
//! \param ip IP address in dotted decimal notation like "192.168.2.1"
//! \param port Port of the hue bridge
//! \param username String that specifies the username that is used to control
//! the bridge. Can be left empty and acquired in \ref requestUsername.
//! \param handler HttpHandler for communication with the bridge
//! \param refreshDuration Time between refreshing the cached state.
Hue(const std::string& ip, const int port, const std::string& username, std::shared_ptr<const IHttpHandler> handler,
std::chrono::steady_clock::duration refreshDuration = std::chrono::seconds(10));
//! \name Configuration
///@{
//! \brief Function to get the ip address of the hue bridge
//!
//! \return string containing ip
std::string getBridgeIP();
//! \brief Function to get the port of the hue bridge
//!
//! \return integer containing port
int getBridgePort();
//! \brief Send a username request to the Hue bridge.
//!
//! Blocks for about 30 seconds and 5 seconds to prepare.
//! It automatically sets the username variable according to the username received and returns the username
//! received. This function should only be called once to acquire a username to control the bridge and the
//! username should be saved for future use. \return username for API usage \throws std::system_error when
//! system or socket operations fail \throws HueException when response contained no body \throws
//! HueAPIResponseException when response contains an error except link button not pressed. \throws
//! nlohmann::json::parse_error when response could not be parsed
std::string requestUsername();
//! \brief Function that returns the username
//!
//! \return The username used for API access
std::string getUsername();
//! \brief Function to set the ip address of this class representing a bridge
//!
//! \param ip String that specifies the ip in dotted decimal notation like "192.168.2.1"
void setIP(const std::string& ip);
//! \brief Function to set the port of this class representing a bridge
//!
//! \param port Integer that specifies the port of an address like
//! "192.168.2.1:8080"
void setPort(const int port);
//! \brief Function that sets the HttpHandler and updates the HueCommandAPI.
//!
//! The HttpHandler and HueCommandAPI are used for bridge communication
//! \param handler a HttpHandler of type \ref IHttpHandler
void setHttpHandler(std::shared_ptr<const IHttpHandler> handler);
///@}
//! \name Lights
///@{
//! \brief Function that returns a \ref HueLight of specified id
//!
//! \param id Integer that specifies the ID of a Hue light
//! \return \ref HueLight that can be controlled
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when id does not exist or type is unknown
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
HueLight& getLight(int id);
//! \brief Function to remove a light from the bridge
//!
//! \attention Any use of the light after it was successfully removed results in undefined behavior
//! \param id Id of the light to remove
//! \return true on success
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contains no body
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
bool removeLight(int id);
//! \brief Function that returns all lights that are associated with this
//! bridge
//!
//! \return A vector containing references to every HueLight
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contains no body
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
std::vector<std::reference_wrapper<HueLight>> getAllLights();
//! \brief Function that tells whether a given light id represents an existing light
//! \param id Id of a light to check for existance
//! \return Bool that is true when a light with the given id exists and false when not
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contains no body
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
bool lightExists(int id);
//! \brief Const function that tells whether a given light id represents an
//! existing light
//!
//! \note This will not update the local state of the bridge
//! \param id Id of a light to check for existance
//! \return Bool that is true when a light with the given id exists and false
//! when not
bool lightExists(int id) const;
///@}
//! \name Groups
///@{
//! \brief Get all groups that exist on this bridge.
//! \return A vector of references to every Group.
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contains no body
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
std::vector<std::reference_wrapper<Group>> getAllGroups();
//! \brief Get group specified by id.
//! \param id ID of the group.
//! \returns Group that can be controlled.
//! \note Every bridge has a special group 0 which contains all lights
//! and is not visible to getAllGroups().
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when id does not exist
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
Group& getGroup(int id);
//! \brief Remove a group from the bridge.
//! \param id ID of the group.
//! \returns true on success.
//! \brief Remove a group from the bridge.
//! \param id ID of the group.
//! \returns true on success.
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contains no body
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
bool removeGroup(int id);
//! \brief Checks whether a group exists.
//! \param id ID of the group.
//! \returns true when the group exists.
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contains no body
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
bool groupExists(int id);
//! \brief Checks whether a group exists.
//! \param id ID of the group.
//! \returns true when the group exists.
//! \note Does not refresh the cached state.
bool groupExists(int id) const;
//! \brief Create a new group.
//! \param params CreateGroup parameters for the new group.
//! \returns The new group id or 0 if failed.
//! \throws std::system_error when system or socket operations fail
//! \throws HueException when response contains no body
//! \throws HueAPIResponseException when response contains an error
//! \throws nlohmann::json::parse_error when response could not be parsed
int createGroup(const CreateGroup& params);
///@}
//! \brief Const function that returns the picture name of a given light id
//!
//! \note This will not update the local state of the bridge.
//! \note This function will only return the filename without extension,
//! because Philips provides different file types. \param id Id of a light to
//! get the picture of \return String that either contains the filename of the
//! picture of the light or if it was not found an empty string
std::string getPictureOfLight(int id) const;
//! \brief Const function that returns the picture name of a given model id
//!
//! \note This will not update the local state of the bridge.
//! \note This function will only return the filename without extension,
//! because Philips provides different file types. \param model_id Model Id of
//! a device to get the picture of \return String that either contains the
//! filename of the picture of the device or if it was not found an empty
//! string
std::string getPictureOfModel(const std::string& model_id) const;
private:
std::string ip; //!< IP-Address of the hue bridge in dotted decimal notation
//!< like "192.168.2.1"
std::string username; //!< Username that is ussed to access the hue bridge
int port;
std::map<uint8_t, HueLight> lights; //!< Maps ids to HueLights that are controlled by this bridge
std::map<uint8_t, Group> groups; //!< Maps ids to Groups
std::shared_ptr<BrightnessStrategy> simpleBrightnessStrategy; //!< Strategy that is used for controlling the
//!< brightness of lights
std::shared_ptr<ColorHueStrategy> simpleColorHueStrategy; //!< Strategy that is used for controlling the
//!< color of lights
std::shared_ptr<ColorHueStrategy> extendedColorHueStrategy; //!< Strategy that is used for controlling the
//!< color of lights
std::shared_ptr<ColorTemperatureStrategy> simpleColorTemperatureStrategy; //!< Strategy that is used for controlling
//!< the color temperature of lights
std::shared_ptr<ColorTemperatureStrategy> extendedColorTemperatureStrategy; //!< Strategy that is used for
//!< controlling the color
//!< temperature of lights
std::shared_ptr<const IHttpHandler> http_handler; //!< A IHttpHandler that is used to communicate with the
//!< bridge
HueCommandAPI commands; //!< A HueCommandAPI that is used to communicate with the bridge
APICache stateCache; //!< The state of the hue bridge as it is returned from it
};
} // namespace hueplusplus
#endif