pac1934.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 PAC1934_H
#define PAC1934_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define PAC1934_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.ale = MIKROBUS( mikrobus, MIKROBUS_INT ) 
#define PAC1934_RETVAL  uint8_t
 
#define PAC1934_OK           0x00
#define PAC1934_INIT_ERROR   0xFF
#define PAC1934_I2C_ADDR                                      0x10
#define PAC1934_REFRESH_CMD                                   0x00
#define PAC1934_CTRL_REG                                      0x01
 
#define PAC1934_CTRL_SAMPLE_RATE_8                     0xC0
#define PAC1934_CTRL_SAMPLE_RATE_64                   0x80
#define PAC1934_CTRL_SAMPLE_RATE_256                  0x40
#define PAC1934_CTRL_SAMPLE_RATE_1024                0x00
#define PAC1934_CTRL_SINGLE_SHOT_MODE              0x10
#define PAC1934_ACC_COUNT                                     0x02
#define PAC1934_VPOWER1_ACC                                   0x03
#define PAC1934_VPOWER2_ACC                                   0x04
#define PAC1934_VPOWER3_ACC                                   0x05
#define PAC1934_VPOWER4_ACC                                   0x06
#define PAC1934_VBUS1                                         0x07
#define PAC1934_VBUS2                                         0x08
#define PAC1934_VBUS3                                         0x09
#define PAC1934_VBUS4                                         0x0A
#define PAC1934_VSENSE1                                       0x0B
#define PAC1934_VSENSE2                                       0x0C
#define PAC1934_VSENSE3                                       0x0D
#define PAC1934_VSENSE4                                       0x0E
#define PAC1934_VBUS1_AVG                                     0x0F
#define PAC1934_VBUS2_AVG                                     0x10
#define PAC1934_VBUS3_AVG                                     0x11
#define PAC1934_VBUS4_AVG                                     0x12
#define PAC1934_VSENSE1_AVG                                   0x13
#define PAC1934_VSENSE2_AVG                                   0x14
#define PAC1934_VSENSE3_AVG                                   0x15
#define PAC1934_VSENSE4_AVG                                   0x16
#define PAC1934_VPOWER1                                       0x17
#define PAC1934_VPOWER2                                       0x18
#define PAC1934_VPOWER3                                       0x19
#define PAC1934_VPOWER4                                       0x1A
#define PAC1934_CHANNEL_DIS                                   0x1C
#define PAC1934_CHANNEL_DIS_ALL_CHA                      0xF0
#define PAC1934_NEG_PWR                                       0x1D
#define PAC1934_REFRESH_G_CMD                                 0x1E
#define PAC1934_REFRESH_V_CMD                                 0x1F
#define PAC1934_SLOW                                          0x20
#define PAC1934_CTRL_ACT                                      0x21
#define PAC1934_DIS_ACT                                       0x22
#define PAC1934_NEG_PWR_ACT                                   0x23
#define PAC1934_CTRL_LAT                                      0x24
#define PAC1934_DIS_LAT                                       0x25
#define PAC1934_NEG_PWR_LAT                                   0x26
#define PAC1934_PRODUCT_ID                                    0xFD
#define PAC1934_MANUFACT_ID                                   0xFE
#define PAC1934_REVISION_ID                                   0xFF
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t ale;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
 
} pac1934_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
 
    pin_name_t ale;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} pac1934_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void pac1934_cfg_setup ( pac1934_cfg_t *cfg );
 
PAC1934_RETVAL pac1934_init ( pac1934_t *ctx, pac1934_cfg_t *cfg );
void pac1934_generic_write ( pac1934_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void pac1934_generic_read ( pac1934_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void pac1934_write_byte ( pac1934_t *ctx, uint8_t wr_addr, uint8_t wr_data );
 
uint8_t pac1934_read_byte ( pac1934_t *ctx, uint8_t rd_addr );
 
uint16_t pac1934_read_two_byte ( pac1934_t *ctx, uint8_t rd_addr );
 
uint32_t pac1934_read_four_byte ( pac1934_t *ctx, uint8_t rd_addr );
 
void pac1934_read_reg( pac1934_t *ctx, uint8_t reg_addr, uint8_t *output_data, uint8_t cnt );
 
void pac1934_send_command ( pac1934_t *ctx, uint8_t wr_cmd );
 
float pac1934_measure_voltage ( pac1934_t *ctx, uint8_t channel );
 
float pac1934_measure_current ( pac1934_t *ctx, uint8_t channel );
 
float pac1934_measure_power ( pac1934_t *ctx, uint8_t channel );
 
float pac1934_calc_power ( pac1934_t *ctx, float voltage, float amperage );
 
float pac1934_measure_energy ( pac1934_t *ctx, uint8_t chann, uint16_t samp_rate );
 
void pac1934_dev_enable ( pac1934_t *ctx );
 
void pac1934_dev_disable ( pac1934_t *ctx );
 
void pac1934_dev_reset ( pac1934_t *ctx );
 
uint8_t pac1934_check_interrupt ( pac1934_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _PAC1934_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END