hallcurrent10 2.0.0.0
hallcurrent10.h File Reference

This file contains API for Hall Current 10 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  hallcurrent10_t
 Hall Current 10 Click context object. More...
 
struct  hallcurrent10_cfg_t
 Hall Current 10 Click configuration object. More...
 

Macros

#define HALLCURRENT10_SET_DEV_ADDR   0x4D
 Hall Current 10 device address setting.
 
#define HALLCURRENT10_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  hallcurrent10_return_value_t { HALLCURRENT10_OK = 0 , HALLCURRENT10_ERROR = -1 }
 Hall Current 10 Click return value data. More...
 

Functions

void hallcurrent10_cfg_setup (hallcurrent10_cfg_t *cfg)
 Hall Current 10 configuration object setup function.
 
err_t hallcurrent10_init (hallcurrent10_t *ctx, hallcurrent10_cfg_t *cfg)
 Hall Current 10 initialization function.
 
err_t hallcurrent10_default_cfg (hallcurrent10_t *ctx)
 Hall Current 10 default configuration function.
 
err_t hallcurrent10_read_adc (hallcurrent10_t *ctx, uint16_t *read_adc)
 Hall Current 10 I2C ADC reading function.
 
err_t hallcurrent10_get_adc_voltage (hallcurrent10_t *ctx, float *adc_vtg)
 Hall Current 10 get ADC voltage function.
 
err_t hallcurrent10_get_current (hallcurrent10_t *ctx, float *current)
 Hall Current 10 get current function.
 

Detailed Description

This file contains API for Hall Current 10 Click Driver.

Enumeration Type Documentation

◆ hallcurrent10_return_value_t

Hall Current 10 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT10_OK 
HALLCURRENT10_ERROR