LowPower
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
low_power::ArduinoLowPowerESP8266 Class Reference

Low Power Management for ESP8266. More...

#include <LowPowerESP8266.h>

Inheritance diagram for low_power::ArduinoLowPowerESP8266:
Inheritance graph
[legend]

Public Member Functions

bool isProcessingOnSleep (sleep_mode_enum_t sleep_mode)
 Returns true if processing is possible in the current sleep mode.
 
bool sleep (void) override
 sets processor into sleep mode
 
bool setSleepTime (uint32_t time, time_unit_t time_unit_type) override
 Defines the sleep time.
 
bool addWakeupPin (int pin, pin_change_t change_type) override
 Defines the wakup pin.
 
void setDeepSleepOption (uint8_t option)
 Deep sleep options: values from 0 to 4 1: RF calibration: Power consumption is high 2: No RF calibration after waking up: Power consumption is low 3: No RF: Power consumption is lowest.
 
void setInstant (bool instant)
 if instant == true -> instantly deep sleep w/o delay
 
bool isModeSupported (sleep_mode_enum_t sleep_mode) override
 Provides information if the indicated mode is supported.
 
void clear ()
 reset the processing
 
virtual bool sleepFor (uint32_t time, time_unit_t time_unit_type)
 sets mc into sleep mode to sleep for indicated millis
 
virtual void setActive (bool flag)
 sets the flag to be active
 
virtual void setActiveTime (uint32_t time, time_unit_t time_unit_type)
 Defiles the active time.
 
virtual bool isActive ()
 Checks if we are active (not sleeping)
 
virtual operator bool ()
 same as isActive()
 
virtual bool setSleepMode (sleep_mode_enum_t mode)
 Defines the sleep mode.
 
virtual void process ()
 Triggers the processing to be active or sleeping based on the set definitions.
 
virtual bool isProcessingOnSleep ()
 Returns true if processing is possible in the current sleep mode.
 

Protected Member Functions

uint64_t toUs (uint64_t time, time_unit_t time_unit)
 

Protected Attributes

uint64_t sleep_time_us = 0
 
uint8_t sleep_option = 1
 
bool is_instant = false
 
uint16_t gpio_count = 0
 
bool is_active = true
 
uint32_t timeout_end = 0
 
uint32_t timeout_us = 0
 
time_unit_t time_unit = time_unit_t::ms
 
sleep_mode_enum_t sleep_mode = sleep_mode_enum_t::deepSleep
 

Detailed Description

Low Power Management for ESP8266.


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