esphome::web_server Namespace Reference

Data Structures
class	DeferredUpdateEventSource
class	DeferredUpdateEventSourceList
struct	EntityMatchResult
	Result of matching a URL against an entity. More...
class	ListEntitiesIterator
struct	SortingComponents
struct	SortingGroup
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...
class	WebServerOTAComponent

Typedefs
using	ParamNameType = ProgmemStr
using	message_generator_t = void(WebServer *, void *, json::JsonBuilder &)

Enumerations
enum	SwitchAction : uint8_t { SWITCH_ACTION_NONE , SWITCH_ACTION_TOGGLE , SWITCH_ACTION_TURN_ON , SWITCH_ACTION_TURN_OFF }
enum	LockAction : uint8_t { LOCK_ACTION_NONE , LOCK_ACTION_LOCK , LOCK_ACTION_UNLOCK , LOCK_ACTION_OPEN }
enum	JsonDetail { DETAIL_ALL , DETAIL_STATE }

Functions
	ESPHOME_LOG_TAG (TAG, "web_server.ota")
	ESPHOME_LOG_TAG (TAG, "web_server")
void	__attribute__ ((flatten)) DeferredUpdateEventSource
	__attribute__ ((noinline)) static uint32_t uptime_seconds()

Variables
constexpr uint8_t INDEX_GZ[]	PROGMEM
WebServer *	global_web_server = nullptr
constexpr size_t	LOG_EVENT_MAX_LEN = 512

Typedef Documentation

message_generator_t

using esphome::web_server::message_generator_t = void(WebServer *, void *, json::JsonBuilder &)

Definition at line 110 of file web_server.h.

ParamNameType

using esphome::web_server::ParamNameType = ProgmemStr

Definition at line 46 of file web_server.h.

Enumeration Type Documentation

JsonDetail

enum esphome::web_server::JsonDetail

Enumerator
DETAIL_ALL
DETAIL_STATE

Definition at line 99 of file web_server.h.

LockAction

enum esphome::web_server::LockAction : uint8_t

Enumerator
LOCK_ACTION_NONE
LOCK_ACTION_LOCK
LOCK_ACTION_UNLOCK
LOCK_ACTION_OPEN

Definition at line 1665 of file web_server.cpp.

SwitchAction

enum esphome::web_server::SwitchAction : uint8_t

Enumerator
SWITCH_ACTION_NONE
SWITCH_ACTION_TOGGLE
SWITCH_ACTION_TURN_ON
SWITCH_ACTION_TURN_OFF

Definition at line 785 of file web_server.cpp.

Function Documentation

__attribute__() [1/2]

void esphome::web_server::__attribute__

(

(flatten)

)

Definition at line 224 of file web_server.cpp.

__attribute__() [2/2]

esphome::web_server::__attribute__

(

(noinline)

)

Definition at line 389 of file web_server.cpp.

ESPHOME_LOG_TAG() [1/2]

esphome::web_server::ESPHOME_LOG_TAG	(	TAG	,
		"web_server"	)

ESPHOME_LOG_TAG() [2/2]

esphome::web_server::ESPHOME_LOG_TAG	(	TAG	,
		"web_server.ota"	)

Variable Documentation

global_web_server

WebServer * esphome::web_server::global_web_server = nullptr

Definition at line 379 of file web_server.cpp.

LOG_EVENT_MAX_LEN

size_t esphome::web_server::LOG_EVENT_MAX_LEN = 512

constexpr

Definition at line 43 of file web_server.h.

PROGMEM

uint8_t INDEX_BR [] esphome::web_server::PROGMEM

constexpr

Definition at line 12 of file server_index_v2.h.