signalk_output.h

Go to the documentation of this file.

#ifndef _signalk_output_H_
#define _signalk_output_H_
 
#include "sensesp/transforms/transform.h"
#include "signalk_emitter.h"
 
namespace sensesp {
 
static const char SIGNALKOUTPUT_SCHEMA[] PROGMEM = R"({
      "type": "object",
      "properties": {
          "sk_path": { "title": "Signal K Path", "type": "string" }
      }
  })";
 
template <typename T>
class SKOutput : public SKEmitter, public SymmetricTransform<T> {
 public:
  SKOutput() : SKOutput("") { this->load_configuration(); }
 
  SKOutput(String sk_path, String config_path = "", SKMetadata* meta = NULL)
      : SKEmitter(sk_path), SymmetricTransform<T>(config_path), meta_{meta} {
    Startable::set_start_priority(-5);
    this->load_configuration();
  }
 
  SKOutput(String sk_path, SKMetadata* meta) : SKOutput(sk_path, "", meta) {}
 
  virtual void set_input(T new_value, uint8_t input_channel = 0) override {
    this->ValueProducer<T>::emit(new_value);
  }
 
  virtual String as_signalk() override {
    DynamicJsonDocument json_doc(1024);
    String json;
    json_doc["path"] = this->get_sk_path();
    json_doc["value"] = ValueProducer<T>::output;
    serializeJson(json_doc, json);
    return json;
  }
 
  virtual void get_configuration(JsonObject& root) override {
    root["sk_path"] = this->get_sk_path();
  }
 
  String get_config_schema() override { return FPSTR(SIGNALKOUTPUT_SCHEMA); }
 
  virtual bool set_configuration(const JsonObject& config) override {
    if (!config.containsKey("sk_path")) {
      return false;
    }
    this->set_sk_path(config["sk_path"].as<String>());
    return true;
  }
 
  virtual void set_metadata(SKMetadata* meta) { this->meta_ = meta; }
 
  virtual SKMetadata* get_metadata() override { return meta_; }
 
 protected:
  SKMetadata* meta_;
};
 
class SKOutputRawJson : public SKOutput<String> {
 public:
  SKOutputRawJson(String sk_path, String config_path = "",
                  SKMetadata* meta = NULL)
      : SKOutput<String>(sk_path, config_path, meta) {}
 
  virtual String as_signalk() override {
    DynamicJsonDocument json_doc(4096);
    String json;
    json_doc["path"] = this->get_sk_path();
    json_doc["value"] = serialized(ValueProducer<String>::output);
    serializeJson(json_doc, json);
    return json;
  }
};
 
template <typename T>
class SKOutputNumeric : public SKOutput<T> {
 public:
  SKOutputNumeric(String sk_path, String config_path = "",
                  SKMetadata* meta = NULL);
 
  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