driver_ina226.h

Go to the documentation of this file.

 
#ifndef DRIVER_INA226_H
#define DRIVER_INA226_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifndef INA226_READ_TIMEOUT
    #define INA226_READ_TIMEOUT    1000        
#endif
 
typedef enum
{
    INA226_ADDRESS_0 = (0x40 << 1),        
    INA226_ADDRESS_1 = (0x41 << 1),        
    INA226_ADDRESS_2 = (0x42 << 1),        
    INA226_ADDRESS_3 = (0x43 << 1),        
    INA226_ADDRESS_4 = (0x44 << 1),        
    INA226_ADDRESS_5 = (0x45 << 1),        
    INA226_ADDRESS_6 = (0x46 << 1),        
    INA226_ADDRESS_7 = (0x47 << 1),        
    INA226_ADDRESS_8 = (0x48 << 1),        
    INA226_ADDRESS_9 = (0x49 << 1),        
    INA226_ADDRESS_A = (0x4A << 1),        
    INA226_ADDRESS_B = (0x4B << 1),        
    INA226_ADDRESS_C = (0x4C << 1),        
    INA226_ADDRESS_D = (0x4D << 1),        
    INA226_ADDRESS_E = (0x4E << 1),        
    INA226_ADDRESS_F = (0x4F << 1)         
} ina226_address_t;
 
typedef enum
{
    INA226_BOOL_FALSE = 0x00,        
    INA226_BOOL_TRUE  = 0x01,        
} ina226_bool_t;
 
typedef enum
{
    INA226_AVG_1    = 0,        
    INA226_AVG_4    = 1,        
    INA226_AVG_16   = 2,        
    INA226_AVG_64   = 3,        
    INA226_AVG_128  = 4,        
    INA226_AVG_256  = 5,        
    INA226_AVG_512  = 6,        
    INA226_AVG_1024 = 7,        
} ina226_avg_t;
 
typedef enum
{
    INA226_CONVERSION_TIME_140_US   = 0,        
    INA226_CONVERSION_TIME_204_US   = 1,        
    INA226_CONVERSION_TIME_332_US   = 2,        
    INA226_CONVERSION_TIME_588_US   = 3,        
    INA226_CONVERSION_TIME_1P1_MS   = 4,        
    INA226_CONVERSION_TIME_2P116_MS = 5,        
    INA226_CONVERSION_TIME_4P156_MS = 6,        
    INA226_CONVERSION_TIME_8P244_MS = 7,        
} ina226_conversion_time_t;
 
typedef enum
{
    INA226_MODE_POWER_DOWN                   = 0x0,        
    INA226_MODE_SHUNT_VOLTAGE_TRIGGERED      = 0x1,        
    INA226_MODE_BUS_VOLTAGE_TRIGGERED        = 0x2,        
    INA226_MODE_SHUNT_BUS_VOLTAGE_TRIGGERED  = 0x3,        
    INA226_MODE_SHUTDOWN                     = 0x4,        
    INA226_MODE_SHUNT_VOLTAGE_CONTINUOUS     = 0x5,        
    INA226_MODE_BUS_VOLTAGE_CONTINUOUS       = 0x6,        
    INA226_MODE_SHUNT_BUS_VOLTAGE_CONTINUOUS = 0x7,        
} ina226_mode_t;
 
typedef enum
{
    INA226_STATUS_SHUNT_VOLTAGE_OVER_VOLTAGE  = 15,        
    INA226_STATUS_SHUNT_VOLTAGE_UNDER_VOLTAGE = 14,        
    INA226_STATUS_BUS_VOLTAGE_OVER_VOLTAGE    = 13,        
    INA226_STATUS_BUS_VOLTAGE_UNDER_VOLTAGE   = 12,        
    INA226_STATUS_POWER_OVER_LIMIT            = 11,        
} ina226_status_t;
 
typedef enum
{
    INA226_MASK_SHUNT_VOLTAGE_OVER_VOLTAGE  = 15,        
    INA226_MASK_SHUNT_VOLTAGE_UNDER_VOLTAGE = 14,        
    INA226_MASK_BUS_VOLTAGE_OVER_VOLTAGE    = 13,        
    INA226_MASK_BUS_VOLTAGE_UNDER_VOLTAGE   = 12,        
    INA226_MASK_POWER_OVER_LIMIT            = 11,        
} ina226_mask_t;
 
typedef enum
{
    INA226_ALERT_POLARITY_NORMAL   = 0,        
    INA226_ALERT_POLARITY_INVERTED = 1,        
} ina226_alert_polarity_t;
 
typedef struct ina226_handle_s
{
    uint8_t iic_addr;                                                                   
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    void (*receive_callback)(uint8_t type);                                             
    double r;                                                                           
    double current_lsb;                                                                 
    uint8_t inited;                                                                     
    uint8_t trigger;                                                                    
} ina226_handle_t;
 
typedef struct ina226_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} ina226_info_t;
 
#define DRIVER_INA226_LINK_INIT(HANDLE, STRUCTURE)         memset(HANDLE, 0, sizeof(STRUCTURE))
 
#define DRIVER_INA226_LINK_IIC_INIT(HANDLE, FUC)          (HANDLE)->iic_init = FUC
 
#define DRIVER_INA226_LINK_IIC_DEINIT(HANDLE, FUC)        (HANDLE)->iic_deinit = FUC
 
