Public function

Functions
void	gaussmeter_cfg_setup (gaussmeter_cfg_t *cfg)
	Config Object Initialization function.
GAUSSMETER_RETVAL	gaussmeter_init (gaussmeter_t *ctx, gaussmeter_cfg_t *cfg)
	Initialization function.
void	gaussmeter_default_cfg (gaussmeter_t *ctx)
	Click Default Configuration function.
uint8_t	gaussmeter_write_reg (gaussmeter_t *ctx, uint8_t reg_addr, uint16_t transfer_data)
	Write register function.
uint8_t	gaussmeter_send_command (gaussmeter_t *ctx, uint8_t command)
	Send command function.
void	gaussmeter_enable_measure (gaussmeter_t *ctx, uint8_t temp)
	Enable measure function.
uint8_t	gaussmeter_get_data (gaussmeter_t *ctx, float *output_data)
	Get data function.
void	gaussmeter_generic_data_transfer (gaussmeter_t *ctx, uint8_t *write_buf, uint8_t write_len, uint8_t *read_buf, uint8_t read_len)
	Generic read function.
uint8_t	gaussmeter_digital_read_int (gaussmeter_t *ctx)
	Digital read interrupt function.
uint8_t	gaussmeter_digital_read_pwm (gaussmeter_t *ctx)
	Digital read pwm function.

Detailed Description

Function Documentation

gaussmeter_cfg_setup()

void gaussmeter_cfg_setup

(

gaussmeter_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.

gaussmeter_default_cfg()

void gaussmeter_default_cfg

(

gaussmeter_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for Gaussmeter click.

gaussmeter_digital_read_int()

uint8_t gaussmeter_digital_read_int

(

gaussmeter_t *

ctx

)

Digital read interrupt function.

Parameters

ctx	Click object.

@description This function reads the digital input signal from the INT pin.

gaussmeter_digital_read_pwm()

uint8_t gaussmeter_digital_read_pwm

(

gaussmeter_t *

ctx

)

Digital read pwm function.

Parameters

ctx	Click object.

@description This function reads the digital input signal from the PWM pin.

gaussmeter_enable_measure()

void gaussmeter_enable_measure	(	gaussmeter_t *	ctx,
		uint8_t	temp )

Enable measure function.

Parameters

ctx	Click object.
temp	Command value.

@description This function enables the measurement function on the chip.

gaussmeter_generic_data_transfer()

void gaussmeter_generic_data_transfer	(	gaussmeter_t *	ctx,
		uint8_t *	write_buf,
		uint8_t	write_len,
		uint8_t *	read_buf,
		uint8_t	read_len )

Generic read function.

Parameters

ctx	Click object.
write_buf	Output data buf
write_len	Number of the bytes to be written.
read_buf	Data buf to be written.
read_len	Number of the bytes to be read.

@description This function reads data from the desired register.

gaussmeter_get_data()

uint8_t gaussmeter_get_data	(	gaussmeter_t *	ctx,
		float *	output_data )

Get data function.

Parameters

ctx	Click object.
output_data	Command value.

@description This function reads the temperature and axis data from the chip.

gaussmeter_init()

GAUSSMETER_RETVAL gaussmeter_init	(	gaussmeter_t *	ctx,
		gaussmeter_cfg_t *	cfg )

Initialization function.

Parameters

gaussmeter	Click object.
cfg	Click configuration structure.

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

gaussmeter_send_command()

uint8_t gaussmeter_send_command	(	gaussmeter_t *	ctx,
		uint8_t	command )

Send command function.

Parameters

ctx	Click object.
command	Command value.

@description This function sends a single specified command to the chip and checks for communication errors.

gaussmeter_write_reg()

uint8_t gaussmeter_write_reg	(	gaussmeter_t *	ctx,
		uint8_t	reg_addr,
		uint16_t	transfer_data )

Write register function.

Parameters

ctx	Click object.
reg_addr	Register address value.
transfer_data	Data to be transfered.

@description This function writes 16-bit data to the specified register address.