Access to the ESP8266 system Provides system control and monitoring of the ESP8266. More...

Classes

class  ISystemReadyHandler
 Interface class implemented by classes to support on-ready callback. More...
 
class  SystemClass
 System class. More...
 

Typedefs

using TaskCallback32 = void(*)(uint32_t param)
 Task callback function type, uint32_t parameter. More...
 
using TaskCallback = void(*)(void *param)
 Task callback function type, void* parameter. More...
 
using TaskDelegate = Delegate< void()>
 Task Delegate callback type. More...
 
using SystemReadyDelegate = TaskDelegate
 Handler function for system ready. More...
 

Enumerations

enum  CpuFrequency {
  eCF_80MHz = 80 , eCF_125MHz = 125 , eCF_133MHz = 133 , eCF_160MHz = 160 ,
  eCF_240MHz = 240
}
 Common CPU frequencies. More...
 
enum  DeepSleepOptions { eDSO_RF_CAL_BY_INIT_DATA = 0 , eDSO_RF_CAL_ALWAYS = 1 , eDSO_RF_CAL_NEVER = 2 , eDSO_DISABLE_RF }
 Deep sleep options. More...
 
enum  SystemState { eSS_None , eSS_Intializing , eSS_Ready }
 System state. More...
 

Variables

SystemClass System
 Global instance of system object. More...
 

Detailed Description

Access to the ESP8266 system Provides system control and monitoring of the ESP8266.

Typedef Documentation

◆ SystemReadyDelegate

Handler function for system ready.

◆ TaskCallback

using TaskCallback = void (*)(void* param)

Task callback function type, void* parameter.

Note
Callback code does not need to be in IRAM

◆ TaskCallback32

using TaskCallback32 = void (*)(uint32_t param)

Task callback function type, uint32_t parameter.

Note
Callback code does not need to be in IRAM

◆ TaskDelegate

using TaskDelegate = Delegate<void()>

Task Delegate callback type.

Enumeration Type Documentation

◆ CpuFrequency

Common CPU frequencies.

Enumerator
eCF_80MHz 
eCF_125MHz 
eCF_133MHz 
eCF_160MHz 
eCF_240MHz 

◆ DeepSleepOptions

Deep sleep options.

Enumerator
eDSO_RF_CAL_BY_INIT_DATA 

RF_CAL or not after deep-sleep wake up, depends on init data byte 108.

eDSO_RF_CAL_ALWAYS 

RF_CAL after deep-sleep wake up, there will be large current.

eDSO_RF_CAL_NEVER 

no RF_CAL after deep-sleep wake up, there will only be small current.

eDSO_DISABLE_RF 

disable RF after deep-sleep wake up, just like modem sleep, there will be the smallest current.

◆ SystemState

System state.

Enumerator
eSS_None 

System state unknown.

eSS_Intializing 

System initialising.

eSS_Ready 

System ready.

Variable Documentation

◆ System

SystemClass System
extern

Global instance of system object.

Note
Use system.function to access system functions
Example:
system.reset();