hallcurrent9.h File Reference

This file contains API for Hall Current 9 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	hallcurrent9_t
	Hall Current 9 Click context object. More...
struct	hallcurrent9_cfg_t
	Hall Current 9 Click configuration object. More...
struct	hallcurrent9_calibration_data_t
	Hall Current 9 Click calibration object. More...

Macros
#define	HALLCURRENT9_SET_DEV_ADDR   0x4D
	Hall Current 9 description setting.
#define	HALLCURRENT9_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	hallcurrent9_return_value_t { HALLCURRENT9_OK = 0 , HALLCURRENT9_ERROR = -1 }
	Hall Current 9 Click return value data. More...

Functions
void	hallcurrent9_cfg_setup (hallcurrent9_cfg_t *cfg)
	Hall Current 9 configuration object setup function.
err_t	hallcurrent9_init (hallcurrent9_t *ctx, hallcurrent9_cfg_t *cfg)
	Hall Current 9 initialization function.
err_t	hallcurrent9_read_adc (hallcurrent9_t *ctx, uint16_t *read_adc)
	Hall Current 9 I2C ADC reading function.
err_t	hallcurrent9_set_calibration (hallcurrent9_t *ctx, hallcurrent9_calibration_data_t *adc_val)
	Hall Current 9 set calibration function.
float	hallcurrent9_get_current (hallcurrent9_t *ctx, hallcurrent9_calibration_data_t *adc_val)
	Hall Current 9 get current function.

Detailed Description

This file contains API for Hall Current 9 Click Driver.

Enumeration Type Documentation

hallcurrent9_return_value_t

enum hallcurrent9_return_value_t

Hall Current 9 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT9_OK
HALLCURRENT9_ERROR