profile_procedures.h

Go to the documentation of this file.

#pragma once
 
#include <chrono>
#include <expected>
#include <nlohmann/json_fwd.hpp>
#include <stop_token>
#include <string>
#include <string_view>
#include <vector>
 
#include "node/device.h"
#include "node/procedure.h"
#include "node/profile_device.h"
 
namespace mm::node {
 
 
inline constexpr std::string_view kStoreParametersProcedure = "store-parameters";
 
inline constexpr std::string_view kStoreParametersStep = "store";
 
std::vector<ProgressStep> storeParametersSteps();
 
std::expected<void, std::string> runStoreParametersProcedure(Device& device,
                                                             ProgressReporter& reporter,
                                                             std::stop_token stop,
                                                             StoreParametersConfig config = {});
 
inline constexpr std::string_view kRestoreDefaultParametersProcedure = "restore-default-parameters";
 
inline constexpr std::string_view kRestoreDefaultParametersStep = "restore";
 
struct RestoreDefaultParametersRequest {
  RestoreGroup group{RestoreGroup::kAll};
};
 
std::expected<RestoreDefaultParametersRequest, std::string> parseRestoreDefaultParametersRequest(
    const nlohmann::json& body);
 
std::vector<ProcedureParameter> restoreDefaultParametersParameters();
 
std::vector<ProgressStep> restoreDefaultParametersSteps();
 
std::expected<void, std::string> runRestoreDefaultParametersProcedure(
    Device& device, ProgressReporter& reporter, std::stop_token stop,
    const RestoreDefaultParametersRequest& request, RestoreDefaultParametersConfig config = {});
 
inline constexpr std::string_view kDeviceLocateProcedure = "device-locate";
 
inline constexpr std::string_view kDeviceLocateStep = "locate";
 
struct DeviceLocateRequest {
  std::chrono::seconds duration{10};
};
 
std::expected<DeviceLocateRequest, std::string> parseDeviceLocateRequest(
    const nlohmann::json& body);
 
std::vector<ProcedureParameter> deviceLocateParameters();
 
std::vector<ProgressStep> deviceLocateSteps();
 
std::expected<void, std::string> runDeviceLocateProcedure(Device& device,
                                                          ProgressReporter& reporter,
                                                          const std::stop_token& stop,
                                                          const DeviceLocateRequest& request);
 
}  // namespace mm::node