driver_hlw8032.h

Go to the documentation of this file.

 
#ifndef DRIVER_HLW8032_H
#define DRIVER_HLW8032_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif


#ifndef HLW8032_VOLTAGE_COEFFICIENT
    #define HLW8032_VOLTAGE_COEFFICIENT        1.88f        
#endif

#ifndef HLW8032_CURRENT_COEFFICIENT
    #define HLW8032_CURRENT_COEFFICIENT        1.0f        
#endif

#ifndef HLW8032_VOLTAGE_K1
    #define HLW8032_VOLTAGE_K1        2.045f        
#endif

#ifndef HLW8032_CURRENT_K2
    #define HLW8032_CURRENT_K2        1.0f        
#endif

#ifndef HLW8032_POWER_K3
    #define HLW8032_POWER_K3        2.045f        
#endif


typedef enum
{
    HLW8032_MODE_SAMPLE      = 0,        
    HLW8032_MODE_TRANSFORMER = 1,        
} hlw8032_mode_t;

typedef enum
{
    HLW8032_STATUS_VOLTAGE_OVERFLOW = (1 << 3),        
    HLW8032_STATUS_CURRENT_OVERFLOW = (1 << 2),        
    HLW8032_STATUS_POWER_OVERFLOW   = (1 << 1),        
    HLW8032_STATUS_REGISTER_INVALID = (1 << 0),        
} hlw8032_status_t;

typedef enum
{
    HLW8032_UPDATE_STATUS_PF_OVERFLOW     = (1 << 7),        
    HLW8032_UPDATE_STATUS_VOLTAGE_UPDATED = (1 << 6),        
    HLW8032_UPDATE_STATUS_CURRENT_UPDATED = (1 << 5),        
    HLW8032_UPDATE_STATUS_POWER_UPDATED   = (1 << 4),        
} hlw8032_update_status_t;

typedef struct hlw8032_data_s
{
    uint32_t voltage_parameter_raw;        
    uint32_t voltage_raw;                  
    uint32_t current_parameter_raw;        
    uint32_t current_raw;                  
    uint32_t power_parameter_raw;          
    uint32_t power_raw;                    
    uint8_t update_status;                 
    uint8_t status;                        
    uint16_t pf_counter;                   
    float effective_voltage_v;             
    float effective_current_a;             
    float active_power_w;                  
    float apparent_power_w;                
    float power_factor;                    
    float quantity_electricity_kwh;        
} hlw8032_data_t;

typedef struct hlw8032_handle_s
{
    uint8_t (*uart_init)(void);                               
    uint8_t (*uart_deinit)(void);                             
    uint16_t (*uart_read)(uint8_t *buf, uint16_t len);        
    uint8_t (*uart_flush)(void);                              
    void (*delay_ms)(uint32_t ms);                            
    void (*debug_print)(const char *const fmt, ...);          
    uint8_t inited;                                           
    uint8_t mode;                                             
    float voltage_coefficient;                                
    float current_coefficient;                                
    float voltage_kl;                                         
    float current_k2;                                         
    float power_k3;                                           
    uint8_t is_first;                                         
    int64_t pf_counter;                                       
    uint16_t pf_last_counter;                                 
    uint8_t pf_last_ovf;                                      
} hlw8032_handle_t;

typedef struct hlw8032_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;           
} hlw8032_info_t;



#define DRIVER_HLW8032_LINK_INIT(HANDLE, STRUCTURE)          memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_HLW8032_LINK_UART_INIT(HANDLE, FUC)          (HANDLE)->uart_init = FUC

#define DRIVER_HLW8032_LINK_UART_DEINIT(HANDLE, FUC)        (HANDLE)->uart_deinit = FUC

#define DRIVER_HLW8032_LINK_UART_READ(HANDLE, FUC)          (HANDLE)->uart_read = FUC

#define DRIVER_HLW8032_LINK_UART_FLUSH(HANDLE, FUC)         (HANDLE)->uart_flush = FUC

#define DRIVER_HLW8032_LINK_DELAY_MS(HANDLE, FUC)           (HANDLE)->delay_ms = FUC

#define DRIVER_HLW8032_LINK_DEBUG_PRINT(HANDLE, FUC)        (HANDLE)->debug_print = FUC



uint8_t hlw8032_info(hlw8032_info_t *info);

uint8_t hlw8032_init(hlw8032_handle_t *handle);

uint8_t hlw8032_deinit(hlw8032_handle_t *handle);

uint8_t hlw8032_read(hlw8032_handle_t *handle, hlw8032_data_t *data);

uint8_t hlw8032_set_mode(hlw8032_handle_t *handle, hlw8032_mode_t mode);

uint8_t hlw8032_get_mode(hlw8032_handle_t *handle, hlw8032_mode_t *mode);

uint8_t hlw8032_quantity_electricity_export(hlw8032_handle_t *handle, int64_t *quantity_electricity_counter);

uint8_t hlw8032_quantity_electricity_import(hlw8032_handle_t *handle, int64_t quantity_electricity_counter);

uint8_t hlw8032_set_sample_voltage_coefficient(hlw8032_handle_t *handle, float coeff);

uint8_t hlw8032_get_sample_voltage_coefficient(hlw8032_handle_t *handle, float *coeff);

uint8_t hlw8032_set_sample_current_coefficient(hlw8032_handle_t *handle, float coeff);

uint8_t hlw8032_get_sample_current_coefficient(hlw8032_handle_t *handle, float *coeff);

uint8_t hlw8032_set_transformer_voltage_k1(hlw8032_handle_t *handle, float coeff);

uint8_t hlw8032_get_transformer_voltage_k1(hlw8032_handle_t *handle, float *coeff);

uint8_t hlw8032_set_transformer_current_k2(hlw8032_handle_t *handle, float coeff);

uint8_t hlw8032_get_transformer_current_k2(hlw8032_handle_t *handle, float *coeff);

uint8_t hlw8032_set_transformer_power_k3(hlw8032_handle_t *handle, float coeff);

uint8_t hlw8032_get_transformer_power_k3(hlw8032_handle_t *handle, float *coeff);



uint8_t hlw8032_get_buffer(hlw8032_handle_t *handle, char *buf, uint16_t len, uint32_t ms);


 
#ifdef __cplusplus
}
#endif
 
#endif