pwrmeter2.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 PWRMETER2_H
#define PWRMETER2_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_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define PWRMETER2_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.md1  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
   cfg.rst  = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.md0  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
   cfg.dr   = MIKROBUS( mikrobus, MIKROBUS_INT );
#define PWRMETER2_OK                            0
#define PWRMETER2_ERROR                        -1
#define PWRMETER2_REG_CH0_ADC_DATA              0x00
#define PWRMETER2_REG_CH1_ADC_DATA              0x01
#define PWRMETER2_REG_MODUL_OUTPUT              0x08
#define PWRMETER2_REG_PHASE_CONFIG              0x0A
#define PWRMETER2_REG_GAIN_CONFIG               0x0B
#define PWRMETER2_REG_STATUS_COMM               0x0C
#define PWRMETER2_REG_CONFIG0                   0x0D
#define PWRMETER2_REG_CONFIG1                   0x0E
#define PWRMETER2_REG_OFFCAL_CH0                0x0F
#define PWRMETER2_REG_GAINCAL_CH0               0x10
#define PWRMETER2_REG_OFFCAL_CH1                0x11
#define PWRMETER2_REG_GAINCAL_CH1               0x12
#define PWRMETER2_REG_LOCK_CRC                  0x1F
#define PWRMETER2_CH0_GAIN1                     0x000000ul
#define PWRMETER2_CH0_GAIN2                     0x000001ul
#define PWRMETER2_CH0_GAIN4                     0x000002ul
#define PWRMETER2_CH0_GAIN8                     0x000003ul
#define PWRMETER2_CH0_GAIN16                    0x000004ul
#define PWRMETER2_CH0_GAIN32                    0x000005ul
#define PWRMETER2_CH1_GAIN1                     0x000000ul
#define PWRMETER2_CH1_GAIN2                     0x000008ul
#define PWRMETER2_CH1_GAIN4                     0x000010ul
#define PWRMETER2_CH1_GAIN8                     0x000018ul
#define PWRMETER2_CH1_GAIN16                    0x000020ul
#define PWRMETER2_CH1_GAIN32                    0x000028ul
#define PWRMETER2_READ_SAME_SINGLE_REG          0x000000ul
#define PWRMETER2_READ_REG_GROUPS               0x400000ul
#define PWRMETER2_READ_REG_TYPES                0x800000ul
#define PWRMETER2_READ_ENTIRE_REG_MAP           0xC00000ul
#define PWRMETER2_ADDR_COUNT_NOT_INCR_WRITE     0x000000ul
#define PWRMETER2_ADDR_COUNT_INCR_WRITE         0x200000ul
#define PWRMETER2_DR_PIN_HIGH_IMP_NOT_READY     0x000000ul
#define PWRMETER2_DR_PIN_LOGIC_HIGH_NOT_READY   0x100000ul
#define PWRMETER2_DATA_READY_LINK_DIS           0x000000ul
#define PWRMETER2_DATA_READY_LINK_EN            0x080000ul
#define PWRMETER2_CRC_WIDTH_16_BIT              0x000000ul
#define PWRMETER2_CRC_WIDTH_32_BIT              0x040000ul
#define PWRMETER2_DATA_WIDTH_16_BIT             0x000000ul
#define PWRMETER2_DATA_WIDTH_24_BIT             0x010000ul
#define PWRMETER2_DATA_WIDTH_32_BIT_WITH_ZEROS  0x020000ul
#define PWRMETER2_DATA_WIDTH_32_BIT_WITH_SIGN   0x030000ul
#define PWRMETER2_CRC_DIS                       0x000000ul
#define PWRMETER2_CRC_EN                        0x008000ul
#define PWRMETER2_CRCREG_INTERR_DIS             0x000000ul
#define PWRMETER2_CRCREG_INTERR_EN              0x004000ul
#define PWRMETER2_MODUL_OUTPUT_DIS              0x000000ul
#define PWRMETER2_MODUL_OUTPUT_EN               0x000800ul
#define PWRMETER2_OFFCAL_DIS                    0x000000ul
#define PWRMETER2_OFFCAL_EN                     0x800000ul
#define PWRMETER2_GAINCAL_DIS                   0x000000ul
#define PWRMETER2_GAINCAL_EN                    0x400000ul
#define PWRMETER2_DITHERING_OFF                 0x000000ul
#define PWRMETER2_DITHERING_STRENGTH_MIN        0x100000ul
#define PWRMETER2_DITHERING_STRENGTH_MED        0x200000ul
#define PWRMETER2_DITHERING_STRENGTH_MAX        0x300000ul
#define PWRMETER2_CURRENT_X_0_5                 0x000000ul
#define PWRMETER2_CURRENT_X_0_66                0x040000ul
#define PWRMETER2_CURRENT_X_1                   0x080000ul
#define PWRMETER2_CURRENT_X_2                   0x0C0000ul
#define PWRMETER2_AMCLK_MCLK                    0x000000ul
#define PWRMETER2_AMCLK_MCLK_PER_2              0x010000ul
#define PWRMETER2_AMCLK_MCLK_PER_4              0x020000ul
#define PWRMETER2_AMCLK_MCLK_PER_8              0x030000ul
#define PWRMETER2_OSR_32                        0x000000ul
#define PWRMETER2_OSR_64                        0x002000ul
#define PWRMETER2_OSR_128                       0x004000ul
#define PWRMETER2_OSR_256                       0x006000ul
#define PWRMETER2_OSR_512                       0x008000ul
#define PWRMETER2_OSR_1024                      0x00A000ul
#define PWRMETER2_OSR_2048                      0x00C000ul
#define PWRMETER2_OSR_4096                      0x00E000ul
#define PWRMETER2_CH0_NORMAL_MODE               0x000000ul
#define PWRMETER2_CH1_NORMAL_MODE               0x000000ul
#define PWRMETER2_CH0_SOFT_RESET_MODE           0x010000ul
#define PWRMETER2_CH1_SOFT_RESET_MODE           0x020000ul
#define PWRMETER2_CH0_SHUTDOWN_MODE             0x000100ul
#define PWRMETER2_CH1_SHUTDOWN_MODE             0x000200ul
#define PWRMETER2_INTERNAL_VOL_REF_EN           0x000000ul
#define PWRMETER2_INTERNAL_VOL_REF_DIS          0x000080ul
#define PWRMETER2_INTERNAL_CLOCK_EN             0x000000ul
#define PWRMETER2_INTERNAL_CLOCK_DIS            0x000040ul
#define PWRMETER2_CH0_CHECK_DIS                 0x00
#define PWRMETER2_CH1_CHECK_DIS                 0x00
#define PWRMETER2_CH0_CHECK_EN                  0x01
#define PWRMETER2_CH1_CHECK_EN                  0x02
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
    digital_out_t rst;
 
    // Input pins 
    digital_in_t md1;
    digital_in_t md0;
    digital_in_t dr;
    
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
 
} pwrmeter2_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
    pin_name_t md1;
    pin_name_t rst;
    pin_name_t md0;
    pin_name_t dr;
 
    // static variable 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} pwrmeter2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void pwrmeter2_cfg_setup ( pwrmeter2_cfg_t *cfg );
 
err_t pwrmeter2_init ( pwrmeter2_t *ctx, pwrmeter2_cfg_t *cfg );
 
err_t pwrmeter2_default_cfg ( pwrmeter2_t *ctx );
 
err_t pwrmeter2_write_reg ( pwrmeter2_t *ctx, uint8_t reg, uint32_t data_in );
 
err_t pwrmeter2_read_reg ( pwrmeter2_t *ctx, uint8_t reg, uint32_t *data_out, uint8_t len );
 
err_t pwrmeter2_read_conv_data ( pwrmeter2_t *ctx, uint32_t *data_ch_0, uint32_t *data_ch_1 );
 
err_t pwrmeter2_get_data ( pwrmeter2_t *ctx, float *voltage, float *current, float *power );
 
void pwrmeter2_reset( pwrmeter2_t *ctx );
 
uint8_t pwrmeter2_get_modulator_1 ( pwrmeter2_t *ctx );
 
uint8_t pwrmeter2_get_modulator_0 ( pwrmeter2_t *ctx );
 
uint8_t pwrmeter2_check_ready_pin ( pwrmeter2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _PWRMETER2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END