Supla::EspWebServer Class Reference

Inheritance diagram for Supla::EspWebServer:

Collaboration diagram for Supla::EspWebServer:

Public Member Functions
	EspWebServer (HtmlGenerator *generator=nullptr)
void	start () override
void	stop () override
void	iterateAlways () override
	Method called on each SuplaDevice iteration.
bool	handlePost (bool beta=false)
::ESPWebServer *	getServerPtr ()
Public Member Functions inherited from Supla::WebServer
	WebServer (Supla::HtmlGenerator *)
void	setSuplaDeviceClass (SuplaDeviceClass *)
void	notifyClientConnected ()
virtual void	parsePost (const char *postContent, int size, bool lastChunk=true)
virtual void	resetParser ()
void	setBetaProcessing ()
Public Member Functions inherited from Supla::Element
Element *	next ()
	Returns next Element from the list.
virtual void	onLoadConfig (SuplaDeviceClass *sdc)
	First method called on element in SuplaDevice.begin().
virtual void	purgeConfig ()
	Removes all configration data related to the element from Storage::Config.
virtual void	onLoadState ()
	Second method called on element in SuplaDevice.begin().
virtual void	onInit ()
	Third method called on element in SuplaDevice.begin()
virtual void	onSaveState ()
	Method called periodically during SuplaDevice iteration.
virtual void	onRegistered (Supla::Protocol::SuplaSrpc *suplaSrpc=nullptr)
	Method called each time when device successfully registers to Supla server.
virtual bool	iterateConnected ()
	Method called on each SuplaDevice iteration when device is connected and registered to Supla server or other protocol.
virtual bool	iterateConnected (void *ptr)
	deprecated
virtual void	onTimer ()
	Method called on timer interupt.
virtual void	onFastTimer ()
	Method called on fast timer interupt.
virtual void	onSoftReset ()
	Method called when device soft restart is triggered.
virtual void	onDeviceConfigChange (uint64_t fieldBit)
	Method called when device config is changed.
virtual int32_t	handleNewValueFromServer (TSD_SuplaChannelNewValue *newValue)
	Handles "new value" request from server.
virtual void	fillSuplaChannelNewValue (TSD_SuplaChannelNewValue *value)
	Fills TSD_SuplaChannelNewValue based on current state.
virtual void	handleGetChannelState (TDSC_ChannelState *channelState)
	Handles "get channel state (i)" request from server.
virtual int	handleCalcfgFromServer (TSD_DeviceCalCfgRequest *request)
	Handles CALCFG requests from server.
virtual uint8_t	handleChannelConfig (TSD_ChannelConfig *newChannelConfig, bool local=false)
	Handles "set channel config" request from server.
virtual uint8_t	handleWeeklySchedule (TSD_ChannelConfig *newWeeklySchedule, bool altSchedule=false, bool local=false)
	Handles "set channel config" with "weekly schedule" type request from server.
virtual void	handleSetChannelConfigResult (TSDS_SetChannelConfigResult *result)
	Handles "set channel config" reply from server.
virtual void	handleChannelConfigFinished ()
	Handles "channel config finished" message from server.
int	getChannelNumber () const
	Returns channel number.
int	getSecondaryChannelNumber () const
	Returns secondary channel number.
virtual bool	isOwnerOfSubDeviceId (int subDeviceId) const
	Returns true if element is owner of subDeviceId.
virtual const Channel *	getChannel () const
	Returns pointer to main channel.
virtual Channel *	getChannel ()
virtual const Channel *	getSecondaryChannel () const
	Returns pointer to secondary channel.
virtual Channel *	getSecondaryChannel ()
virtual void	generateKey (char *output, const char *key) const
	Generates key used for Config.
Element &	disableChannelState ()
	Disables channel state (i) function.
bool	isChannelStateEnabled () const
	Returns true if channel state (i) function is enabled.
virtual bool	isAnyUpdatePending ()
	Returns true if any update is pending.
void	setInitialCaption (const char *caption, bool secondaryChannel=false)
	Sets initial caption.
void	setDefaultFunction (int32_t defaultFunction)
	Sets default channel's function.

Public Attributes
bool	dataSaved = false
Public Attributes inherited from Supla::WebServer
Supla::HtmlGenerator *	htmlGenerator = nullptr

Protected Attributes
::ESPWebServer	server
bool	started = false
Protected Attributes inherited from Supla::WebServer
bool	destroyGenerator = false
SuplaDeviceClass *	sdc = nullptr
bool	keyFound = false
int	partialSize = 0
char	key [HTML_KEY_LENGTH] = {}
char *	value = nullptr
enum Supla::HtmlSection	excludeSection
Protected Attributes inherited from Supla::Element
Element *	nextPtr = nullptr

Additional Inherited Members
Static Public Member Functions inherited from Supla::WebServer
static WebServer *	Instance ()
Static Public Member Functions inherited from Supla::Element
static Element *	begin ()
	Returns first Element (based on creation order)
static Element *	last ()
	Returns last Element (based on creation order)
static Element *	getElementByChannelNumber (int channelNumber)
	Returns Element by channel number.
static Element *	getOwnerOfSubDeviceId (int subDeviceId)
	Returns Element which owns given subDeviceId.
static bool	IsAnyUpdatePending ()
	Checks if any element has pending update for remote server.
static void	NotifyElementsAboutConfigChange (uint64_t fieldBit)
	Notifies all elements about device config change.
static bool	IsInvalidPtrSet ()
	When "invalid pointer" is set, previously obtained Element pointer may be invalid.
static void	ClearInvalidPtr ()
	Clears "invalid pointer" flag.
Static Protected Attributes inherited from Supla::WebServer
static WebServer *	webServerInstance = nullptr
Static Protected Attributes inherited from Supla::Element
static Element *	firstPtr = nullptr
static bool	invalidatePtr = false

Member Function Documentation

iterateAlways()

void Supla::EspWebServer::iterateAlways ( )

overridevirtual

Method called on each SuplaDevice iteration.

It should provide all actions that have to be executed periodically regardless of network state.

Reimplemented from Supla::Element.

start()

void Supla::EspWebServer::start ( )

overridevirtual

Implements Supla::WebServer.

stop()

void Supla::EspWebServer::stop ( )

overridevirtual

Implements Supla::WebServer.

---

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

• src/supla/network/esp_web_server.h
• src/supla/network/esp_web_server.cpp