signalk_put_request.h

Go to the documentation of this file.

#ifndef SENSESP_SIGNALK_SIGNALK_PUT_REQUEST_H_
#define SENSESP_SIGNALK_SIGNALK_PUT_REQUEST_H_
 
#include <ArduinoJson.h>
#include <functional>
#include <map>
 
#include "sensesp/ui/config_item.h"
#include "sensesp/system/valueconsumer.h"
 
namespace sensesp {

class SKRequest {
 public:
  static String send_request(JsonDocument& request,
                             std::function<void(JsonDocument&)> callback,
                             uint32_t timeout = 5000);

  static void handle_response(JsonDocument& response);
 
 protected:
  class PendingRequest {
   public:
    String request_id;
    std::function<void(JsonDocument&)> callback;
    reactesp::DelayEvent* timeout_cleanup;
  };

  static std::map<String, PendingRequest*> request_map_;

  static StaticSemaphore_t request_map_mutex_buffer_;
  static SemaphoreHandle_t request_map_mutex_;

  static void remove_request(String request_id);

  static PendingRequest* get_request(String request_id);
};

class SKPutRequestBase : public SKRequest,
                         public FileSystemSaveable {
 public:
  SKPutRequestBase(const String& sk_path, const String& config_path = "",
                   uint32_t timeout = 5000);
 
  // For reading and writing the configuration
  virtual bool to_json(JsonObject& root) override;
  virtual bool from_json(const JsonObject& config) override;

  String get_sk_path() { return sk_path; }

  bool request_pending();
 
 protected:
  void send_put_request();

  virtual void set_put_value(JsonObject& put_data) = 0;

  virtual void on_response(JsonDocument& response);
 
  String sk_path{};
  uint32_t timeout{};
  String pending_request_id_{};
};

template <typename T>
class SKPutRequest : public SKPutRequestBase,
                     public ValueConsumer<T> {
 public:
  SKPutRequest(String sk_path, String config_path = "",
               bool ignore_duplicates = true, uint32_t timeout = 5000)
      : SKPutRequestBase(sk_path, config_path, timeout),
        ignore_duplicates_{ignore_duplicates} {}
 
  virtual void set(const T& new_value) override {
    if (ignore_duplicates_ && new_value == value_) {
      return;
    }
    if (!request_pending()) {
      this->value_ = new_value;
      send_put_request();
    } else {
      ESP_LOGW(__FILENAME__,
               "Ignoring PUT request (previous request still outstanding)");
    }
  };
 
  virtual void set_put_value(JsonObject& put_data) override {
    put_data["value"] = value_;
  };
 
 protected:
  T value_;
  bool ignore_duplicates_;
};
 
template <typename T>
const String ConfigSchema(const SKPutRequest<T>& obj) {
  static const char schema[] = R"###({"type":"object","properties":{"sk_path":{"title":"Signal K Path","type":"string"}}  })###";
  return schema;
}
 
typedef SKPutRequest<float> FloatSKPutRequest;
typedef SKPutRequest<int> IntSKPutRequest;
typedef SKPutRequest<bool> BoolSKPutRequest;
typedef SKPutRequest<String> StringSKPutRequest;
 
}  // namespace sensesp
 
#endif