ESPHome  2024.9.2
Data Structures | Enumerations | Functions | Variables
esphome::web_server Namespace Reference

Data Structures

class  ListEntitiesIterator
 
struct  SortingComponents
 
struct  UrlMatch
 Internal helper struct that is used to parse incoming URLs. More...
 
class  WebServer
 This class allows users to create a web server with their ESP nodes. More...
 

Enumerations

enum  JsonDetail { DETAIL_ALL, DETAIL_STATE }
 

Functions

UrlMatch match_url (const std::string &url, bool only_domain=false)
 
void write_row (AsyncResponseStream *stream, EntityBase *obj, const std::string &klass, const std::string &action, const std::function< void(AsyncResponseStream &stream, EntityBase *obj)> &action_func=nullptr)
 

Variables

const uint8_t INDEX_GZ [] PROGMEM
 

Enumeration Type Documentation

◆ JsonDetail

Enumerator
DETAIL_ALL 
DETAIL_STATE 

Definition at line 49 of file web_server.h.

Function Documentation

◆ match_url()

UrlMatch esphome::web_server::match_url ( const std::string &  url,
bool  only_domain = false 
)

Definition at line 49 of file web_server.cpp.

◆ write_row()

void esphome::web_server::write_row ( AsyncResponseStream *  stream,
EntityBase obj,
const std::string &  klass,
const std::string &  action,
const std::function< void(AsyncResponseStream &stream, EntityBase *obj)> &  action_func = nullptr 
)

Definition at line 9 of file web_server_v1.cpp.

Variable Documentation

◆ PROGMEM

const uint8_t INDEX_GZ [] esphome::web_server::PROGMEM

Definition at line 12 of file server_index_v2.h.