Public function

Functions
void	hztov2_cfg_setup (hztov2_cfg_t *cfg)
	Config Object Initialization function.
HZTOV2_RETVAL	hztov2_init (hztov2_t *ctx, hztov2_cfg_t *cfg)
	Initialization function.
hztov2_data_t	hztov2_generic_read (hztov2_t *ctx)
	Generic read function.
float	hztov2_read_voltage (hztov2_t *ctx)
	Read voltage function.
void	hztov2_en_pin (hztov2_t *ctx, uint8_t pin_state)
	Function for enabling the click board.
HZTOV2_RETVAL	hztov2_fin_set (hztov2_t *ctx, uint32_t fin)
	PWM frequency set function.

Detailed Description

Function Documentation

hztov2_cfg_setup()

void hztov2_cfg_setup

(

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

hztov2_en_pin()

void hztov2_en_pin	(	hztov2_t *	ctx,
		uint8_t	pin_state )

Function for enabling the click board.

Parameters

ctx	Click object.
pin_state	Pin state.

@description This function enable the click board.

hztov2_fin_set()

HZTOV2_RETVAL hztov2_fin_set	(	hztov2_t *	ctx,
		uint32_t	fin )

PWM frequency set function.

Parameters

ctx	Click object.
fin	PWM frequency input value in the range of 200 to 120000 Hz.

Returns

HZTOV2_RETVAL

@description This function sets PWM clock frequency at FIN pin.

hztov2_generic_read()

hztov2_data_t hztov2_generic_read

(

hztov2_t *

ctx

)

Generic read function.

Parameters

ctx	Click object.

Returns

ADC data

@description This function read ADC data.

hztov2_init()

HZTOV2_RETVAL hztov2_init	(	hztov2_t *	ctx,
		hztov2_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.

hztov2_read_voltage()

float hztov2_read_voltage

(

hztov2_t *

ctx

)

Read voltage function.

Parameters

ctx	Click object.

Returns

Voltage

@description This function read ADC data and converts it to voltage.