pwrmeter3.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef PWRMETER3_H
#define PWRMETER3_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define PWRMETER3_REG_EEPROM_0B             0x0B
#define PWRMETER3_REG_EEPROM_0C             0x0C
#define PWRMETER3_REG_EEPROM_0D             0x0D
#define PWRMETER3_REG_EEPROM_0E             0x0E
#define PWRMETER3_REG_EEPROM_0F             0x0F
 
#define PWRMETER3_REG_SHADOW_1B             0x1B
#define PWRMETER3_REG_SHADOW_1C             0x1C
#define PWRMETER3_REG_SHADOW_1D             0x1D
#define PWRMETER3_REG_SHADOW_1E             0x1E
#define PWRMETER3_REG_SHADOW_1F             0x1F
 
#define PWRMETER3_REG_VOLATILE_20           0x20
#define PWRMETER3_REG_VOLATILE_21           0x21
#define PWRMETER3_REG_VOLATILE_22           0x22
#define PWRMETER3_REG_VOLATILE_25           0x25
#define PWRMETER3_REG_VOLATILE_26           0x26
#define PWRMETER3_REG_VOLATILE_27           0x27
#define PWRMETER3_REG_VOLATILE_28           0x28
#define PWRMETER3_REG_VOLATILE_29           0x29
#define PWRMETER3_REG_VOLATILE_2A           0x2A
#define PWRMETER3_REG_VOLATILE_2C           0x2C
#define PWRMETER3_REG_VOLATILE_2D           0x2D
#define PWRMETER3_REG_VOLATILE_2F           0x2F
#define PWRMETER3_REG_VOLATILE_30           0x30
 
 // pwrmeter3_reg
 
#define PWRMETER3_CUST_ACCESS_CODE          0x4F70656Eul
#define PWRMETER3_CUST_ACCESS_CODE_CLEAR    0x00000000ul
 
#define PWRMETER3_VEVENT_CYCS_MASK          0x0000003Ful
#define PWRMETER3_OVERVREG_MASK             0x00003F00ul
#define PWRMETER3_UNDERVREG_MASK            0x000FC000ul
#define PWRMETER3_DELAYCNT_SEL_MASK         0x00100000ul
#define PWRMETER3_HALFCYCLC_EN_MASK         0x00200000ul
#define PWRMETER3_SQUAREWAVE_EN_MASK        0x00400000ul
#define PWRMETER3_ZEROCROSSCHANSEL_MASK     0x00800000ul
#define PWRMETER3_ZEROCROSSEDGESEL_MASK     0x01000000ul
#define PWRMETER3_ECC_MASK                  0xFC000000ul
#define PWRMETER3_OVERVREG_MAX              63
#define PWRMETER3_UNDERVREG_MAX             63
#define PWRMETER3_OVERVREG_3                3
#define PWRMETER3_UNDERVREG_1               1
 
#define PWRMETER3_I2C_SLV_ADDR_MASK         0x000001FCul
#define PWRMETER3_I2C_DIS_SLV_ADDR          0x00000200ul
#define PWRMETER3_DIO_0_SEL_MASK            0x00000C00ul
#define PWRMETER3_DIO_1_SEL_MASK            0x00003000ul
#define PWRMETER3_N_MASK                    0x00FFC000ul
#define PWRMETER3_BYPASS_N_EN_MASK          0x01000000ul
#define PWRMETER3_DIO_0_SEL_ZC              0
#define PWRMETER3_DIO_0_SEL_OV              1
#define PWRMETER3_DIO_0_SEL_UV              2
#define PWRMETER3_DIO_0_SEL_OV_UV           3
#define PWRMETER3_DIO_1_SEL_OCF             0
#define PWRMETER3_DIO_1_SEL_UV              1
#define PWRMETER3_DIO_1_SEL_OV              2
#define PWRMETER3_DIO_1_SEL_OV_UV_OCF       3
#define PWRMETER3_BYPASS_N_DISABLE          0
#define PWRMETER3_BYPASS_N_ENABLE           1
#define PWRMETER3_MAX_NUM_SAMPLES           1023u
 
