snapshot.h

Go to the documentation of this file.

#pragma once
 
#ifdef USE_HOST
#include "esphome/core/automation.h"
 
#include <cstddef>
#include <cstdint>
#include <string>
 
// Directory snapshots are written to. Normally set by codegen to a folder under .esphome; the
// fallback keeps the component compiling for static analysis, where no defines.h is generated.
#ifndef ESPHOME_SNAPSHOT_DIR
#define ESPHOME_SNAPSHOT_DIR "."
#endif
 
namespace esphome::snapshot {
 
class Snapshot {
 public:
  virtual ~Snapshot() = default;
 
  void set_snapshot_prefix(const char *prefix) { this->snapshot_prefix_ = prefix; }
 
  bool take_snapshot(const char *filename);
 
  static void log_action_failed();
 
 protected:
  virtual int snapshot_width() = 0;
  virtual int snapshot_height() = 0;
  virtual bool capture_bgr(uint8_t *dest, size_t row_stride) = 0;
 
  const char *snapshot_prefix_{"snapshot"};
};
 
template<typename... Ts> class SnapshotAction final : public Action<Ts...>, public Parented<Snapshot> {
 public:
  TEMPLATABLE_VALUE(std::string, filename)
 
 protected:
  void play(const Ts &...x) override {
    bool ok;
    if (this->filename_.has_value()) {
      ok = this->parent_->take_snapshot(this->filename_.value(x...).c_str());
    } else {
      ok = this->parent_->take_snapshot(nullptr);
    }
    if (!ok)
      this->parent_->log_action_failed();
  }
};
 
}  // namespace esphome::snapshot
 
#endif