signalk_output.h

Go to the documentation of this file.

#ifndef SENSESP_SIGNALK_SIGNALK_OUTPUT_H_
#define SENSESP_SIGNALK_SIGNALK_OUTPUT_H_
 
#include <memory>
 
#include "sensesp/transforms/transform.h"
#include "sensesp/ui/config_item.h"
#include "signalk_emitter.h"
 
namespace sensesp {
 
template <typename T>
class SKOutput : public SKEmitter, public SymmetricTransform<T> {
 public:
  SKOutput() : SKOutput("") { this->load(); }
 
  SKOutput(String sk_path, String config_path = "", SKMetadata* meta = nullptr)
      : SKOutput(sk_path, config_path, std::shared_ptr<SKMetadata>(meta)) {}
 
  SKOutput(String sk_path, String config_path, std::shared_ptr<SKMetadata> meta)
      : SKEmitter(sk_path), SymmetricTransform<T>(config_path), meta_{meta} {
    this->load();
  }
 
  SKOutput(String sk_path, SKMetadata* meta) : SKOutput(sk_path, "", meta) {}
 
  virtual void set(const T& new_value) override {
    this->ValueProducer<T>::emit(new_value);
  }
 
  virtual void as_signalk_json(JsonDocument& doc) override {
    doc["path"] = this->get_sk_path();
    doc["value"] = ValueProducer<T>::output_;
  }
 
  virtual bool to_json(JsonObject& root) override {
    root["sk_path"] = this->get_sk_path();
    return true;
  }
 
  virtual bool from_json(const JsonObject& config) override {
    if (!config["sk_path"].is<String>()) {
      return false;
    }
    this->set_sk_path(config["sk_path"].as<String>());
    return true;
  }
 
  virtual void set_metadata(SKMetadata* meta) {
    this->meta_ = std::make_shared<SKMetadata>(*meta);
  }
 
  virtual SKMetadata* get_metadata() override { return meta_.get(); }
 
 protected:
  std::shared_ptr<SKMetadata> meta_;
};
 
template <typename T>
const String ConfigSchema(const SKOutput<T>& obj) {
  return R"({"type":"object","properties":{"sk_path":{"title":"Signal K Path","type":"string"}}  })";
}
 
template <typename T>
bool ConfigRequiresRestart(const SKOutput<T>& obj) {
  return true;
}
 
class SKOutputRawJson : public SKOutput<String> {
 public:
  SKOutputRawJson(String sk_path, String config_path = "",
                  SKMetadata* meta = NULL)
      : SKOutput<String>(sk_path, config_path, meta) {}
 
  virtual void as_signalk_json(JsonDocument& doc) override {
    doc["path"] = this->get_sk_path();
    doc["value"] = serialized(ValueProducer<String>::output_);
  }
};
 
template <typename T>
class SKOutputNumeric : public SKOutput<T> {
 public:
  SKOutputNumeric(String sk_path, String config_path = "",
                  SKMetadata* meta = nullptr);
 
  SKOutputNumeric(String sk_path, SKMetadata* meta)
      : SKOutputNumeric(sk_path, "", meta) {}
 
  SKOutputNumeric(String sk_path, String config_path, String units)
      : SKOutputNumeric(sk_path, config_path, new SKMetadata(units)) {}
};
 
typedef SKOutputNumeric<float> SKOutputFloat;
typedef SKOutputNumeric<int> SKOutputInt;
typedef SKOutput<bool> SKOutputBool;
typedef SKOutput<String> SKOutputString;
 
}  // namespace sensesp
 
#endif