lc709203f.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 RWTH Aachen
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "periph/i2c.h"
#include "periph/gpio.h"

typedef enum {
    AUTO_MODE       = 0x0,
    CHARGE_MODE     = 0x1,
    DISCHARGE_MODE  = 0xffff
} lc709203f_current_direction_t;


typedef enum {
    BAT_PROFILE_1   = 0,
    BAT_PROFILE_2   = 1
} lc709203f_battery_profile_t;


typedef enum {
    OPERATIONAL_MODE    = 1,
    SLEEP_MODE          = 2
} lc709203f_power_mode_t;


typedef enum {
    I2C_MODE        = 0,
    THERMISTOR_MODE = 1
} lc709203f_temp_obtaining_mode_t;


typedef void (*lc709203f_cb_t)(void *arg);

typedef struct {
    gpio_t alarm_pin;           
    i2c_t bus;                  
    uint8_t addr;               
} lc709203f_params_t;

 
enum {
    LC709203F_OK                =  0,       
    LC709203F_NOI2C             = -1,       
    LC709203F_CELL_TEMP_INVALID = -2        
};

typedef struct {
    i2c_t bus;                  
    uint8_t addr;               
    uint8_t scale;              
    lc709203f_params_t params;  
    lc709203f_cb_t cb;          
    void *arg;                  
} lc709203f_t;


#define LC709203F_REG_CELL_VOLTAGE      0x09        
#define LC709203F_REG_RSOC              0x0d        
#define LC709203F_REG_ITE               0x0f        
#define LC709203F_REG_ID                0x11        
#define LC709203F_REG_CELL_TEMP         0x08        
#define LC709203F_REG_STATUS            0x16        
#define LC709203F_REG_POWER_MODE        0x15        
#define LC709203F_REG_ALARM_VOLTAGE     0x14        
#define LC709203F_REG_ALARM_RSOC        0x13        
#define LC709203F_REG_CHANGE_PARAMETER  0x12        
#define LC709203F_REG_APT               0x0c        
#define LC709203F_REG_APA               0x0b        
#define LC709203F_REG_CURRENT_DIRECTION 0x0a        
#define LC709203F_REG_THERMISTOR        0x06        
#define LC709203F_REG_BEFORE_RSOC       0x04        
#define LC709203F_REG_INITIAL_RSOC      0x07        
 
#define LC709203F_CRC_POLYNOMIAL        0x07        

int lc709203f_init(lc709203f_t *dev, const lc709203f_params_t *params);

int16_t lc709203f_get_voltage(const lc709203f_t *dev);

int16_t lc709203f_get_rsoc(const lc709203f_t *dev);

int16_t lc709203f_get_ite(const lc709203f_t *dev);

int16_t lc709203f_get_id(const lc709203f_t *dev);

int16_t lc709203f_get_cell_temp(const lc709203f_t *dev);

lc709203f_temp_obtaining_mode_t lc709203f_get_status_bit(const lc709203f_t *dev);

lc709203f_power_mode_t lc709203f_get_power_mode(const lc709203f_t *dev);

int16_t lc709203f_get_alarm_low_voltage(const lc709203f_t *dev);

int16_t lc709203f_get_alarm_low_rsoc(const lc709203f_t *dev);

int16_t lc709203f_get_change_of_parameter(const lc709203f_t *dev);

int16_t lc709203f_get_apt(const lc709203f_t *dev);

int16_t lc709203f_get_apa(const lc709203f_t *dev);

lc709203f_current_direction_t lc709203f_get_current_direction(const lc709203f_t *dev);

int16_t lc709203f_get_thermistor_b(const lc709203f_t *dev);

void lc709203f_set_rsoc_before(const lc709203f_t *dev);

void lc709203f_set_thermistor_b(const lc709203f_t *dev, const unsigned int value);

void lc709203f_set_rsoc_initial(const lc709203f_t *dev);

int8_t lc709203f_set_cell_temp(const lc709203f_t *dev, const unsigned int value);

void lc709203f_set_current_direction(const lc709203f_t *dev, const lc709203f_current_direction_t direction);

void lc709203f_set_apa(const lc709203f_t *dev, const uint8_t value);

void lc709203f_set_apt(const lc709203f_t *dev, const unsigned int value);

void lc709203f_set_change_of_parameter(const lc709203f_t *dev, const lc709203f_battery_profile_t value);

void lc709203f_set_alarm_low_rsoc(const lc709203f_t *dev, const uint8_t value);

void lc709203f_set_alarm_low_cell_voltage(const lc709203f_t *dev, const unsigned int value);

void lc709203f_set_power_mode(const lc709203f_t *dev, const lc709203f_power_mode_t value);

void lc709203f_set_status_bit(const lc709203f_t *dev, const lc709203f_temp_obtaining_mode_t value);
 
#ifdef __cplusplus
}
#endif