signalk_metadata.h

Go to the documentation of this file.

#ifndef SENSESP_SIGNALK_SIGNALK_METADATA_H_
#define SENSESP_SIGNALK_SIGNALK_METADATA_H_
 
#include <ArduinoJson.h>
#include <cmath>
#include <vector>
 
namespace sensesp {
 
enum class SKAlarmState {
  kNominal,
  kNormal,
  kAlert,
  kWarn,
  kAlarm,
  kEmergency
};
 
struct SKMetadataZone {
  float lower;  
  float upper;  
  String message;
  SKAlarmState state;
 
  SKMetadataZone(SKAlarmState state, const String& message, float lower,
                 float upper = NAN)
      : lower{lower}, upper{upper}, message{message}, state{state} {}
};
 
class SKMetadata {
 public:
  String display_name_;
  String units_;
  String description_;
  String short_name_;
  float timeout_;
  bool supports_put_;
  String example_;  
  float display_scale_lower_ = NAN;
  float display_scale_upper_ = NAN;
  std::vector<SKMetadataZone> zones_;
 
  SKMetadata(const String& units, const String& display_name = "",
             const String& description = "", const String& short_name = "",
             float timeout = -1.0, bool supports_put = false);
 
  SKMetadata() : timeout_{-1}, supports_put_{false} {}
 
  virtual void add_entry(const String& sk_path, JsonArray& meta);
 
 protected:
  static const char* alarm_state_to_string(SKAlarmState state);
};
 
}  // namespace sensesp
 
#endif