charging_ic.h

Go to the documentation of this file.

 
#ifndef CHARGING_IC_H
#define CHARGING_IC_H
 
#include <cstdint>
#include <string>
 
namespace lampda {
namespace power {
namespace charger {
 
namespace drivers {
 
enum class Status_t
{
  UNINITIALIZED,
  NOMINAL,
  ERROR,
  ERROR_COMPONENT,
  ERROR_HAS_FAULTS,
};
 
enum class ChargeStatus_t
{
  OFF,
  PRECHARGE,
  FASTCHARGE,
  SLOW_CHARGE
};
 
bool enable(const uint16_t minSystemVoltage_mV,
            const uint16_t maxBatteryVoltage_mV,
            const uint16_t maxChargingCurrent_mA,
            const uint16_t maxDichargingCurrent_mA,
            const bool forceReset = false);
 
void loop(const bool isChargeOk);
 
void shutdown();
 
void enable_charge(const bool enable);
 
void set_input_current_limit(const uint16_t maxInputCurrent_mA, const bool shouldUseICO);
 
uint16_t get_charge_current();
 
bool is_input_source_present();
 
void enable_OTG();
void disable_OTG();
void set_OTG_targets(const uint16_t voltage_mV, const uint16_t maxCurrent_mA);
bool is_in_OTG();
 
void try_clear_faults();
 
Status_t get_status();
std::string get_status_detail();
ChargeStatus_t get_charge_status();
std::string get_software_error_message();
 
struct Measurments
{
  uint32_t time = 0;
  bool is_measurment_valid() const;
 
  bool isChargeOk;
 
  uint16_t vbus_mV;
  uint16_t psys_mV;
  uint16_t batChargeCurrent_mA;
  uint16_t batDischargeCurrent_mA;
  uint16_t vbus_mA;
  uint16_t cmpin_mA;
  uint16_t vsys_mV;
  uint16_t battery_mV;
};
Measurments get_measurments();
 
struct Battery
{
  bool isPresent = false;
 
  uint16_t voltage_mV;
  int16_t current_mA;
};
Battery get_battery();
 
} // namespace drivers
} // namespace charger
} // namespace power
} // namespace lampda
 
#endif