System

Access to the ESP8266 system. More...

Functions
void	SystemClass::initialize ()
	System initialisation. More...
bool	SystemClass::isReady ()
	Check if system ready. More...
void	SystemClass::restart ()
	Restart system. More...
void	SystemClass::setCpuFrequency (CpuFrequency freq)
	Set the CPU frequency. More...
CpuFrequency	SystemClass::getCpuFrequency ()
	Get the CPU frequency. More...
bool	SystemClass::deepSleep (uint32 timeMilliseconds, DeepSleepOptions options=eDSO_RF_CAL_BY_INIT_DATA)
	Enter deep sleep mode. More...
void	SystemClass::onReady (SystemReadyDelegate readyHandler)
	Set handler for system ready event. More...
void	SystemClass::onReady (ISystemReadyHandler *readyHandler)
	Set handler for system ready event. More...
void	SystemClass::applyFirmwareUpdate (uint32_t readFlashOffset, uint32_t targetFlashOffset, int firmwareSize)
	Apply a firmware update. More...

Detailed Description

Access to the ESP8266 system.

System class.

Note

Provides system control and monitoring of the ESP8266.

Function Documentation

void SystemClass::applyFirmwareUpdate	(	uint32_t	readFlashOffset,
		uint32_t	targetFlashOffset,
		int	firmwareSize
	)

Apply a firmware update.

Parameters

readFlashOffset	Address of the firmware to use for update
targetFlashOffset	Address to write firmware to
firmwareSize	Quantity of bytes to write

bool SystemClass::deepSleep	(	uint32	timeMilliseconds,
		DeepSleepOptions	options = eDSO_RF_CAL_BY_INIT_DATA
	)

Enter deep sleep mode.

Parameters

timeMilliseconds	Quantity of milliseconds to remain in deep sleep mode
options	Deep sleep options

CpuFrequency SystemClass::getCpuFrequency

(

)

Get the CPU frequency.

Return values

CpuFrequency

The frequency of the CPU

void SystemClass::initialize

(

)

System initialisation.

bool SystemClass::isReady

(

)

Check if system ready.

Return values

bool	True if system initialisation is complete and system is now ready

void SystemClass::onReady

(

SystemReadyDelegate

readyHandler

)

Set handler for system ready event.

Parameters

readyHandler

Function to handle event

void SystemClass::onReady

(

ISystemReadyHandler *

readyHandler

)

Set handler for system ready event.

Parameters

readyHandler

Function to handle event

void SystemClass::restart

(

)

Restart system.

void SystemClass::setCpuFrequency

(

CpuFrequency

freq

)

Set the CPU frequency.

Parameters

freq	Frequency to set CPU