battery.h File Reference

Battery driver. More...

#include "driver/adc.h"
#include "driver/gpio.h"
#include "esp_err.h"

Include dependency graph for battery.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	battery_t
	Custom battery_t object. More...

Functions
void	battery_ctor (battery_t *const battery, adc1_channel_t ch, adc_bits_width_t width, adc_atten_t atten, gpio_num_t enable)
	Battery object constructor. More...
void	battery_default (battery_t *const battery)
	Set battery to default configuration. More...
void	battery_enable (battery_t *const battery)
	Enable battery reading. More...
void	battery_disable (battery_t *const battery)
	Disable battery reading. More...
esp_err_t	battery_init (battery_t *const battery)
	Initialize battery configuration: adc and gpio. More...
int	battery_read (battery_t *const battery)
	Get battery voltage reading. More...
int	battery_percentage (battery_t *const battery)
	Battery percentage. More...

Detailed Description

Battery driver.

Author

Jesus Minjares (https://github.com/jminjares4)

Version

0.1

Date

2022-09-01

Copyright

Copyright (c) 2022

Function Documentation

battery_ctor()

void battery_ctor	(	battery_t *const	battery,
		adc1_channel_t	ch,
		adc_bits_width_t	width,
		adc_atten_t	atten,
		gpio_num_t	enable
	)

Battery object constructor.

Parameters

battery	pointer to a const battery object
ch	adc channel
width	adc width
atten	adc attentuation
enable	battery gpio

Warning

Uses ADC1, please

See also

battery_t

battery_default()

void battery_default

(

battery_t *const

battery

)

Set battery to default configuration.

Parameters

battery

pointer to a const battery object

Note

Please

See also

battery_ctor()

Warning

Uses ADC1, please

See also

battery_t

battery_disable()

void battery_disable

(

battery_t *const

battery

)

Disable battery reading.

Parameters

battery

pointer to const battery object

battery_enable()

void battery_enable

(

battery_t *const

battery

)

Enable battery reading.

Parameters

battery

pointer to const battery object

battery_init()

esp_err_t battery_init

(

battery_t *const

battery

)

Initialize battery configuration: adc and gpio.

Parameters

battery

pointer to a const battery object

Returns

esp_err_t status

Note

For esp_err_t

See also

esp_err.h

Warning

Please use battery_ctor() or battery_default() prior of this function.

battery_percentage()

int battery_percentage

(

battery_t *const

battery

)

Battery percentage.

Parameters

battery

pointer to a const battery object

Returns

int percent value

battery_read()

int battery_read

(

battery_t *const

battery

)

Get battery voltage reading.

Parameters

battery

pointer to a const battery object

Returns

int voltage reading

Note

reading will be stored in battery.value