ltc4150.h

Go to the documentation of this file.

/*
 * Copyright 2019 Otto-von-Guericke-Universität Magdeburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef LTC4150_H
#define LTC4150_H
 
#include <stdint.h>
 
#include "mutex.h"
#include "periph/gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum {
    LTC4150_INT_EXT_PULL_UP = 0x01,
    LTC4150_POL_EXT_PULL_UP = 0x02,
    LTC4150_EXT_PULL_UP = LTC4150_INT_EXT_PULL_UP | LTC4150_POL_EXT_PULL_UP,
};
 
typedef enum {
    LTC4150_CHARGE,             
    LTC4150_DISCHARGE,          
} ltc4150_dir_t;
 
typedef struct ltc4150_dev ltc4150_dev_t;
 
typedef struct {
    void (*pulse)(ltc4150_dev_t *dev, ltc4150_dir_t dir, uint64_t now_usec, void *arg);
    void (*reset)(ltc4150_dev_t *dev, uint64_t now_usec, void *arg);
} ltc4150_recorder_t;
 
typedef struct {
    gpio_t interrupt;
    gpio_t polarity;
    gpio_t shutdown;
    uint16_t pulses_per_ah;
    uint16_t flags;
    const ltc4150_recorder_t **recorders;
    void **recorder_data;
} ltc4150_params_t;
 
struct ltc4150_dev {
    ltc4150_params_t params;    
    uint32_t start_sec;         
    uint32_t last_update_sec;   
    uint32_t charged;           
    uint32_t discharged;        
};
 
typedef struct {
    uint32_t last_rotate_sec;   
    uint16_t charged;
    uint16_t discharged;
    uint8_t buf_charged[7];
    uint8_t buf_discharged[7];
    uint8_t ring_pos;           
} ltc4150_last_minute_data_t;
 
extern const ltc4150_recorder_t ltc4150_last_minute;
 
int ltc4150_init(ltc4150_dev_t *dev, const ltc4150_params_t *params);
 
int ltc4150_reset_counters(ltc4150_dev_t *dev);
 
int ltc4150_shutdown(ltc4150_dev_t *dev);
 
int ltc4150_charge(ltc4150_dev_t *dev, uint32_t *charged, uint32_t *discharged);
 
int ltc4150_avg_current(ltc4150_dev_t *dev, int16_t *dest);
 
int ltc4150_last_minute_charge(ltc4150_dev_t *dev,
                               ltc4150_last_minute_data_t *data,
                               uint32_t *charged, uint32_t *discharged);
 
void ltc4150_pulses2c(const ltc4150_dev_t *dev,
                      uint32_t *charged, uint32_t *discharged,
                      uint32_t raw_charged,
                      uint32_t raw_discharged);
#ifdef __cplusplus
}
#endif
 
#endif /* LTC4150_H */