LMA_Types.h

Go to the documentation of this file.

 
#ifndef _LMA_TYPES_H
#define _LMA_TYPES_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>


typedef int32_t spl_t;

typedef int64_t acc_t;




typedef enum LMA_Status_e
{
  LMA_OK = 0,               
  LMA_NO_ACTIVE_LOAD = 1,   
  LMA_NO_REACTIVE_LOAD = 2, 
  LMA_NO_APPARENT_LOAD = 4, 
  LMA_VOLTAGE_SAG = 8,      
  LMA_VOLTAGE_SWELL = 16    
} LMA_Status;

typedef enum LMA_CalibrationStatus_e
{
  LMA_CALIB_OK = 0,            
  LMA_CALIB_PHASE_ANGLE_ERROR, 
} LMA_CalibrationStatus;

typedef struct LMA_PhaseInputs_str
{
  spl_t v_sample;   
  spl_t v90_sample; 
  spl_t i_sample;   
} LMA_PhaseInputs;

typedef struct LMA_NeutralInputs_str
{
  spl_t i_sample; 
} LMA_NeutralInputs;

typedef struct LMA_Accs_str
{
  acc_t v_acc;           
  acc_t i_acc;           
  acc_t p_acc;           
  acc_t q_acc;           
  uint32_t sample_count; 
} LMA_Accs;

typedef struct LMA_PhaseAccs_str
{
  LMA_Accs temp;     
  LMA_Accs snapshot; 
} LMA_PhaseAccs;

typedef struct LMA_NeutralAccs_str
{
  acc_t i_acc_temp;     
  acc_t i_acc_snapshot; 
} LMA_NeutralAccs;

typedef struct LMA_ZeroCross_str
{
  uint32_t count;    
  spl_t last_sample; 
  bool debounce;     
  bool first_event;  
} LMA_ZeroCross;

typedef struct LMA_Measurements_str
{
  float vrms;         
  float irms;         
  float irms_neutral; 
  float fline;        
  float p;            
  float q;            
  float s;            
} LMA_Measurements;

typedef struct LMA_ConsumptionData_str
{
  float act_imp_energy_wh; 
  float act_exp_energy_wh; 
  float app_imp_energy_wh; 
  float app_exp_energy_wh; 
  float c_imp_energy_wh;   
  float c_exp_energy_wh;   
  float l_imp_energy_wh;   
  float l_exp_energy_wh;   
} LMA_ConsumptionData;

typedef struct LMA_EnergyUnit_str
{
  float act;   
  float app;   
  float react; 
} LMA_EnergyUnit;



typedef struct LMA_GlobalCalibration_str
{
  float fs;             
  float fline_coeff;    
  float deg_per_sample; 
} LMA_GlobalCalibration;

typedef struct LMA_PhaseCalibration_str
{
  float vrms_coeff;          
  float irms_coeff;          
  float vi_phase_correction; 
  float p_coeff;             
} LMA_PhaseCalibration;

typedef struct LMA_NeutralCalibration_str
{
  float irms_coeff; 
} LMA_NeutralCalibration;



typedef struct LMA_PhaseAngleError_str
{
  LMA_CalibrationStatus status; 
  LMA_ZeroCross v_zero_cross;   
  LMA_ZeroCross i_zero_cross;   
  uint32_t sample_counter;      
  float v_fraction;             
  float i_fraction;             
} LMA_PhaseAngleError;

typedef struct LMA_Signals_str
{
  bool accumulators_ready;    
  bool measurements_ready;    
  bool calibrate_angle_error; 
} LMA_Signals;

typedef struct LMA_Neutral_str
{
  LMA_NeutralInputs inputs;     
  LMA_NeutralAccs accs;         
  LMA_NeutralCalibration calib; 
} LMA_Neutral;

typedef struct LMA_Phase_str
{
  struct LMA_Phase_str *p_next;  
  LMA_PhaseInputs inputs;        
  LMA_PhaseAccs accs;            
  LMA_ZeroCross zero_cross;      
  LMA_PhaseCalibration calib;    
  LMA_PhaseAngleError pa_error;  
  LMA_Measurements measurements; 
  LMA_EnergyUnit energy_units;   
  LMA_Status status;             
  LMA_Signals sigs;              
  LMA_Neutral *p_neutral;        
  float (*p_computation_hook)(float *i, float *v,
                              float *f); 
  uint32_t phase_number;                 
} LMA_Phase;



typedef struct LMA_SystemEnergy_str
{
  struct energy
  {
    struct unit
    {
      float act;   
      float app;   
      float react; 
    } unit;        

    struct accumulator
    {
      float act_imp_ws;     
      float act_exp_ws;     
      float app_imp_ws;     
      float app_exp_ws;     
      float c_react_imp_ws; 
      float c_react_exp_ws; 
      float l_react_imp_ws; 
      float l_react_exp_ws; 
    } accumulator;          

    struct counter
    {
      uint64_t act_imp; 
      uint64_t
          act_exp; 
      uint64_t app_imp; 
      uint64_t app_exp; 
      uint64_t c_react_imp; 
      uint64_t c_react_exp; 
      uint64_t l_react_imp; 
      uint64_t l_react_exp; 
    } counter;              
  } energy;                 

  struct impulse
  {
    uint32_t led_on_count;     
    uint32_t active_counter;   
    uint32_t apparent_counter; 
    uint32_t reactive_counter; 
    bool active_on;            
    bool apparent_on;          
    bool reactive_on;          
  } impulse;                   
} LMA_SystemEnergy;



typedef struct LMA_PhaseCalibArgs_str
{
  LMA_Phase *p_phase;   
  float vrms_tgt;       
  float irms_tgt;       
  uint32_t line_cycles; 
} LMA_PhaseCalibArgs;

typedef struct LMA_GlobalCalibArgs_str
{
  float rtc_period;    
  float fline_target;  
  uint32_t rtc_cycles; 
} LMA_GlobalCalibArgs;

typedef struct LMA_Config_str
{
  LMA_GlobalCalibration gcalib; 
  uint32_t update_interval;     
  float fline_tol_low;          
  float fline_tol_high;         
  float meter_constant;         
  float no_load_i;              
  float no_load_p;              
  float v_sag;                  
  float v_swell;                
} LMA_Config;


 
#endif /* _LMA_TYPES_H */