#define DRIVER_INA226_LINK_IIC_READ(HANDLE, FUC)          (HANDLE)->iic_read = FUC
 
#define DRIVER_INA226_LINK_IIC_WRITE(HANDLE, FUC)         (HANDLE)->iic_write = FUC
 
#define DRIVER_INA226_LINK_DELAY_MS(HANDLE, FUC)          (HANDLE)->delay_ms = FUC
 
#define DRIVER_INA226_LINK_DEBUG_PRINT(HANDLE, FUC)       (HANDLE)->debug_print = FUC
 
#define DRIVER_INA226_LINK_RECEIVE_CALLBACK(HANDLE, FUC)  (HANDLE)->receive_callback = FUC
 
uint8_t ina226_info(ina226_info_t *info);
 
uint8_t ina226_set_addr_pin(ina226_handle_t *handle, ina226_address_t addr_pin);
 
uint8_t ina226_get_addr_pin(ina226_handle_t *handle, ina226_address_t *addr_pin);
 
uint8_t ina226_set_resistance(ina226_handle_t *handle, double resistance);
 
uint8_t ina226_get_resistance(ina226_handle_t *handle, double *resistance);
 
uint8_t ina226_irq_handler(ina226_handle_t *handle);
 
uint8_t ina226_init(ina226_handle_t *handle);
 
uint8_t ina226_deinit(ina226_handle_t *handle);
 
uint8_t ina226_soft_reset(ina226_handle_t *handle);
 
uint8_t ina226_set_average_mode(ina226_handle_t *handle, ina226_avg_t mode);
 
uint8_t ina226_get_average_mode(ina226_handle_t *handle, ina226_avg_t *mode);
 
uint8_t ina226_set_bus_voltage_conversion_time(ina226_handle_t *handle, ina226_conversion_time_t t);
 
uint8_t ina226_get_bus_voltage_conversion_time(ina226_handle_t *handle, ina226_conversion_time_t *t);
 
uint8_t ina226_set_shunt_voltage_conversion_time(ina226_handle_t *handle, ina226_conversion_time_t t);
 
uint8_t ina226_get_shunt_voltage_conversion_time(ina226_handle_t *handle, ina226_conversion_time_t *t);
 
uint8_t ina226_set_mode(ina226_handle_t *handle, ina226_mode_t mode);
 
uint8_t ina226_get_mode(ina226_handle_t *handle, ina226_mode_t *mode);
 
uint8_t ina226_read_shunt_voltage(ina226_handle_t *handle, int16_t *raw, float *mV);
 
uint8_t ina226_read_bus_voltage(ina226_handle_t *handle, uint16_t *raw, float *mV);
 
uint8_t ina226_read_power(ina226_handle_t *handle, uint16_t *raw, float *mW);
 
uint8_t ina226_read_current(ina226_handle_t *handle, int16_t *raw, float *mA);
 
uint8_t ina226_set_calibration(ina226_handle_t *handle, uint16_t data);
 
uint8_t ina226_get_calibration(ina226_handle_t *handle, uint16_t *data);
 
uint8_t ina226_calculate_calibration(ina226_handle_t *handle, uint16_t *calibration);
 
uint8_t ina226_set_mask(ina226_handle_t *handle, ina226_mask_t mask, ina226_bool_t enable);
 
uint8_t ina226_get_mask(ina226_handle_t *handle, ina226_mask_t mask, ina226_bool_t *enable);
 
uint8_t ina226_set_conversion_ready_alert_pin(ina226_handle_t *handle, ina226_bool_t enable);
 
uint8_t ina226_get_conversion_ready_alert_pin(ina226_handle_t *handle, ina226_bool_t *enable);
 
uint8_t ina226_set_alert_polarity_pin(ina226_handle_t *handle, ina226_alert_polarity_t pin);
 
uint8_t ina226_get_alert_polarity_pin(ina226_handle_t *handle, ina226_alert_polarity_t *pin);
 
uint8_t ina226_set_alert_latch(ina226_handle_t *handle, ina226_bool_t enable);
 
uint8_t ina226_get_alert_latch(ina226_handle_t *handle, ina226_bool_t *enable);
 
uint8_t ina226_set_alert_limit(ina226_handle_t *handle, uint16_t reg);
 
uint8_t ina226_get_alert_limit(ina226_handle_t *handle, uint16_t *reg);
 
uint8_t ina226_shunt_voltage_convert_to_register(ina226_handle_t *handle, float mV, uint16_t *reg);
 
uint8_t ina226_shunt_voltage_convert_to_data(ina226_handle_t *handle, uint16_t reg, float *mV);
 
uint8_t ina226_bus_voltage_convert_to_register(ina226_handle_t *handle, float mV, uint16_t *reg);
 
uint8_t ina226_bus_voltage_convert_to_data(ina226_handle_t *handle, uint16_t reg, float *mV);
 
uint8_t ina226_power_convert_to_register(ina226_handle_t *handle, float mW, uint16_t *reg);
 
uint8_t ina226_power_convert_to_data(ina226_handle_t *handle, uint16_t reg, float *mW);
 
uint8_t ina226_get_die_id(ina226_handle_t *handle, uint16_t *device_id, uint8_t *die_revision_id);
 
uint8_t ina226_set_reg(ina226_handle_t *handle, uint8_t reg, uint16_t data);
 
uint8_t ina226_get_reg(ina226_handle_t *handle, uint8_t reg, uint16_t *data);
 
#ifdef __cplusplus
}
#endif
 
#endif