current14  2.1.0.0
Data Structures | Macros | Enumerations | Functions
current14.h File Reference

This file contains API for Current 14 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  current14_t
 Current 14 Click context object. More...
 
struct  current14_cfg_t
 Current 14 Click configuration object. More...
 

Macros

#define CURRENT14_REG_STA1   0x0F
 Current 14 register list. More...
 
#define CURRENT14_REG_DATA_LSB   0x10
 
#define CURRENT14_REG_DATA_MSB   0x11
 
#define CURRENT14_REG_CNTL1   0x1B
 
#define CURRENT14_REG_CNTL2   0x1C
 
#define CURRENT14_REG_CNTL3   0x1D
 
#define CURRENT14_REG_CNTL4_LSB   0x5C
 
#define CURRENT14_REG_CNTL4_MSB   0x5D
 
#define CURRENT14_STA1_RD_DRDY   0x80
 Current 14 STA1 register setting. More...
 
#define CURRENT14_CNTL1_PC1_POWER_DOWN   0x00
 Current 14 CNTL1 register setting. More...
 
#define CURRENT14_CNTL1_PC1_ACTIVE   0x80
 
#define CURRENT14_CNTL1_PC1_MASK   0x80
 
#define CURRENT14_CNTL1_RST_LV_RELEASE   0x00
 
#define CURRENT14_CNTL1_RST_LV_ACTIVE   0x20
 
#define CURRENT14_CNTL1_RST_LV_MASK   0x20
 
#define CURRENT14_CNTL1_ODR_20_HZ   0x00
 
#define CURRENT14_CNTL1_ODR_100_HZ   0x08
 
#define CURRENT14_CNTL1_ODR_200_HZ   0x10
 
#define CURRENT14_CNTL1_ODR_1_KHZ   0x18
 
#define CURRENT14_CNTL1_ODR_MASK   0x18
 
#define CURRENT14_CNTL1_FS1_CONTINUOUS   0x00
 
#define CURRENT14_CNTL1_FS1_SINGLE   0x02
 
#define CURRENT14_CNTL1_FS1_MASK   0x02
 
#define CURRENT14_CNTL2_ALERT_EN   0x08
 Current 14 CNTL2 register setting. More...
 
#define CURRENT14_CNTL3_FORCE   0x40
 Current 14 CNTL3 register setting. More...
 
#define CURRENT14_CNTL4_RELEASE   0x0000
 Current 14 CNTL4 register setting. More...
 
#define CURRENT14_ODR_20_HZ   0
 Current 14 ODR setting. More...
 
#define CURRENT14_ODR_100_HZ   1
 
#define CURRENT14_ODR_200_HZ   2
 
#define CURRENT14_ODR_1_KHZ   3
 
#define CURRENT14_TIMEOUT_MS   2000
 Current 14 timeout setting. More...
 
#define CURRENT14_DEVICE_ADDRESS_0   0x0E
 Current 14 device address setting. More...
 
#define CURRENT14_DEVICE_ADDRESS_1   0x0F
 
#define CURRENT14_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  current14_return_value_t { CURRENT14_OK = 0, CURRENT14_ERROR = -1 }
 Current 14 Click return value data. More...
 

Functions

void current14_cfg_setup (current14_cfg_t *cfg)
 Current 14 configuration object setup function. More...
 
err_t current14_init (current14_t *ctx, current14_cfg_t *cfg)
 Current 14 initialization function. More...
 
err_t current14_default_cfg (current14_t *ctx)
 Current 14 default configuration function. More...
 
err_t current14_write_reg_byte (current14_t *ctx, uint8_t reg, uint8_t data_in)
 Current 14 write reg byte function. More...
 
err_t current14_write_reg_word (current14_t *ctx, uint8_t reg, uint16_t data_in)
 Current 14 write reg word function. More...
 
err_t current14_read_reg_byte (current14_t *ctx, uint8_t reg, uint8_t *data_out)
 Current 14 read reg byte function. More...
 
uint8_t current14_get_alert_pin (current14_t *ctx)
 Current 14 get alert pin function. More...
 
err_t current14_set_odr (current14_t *ctx, uint8_t odr)
 Current 14 set odr function. More...
 
err_t current14_read_data (current14_t *ctx, int16_t *data_out)
 Current 14 read data function. More...
 
err_t current14_calib_offset (current14_t *ctx)
 Current 14 calib offset function. More...
 
err_t current14_calib_resolution (current14_t *ctx, float calib_current)
 Current 14 calib resolution function. More...
 
err_t current14_get_current (current14_t *ctx, float *current)
 Current 14 get current function. More...
 

Detailed Description

This file contains API for Current 14 Click Driver.

Enumeration Type Documentation

◆ current14_return_value_t

Current 14 Click return value data.

Predefined enum values for driver return values.

Enumerator
CURRENT14_OK 
CURRENT14_ERROR