Power_Class.hpp

Go to the documentation of this file.

// Copyright (c) M5Stack. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
#ifndef __M5_Power_Class_H__
#define __M5_Power_Class_H__
 
#include "m5unified_common.h"
 
#include "I2C_Class.hpp"
#include "AXP192_Class.hpp"
#include "AXP2101_Class.hpp"
#include "IP5306_Class.hpp"
#include "INA3221_Class.hpp"
#include "RTC8563_Class.hpp"
 
#if __has_include (<driver/adc.h>)
#include <driver/adc.h>
#endif
 
namespace m5
{
  class M5Unified;
 
  enum ext_port_mask_t
  { ext_none = 0
  // For individual control of external ports of M5Station
  , ext_PA   = 0b00000001
  , ext_PB1  = 0b00000010
  , ext_PB2  = 0b00000100
  , ext_PC1  = 0b00001000
  , ext_PC2  = 0b00010000
  , ext_USB  = 0b00100000 // M5Station external USB.   ※ Not for CoreS3 main USB.
  , ext_MAIN = 0b10000000
  };
 
  class Power_Class
  {
  friend M5Unified;
  public:
 
    enum pmic_t
    { pmic_unknown
    , pmic_adc
    , pmic_axp192
    , pmic_ip5306
    , pmic_axp2101
    };
 
    enum is_charging_t
    { is_discharging = 0
    , is_charging
    , charge_unknown
    };
 
    bool begin(void);
 
    void setExtOutput(bool enable, ext_port_mask_t port_mask = (ext_port_mask_t)0xFF);
 
    [[deprecated("Change to setExtOutput")]]
    void setExtPower(bool enable, ext_port_mask_t port_mask = (ext_port_mask_t)0xFF) { setExtOutput(enable, port_mask); }
 
    bool getExtOutput(void);
 
    void setUsbOutput(bool enable);
 
    bool getUsbOutput(void);
 
    void setLed(uint8_t brightness = 255);
 
    void powerOff(void);
 
    void timerSleep(int seconds);
 
    void timerSleep(const rtc_time_t& time);
 
    void timerSleep(const rtc_date_t& date, const rtc_time_t& time);
 
    void deepSleep(std::uint64_t micro_seconds = 0, bool touch_wakeup = true);
 
    void lightSleep(std::uint64_t micro_seconds = 0, bool touch_wakeup = true);
 
    std::int32_t getBatteryLevel(void);
 
    void setBatteryCharge(bool enable);
 
    void setChargeCurrent(std::uint16_t max_mA);
 
    void setChargeVoltage(std::uint16_t max_mV);
 
    is_charging_t isCharging(void);
 
    int16_t getBatteryVoltage(void);
 
    int32_t getBatteryCurrent(void);
 
    uint8_t getKeyState(void);
 
    void setVibration(uint8_t level);
 
    pmic_t getType(void) const { return _pmic; }
 
#if defined (CONFIG_IDF_TARGET_ESP32S3)
 
    AXP2101_Class Axp2101;
 
#elif defined (CONFIG_IDF_TARGET_ESP32C3)
 
#else
 
    AXP2101_Class Axp2101;
    AXP192_Class Axp192;
    IP5306_Class Ip5306;
    INA3221_Class Ina3221;
 
#endif
 
  private:
    void _powerOff(bool withTimer);
    void _timerSleep(void);
 
    float _adc_ratio = 0;
    std::uint8_t _pwrHoldPin = 255;
    std::uint8_t _wakeupPin = 255;
    std::uint8_t _rtcIntPin = 255;
    pmic_t _pmic = pmic_t::pmic_unknown;
#if !defined (M5UNIFIED_PC_BUILD)
    adc1_channel_t _batAdc;
#endif
  };
}
 
#endif