ESPHome  2024.11.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::esp32_camera_web_server::CameraWebServer Class Reference

#include <camera_web_server.h>

Inheritance diagram for esphome::esp32_camera_web_server::CameraWebServer:
esphome::Component

Public Member Functions

 CameraWebServer ()
 
 ~CameraWebServer ()
 
void setup () override
 
void on_shutdown () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_port (uint16_t port)
 
void set_mode (Mode mode)
 
void loop () override
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

std::shared_ptr< esphome::esp32_camera::CameraImagewait_for_image_ ()
 
esp_err_t handler_ (struct httpd_req *req)
 
esp_err_t streaming_handler_ (struct httpd_req *req)
 
esp_err_t snapshot_handler_ (struct httpd_req *req)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

uint16_t port_ {0}
 
void * httpd_ {nullptr}
 
SemaphoreHandle_t semaphore_
 
std::shared_ptr< esphome::esp32_camera::CameraImageimage_
 
bool running_ {false}
 
Mode mode_ {STREAM}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

Definition at line 21 of file camera_web_server.h.

Constructor & Destructor Documentation

◆ CameraWebServer()

esphome::esp32_camera_web_server::CameraWebServer::CameraWebServer ( )

Definition at line 38 of file camera_web_server.cpp.

◆ ~CameraWebServer()

esphome::esp32_camera_web_server::CameraWebServer::~CameraWebServer ( )

Definition at line 40 of file camera_web_server.cpp.

Member Function Documentation

◆ dump_config()

void esphome::esp32_camera_web_server::CameraWebServer::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 87 of file camera_web_server.cpp.

◆ get_setup_priority()

float esphome::esp32_camera_web_server::CameraWebServer::get_setup_priority ( ) const
overridevirtual

Reimplemented from esphome::Component.

Definition at line 101 of file camera_web_server.cpp.

◆ handler_()

esp_err_t esphome::esp32_camera_web_server::CameraWebServer::handler_ ( struct httpd_req *  req)
protected

Definition at line 122 of file camera_web_server.cpp.

◆ loop()

void esphome::esp32_camera_web_server::CameraWebServer::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 103 of file camera_web_server.cpp.

◆ on_shutdown()

void esphome::esp32_camera_web_server::CameraWebServer::on_shutdown ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 78 of file camera_web_server.cpp.

◆ set_mode()

void esphome::esp32_camera_web_server::CameraWebServer::set_mode ( Mode  mode)
inline

Definition at line 31 of file camera_web_server.h.

◆ set_port()

void esphome::esp32_camera_web_server::CameraWebServer::set_port ( uint16_t  port)
inline

Definition at line 30 of file camera_web_server.h.

◆ setup()

void esphome::esp32_camera_web_server::CameraWebServer::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file camera_web_server.cpp.

◆ snapshot_handler_()

esp_err_t esphome::esp32_camera_web_server::CameraWebServer::snapshot_handler_ ( struct httpd_req *  req)
protected

Definition at line 213 of file camera_web_server.cpp.

◆ streaming_handler_()

esp_err_t esphome::esp32_camera_web_server::CameraWebServer::streaming_handler_ ( struct httpd_req *  req)
protected

Definition at line 157 of file camera_web_server.cpp.

◆ wait_for_image_()

std::shared_ptr< esphome::esp32_camera::CameraImage > esphome::esp32_camera_web_server::CameraWebServer::wait_for_image_ ( )
protected

Definition at line 109 of file camera_web_server.cpp.

Field Documentation

◆ httpd_

void* esphome::esp32_camera_web_server::CameraWebServer::httpd_ {nullptr}
protected

Definition at line 41 of file camera_web_server.h.

◆ image_

std::shared_ptr<esphome::esp32_camera::CameraImage> esphome::esp32_camera_web_server::CameraWebServer::image_
protected

Definition at line 43 of file camera_web_server.h.

◆ mode_

Mode esphome::esp32_camera_web_server::CameraWebServer::mode_ {STREAM}
protected

Definition at line 45 of file camera_web_server.h.

◆ port_

uint16_t esphome::esp32_camera_web_server::CameraWebServer::port_ {0}
protected

Definition at line 40 of file camera_web_server.h.

◆ running_

bool esphome::esp32_camera_web_server::CameraWebServer::running_ {false}
protected

Definition at line 44 of file camera_web_server.h.

◆ semaphore_

SemaphoreHandle_t esphome::esp32_camera_web_server::CameraWebServer::semaphore_
protected

Definition at line 42 of file camera_web_server.h.


The documentation for this class was generated from the following files: