hallcurrent4.h File Reference

This file contains API for Hall Current 4 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	hallcurrent4_t
	Click ctx object definition. More...
struct	hallcurrent4_cfg_t
	Click configuration structure definition. More...

Macros
#define	HALLCURRENT4_MAP_MIKROBUS(cfg, mikrobus)
#define	HALLCURRENT4_RETVAL   uint8_t
#define	HALLCURRENT4_OK   0x00
#define	HALLCURRENT4_INIT_ERROR   0xFF
#define	HALLCURRENT4_DEVICE_SLAVE_ADDRESS   0x4D

Functions
void	hallcurrent4_cfg_setup (hallcurrent4_cfg_t *cfg)
	Config Object Initialization function.
HALLCURRENT4_RETVAL	hallcurrent4_init (hallcurrent4_t *ctx, hallcurrent4_cfg_t *cfg)
	Initialization function.
void	hallcurrent4_generic_write (hallcurrent4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	hallcurrent4_generic_read (hallcurrent4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
uint16_t	hallcurrent4_get_raw_data (hallcurrent4_t *ctx)
	Reads raw (ADC) current data.
float	hallcurrent4_get_current_data (hallcurrent4_t *ctx)
	Reads current in mA.

Detailed Description

This file contains API for Hall Current 4 Click driver.