Add scheduleScene to Group so scenes can be scheduled.

Needed because setScene is not available in StateTransaction.

Add scheduleScene to Group so scenes can be scheduled.
Needed because setScene is not available in StateTransaction.
Jojo-1000 · Moritz Wirger
1 parent 9db7c1ab
Showing 6 changed files with 41 additions and 5 deletions
include/hueplusplus/APICache.h
include/hueplusplus/Group.h
include/hueplusplus/HueCommandAPI.h
src/APICache.cpp
src/Group.cpp
test/test_Group.cpp
@@ -74,6 +74,8 @@ public:
     //! \brief Get HueCommandAPI used for requests
     HueCommandAPI& getCommandAPI();
+    //! \brief Get HueCommandAPI used for requests
+    const HueCommandAPI& getCommandAPI() const;
     //! \brief Get path the cache is refreshed from
     //! \returns Request path as passed to HueCommandAPI::GETRequest
@@ -264,6 +264,13 @@ public:
     //! \param scene Scene name.
     void setScene(const std::string& scene);
+    //! \brief Get ScheduleCommand to set scene
+    //! \param scene Scene name
+    //! \returns A ScheduleCommand that can be used to set the scene on a Schedule
+    //!
+    //! To set other light properties in a scene, use transaction().
+    ScheduleCommand scheduleScene(const std::string& scene) const;
+
     ///@}
 protected:
@@ -62,7 +62,7 @@ public:
     //! \brief Sends a HTTP PUT request to the bridge and returns the response
     //!
-    //! This function will block until at least \ref minDelay has passed to any previous request
+    //! This function will block until at least Config::getBridgeRequestDelay() has passed to any previous request
     //! \param path API request path (appended after /api/{username})
     //! \param request Request to the api, may be empty
     //! \param fileInfo File information for thrown exceptions.
@@ -76,7 +76,7 @@ public:
     //! \brief Sends a HTTP GET request to the bridge and returns the response
     //!
-    //! This function will block until at least \ref minDelay has passed to any previous request
+    //! This function will block until at least Config::getBridgeRequestDelay() has passed to any previous request
     //! \param path API request path (appended after /api/{username})
     //! \param request Request to the api, may be empty
     //! \param fileInfo File information for thrown exceptions.
@@ -91,7 +91,7 @@ public:
     //! \brief Sends a HTTP DELETE request to the bridge and returns the response
     //!
-    //! This function will block until at least \ref minDelay has passed to any previous request
+    //! This function will block until at least Config::getBridgeRequestDelay() has passed to any previous request
     //! \param path API request path (appended after /api/{username})
     //! \param request Request to the api, may be empty
     //! \param fileInfo File information for thrown exceptions.
@@ -106,7 +106,7 @@ public:
     //! \brief Sends a HTTP POST request to the bridge and returns the response
     //!
-    //! This function will block until at least \ref minDelay has passed to any previous request
+    //! This function will block until at least Config::getBridgeRequestDelay() has passed to any previous request
     //! \param path API request path (appended after /api/{username})
     //! \param request Request to the api, may be empty
     //! \param fileInfo File information for thrown exceptions.
@@ -118,6 +118,11 @@ HueCommandAPI&amp; APICache::getCommandAPI()
     return commands;
 }
+const HueCommandAPI& APICache::getCommandAPI() const
+{
+    return commands;
+}
+
 bool APICache::needsRefresh()
 {
     using clock = std::chrono::steady_clock;
@@ -141,7 +141,8 @@ std::string Group::getActionColorMode() const
 StateTransaction Group::transaction()
 {
     // Do not pass state, because it is not the state of ALL lights in the group
-    return StateTransaction(state.getCommandAPI(), "/groups/" + std::to_string(id) + "/action", nlohmann::json::object());
+    return StateTransaction(
+        state.getCommandAPI(), "/groups/" + std::to_string(id) + "/action", nlohmann::json::object());
 }
 void Group::setOn(bool on, uint8_t transition)
@@ -179,6 +180,14 @@ void Group::setScene(const std::string&amp; scene)
     sendPutRequest({{"scene", scene}}, "/action", CURRENT_FILE_INFO);
 }
+ScheduleCommand Group::scheduleScene(const std::string& scene) const
+{
+    const nlohmann::json command {{"method", "PUT"},
+        {"address", state.getCommandAPI().combinedPath("/groups/" + std::to_string(id) + "/action")},
+        {"body", {{"scene", scene}}}};
+    return ScheduleCommand(command);
+}
+
 nlohmann::json Group::sendPutRequest(const nlohmann::json& request, const std::string& subPath, FileInfo fileInfo)
 {
     return state.getCommandAPI().PUTRequest("/groups/" + std::to_string(id) + subPath, request, std::move(fileInfo));
@@ -253,6 +253,19 @@ TEST_F(GroupTest, setScene)
     group.setScene(scene);
 }
+TEST_F(GroupTest, scheduleScene)
+{
+    const int id = 1;
+    expectGetState(id);
+    const Group group(id, commands, std::chrono::steady_clock::duration::max());
+    const std::string scene = "testScene";
+    nlohmann::json request = { {"scene", scene} };
+    ScheduleCommand command = group.scheduleScene(scene);
+    EXPECT_EQ(ScheduleCommand::Method::put, command.getMethod());
+    EXPECT_EQ("/api/" + getBridgeUsername() + "/groups/1/action", command.getAddress());
+    EXPECT_EQ(request, command.getBody());
+}
+
 TEST(CreateGroup, LightGroup)
 {
     EXPECT_EQ(nlohmann::json({{"lights", {"1"}}, {"type", "LightGroup"}, {"name", "Name"}}),