vac_monitor.h

Go to the documentation of this file.

 
/*
    (c) 2022 Microchip Technology Inc. and its subsidiaries. You may use this
    software and any derivatives exclusively with Microchip products.
 
    THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
    EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
    WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
    PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION
    WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.
 
    IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
    INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
    WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
    BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
    FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
    ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
    THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
 
    MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE
    TERMS.
*/
 
// This is a guard condition so that contents of this file are not included
// more than once.  
#ifndef VAC_MONITOR_H
#define VAC_MONITOR_H
 
#include <xc.h> // include processor files - each processor file is guarded.  
#include "vac_monitor_typedef.h"
#include "../../../revision.h"
#include "../sources_common/Totempole_Application_Setup.h"
 
 
#define rnd(a)      ((uint16_t)((a)+((a)<0?-0.5:0.5)))
 
 
#define min(a,b)    ((uint16_t)(((a)>(b)) ? (b):(a)))
 
 
#define max(a,b)    ((uint16_t)(((a)>(b)) ? (a):(b)))
 
 
#define FCALL_AC_MONITOR         (1.0/10.0e-6)
 
 
#if HIGH_VOLTAGE == 1 // defined in revision.h
#define AC_SENSE_GAIN             (3.771e-3)
#else 
#define AC_SENSE_GAIN             (37.585e-3)
#endif // #if HIGH_VOLTAGE == 1 
 
 
#define FIN_MIN                   (40.0)
 
 
#define FIN_MAX                   (65.0)
 
 
#if HIGH_VOLTAGE == 1
#define UV_TRIG               10//<<<(60.0)
#else
#define UV_TRIG               (8.0)
#endif // #if HIGH_VOLTAGE == '1'
 
 
#define UV_HYS                (2.0)
 
 
#if HIGH_VOLTAGE == 1
#define OV_TRIG               350//<<<(240.0)
#else
#define OV_TRIG               (80.0)
#endif // #if HIGH_VOLTAGE == '1'
 
 
#define OV_HYS                (2.0)
 
 
// ZC_TIMEOUT: 
#define ZC_TIMEOUT             (2.0e-3) 
 
 
#define ZC_TMIN                (100.0e-6)  
 
 
#define AC_DROP_TIMEOUT           (25.0e-3)
 
//------------------------------------------------------------------------------
// convert values above from SI units to integers for use by the firmware
// these macros should not need to be modified by the end user
//------------------------------------------------------------------------------
 
 
#define DC_ACCEPTANCE_PERIOD_TICKS      (rnd(FCALL_AC_MONITOR * 40.0e-3))
 
 
#define FIN_MIN_TICKS                 (rnd(FCALL_AC_MONITOR / FIN_MIN))  
 
 
#define FIN_MAX_TICKS                 (rnd(FCALL_AC_MONITOR / FIN_MAX))
 
 
#define ZC_TIMEOUT_TICKS           (rnd(FCALL_AC_MONITOR * ZC_TIMEOUT))
 
 
#define ZC_TMIN_TICKS          (rnd(FCALL_AC_MONITOR * ZC_TMIN))
 
 
#define AC_DROP_TIMEOUT_TICKS     (rnd(FCALL_AC_MONITOR * AC_DROP_TIMEOUT))
   
// ADC thresholds corresponding to UV and OV levels
// these are compared to the averaged rectified AC values
 
 
 
#define UV_TRIG_ADC           (rnd((UV_TRIG*AC_SENSE_GAIN)/3.3*4096))
 
 
#define UV_CLR_ADC            (rnd(((UV_TRIG + UV_HYS)*AC_SENSE_GAIN)/3.3*4096))
 
 
#define OV_TRIG_ADC           (rnd((OV_TRIG*AC_SENSE_GAIN)/3.3*4096))
 
 
#define OV_CLR_ADC            (rnd(((OV_TRIG - OV_HYS)*AC_SENSE_GAIN)/3.3*4096))
 
 
 
#if HIGH_VOLTAGE == 1
#define HV_FLAG     (1<<15)
#else
#define HV_FLAG     (0<<15)     
#endif // #if HIGH_VOLTAGE == '1'
 
// OP AMP Bias, ideal value
#define OPAMP_BIAS_IDEAL            ((uint16_t)(1.65/3.3*4096)) // in ADC codes
 
// OPAMP_BIAS_HIGH_LIMIT and OPAMP_BIAS_LOW_LIMIT: measured op amp bias should be within 5% of ideal value
#define OPAMP_BIAS_HIGH_LIMIT       ((uint16_t)(OPAMP_BIAS_IDEAL*1.05)) // in ADC codes
#define OPAMP_BIAS_LOW_LIMIT        ((uint16_t)(OPAMP_BIAS_IDEAL*0.95)) // in ADC codes
 
//------------------------------------------------------------------------------
// function declarations
//------------------------------------------------------------------------------
void vacm_reset_phase_monitor_object(struct VACM_s* vacm_obj);
void vacm_state_machine(struct VACM_s* vacm_obj);
void vacm_reset_state_machine(struct VACM_s* vacm_obj);
 
#ifdef  __cplusplus
extern "C" {
#endif /* __cplusplus */
  
  // TODO If C++ is being used, regular C code needs function names to have C 
  // linkage so the functions can be used by the c code. 
 
//------------------------------------------------------------------------------
// compile time protection
//------------------------------------------------------------------------------
#ifndef HIGH_VOLTAGE
#error HIGH_VOLTAGE must be defined as either 0 or 1 in revision.h
#else 
#if HIGH_VOLTAGE != 0 && HIGH_VOLTAGE != 1
#error HIGH_VOLTAGE must be defined as either 0 or 1 in revision.h
#endif 
#endif
  
//------------------------------------------------------------------------------
// variables  
//------------------------------------------------------------------------------
extern VACM_t phase1;
extern VACM_t phase2;
extern VACM_t phase3;
  
#ifdef  __cplusplus
}
#endif /* __cplusplus */
 
#endif  /* VAC_MONITOR_H */