Vibro Motor 2 Click Driver

API for configuring and manipulating Vibro Motor 2 Click driver. More...

Topics
	Vibro Motor 2 PWM Settings
	Settings for configuration of Vibro Motor 2 Click driver.
	Vibro Motor 2 MikroBUS Map
	MikroBUS pin mapping of Vibro Motor 2 Click driver.
	Vibromotor2_cfg

Functions
void	vibromotor2_cfg_setup (vibromotor2_cfg_t *cfg)
	Vibro Motor 2 configuration object setup function.
err_t	vibromotor2_init (vibromotor2_t *ctx, vibromotor2_cfg_t *cfg)
	Vibro Motor 2 initialization function.
err_t	vibromotor2_set_duty_cycle (vibromotor2_t *ctx, float duty_cycle)
	Vibro Motor 2 sets PWM duty cycle.
err_t	vibromotor2_pwm_stop (vibromotor2_t *ctx)
	Vibro Motor 2 stop PWM module.
err_t	vibromotor2_pwm_start (vibromotor2_t *ctx)
	Vibro Motor 2 start PWM module.

Detailed Description

API for configuring and manipulating Vibro Motor 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

vibromotor2_cfg_setup()

void vibromotor2_cfg_setup

(

vibromotor2_cfg_t *

cfg

)

Vibro Motor 2 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See vibromotor2_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

vibromotor2_init()

err_t vibromotor2_init	(	vibromotor2_t *	ctx,
		vibromotor2_cfg_t *	cfg )

Vibro Motor 2 initialization function.

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

Parameters

[out]	ctx	: Click context object. See vibromotor2_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See vibromotor2_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

vibromotor2_pwm_start()

err_t vibromotor2_pwm_start

(

vibromotor2_t *

ctx

)

Vibro Motor 2 start PWM module.

This function starts the PWM moudle output.

Parameters

[out]

ctx

: Click context object. See vibromotor2_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

vibromotor2_pwm_stop()

err_t vibromotor2_pwm_stop

(

vibromotor2_t *

ctx

)

Vibro Motor 2 stop PWM module.

This function stops the PWM moudle output.

Parameters

[out]

ctx

: Click context object. See vibromotor2_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

vibromotor2_set_duty_cycle()

err_t vibromotor2_set_duty_cycle	(	vibromotor2_t *	ctx,
		float	duty_cycle )

Vibro Motor 2 sets PWM duty cycle.

This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).

Parameters

[out]	ctx	: Click context object. See vibromotor2_t object definition for detailed explanation.
[in]	duty_ratio	: PWM duty_ratio.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.