ESPHome  2024.7.0
esp32_camera.h
Go to the documentation of this file.
1 #pragma once
2 
3 #ifdef USE_ESP32
4 
8 #include "esphome/core/helpers.h"
9 #include <esp_camera.h>
10 #include <freertos/FreeRTOS.h>
11 #include <freertos/queue.h>
12 
13 namespace esphome {
14 namespace esp32_camera {
15 
16 class ESP32Camera;
17 
18 /* ---------------- enum classes ---------------- */
20 
40 };
41 
43  ESP32_GAINCEILING_2X = GAINCEILING_2X,
44  ESP32_GAINCEILING_4X = GAINCEILING_4X,
45  ESP32_GAINCEILING_8X = GAINCEILING_8X,
46  ESP32_GAINCEILING_16X = GAINCEILING_16X,
47  ESP32_GAINCEILING_32X = GAINCEILING_32X,
48  ESP32_GAINCEILING_64X = GAINCEILING_64X,
49  ESP32_GAINCEILING_128X = GAINCEILING_128X,
50 };
51 
55 };
56 
63 };
64 
73 };
74 
75 /* ---------------- CameraImage class ---------------- */
76 class CameraImage {
77  public:
78  CameraImage(camera_fb_t *buffer, uint8_t requester);
79  camera_fb_t *get_raw_buffer();
80  uint8_t *get_data_buffer();
81  size_t get_data_length();
82  bool was_requested_by(CameraRequester requester) const;
83 
84  protected:
85  camera_fb_t *buffer_;
86  uint8_t requesters_;
87 };
88 
90  uint8_t *data;
91  size_t length;
92 };
93 
94 /* ---------------- CameraImageReader class ---------------- */
96  public:
97  void set_image(std::shared_ptr<CameraImage> image);
98  size_t available() const;
99  uint8_t *peek_data_buffer();
100  void consume_data(size_t consumed);
101  void return_image();
102 
103  protected:
104  std::shared_ptr<CameraImage> image_;
105  size_t offset_{0};
106 };
107 
108 /* ---------------- ESP32Camera class ---------------- */
109 class ESP32Camera : public Component, public EntityBase {
110  public:
111  ESP32Camera();
112 
113  /* setters */
114  /* -- pin assignment */
115  void set_data_pins(std::array<uint8_t, 8> pins);
116  void set_vsync_pin(uint8_t pin);
117  void set_href_pin(uint8_t pin);
118  void set_pixel_clock_pin(uint8_t pin);
119  void set_external_clock(uint8_t pin, uint32_t frequency);
120  void set_i2c_pins(uint8_t sda, uint8_t scl);
121  void set_reset_pin(uint8_t pin);
122  void set_power_down_pin(uint8_t pin);
123  /* -- image */
124  void set_frame_size(ESP32CameraFrameSize size);
125  void set_jpeg_quality(uint8_t quality);
126  void set_vertical_flip(bool vertical_flip);
127  void set_horizontal_mirror(bool horizontal_mirror);
128  void set_contrast(int contrast);
129  void set_brightness(int brightness);
130  void set_saturation(int saturation);
131  void set_special_effect(ESP32SpecialEffect effect);
132  /* -- exposure */
133  void set_aec_mode(ESP32GainControlMode mode);
134  void set_aec2(bool aec2);
135  void set_ae_level(int ae_level);
136  void set_aec_value(uint32_t aec_value);
137  /* -- gains */
138  void set_agc_mode(ESP32GainControlMode mode);
139  void set_agc_value(uint8_t agc_value);
140  void set_agc_gain_ceiling(ESP32AgcGainCeiling gain_ceiling);
141  /* -- white balance */
142  void set_wb_mode(ESP32WhiteBalanceMode mode);
143  /* -- test */
144  void set_test_pattern(bool test_pattern);
145  /* -- framerates */
146  void set_max_update_interval(uint32_t max_update_interval);
147  void set_idle_update_interval(uint32_t idle_update_interval);
148 
149  /* public API (derivated) */
150  void setup() override;
151  void loop() override;
152  void dump_config() override;
153  float get_setup_priority() const override;
154  /* public API (specific) */
155  void start_stream(CameraRequester requester);
156  void stop_stream(CameraRequester requester);
157  void request_image(CameraRequester requester);
158  void update_camera_parameters();
159 
160  void add_image_callback(std::function<void(std::shared_ptr<CameraImage>)> &&callback);
161  void add_stream_start_callback(std::function<void()> &&callback);
162  void add_stream_stop_callback(std::function<void()> &&callback);
163 
164  protected:
165  /* internal methods */
166  bool has_requested_image_() const;
167  bool can_return_image_() const;
168 
169  static void framebuffer_task(void *pv);
170 
171  /* attributes */
172  /* camera configuration */
173  camera_config_t config_{};
174  /* -- image */
175  bool vertical_flip_{true};
176  bool horizontal_mirror_{true};
177  int contrast_{0};
178  int brightness_{0};
179  int saturation_{0};
181  /* -- exposure */
183  bool aec2_{false};
184  int ae_level_{0};
185  uint32_t aec_value_{300};
186  /* -- gains */
188  uint8_t agc_value_{0};
190  /* -- white balance */
192  /* -- Test */
193  bool test_pattern_{false};
194  /* -- framerates */
195  uint32_t max_update_interval_{1000};
196  uint32_t idle_update_interval_{15000};
197 
198  esp_err_t init_error_{ESP_OK};
199  std::shared_ptr<CameraImage> current_image_;
200  uint8_t single_requesters_{0};
201  uint8_t stream_requesters_{0};
202  QueueHandle_t framebuffer_get_queue_;
205  CallbackManager<void()> stream_start_callback_{};
206  CallbackManager<void()> stream_stop_callback_{};
207 
208  uint32_t last_idle_request_{0};
209  uint32_t last_update_{0};
210 };
211 
212 // NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
214 
215 class ESP32CameraImageTrigger : public Trigger<CameraImageData> {
216  public:
218  parent->add_image_callback([this](const std::shared_ptr<esp32_camera::CameraImage> &image) {
219  CameraImageData camera_image_data{};
220  camera_image_data.length = image->get_data_length();
221  camera_image_data.data = image->get_data_buffer();
222  this->trigger(camera_image_data);
223  });
224  }
225 };
226 
228  public:
230  parent->add_stream_start_callback([this]() { this->trigger(); });
231  }
232 
233  protected:
234 };
236  public:
238  parent->add_stream_stop_callback([this]() { this->trigger(); });
239  }
240 
241  protected:
242 };
243 
244 } // namespace esp32_camera
245 } // namespace esphome
246 
247 #endif
void setup()
std::shared_ptr< CameraImage > current_image_
Definition: esp32_camera.h:199
void loop()
std::shared_ptr< CameraImage > image_
Definition: esp32_camera.h:104
void add_stream_start_callback(std::function< void()> &&callback)
void add_image_callback(std::function< void(std::shared_ptr< CameraImage >)> &&callback)
ESP32Camera * global_esp32_camera
BedjetMode mode
BedJet operating mode.
Definition: bedjet_codec.h:181
void add_stream_stop_callback(std::function< void()> &&callback)
uint16_le_t frequency
Definition: bl0942.h:21
bool was_requested_by(CameraRequester requester) const
CameraImage(camera_fb_t *buffer, uint8_t requester)
Implementation of SPI Controller mode.
Definition: a01nyub.cpp:7