#define PWRMETER3_RSENSE_OHM                2000.0f
#define PWRMETER3_AC_RDIV_OHM               2000000.0f
#define PWRMETER3_DC_RDIV_OHM               4000000.0f
#define PWRMETER3_ADC_FSCALE                55000u
#define PWRMETER3_DELTA_VIN_MAX_mV          250
#define PWRMETER3_mV_TO_V                   1000u
#define PWRMETER3_MAX_CURRENT               90
#define PWRMETER3_DEF_AVG_SAMPLES           500u
 
#define PWRMETER3_DEVICE_ADDRESS_0          0x60
#define PWRMETER3_DEVICE_ADDRESS_1          0x61
#define PWRMETER3_DEVICE_ADDRESS_2          0x64
#define PWRMETER3_DEVICE_ADDRESS_3          0x65
 
 // pwrmeter3_set
 
#define PWRMETER3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.dio1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.dio0 = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // pwrmeter3_map
 // pwrmeter3
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    // Input pins
    digital_in_t dio1;          
    digital_in_t dio0;          
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
    uint8_t bypass_n_en;        
} pwrmeter3_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    pin_name_t dio1;            
    pin_name_t dio0;            
    pin_name_t en;              
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} pwrmeter3_cfg_t;
 
typedef enum
{
    PWRMETER3_OK = 0,
    PWRMETER3_ERROR = -1
 
} pwrmeter3_return_value_t;
 
void pwrmeter3_cfg_setup ( pwrmeter3_cfg_t *cfg );
 
err_t pwrmeter3_init ( pwrmeter3_t *ctx, pwrmeter3_cfg_t *cfg );
 
err_t pwrmeter3_default_cfg ( pwrmeter3_t *ctx );
 
err_t pwrmeter3_write_register ( pwrmeter3_t *ctx, uint8_t reg, uint32_t data_in );
 
err_t pwrmeter3_read_register ( pwrmeter3_t *ctx, uint8_t reg, uint32_t *data_out );
 
uint8_t pwrmeter3_get_dio0_pin ( pwrmeter3_t *ctx );
 
uint8_t pwrmeter3_get_dio1_pin ( pwrmeter3_t *ctx );
 
void pwrmeter3_enable_device ( pwrmeter3_t *ctx );
 
void pwrmeter3_disable_device ( pwrmeter3_t *ctx );
 
err_t pwrmeter3_allow_write_access ( pwrmeter3_t *ctx );
 
err_t pwrmeter3_deny_write_access ( pwrmeter3_t *ctx );
 
err_t pwrmeter3_set_bypass_n_state ( pwrmeter3_t *ctx, uint8_t state );
 
err_t pwrmeter3_set_num_samples ( pwrmeter3_t *ctx, uint16_t num_samples );
 
err_t pwrmeter3_set_dio0_sel ( pwrmeter3_t *ctx, uint8_t dio_sel );
 
err_t pwrmeter3_set_dio1_sel ( pwrmeter3_t *ctx, uint8_t dio_sel );
 
err_t pwrmeter3_set_ovrms_threshold ( pwrmeter3_t *ctx, uint8_t ovrms );
 
err_t pwrmeter3_set_uvrms_threshold ( pwrmeter3_t *ctx, uint8_t uvrms );
 
err_t pwrmeter3_read_rms ( pwrmeter3_t *ctx, float *v_rms, float *i_rms );
 
err_t pwrmeter3_read_average_rms ( pwrmeter3_t *ctx, float *v_rms, float *i_rms, uint16_t num_avg );
 
#ifdef __cplusplus
}
#endif
#endif // PWRMETER3_H
 
 // pwrmeter3
 
// ------------------------------------------------------------------------ END