Public function

Functions
void	vtohz2_cfg_setup (vtohz2_cfg_t *cfg)
	Config Object Initialization function.
VTOHZ2_RETVAL	vtohz2_init (vtohz2_t *ctx, vtohz2_cfg_t *cfg)
	Initialization function.
void	vtohz2_default_cfg (vtohz2_t *ctx)
	Click Default Configuration function.
void	vtohz2_set_duty_cycle (vtohz2_t *ctx, float duty_cycle)
	Generic sets PWM duty cycle.
void	vtohz2_pwm_stop (vtohz2_t *ctx)
	Stop PWM module.
void	vtohz2_pwm_start (vtohz2_t *ctx)
	Start PWM module.
void	vtohz2_enable (vtohz2_t *ctx, uint8_t state)
	Enable function.
uint8_t	vtohz2_get_freq_out (vtohz2_t *ctx)
	Frequency Out Get function.

Detailed Description

Function Documentation

vtohz2_cfg_setup()

void vtohz2_cfg_setup

(

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

vtohz2_default_cfg()

void vtohz2_default_cfg

(

vtohz2_t *

ctx

)

Click Default Configuration function.

Parameters

ctx	Click object.

@description This function executes default configuration for VToHz2 click.

vtohz2_enable()

void vtohz2_enable	(	vtohz2_t *	ctx,
		uint8_t	state )

Enable function.

Parameters

ctx	Click object.
state	0 - Disable 1 - Enable

@descripion Function performs enabling and disabling of the device.

vtohz2_get_freq_out()

uint8_t vtohz2_get_freq_out

(

vtohz2_t *

ctx

)

Frequency Out Get function.

Parameters

ctx	Click object.

Returns

State of the INT pin (out frequency)

@description Function gets the out frequency on mikrobus INT pin.

vtohz2_init()

VTOHZ2_RETVAL vtohz2_init	(	vtohz2_t *	ctx,
		vtohz2_cfg_t *	cfg )

Initialization function.

Parameters

vtohz2	Click object.
cfg	Click configuration structure.

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

vtohz2_pwm_start()

void vtohz2_pwm_start

(

vtohz2_t *

ctx

)

Start PWM module.

Parameters

ctx	Click object.

@description This function starts PWM module.

vtohz2_pwm_stop()

void vtohz2_pwm_stop

(

vtohz2_t *

ctx

)

Stop PWM module.

Parameters

ctx	Click object.

@description This function stops PWM module.

vtohz2_set_duty_cycle()

void vtohz2_set_duty_cycle	(	vtohz2_t *	ctx,
		float	duty_cycle )

Generic sets PWM duty cycle.

Parameters

ctx	Click object.
duty_cycle	Duty cycle.

@description This function sets the PWM duty cycle.