Public function

Functions
void	fan4_cfg_setup (fan4_cfg_t *cfg)
	Config Object Initialization function.
FAN4_RETVAL	fan4_init (fan4_t *ctx, fan4_cfg_t *cfg)
	Initialization function.
void	fan4_default_cfg (fan4_t *ctx)
	Click Default Configuration function.
void	fan4_generic_write (fan4_t *ctx, uint8_t cmd)
	Generic write function.
void	fan4_generic_read (fan4_t *ctx, uint8_t *data_out)
	Generic read function.
FAN4_RETVAL	fan4_set_output (fan4_t *ctx, uint16_t output_volt, uint8_t boost_start_timer)
	Set output voltage.
uint8_t	fan4_check_diagnostic (fan4_t *ctx)
	Check diagnostic.

Detailed Description

Function Documentation

fan4_cfg_setup()

void fan4_cfg_setup

(

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

fan4_check_diagnostic()

uint8_t fan4_check_diagnostic

(

fan4_t *

ctx

)

Check diagnostic.

Parameters

ctx	Click object.

Returns

Diagnostic return value

fan4_default_cfg()

void fan4_default_cfg

(

fan4_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for Fan4 click.

fan4_generic_read()

void fan4_generic_read	(	fan4_t *	ctx,
		uint8_t *	data_out )

Generic read function.

Parameters

ctx	Click object.
data_out	Output data buf

fan4_generic_write()

void fan4_generic_write	(	fan4_t *	ctx,
		uint8_t	cmd )

Generic write function.

Parameters

ctx	Click object.
cmd	Command.

fan4_init()

FAN4_RETVAL fan4_init	(	fan4_t *	ctx,
		fan4_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

fan4_set_output()

FAN4_RETVAL fan4_set_output	(	fan4_t *	ctx,
		uint16_t	output_volt,
		uint8_t	boost_start_timer )

Set output voltage.

Parameters

ctx	Click object.
output_volt	Output voltage
boost_start_timer	boost timer