Class FuelGauge

Class Documentation

class esc::FuelGauge

Public Functions

FuelGauge(FuelGauge const&) = delete
FuelGauge(FuelGauge&&) = delete
FuelGauge &operator=(FuelGauge const&) = delete
FuelGauge &operator=(FuelGauge&&) = delete
esp_err_t temperature(TempMeasure type, std::uint16_t *temp)

Get the battery voltage.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] type: Temperature measure type.

  • [out] temp: Temperature return value.

esp_err_t voltage(std::uint16_t *voltage)

Get the battery voltage.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [out] voltage: The voltage return value.

esp_err_t avgCurrent(std::int16_t *avg_current)

Get the avg. battery current.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [out] avg_current: The avg. current return value.

esp_err_t avgPower(std::int16_t *avg_power)

Get the Avg Power object.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [out] avg_power: The avg. power return value.

esp_err_t soc(SocMeasure type, std::uint16_t *soc)

Get State-Of-Charge.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] type: Measure type.

  • [out] soc: The SoC return value.

esp_err_t setCapacity(std::uint16_t capacity)

Set capacity.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] capacity: The capacity in mA.

esp_err_t GPOUTPolarity(bool *value)

GPOUT polarity.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [out] value: Return value.

esp_err_t setGPOUTPolarity(bool active_high)

Set GPOUT polarity.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] active_high: true to set to active high, false for low.

esp_err_t GPOUTFunction(bool *function)

GPOUT function.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [out] function: The return value.

esp_err_t setGPOUTFunction(bool function)

Set GPOUT function.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] function: The GPOUT function.

esp_err_t sociDelta(std::uint8_t *value)

SOC_INT delta.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [out] value: The return value.

esp_err_t setSOCIDelta(std::uint8_t delta)

SOC_INT delta.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] delta: The SOC_INT delta.

esp_err_t pulseGPOUT()

Pulse GPOUT.

Return

  • ESP_OK: succeed.

  • (others): failed.

esp_err_t enterConfig(bool manual_config)

Enter configuration mode.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] manual_mode: Used to indicate if the user is manually configuring.

esp_err_t exitConfig(bool resim)

Exit configuration mode.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] resim: Resimulate?

esp_err_t opConfig(std::uint16_t *result)

Get opConfig.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [out] result: The return value.

esp_err_t writeOpConfig(std::uint16_t value)

Write opConfig.

Return

  • ESP_OK: succeed.

  • (others): failed.

Parameters

  • [in] value: The opConfig value.

esp_err_t softReset()

Soft reset.

Return

  • ESP_OK: succeed.

  • (others): failed.

Public Static Functions

FuelGauge &getInstance()

Get the Fuel Gauge unique instance.

Return

FuelGauge& a reference to the Fuel Gauge