control: Add timer trigger support
When an event is configured with a "timer" trigger, the event's actions
are run after the configured type of timer expires.
Change-Id: I4a400cdae0df560ba58383916c246c10d27d3516
Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
diff --git a/control/json/triggers/timer.cpp b/control/json/triggers/timer.cpp
new file mode 100644
index 0000000..641e33b
--- /dev/null
+++ b/control/json/triggers/timer.cpp
@@ -0,0 +1,85 @@
+/**
+ * Copyright © 2021 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#include "timer.hpp"
+
+#include "../manager.hpp"
+
+#include <fmt/format.h>
+
+#include <nlohmann/json.hpp>
+#include <phosphor-logging/log.hpp>
+
+#include <chrono>
+
+namespace phosphor::fan::control::json::trigger::timer
+{
+
+using json = nlohmann::json;
+using namespace phosphor::logging;
+
+TimerType getType(const json& jsonObj)
+{
+ if (!jsonObj.contains("type"))
+ {
+ log<level::ERR>("Missing required timer trigger type",
+ entry("JSON=%s", jsonObj.dump().c_str()));
+ throw std::runtime_error("Missing required timer trigger type");
+ }
+ auto type = jsonObj["type"].get<std::string>();
+ if (type == "oneshot")
+ {
+ return TimerType::oneshot;
+ }
+ else if (type == "repeating")
+ {
+ return TimerType::repeating;
+ }
+ else
+ {
+ log<level::ERR>(
+ fmt::format("Timer trigger type '{}' is not supported", type)
+ .c_str(),
+ entry("AVAILABLE_TYPES={oneshot, repeating}"));
+ throw std::runtime_error("Unsupported timer trigger type given");
+ }
+}
+
+std::chrono::microseconds getInterval(const json& jsonObj)
+{
+ if (!jsonObj.contains("interval"))
+ {
+ log<level::ERR>("Missing required timer trigger interval",
+ entry("JSON=%s", jsonObj.dump().c_str()));
+ throw std::runtime_error("Missing required timer trigger interval");
+ }
+ return static_cast<std::chrono::microseconds>(
+ jsonObj["interval"].get<uint64_t>());
+}
+
+void triggerTimer(const json& jsonObj, const std::string& eventName,
+ Manager* mgr,
+ std::vector<std::unique_ptr<ActionBase>>& actions)
+{
+ // Get the type and interval of this timer from the JSON
+ auto type = getType(jsonObj);
+ auto interval = getInterval(jsonObj);
+
+ // Create/add event timer
+ auto tpPtr = std::make_unique<TimerPkg>(eventName, std::ref(actions));
+ mgr->addTimer(type, interval, std::move(tpPtr));
+}
+
+} // namespace phosphor::fan::control::json::trigger::timer