Button Play Click Driver

API for configuring and manipulating Button Play Click driver. More...

Topics
	Button Play PWM Settings
	Settings for configuration of Button Play Click driver.
	Button Play MikroBUS Map
	MikroBUS pin mapping of Button Play Click driver.
	Buttonplay_cfg

Functions
void	buttonplay_cfg_setup (buttonplay_cfg_t *cfg)
	Button Play configuration object setup function.
err_t	buttonplay_init (buttonplay_t *ctx, buttonplay_cfg_t *cfg)
	Button Play initialization function.
err_t	buttonplay_set_duty_cycle (buttonplay_t *ctx, float duty_cycle)
	Button Play sets PWM duty cycle.
err_t	buttonplay_pwm_stop (buttonplay_t *ctx)
	Button Play stop PWM module.
err_t	buttonplay_pwm_start (buttonplay_t *ctx)
	Button Play start PWM module.
uint8_t	buttonplay_get_button_state (buttonplay_t *ctx)
	Button Play get button state function.

Detailed Description

API for configuring and manipulating Button Play 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

buttonplay_cfg_setup()

void buttonplay_cfg_setup

(

buttonplay_cfg_t *

cfg

)

Button Play configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

buttonplay_get_button_state()

uint8_t buttonplay_get_button_state

(

buttonplay_t *

ctx

)

Button Play get button state function.

This function reads the digital signal from the INT pin which tells us whether the button has been pressed or not.

Parameters

[out]

ctx

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

Returns

Function returns pin logical state (1 or 0).

See #err_t definition for detailed explanation.

Note

None.

buttonplay_init()

err_t buttonplay_init	(	buttonplay_t *	ctx,
		buttonplay_cfg_t *	cfg )

Button Play initialization function.

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

Parameters

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

buttonplay_pwm_start()

err_t buttonplay_pwm_start

(

buttonplay_t *

ctx

)

Button Play start PWM module.

This function starts the PWM moudle output.

Parameters

[out]

ctx

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

buttonplay_pwm_stop()

err_t buttonplay_pwm_stop

(

buttonplay_t *

ctx

)

Button Play stop PWM module.

This function stops the PWM moudle output.

Parameters

[out]

ctx

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

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

buttonplay_set_duty_cycle()

err_t buttonplay_set_duty_cycle	(	buttonplay_t *	ctx,
		float	duty_cycle )

Button Play sets PWM duty cycle.

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

Parameters

[out]	ctx	: Click context object. See buttonplay_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.