Public function

Functions
void	c3dhall7_cfg_setup (c3dhall7_cfg_t *cfg)
	Config Object Initialization function.
C3DHALL7_RETVAL	c3dhall7_init (c3dhall7_t *ctx, c3dhall7_cfg_t *cfg)
	Initialization function.
void	c3dhall7_default_cfg (c3dhall7_t *ctx)
	Click Default Configuration function.
void	c3dhall7_generic_write (c3dhall7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	c3dhall7_generic_read (c3dhall7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
void	c3dhall7_device_reset (c3dhall7_t *ctx)
	Hardware device reset.
void	c3dhall7_get_axis_data (c3dhall7_t *ctx, c3dhall7_axis_t *axis)
	Get Axis data function.
void	c3dhall7_software_reset (c3dhall7_t *ctx)
	Software device reset.
void	c3dhall7_configuration (c3dhall7_t *ctx, uint8_t reg, uint16_t data_in)
	Configuration function (for ctrl register).
void	c3dhall7_device_info (c3dhall7_t *ctx, c3dhall7_dev_info_t *info)
	Device info function.
void	c3dhall7_get_status (c3dhall7_t *ctx, c3dhall7_status_t *status)
	Measurement status function.
void	c3dhall7_get_interrupt_state (c3dhall7_t *ctx, c3dhall7_int_state_t *state)
	Interrupt state function.

Detailed Description

Function Documentation

c3dhall7_cfg_setup()

void c3dhall7_cfg_setup

(

c3dhall7_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

c3dhall7_configuration()

void c3dhall7_configuration	(	c3dhall7_t *	ctx,
		uint8_t	reg,
		uint16_t	data_in )

Configuration function (for ctrl register).

Parameters

ctx	Click object.
reg	Address where data be written.
data_in	Config data

@description This function reads data from the desired register.

c3dhall7_default_cfg()

void c3dhall7_default_cfg

(

c3dhall7_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for 3D Hall 7 click.

c3dhall7_device_info()

void c3dhall7_device_info	(	c3dhall7_t *	ctx,
		c3dhall7_dev_info_t *	info )

Device info function.

Parameters

ctx	Click object.
T_C3DHALL7_DEV_INFO	Tructure of device information

@description This function reads data from the desired register.

c3dhall7_device_reset()

void c3dhall7_device_reset

(

c3dhall7_t *

ctx

)

Hardware device reset.

Parameters

ctx	Click object.

@description This function reads data from the desired register.

c3dhall7_generic_read()

void c3dhall7_generic_read	(	c3dhall7_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function reads data from the desired register.

c3dhall7_generic_write()

void c3dhall7_generic_write	(	c3dhall7_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number of the bytes to be read

@description This function writes data to the desired register.

c3dhall7_get_axis_data()

void c3dhall7_get_axis_data	(	c3dhall7_t *	ctx,
		c3dhall7_axis_t *	axis )

Get Axis data function.

Parameters

ctx	Click object.
T_C3DHALL7_AXIS	axis structure of axis data

@description This function reads data from the desired register.

c3dhall7_get_interrupt_state()

void c3dhall7_get_interrupt_state	(	c3dhall7_t *	ctx,
		c3dhall7_int_state_t *	state )

Interrupt state function.

Parameters

ctx	Click object.
T_C3DHALL7_INT_STATE	structure of Interrupt pin state

@description This function reads data from the desired register.

c3dhall7_get_status()

void c3dhall7_get_status	(	c3dhall7_t *	ctx,
		c3dhall7_status_t *	status )

Measurement status function.

Parameters

ctx	Click object.
T_C3DHALL7_STATUS	Structure of measurement status

@description This function reads data from the desired register.

c3dhall7_init()

C3DHALL7_RETVAL c3dhall7_init	(	c3dhall7_t *	ctx,
		c3dhall7_cfg_t *	cfg )

Initialization function.

Parameters

c3dhall7	Click object.
cfg	Click configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

c3dhall7_software_reset()

void c3dhall7_software_reset

(

c3dhall7_t *

ctx

)

Software device reset.

Parameters

ctx	Click object.

@description This function reads data from the desired register.